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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
gcbandwidths |
Yes |
Array of AssociateGlobalConnectionBandwidthInstanceRequestInfo objects |
Detailed information about the instance that the global connection bandwidth is bound to. |
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
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 |
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.
|
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" : "" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
The global connection bandwidth has been bound to the instance. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.