Removing an Attachment from a Central Network
Function
This API is used to remove an attachment from a central network.
URI
DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/attachments/{attachment_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
domain_id |
Yes |
String |
Account ID. |
|
central_network_id |
Yes |
String |
Central network ID. |
|
attachment_id |
Yes |
String |
ID of the attachment on the central network. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token. |
Response Parameters
Status code: 202
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
Request ID. |
|
central_network_attachment |
CentralNetworkAttachment object |
Details of the attachment on the central network. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Instance ID. |
|
name |
String |
Instance name. |
|
description |
String |
Resource description. Angle brackets (<>) are not allowed. |
|
domain_id |
String |
ID of the account that the instance belongs to. |
|
state |
String |
Central network connection status.
|
|
created_at |
String |
Time when the resource was created. The UTC time is in the yyyy-MM-ddTHH:mm:ss format. |
|
updated_at |
String |
Time when the resource was updated. The UTC time must be in the yyyy-MM-ddTHH:mm:ss format. |
|
central_network_id |
String |
Central network ID. |
|
central_network_plane_id |
String |
ID of the central network plane. |
|
global_connection_bandwidth_id |
String |
Global connection bandwidth ID. |
|
bandwidth_type |
String |
Bandwidth type. The bandwidth types are as follows:
|
|
bandwidth_size |
Integer |
Bandwidth capacity, in Mbit/s. |
|
is_frozen |
Boolean |
Whether the resource is frozen. |
|
enterprise_router_id |
String |
Enterprise router ID. |
|
enterprise_router_project_id |
String |
Project ID of the enterprise router. |
|
enterprise_router_region_id |
String |
Region ID of an enterprise router. |
|
enterprise_router_attachment_id |
String |
Attachment ID of the enterprise router. |
|
attachment_instance_type |
String |
Type of the resource that can be added to a central network as an attachment. The value can be GDGW (global DC gateway) or ER_ROUTE_TABLE (enterprise router route table). |
|
attachment_instance_id |
String |
ID of the resource used as an attachment on the central network, for example, enterprise router route table ID or global DC gateway ID. |
|
attachment_id |
String |
Attachment ID of the enterprise router or peer link ID of the global DC gateway. |
|
attachment_instance_project_id |
String |
Project ID of the resource used as an attachment on the central network. |
|
attachment_instance_region_id |
String |
Region ID of the resource used as an attachment on the central network. |
|
attachment_instance_site_code |
String |
Site code of the resource used as an attachment on the central network. |
|
enterprise_router_site_code |
String |
Site code of the enterprise router on a central network. |
|
specification_value |
Additional information about an attachment. |
|
Parameter |
Type |
Description |
|---|---|---|
|
enterprise_router_table_id |
String |
ID of the enterprise router route table. |
|
attachment_parent_instance_id |
String |
ID of the parent resource of an attachment. Here it is the ID of the enterprise router. |
|
hosted_cloud |
String |
|
|
approved_state |
String |
Approval status.
|
|
reason |
String |
Reason for rejecting attachment creation. |
Example Requests
Removing an attachment from a central network
DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/attachments/{attachment_id}
Example Responses
Status code: 202
The attachment has been removed from the central network.
{
"request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"central_network_attachment" : {
"id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"name" : "name",
"description" : "description",
"domain_id" : "XXX",
"state" : "AVAILABLE",
"created_at" : "2023-10-09T10:15:32.134Z",
"updated_at" : "2023-10-09T10:15:32.134Z",
"central_network_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"central_network_plane_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"bandwidth_type" : "BandwidthPackage",
"bandwidth_size" : 20,
"is_frozen" : false,
"enterprise_router_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"enterprise_router_project_id" : "XXX",
"enterprise_router_region_id" : "region-abc",
"enterprise_router_attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"attachment_instance_type" : "GDGW",
"attachment_instance_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"attachment_instance_project_id" : "XXX",
"attachment_instance_region_id" : "region-abc",
"attachment_instance_site_code" : "site-abc",
"enterprise_router_site_code" : "site-abc",
"specification_value" : {
"enterprise_router_table_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"attached_er_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"approved_state" : "APPROVING",
"hosted_cloud" : "HWCloud",
"reason" : "string"
}
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
202 |
The attachment has been removed from the central network. |
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.