Removing an Attachment from a Central Network
Function
This API is used to remove an attachment from a central network.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
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 time is in the yyyy-MM-ddTHH:mm:ss format. |
updated_at |
String |
Time when the resource was updated. The 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 |
Amount of bandwidth, 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 |
Huawei Cloud or partner cloud.
|
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 removed from a 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" } } }
SDK Sample Code
The SDK sample code is as follows.
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 |
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.*; public class DeleteCentralNetworkAttachmentSolution { 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(); DeleteCentralNetworkAttachmentRequest request = new DeleteCentralNetworkAttachmentRequest(); request.withCentralNetworkId("{central_network_id}"); request.withAttachmentId("{attachment_id}"); try { DeleteCentralNetworkAttachmentResponse response = client.deleteCentralNetworkAttachment(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()); } } } |
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 |
# 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 = DeleteCentralNetworkAttachmentRequest() request.central_network_id = "{central_network_id}" request.attachment_id = "{attachment_id}" response = client.delete_central_network_attachment(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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.DeleteCentralNetworkAttachmentRequest{} request.CentralNetworkId = "{central_network_id}" request.AttachmentId = "{attachment_id}" response, err := client.DeleteCentralNetworkAttachment(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 |
---|---|
202 |
The attachment removed from a 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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot