Help Center/ Cloud Connect/ API Reference/ API/ Global Connection Bandwidths/ Binding a Global Connection Bandwidth to an Instance

Updated on 2025-07-29 GMT+08:00

View PDF

Binding a Global Connection Bandwidth to an Instance

Function

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

URI

POST /v3/{domain_id}/gcb/gcbandwidths/{id}/associate-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 AssociateGlobalConnectionBandwidthInstanceRequestInfo objects	Detailed information about the instance that the global connection bandwidth is bound to.

**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 (-).
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 AssociateGlobalConnectionBandwidthInstanceResponseInfo objects	Response to the operation for binding a global connection bandwidth to an instance

**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 (-).
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	Binding operation result. success: The operation is successful. fail: The operation failed.
message	String	Error information when the binding operation fails.

Example Requests

Binding a global connection 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 connection 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" : ""
  } ]
}