Help Center/ Cloud Connect/ API Reference/ API/ Global Connection Bandwidths/ Unbinding a Global Connection Bandwidth from an Instance
Updated on 2024-11-25 GMT+08:00

Unbinding a Global Connection Bandwidth from an Instance

Function

This API is used to unbind a global connection bandwidth from an instance.

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}/gcb/gcbandwidths/{id}/disassociate-instance

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

id

Yes

String

Instance 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

gcbandwidths

Yes

Array of DisassociateGlobalConnectionBandwidthInstanceRequestInfo objects

Detailed information about the instance that the global connection bandwidth is unbound from.

Table 4 DisassociateGlobalConnectionBandwidthInstanceRequestInfo

Parameter

Mandatory

Type

Description

resource_id

Yes

String

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

resource_type

Yes

String

Instance type.

region_id

No

String

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

project_id

Yes

String

Project ID of the region where the instance is located.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

gcbandwidths

Array of DisassociateGlobalConnectionBandwidthInstanceResponseInfo objects

Response to the operation for unbinding a global connection bandwidth from an instance.

Table 6 DisassociateGlobalConnectionBandwidthInstanceResponseInfo

Parameter

Type

Description

resource_id

String

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

resource_type

String

Instance type.

region_id

String

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

project_id

String

Project ID of the region where the instance is located.

result

String

Unbinding operation result.

  • success: The operation is successful.

  • fail: The operation failed.

message

String

Error information when the unbinding operation fails.

Example Requests

Unbinding a global connection bandwidth from an instance

POST https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/{id}/disassociate-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 connection bandwidth has been unbound from 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.

Unbinding a global connection bandwidth from 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
59
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 DisassociateGlobalConnectionBandwidthInstanceSolution {

    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();
        DisassociateGlobalConnectionBandwidthInstanceRequest request = new DisassociateGlobalConnectionBandwidthInstanceRequest();
        request.withId("{id}");
        DisassociateGlobalConnectionBandwidthInstanceRequestBody body = new DisassociateGlobalConnectionBandwidthInstanceRequestBody();
        List<DisassociateGlobalConnectionBandwidthInstanceRequestInfo> listbodyGcbandwidths = new ArrayList<>();
        listbodyGcbandwidths.add(
            new DisassociateGlobalConnectionBandwidthInstanceRequestInfo()
                .withResourceType("GEIP")
                .withRegionId("global")
                .withResourceId("37289f8a-8fd2-4eff-a6c4-f3b94bdbb1bc")
                .withProjectId("XXX")
        );
        body.withGcbandwidths(listbodyGcbandwidths);
        request.withBody(body);
        try {
            DisassociateGlobalConnectionBandwidthInstanceResponse response = client.disassociateGlobalConnectionBandwidthInstance(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());
        }
    }
}

Unbinding a global connection bandwidth from 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
# 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 = DisassociateGlobalConnectionBandwidthInstanceRequest()
        request.id = "{id}"
        listGcbandwidthsbody = [
            DisassociateGlobalConnectionBandwidthInstanceRequestInfo(
                resource_type="GEIP",
                region_id="global",
                resource_id="37289f8a-8fd2-4eff-a6c4-f3b94bdbb1bc",
                project_id="XXX"
            )
        ]
        request.body = DisassociateGlobalConnectionBandwidthInstanceRequestBody(
            gcbandwidths=listGcbandwidthsbody
        )
        response = client.disassociate_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)

Unbinding a global connection bandwidth from 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
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.DisassociateGlobalConnectionBandwidthInstanceRequest{}
	request.Id = "{id}"
	regionIdGcbandwidths:= "global"
	var listGcbandwidthsbody = []model.DisassociateGlobalConnectionBandwidthInstanceRequestInfo{
        {
            ResourceType: "GEIP",
            RegionId: &regionIdGcbandwidths,
            ResourceId: "37289f8a-8fd2-4eff-a6c4-f3b94bdbb1bc",
            ProjectId: "XXX",
        },
    }
	request.Body = &model.DisassociateGlobalConnectionBandwidthInstanceRequestBody{
		Gcbandwidths: listGcbandwidthsbody,
	}
	response, err := client.DisassociateGlobalConnectionBandwidthInstance(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 connection bandwidth has been unbound from the instance.

Error Codes

See Error Codes.