Help Center/ Cloud Connect/ API Reference/ API/ Global Private Bandwidths/ Binding a Global Private Bandwidth to an Instance
Updated on 2024-03-29 GMT+08:00

Binding a Global Private Bandwidth to an Instance

Function

This API is used to bind a global private bandwidth to an instance.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{domain_id}/gcb/gcbandwidths/{id}/associate-instance

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

gcbandwidths

Yes

Array of AssociateGlobalConnectionBandwidthInstanceRequestInfo objects

Detailed information about the instance that the global private bandwidth is bound to.

Array Length: 1 - 200

Table 4 AssociateGlobalConnectionBandwidthInstanceRequestInfo

Parameter

Mandatory

Type

Description

resource_id

Yes

String

Instance ID. The ID can contain 1 to 36 characters, including letters, digits, underscores (_), and hyphens (-).

Minimum: 1

Maximum: 36

resource_type

Yes

String

Instance type.

Minimum: 1

Maximum: 36

region_id

No

String

Region where the instance is located. If this parameter is left blank, the default value is global.

Minimum: 1

Maximum: 36

project_id

Yes

String

Project ID of the region where the instance is located.

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

gcbandwidths

Array of AssociateGlobalConnectionBandwidthInstanceResponseInfo objects

Response to the operation for binding a global private bandwidth to an instance

Array Length: 1 - 200

Table 6 AssociateGlobalConnectionBandwidthInstanceResponseInfo

Parameter

Type

Description

resource_id

String

Instance ID. The ID can contain 1 to 36 characters, including letters, digits, underscores (_), and hyphens (-).

Minimum: 1

Maximum: 36

resource_type

String

Instance type.

Minimum: 1

Maximum: 36

region_id

String

Region where the instance is located. If this parameter is left blank, the default value is global.

Minimum: 1

Maximum: 36

project_id

String

Project ID of the region where the instance is located.

Minimum: 1

Maximum: 36

result

String

Binding operation result.

  • success: The operation is successful.

  • fail: The operation failed.

message

String

Error information when the binding operation fails.

Minimum: 0

Maximum: 4096

Example Requests

Binding a global private bandwidth to an instance

POST https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/{id}/associate-instance

{
  "gcbandwidths" : [ {
    "resource_type" : "GEIP",
    "resource_id" : "37289f8a-8fd2-4eff-a6c4-f3b94bdbb1bc",
    "project_id" : "XXX",
    "region_id" : "global"
  } ]
}

Example Responses

Status code: 200

The global private bandwidth has been bound to the instance.

{
  "request_id" : "1b90e4762e3090961a30ca3a712dc0ed",
  "gcbandwidths" : [ {
    "resource_id" : "37289f8a-8fd2-4eff-a6c4-f3b94bdbb1bc",
    "resource_type" : "GEIP",
    "project_id" : "XXX",
    "region_id" : "global",
    "result" : "success",
    "message" : ""
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Binding a global private bandwidth to an instance

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

    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();
        AssociateGlobalConnectionBandwidthInstanceRequest request = new AssociateGlobalConnectionBandwidthInstanceRequest();
        AssociateGlobalConnectionBandwidthInstanceRequestBody body = new AssociateGlobalConnectionBandwidthInstanceRequestBody();
        List<AssociateGlobalConnectionBandwidthInstanceRequestInfo> listbodyGcbandwidths = new ArrayList<>();
        listbodyGcbandwidths.add(
            new AssociateGlobalConnectionBandwidthInstanceRequestInfo()
                .withResourceType("GEIP")
                .withRegionId("global")
                .withResourceId("37289f8a-8fd2-4eff-a6c4-f3b94bdbb1bc")
                .withProjectId("XXX")
        );
        body.withGcbandwidths(listbodyGcbandwidths);
        request.withBody(body);
        try {
            AssociateGlobalConnectionBandwidthInstanceResponse response = client.associateGlobalConnectionBandwidthInstance(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 global private bandwidth to an instance

 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
# 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 = AssociateGlobalConnectionBandwidthInstanceRequest()
        listGcbandwidthsbody = [
            AssociateGlobalConnectionBandwidthInstanceRequestInfo(
                resource_type="GEIP",
                region_id="global",
                resource_id="37289f8a-8fd2-4eff-a6c4-f3b94bdbb1bc",
                project_id="XXX"
            )
        ]
        request.body = AssociateGlobalConnectionBandwidthInstanceRequestBody(
            gcbandwidths=listGcbandwidthsbody
        )
        response = client.associate_global_connection_bandwidth_instance(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 global private bandwidth to an instance

 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
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.AssociateGlobalConnectionBandwidthInstanceRequest{}
	regionIdGcbandwidths:= "global"
	var listGcbandwidthsbody = []model.AssociateGlobalConnectionBandwidthInstanceRequestInfo{
        {
            ResourceType: "GEIP",
            RegionId: &regionIdGcbandwidths,
            ResourceId: "37289f8a-8fd2-4eff-a6c4-f3b94bdbb1bc",
            ProjectId: "XXX",
        },
    }
	request.Body = &model.AssociateGlobalConnectionBandwidthInstanceRequestBody{
		Gcbandwidths: listGcbandwidthsbody,
	}
	response, err := client.AssociateGlobalConnectionBandwidthInstance(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 bound to the instance.

Error Codes

See Error Codes.