Help Center/Cloud Connect/API Reference/API/Global Connection Bandwidths/Unbinding a Global Connection Bandwidth from an Instance
Updated on 2025-07-29 GMT+08:00
View PDF

Unbinding a Global Connection Bandwidth from an Instance

Function

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

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" : ""
  } ]
}

Status Codes

Status Code

Description

200

The global connection bandwidth has been unbound from the instance.

Error Codes

See Error Codes.

Parent Topic: Global Connection Bandwidths