From 070036121f0605ae625830461f9c1e02058e22f1 Mon Sep 17 00:00:00 2001 From: fanqinying Date: Mon, 8 Sep 2025 13:31:33 +0000 Subject: [PATCH] DC API 20241129 version MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reviewed-by: Hajba, László Antal Co-authored-by: fanqinying Co-committed-by: fanqinying --- docs/dc/api-ref/ALL_META.TXT.json | 378 ++++-- docs/dc/api-ref/BatchCreateResourceTags.html | 182 +++ docs/dc/api-ref/CLASS.TXT.json | 166 ++- .../dc/api-ref/CreateHostedDirectConnect.html | 348 ++--- docs/dc/api-ref/CreateResourceTag.html | 147 ++ docs/dc/api-ref/CreateVirtualGateway.html | 539 ++++---- docs/dc/api-ref/CreateVirtualInterface.html | 1186 +++++++++-------- docs/dc/api-ref/DeleteDirectConnect.html | 76 +- .../dc/api-ref/DeleteHostedDirectConnect.html | 76 +- docs/dc/api-ref/DeleteResourceTag.html | 93 ++ docs/dc/api-ref/DeleteVirtualGateway.html | 72 +- docs/dc/api-ref/DeleteVirtualInterface.html | 76 +- docs/dc/api-ref/ListDirectConnects.html | 638 ++++----- docs/dc/api-ref/ListHostedDirectConnects.html | 382 +++--- docs/dc/api-ref/ListProjectTags.html | 135 ++ docs/dc/api-ref/ListTagResourceInstances.html | 407 ++++++ docs/dc/api-ref/ListVirtualGateways.html | 390 +++--- docs/dc/api-ref/ListVirtualInterfaces.html | 916 +++++++------ docs/dc/api-ref/ShowDirectConnect.html | 520 ++++---- docs/dc/api-ref/ShowHostedDirectConnect.html | 332 ++--- docs/dc/api-ref/ShowResourceTag.html | 159 +++ docs/dc/api-ref/ShowVirtualGateway.html | 278 ++-- docs/dc/api-ref/ShowVirtualInterface.html | 788 +++++------ docs/dc/api-ref/UpdateDirectConnect.html | 597 +++++---- .../dc/api-ref/UpdateHostedDirectConnect.html | 328 ++--- docs/dc/api-ref/UpdateVirtualGateway.html | 328 +++-- docs/dc/api-ref/UpdateVirtualInterface.html | 874 ++++++------ docs/dc/api-ref/dc_07_0000.html | 10 +- docs/dc/api-ref/dc_08_3000.html | 2 + docs/dc/api-ref/dc_08_3001.html | 2 +- docs/dc/api-ref/dc_08_3007.html | 106 ++ docs/dc/api-ref/en-us_topic_0055025300.html | 2 +- docs/dc/api-ref/en-us_topic_0055025301.html | 14 +- docs/dc/api-ref/en-us_topic_0055025309.html | 2 +- docs/dc/api-ref/en-us_topic_0055025310.html | 2 +- docs/dc/api-ref/en-us_topic_0055025313.html | 2 +- docs/dc/api-ref/en-us_topic_0055025314.html | 2 +- docs/dc/api-ref/en-us_topic_0055025315.html | 10 +- docs/dc/api-ref/en-us_topic_0055025320.html | 2 +- docs/dc/api-ref/en-us_topic_0055025327.html | 2 +- docs/dc/api-ref/en-us_topic_0055025334.html | 2 +- docs/dc/api-ref/en-us_topic_0055025336.html | 2 +- docs/dc/api-ref/en-us_topic_0055025337.html | 2 +- docs/dc/api-ref/en-us_topic_0055025339.html | 2 +- docs/dc/api-ref/en-us_topic_0055025347.html | 36 +- docs/dc/api-ref/topic_300000000.html | 6 +- docs/dc/api-ref/topic_300000001.html | 8 +- docs/dc/api-ref/topic_300000002.html | 6 +- docs/dc/api-ref/topic_300000003.html | 26 + 49 files changed, 6332 insertions(+), 4327 deletions(-) create mode 100644 docs/dc/api-ref/BatchCreateResourceTags.html create mode 100644 docs/dc/api-ref/CreateResourceTag.html create mode 100644 docs/dc/api-ref/DeleteResourceTag.html create mode 100644 docs/dc/api-ref/ListProjectTags.html create mode 100644 docs/dc/api-ref/ListTagResourceInstances.html create mode 100644 docs/dc/api-ref/ShowResourceTag.html create mode 100644 docs/dc/api-ref/dc_08_3007.html create mode 100644 docs/dc/api-ref/topic_300000003.html diff --git a/docs/dc/api-ref/ALL_META.TXT.json b/docs/dc/api-ref/ALL_META.TXT.json index 6fdfe7200..bb450f94a 100644 --- a/docs/dc/api-ref/ALL_META.TXT.json +++ b/docs/dc/api-ref/ALL_META.TXT.json @@ -16,7 +16,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"API Usage Guidelines", @@ -36,7 +36,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"API Overview", @@ -56,7 +56,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"API Usage", @@ -69,17 +69,17 @@ "code":"4", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"APIs v2.0", + "kw":"API v2.0", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], - "title":"APIs v2.0", + "title":"API v2.0", "githuburl":"" }, { @@ -96,7 +96,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"API Version", @@ -116,7 +116,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying All API Versions", @@ -136,7 +136,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying a Specified API Version", @@ -156,7 +156,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Connection", @@ -167,7 +167,7 @@ "node_id":"en-us_topic_0055025314.xml", "product_code":"dc", "code":"9", - "des":"This section describes the APIs for managing connections, including the API used to create a hosted connection, the APIs used to query, update, and delete a connection, a", + "des":"This topic describes the APIs for managing connections, including the API used to create a hosted connection, the APIs used to query, update, and delete a connection, and", "doc_type":"api", "kw":"Overview,Connection,API Reference", "search_title":"", @@ -176,7 +176,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Overview", @@ -187,7 +187,7 @@ "node_id":"en-us_topic_0055025315.xml", "product_code":"dc", "code":"10", - "des":"This API is used to create a hosted connection.This API can only be used to create hosted connections.POST /v2.0/dcaas/direct-connectsFor details about the direct_connect", + "des":"This API is used to create a hosted connection.This API can only be used to create a hosted connection.POST /v2.0/dcaas/direct-connectsFor details about the direct_connec", "doc_type":"api", "kw":"Creating a Connection,Connection,API Reference", "search_title":"", @@ -196,7 +196,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Creating a Connection", @@ -216,7 +216,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying the Connection List", @@ -236,7 +236,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Deleting a Connection", @@ -256,7 +256,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying a Connection", @@ -276,7 +276,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Updating a Connection", @@ -296,7 +296,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Virtual Gateway", @@ -316,7 +316,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Overview", @@ -336,7 +336,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Creating a Virtual Gateway", @@ -356,7 +356,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying the Virtual Gateway List", @@ -376,7 +376,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Deleting a Virtual Gateway", @@ -396,7 +396,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying a Virtual Gateway", @@ -416,7 +416,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Updating a Virtual Gateway", @@ -436,7 +436,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Virtual Interface", @@ -456,7 +456,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Overview", @@ -476,7 +476,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Creating a Virtual Interface", @@ -496,7 +496,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying the Virtual Interface List", @@ -516,7 +516,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Deleting a Virtual Interface", @@ -536,7 +536,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying a Virtual Interface", @@ -556,7 +556,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Updating a Virtual Interface", @@ -576,7 +576,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Direct Connect Endpoint Group", @@ -596,7 +596,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Overview", @@ -616,7 +616,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Creating an Endpoint Group", @@ -636,7 +636,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying the Direct Connect Endpoint Group List", @@ -656,7 +656,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Deleting an Endpoint Group", @@ -676,7 +676,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Querying a Direct Connect Endpoint Group", @@ -689,17 +689,17 @@ "code":"35", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"APIs v3", + "kw":"API v3", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], - "title":"APIs v3", + "title":"API v3", "githuburl":"" }, { @@ -709,7 +709,7 @@ "code":"36", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Connection", + "kw":"Connections", "search_title":"", "metedata":[ { @@ -717,7 +717,7 @@ "prodname":"dc" } ], - "title":"Connection", + "title":"Connections", "githuburl":"" }, { @@ -725,9 +725,9 @@ "node_id":"showdirectconnect.xml", "product_code":"dc", "code":"37", - "des":"This API is used to query details about a connection.GET /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}Status code: 200Querying details about a connectionStat", + "des":"This API is used to query details about a connection.GET /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}Status code: 200Querying a connectionStatus code: 200OK", "doc_type":"api", - "kw":"Querying Details About a Connection,Connection,API Reference", + "kw":"Querying Details About a Connection,Connections,API Reference", "search_title":"", "metedata":[ { @@ -745,9 +745,9 @@ "node_id":"updatedirectconnect.xml", "product_code":"dc", "code":"38", - "des":"This API is used to update a connection, including updating its name and description.PUT /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}Status code: 200Updatin", + "des":"This API is used to update a connection, such as its name and description.PUT /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}Status code: 200Updating the name ", "doc_type":"api", - "kw":"Updating a Connection,Connection,API Reference", + "kw":"Updating a Connection,Connections,API Reference", "search_title":"", "metedata":[ { @@ -765,9 +765,9 @@ "node_id":"deletedirectconnect.xml", "product_code":"dc", "code":"39", - "des":"This API is used to delete pay-per-use connections only. To delete yearly/monthly connections, you need to first unsubscribe them.DELETE /v3/{project_id}/dcaas/direct-con", + "des":"This API is used to delete a connection.DELETE /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}NoneDeleting a connectionNoneSee Error Codes.", "doc_type":"api", - "kw":"Deleting a Connection,Connection,API Reference", + "kw":"Deleting a Connection,Connections,API Reference", "search_title":"", "metedata":[ { @@ -785,9 +785,9 @@ "node_id":"listdirectconnects.xml", "product_code":"dc", "code":"40", - "des":"This API is used to query all direct connections created by a tenant.GET /v3/{project_id}/dcaas/direct-connectsStatus code: 200Querying the connection listStatus code: 20", + "des":"This API is used to query the connection list.GET /v3/{project_id}/dcaas/direct-connectsStatus code: 200Querying the connection listStatus code: 200OKThe connection list ", "doc_type":"api", - "kw":"Querying the Connection List,Connection,API Reference", + "kw":"Querying the Connection List,Connections,API Reference", "search_title":"", "metedata":[ { @@ -805,9 +805,9 @@ "node_id":"listhosteddirectconnects.xml", "product_code":"dc", "code":"41", - "des":"This API is used to query hosted connections created by partners.GET /v3/{project_id}/dcaas/hosted-connectsStatus code: 200Querying the list of hosted connections created", + "des":"This API is used to query hosted connections created by partners.GET /v3/{project_id}/dcaas/hosted-connectsStatus code: 200Querying the hosted connection listStatus code:", "doc_type":"api", - "kw":"Querying the Hosted Connection List,Connection,API Reference", + "kw":"Querying the Hosted Connection List,Connections,API Reference", "search_title":"", "metedata":[ { @@ -825,9 +825,9 @@ "node_id":"createhosteddirectconnect.xml", "product_code":"dc", "code":"42", - "des":"This API is used by partners to create hosted connections for their users. The creator must have the partner qualification and have an operations connection.POST /v3/{pro", + "des":"This API is used by partners to create a hosted connection for their users. The creator must have the partner qualification and have an operations connection.POST /v3/{pr", "doc_type":"api", - "kw":"Creating a Hosted Connection,Connection,API Reference", + "kw":"Creating a Hosted Connection,Connections,API Reference", "search_title":"", "metedata":[ { @@ -845,9 +845,9 @@ "node_id":"showhosteddirectconnect.xml", "product_code":"dc", "code":"43", - "des":"This API is used to query a hosted connection of a partner.GET /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}Status code: 200Querying details about a hosted c", + "des":"This API is used by partners to query a hosted connection.GET /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}Status code: 200Querying details about a hosted co", "doc_type":"api", - "kw":"Querying Details About a Hosted Connection,Connection,API Reference", + "kw":"Querying Details About a Hosted Connection,Connections,API Reference", "search_title":"", "metedata":[ { @@ -865,9 +865,9 @@ "node_id":"updatehosteddirectconnect.xml", "product_code":"dc", "code":"44", - "des":"Updating a hosted connection by a partnerPUT /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}Status code: 200Updating the name and description of a hosted conne", + "des":"This API is used by partners to update a hosted connection.PUT /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}Status code: 200Updating the name and description", "doc_type":"api", - "kw":"Updating a Hosted Connection,Connection,API Reference", + "kw":"Updating a Hosted Connection,Connections,API Reference", "search_title":"", "metedata":[ { @@ -885,9 +885,9 @@ "node_id":"deletehosteddirectconnect.xml", "product_code":"dc", "code":"45", - "des":"This API is used by partners to delete hosted connections.DELETE /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}NoneDeleting a hosted connectionNoneSee Error C", + "des":"This API is used by partners to delete a hosted connection.DELETE /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}NoneDeleting a hosted connectionNoneSee Error ", "doc_type":"api", - "kw":"Deleting a Hosted Connection,Connection,API Reference", + "kw":"Deleting a Hosted Connection,Connections,API Reference", "search_title":"", "metedata":[ { @@ -907,7 +907,7 @@ "code":"46", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Virtual Gateway", + "kw":"Virtual Gateways", "search_title":"", "metedata":[ { @@ -915,7 +915,7 @@ "prodname":"dc" } ], - "title":"Virtual Gateway", + "title":"Virtual Gateways", "githuburl":"" }, { @@ -923,9 +923,9 @@ "node_id":"showvirtualgateway.xml", "product_code":"dc", "code":"47", - "des":"This API is used to query details about a specified virtual gateway.GET /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}Status code: 200Querying a virtual gat", + "des":"This API is used to query details about a specific virtual gateway.GET /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}Status code: 200Querying a virtual gate", "doc_type":"api", - "kw":"Querying Details About a Virtual Gateway,Virtual Gateway,API Reference", + "kw":"Querying Details About a Virtual Gateway,Virtual Gateways,API Reference", "search_title":"", "metedata":[ { @@ -945,7 +945,7 @@ "code":"48", "des":"This API is used to update a virtual gateway.PUT /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}Status code: 200Updating the name and description of a virtua", "doc_type":"api", - "kw":"Updating a Virtual Gateway,Virtual Gateway,API Reference", + "kw":"Updating a Virtual Gateway,Virtual Gateways,API Reference", "search_title":"", "metedata":[ { @@ -963,9 +963,9 @@ "node_id":"deletevirtualgateway.xml", "product_code":"dc", "code":"49", - "des":"The API is used to delete a specified virtual gateway.DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}NoneDeleting a virtual gatewayNoneSee Error Codes", + "des":"The API is used to delete a specific virtual gateway.DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}NoneDeleting a virtual gatewayNoneSee Error Codes.", "doc_type":"api", - "kw":"Deleting a Virtual Gateway,Virtual Gateway,API Reference", + "kw":"Deleting a Virtual Gateway,Virtual Gateways,API Reference", "search_title":"", "metedata":[ { @@ -983,9 +983,9 @@ "node_id":"listvirtualgateways.xml", "product_code":"dc", "code":"50", - "des":"This API is used to query virtual gateways.GET /v3/{project_id}/dcaas/virtual-gatewaysStatus code: 200Querying the virtual gateway listStatus code: 200OKThe list of virtu", + "des":"This API is used to query the virtual gateway list.GET /v3/{project_id}/dcaas/virtual-gatewaysStatus code: 200Querying the virtual gateway listStatus code: 200OKThe list ", "doc_type":"api", - "kw":"Querying Virtual Gateways,Virtual Gateway,API Reference", + "kw":"Querying the Virtual Gateway List,Virtual Gateways,API Reference", "search_title":"", "metedata":[ { @@ -995,7 +995,7 @@ "operation_id":"ListVirtualGateways" } ], - "title":"Querying Virtual Gateways", + "title":"Querying the Virtual Gateway List", "githuburl":"" }, { @@ -1005,7 +1005,7 @@ "code":"51", "des":"This API is used to create a virtual gateway.POST /v3/{project_id}/dcaas/virtual-gatewaysStatus code: 201Creating a virtual gateway that will be used to access a VPC, wit", "doc_type":"api", - "kw":"Creating a Virtual Gateway,Virtual Gateway,API Reference", + "kw":"Creating a Virtual Gateway,Virtual Gateways,API Reference", "search_title":"", "metedata":[ { @@ -1025,7 +1025,7 @@ "code":"52", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Virtual Interface", + "kw":"Virtual Interfaces", "search_title":"", "metedata":[ { @@ -1033,7 +1033,7 @@ "prodname":"dc" } ], - "title":"Virtual Interface", + "title":"Virtual Interfaces", "githuburl":"" }, { @@ -1043,7 +1043,7 @@ "code":"53", "des":"This API is used to querying details about a virtual interface.GET /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}Status code: 200Querying a virtual inte", "doc_type":"api", - "kw":"Querying Details About a Virtual Interface,Virtual Interface,API Reference", + "kw":"Querying Details About a Virtual Interface,Virtual Interfaces,API Reference", "search_title":"", "metedata":[ { @@ -1063,7 +1063,7 @@ "code":"54", "des":"This API is used to update a virtual interface.PUT /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}Status code: 200Updating the name and description of a ", "doc_type":"api", - "kw":"Updating a Virtual Interface,Virtual Interface,API Reference", + "kw":"Updating a Virtual Interface,Virtual Interfaces,API Reference", "search_title":"", "metedata":[ { @@ -1083,7 +1083,7 @@ "code":"55", "des":"This API is used to delete a virtual interface.DELETE /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}NoneDeleting a virtual interfaceNoneSee Error Codes.", "doc_type":"api", - "kw":"Deleting a Virtual Interface,Virtual Interface,API Reference", + "kw":"Deleting a Virtual Interface,Virtual Interfaces,API Reference", "search_title":"", "metedata":[ { @@ -1101,9 +1101,9 @@ "node_id":"listvirtualinterfaces.xml", "product_code":"dc", "code":"56", - "des":"This API is used to query all virtual interfaces of a tenant.GET /v3/{project_id}/dcaas/virtual-interfacesStatus code: 200Querying the virtual interface listStatus code: ", + "des":"This API is used to query the virtual interface list.GET /v3/{project_id}/dcaas/virtual-interfacesStatus code: 200Querying the virtual interface listStatus code: 200OKSee", "doc_type":"api", - "kw":"Querying the Virtual Interface List,Virtual Interface,API Reference", + "kw":"Querying the Virtual Interface List,Virtual Interfaces,API Reference", "search_title":"", "metedata":[ { @@ -1123,7 +1123,7 @@ "code":"57", "des":"This API is used to create a virtual interface.POST /v3/{project_id}/dcaas/virtual-interfacesStatus code: 201Creating a private virtual interface, with the bandwidth set ", "doc_type":"api", - "kw":"Creating a Virtual Interface,Virtual Interface,API Reference", + "kw":"Creating a Virtual Interface,Virtual Interfaces,API Reference", "search_title":"", "metedata":[ { @@ -1136,11 +1136,149 @@ "title":"Creating a Virtual Interface", "githuburl":"" }, + { + "uri":"topic_300000003.html", + "node_id":"topic_300000003.xml", + "product_code":"dc", + "code":"58", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Tag Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dc" + } + ], + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"ListProjectTags.html", + "node_id":"listprojecttags.xml", + "product_code":"dc", + "code":"59", + "des":"This API is used to query all resource tags of a resource in a specified project.TMS uses this API to list tags created by a tenant to ease tag creation and resource filt", + "doc_type":"api", + "kw":"Querying Tags by Project,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"dc", + "operation_id":"ListProjectTags" + } + ], + "title":"Querying Tags by Project", + "githuburl":"" + }, + { + "uri":"ShowResourceTag.html", + "node_id":"showresourcetag.xml", + "product_code":"dc", + "code":"60", + "des":"This API is used to query the tags of a resource.GET /v3/{project_id}/{resource_type}/{resource_id}/tagsNoneStatus code: 200Querying tags of a resourceStatus code: 200OKS", + "doc_type":"api", + "kw":"Querying Tags of a Resource,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"dc", + "operation_id":"ShowResourceTag" + } + ], + "title":"Querying Tags of a Resource", + "githuburl":"" + }, + { + "uri":"CreateResourceTag.html", + "node_id":"createresourcetag.xml", + "product_code":"dc", + "code":"61", + "des":"A resource can have a maximum of 20 tags.The API is idempotent.If a tag to be added has the same key as an existing tag, the tag will be added and overwrite the existing ", + "doc_type":"api", + "kw":"Adding a Resource Tag,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"dc", + "operation_id":"CreateResourceTag" + } + ], + "title":"Adding a Resource Tag", + "githuburl":"" + }, + { + "uri":"BatchCreateResourceTags.html", + "node_id":"batchcreateresourcetags.xml", + "product_code":"dc", + "code":"62", + "des":"This API is used to add or delete tags of a specific resource in batches.TMS may use this API to manage service resource tags.A resource can have a maximum of 20 tags.POS", + "doc_type":"api", + "kw":"Adding or Deleting Tags in Batches,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"dc", + "operation_id":"BatchCreateResourceTags" + } + ], + "title":"Adding or Deleting Tags in Batches", + "githuburl":"" + }, + { + "uri":"DeleteResourceTag.html", + "node_id":"deleteresourcetag.xml", + "product_code":"dc", + "code":"63", + "des":"When a tag is deleted, the tag character set is not verified. Before calling this API, perform the encodeURI operation. The server must perform decodeURI on the API URI. ", + "doc_type":"api", + "kw":"Deleting a Resource Tag,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"dc", + "operation_id":"DeleteResourceTag" + } + ], + "title":"Deleting a Resource Tag", + "githuburl":"" + }, + { + "uri":"ListTagResourceInstances.html", + "node_id":"listtagresourceinstances.xml", + "product_code":"dc", + "code":"64", + "des":"This API is used to query resources by tag.POST /v3/{project_id}/{resource_type}/resource-instances/actionStatus code: 200Querying resources (action set to filter)https:/", + "doc_type":"api", + "kw":"Querying Resources by Tag,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"dc", + "operation_id":"ListTagResourceInstances" + } + ], + "title":"Querying Resources by Tag", + "githuburl":"" + }, { "uri":"dc_08_0000.html", "node_id":"dc_08_0000.xml", "product_code":"dc", - "code":"58", + "code":"65", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Permissions Policies and Supported Actions (APIs v2.0)", @@ -1150,7 +1288,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Permissions Policies and Supported Actions (APIs v2.0)", @@ -1160,7 +1298,7 @@ "uri":"dc_08_0001.html", "node_id":"dc_08_0001.xml", "product_code":"dc", - "code":"59", + "code":"66", "des":"This chapter describes fine-grained permissions management for Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, ", "doc_type":"api", "kw":"Introduction,Permissions Policies and Supported Actions (APIs v2.0),API Reference", @@ -1170,7 +1308,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Introduction", @@ -1180,7 +1318,7 @@ "uri":"dc_08_0002.html", "node_id":"dc_08_0002.xml", "product_code":"dc", - "code":"60", + "code":"67", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Connections,Permissions Policies and Supported Actions (APIs v2.0),API Reference", @@ -1190,7 +1328,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Connections", @@ -1200,7 +1338,7 @@ "uri":"dc_08_0003.html", "node_id":"dc_08_0003.xml", "product_code":"dc", - "code":"61", + "code":"68", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Virtual Gateways,Permissions Policies and Supported Actions (APIs v2.0),API Reference", @@ -1210,7 +1348,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Virtual Gateways", @@ -1220,7 +1358,7 @@ "uri":"dc_08_0004.html", "node_id":"dc_08_0004.xml", "product_code":"dc", - "code":"62", + "code":"69", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Virtual Interfaces,Permissions Policies and Supported Actions (APIs v2.0),API Reference", @@ -1230,7 +1368,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Virtual Interfaces", @@ -1240,7 +1378,7 @@ "uri":"dc_08_3000.html", "node_id":"dc_08_3000.xml", "product_code":"dc", - "code":"63", + "code":"70", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Permissions Policies and Supported Actions (APIs v3)", @@ -1250,7 +1388,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Permissions Policies and Supported Actions (APIs v3)", @@ -1260,7 +1398,7 @@ "uri":"dc_08_3001.html", "node_id":"dc_08_3001.xml", "product_code":"dc", - "code":"64", + "code":"71", "des":"This topic describes fine-grained permissions management for Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, yo", "doc_type":"api", "kw":"Introduction,Permissions Policies and Supported Actions (APIs v3),API Reference", @@ -1270,7 +1408,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Introduction", @@ -1280,7 +1418,7 @@ "uri":"dc_08_3002.html", "node_id":"dc_08_3002.xml", "product_code":"dc", - "code":"65", + "code":"72", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Connections,Permissions Policies and Supported Actions (APIs v3),API Reference", @@ -1290,7 +1428,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Connections", @@ -1300,7 +1438,7 @@ "uri":"dc_08_3003.html", "node_id":"dc_08_3003.xml", "product_code":"dc", - "code":"66", + "code":"73", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Virtual Gateways,Permissions Policies and Supported Actions (APIs v3),API Reference", @@ -1310,7 +1448,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Virtual Gateways", @@ -1320,7 +1458,7 @@ "uri":"dc_08_3004.html", "node_id":"dc_08_3004.xml", "product_code":"dc", - "code":"67", + "code":"74", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Virtual Interfaces,Permissions Policies and Supported Actions (APIs v3),API Reference", @@ -1330,17 +1468,37 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Virtual Interfaces", "githuburl":"" }, + { + "uri":"dc_08_3007.html", + "node_id":"dc_08_3007.xml", + "product_code":"dc", + "code":"75", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Tags,Permissions Policies and Supported Actions (APIs v3),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dc", + "opensource":"true", + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" + } + ], + "title":"Tags", + "githuburl":"" + }, { "uri":"en-us_topic_0055025341.html", "node_id":"en-us_topic_0055025341.xml", "product_code":"dc", - "code":"68", + "code":"76", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Public Parameters", @@ -1350,7 +1508,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Public Parameters", @@ -1360,7 +1518,7 @@ "uri":"en-us_topic_0055025342.html", "node_id":"en-us_topic_0055025342.xml", "product_code":"dc", - "code":"69", + "code":"77", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Common Status Codes,Public Parameters,API Reference", @@ -1370,7 +1528,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Common Status Codes", @@ -1380,7 +1538,7 @@ "uri":"en-us_topic_0055025343.html", "node_id":"en-us_topic_0055025343.xml", "product_code":"dc", - "code":"70", + "code":"78", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Error Codes (APIs v2.0),Public Parameters,API Reference", @@ -1390,7 +1548,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Error Codes (APIs v2.0)", @@ -1400,7 +1558,7 @@ "uri":"ErrorCode.html", "node_id":"errorcode.xml", "product_code":"dc", - "code":"71", + "code":"79", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Error Codes (APIs v3),Public Parameters,API Reference", @@ -1410,7 +1568,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Error Codes (APIs v3)", @@ -1420,7 +1578,7 @@ "uri":"en-us_topic_0055025347.html", "node_id":"en-us_topic_0055025347.xml", "product_code":"dc", - "code":"72", + "code":"80", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", @@ -1430,7 +1588,7 @@ "documenttype":"api", "prodname":"dc", "opensource":"true", - "operation_id":"ShowDirectConnectLocation" + "operation_id":"CreateHostedDirectConnect;ListDirectConnects;ShowDirectConnect;ListHostedDirectConnects;ShowHostedDirectConnect;UpdateDirectConnect;UpdateHostedDirectConnect;DeleteDirectConnect;DeleteHostedDirectConnect;CreateVirtualGateway;ListVirtualGateways;ShowVirtualGateway;UpdateVirtualGateway;DeleteVirtualGateway;CreateVirtualInterface;ListVirtualInterfaces;ShowVirtualInterface;UpdateVirtualInterface;DeleteVirtualInterface;CreateVifPeer;UpdateVifPeer;DeleteVifPeer;SwitchoverTest;ListSwitchoverTestRecords;CreateResourceTag;BatchCreateResourceTags;ListTagResourceInstances;ListProjectTags;ShowResourceTag;DeleteResourceTag;ShowQuotas;ShowLinkAggregationGroup;UpdateLinkAggregationGroup;DeleteLinkAggregationGroup;ListLinkAggregationGroup;CreateLinkAggregationGroup;ListGlobalDcGateways;CreateGlobalDcGateway;ShowGlobalDcGateway;UpdateGlobalDcGateway;DeleteGlobalDcGateway;ListPeerLinks;CreateExternalPeerLink;ShowPeerLink;UpdateExternalPeerLink;DeleteExternalPeerLink;ListDirectConnectLocations;ShowDirectConnectLocation" } ], "title":"Change History", diff --git a/docs/dc/api-ref/BatchCreateResourceTags.html b/docs/dc/api-ref/BatchCreateResourceTags.html new file mode 100644 index 000000000..d6dafc3a4 --- /dev/null +++ b/docs/dc/api-ref/BatchCreateResourceTags.html @@ -0,0 +1,182 @@ + + +

Adding or Deleting Tags in Batches

+

Function

  • This API is used to add or delete tags of a specific resource in batches.
  • TMS may use this API to manage service resource tags.
  • A resource can have a maximum of 20 tags.
+
+

URI

POST /v3/{project_id}/{resource_type}/{resource_id}/tags/action

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 URI parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+

resource_type

+

Yes

+

String

+
  • Specifies the Direct Connect resource type. The value can be dc-directconnect, dc-vgw, or dc-vif.
  • dc-directconnect: Direct Connect connection
  • dc-vgw: virtual gateway
  • dc-vif: virtual interface
+

Enumeration values:

+
  • dc-directconnect
  • dc-vgw
  • dc-vif
+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

Yes

+

String

+

Specifies the action type. Value options: create and delete

+

Enumeration values:

+
  • create
  • delete
+

tags

+

No

+

Array of Tag objects

+

Specifies the tag list.

+

sys_tags

+

No

+

Array of Tag objects

+

Specifies the tag list.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Tag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+
Specifies the tag key. The key:
  • Cannot be left blank.
  • Must be unique for each resource.
  • Can contain a maximum of 36 Unicode characters.
  • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
+
+

value

+

No

+

String

+
Specifies the tag value. The value:
  • Can be left blank.
  • Can contain a maximum of 43 Unicode characters.
  • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
+
+
+
+
+

Response Parameters

None

+
+

Example Requests

  • Batch adding resource tags
    POST https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action
    +
    +{
    +  "action" : "create",
    +  "tags" : [ {
    +    "key" : "key1",
    +    "value" : "value1"
    +  }, {
    +    "key" : "key2",
    +    "value" : "value2"
    +  } ]
    +}
    +
  • Batch deleting resource tags
    POST https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action
    +
    +{
    +  "action" : "delete",
    +  "tags" : [ {
    +    "key" : "key1"
    +  }, {
    +    "key" : "key2",
    +    "value" : "value3"
    +  } ]
    +}
    +
+
+

Example Responses

None

+
+

Status Code

+
+ + + + + + + +

Status Code

+

Description

+

204

+

No Content

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dc/api-ref/CLASS.TXT.json b/docs/dc/api-ref/CLASS.TXT.json index 613d58db0..4ccff5ede 100644 --- a/docs/dc/api-ref/CLASS.TXT.json +++ b/docs/dc/api-ref/CLASS.TXT.json @@ -29,7 +29,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dc", - "title":"APIs v2.0", + "title":"API v2.0", "uri":"en-us_topic_0055025309.html", "doc_type":"api", "p_code":"", @@ -72,7 +72,7 @@ "code":"8" }, { - "desc":"This section describes the APIs for managing connections, including the API used to create a hosted connection, the APIs used to query, update, and delete a connection, a", + "desc":"This topic describes the APIs for managing connections, including the API used to create a hosted connection, the APIs used to query, update, and delete a connection, and", "product_code":"dc", "title":"Overview", "uri":"en-us_topic_0055025314.html", @@ -81,7 +81,7 @@ "code":"9" }, { - "desc":"This API is used to create a hosted connection.This API can only be used to create hosted connections.POST /v2.0/dcaas/direct-connectsFor details about the direct_connect", + "desc":"This API is used to create a hosted connection.This API can only be used to create a hosted connection.POST /v2.0/dcaas/direct-connectsFor details about the direct_connec", "product_code":"dc", "title":"Creating a Connection", "uri":"en-us_topic_0055025315.html", @@ -308,7 +308,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dc", - "title":"APIs v3", + "title":"API v3", "uri":"dc_07_0000.html", "doc_type":"api", "p_code":"", @@ -317,14 +317,14 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dc", - "title":"Connection", + "title":"Connections", "uri":"topic_300000000.html", "doc_type":"api", "p_code":"35", "code":"36" }, { - "desc":"This API is used to query details about a connection.GET /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}Status code: 200Querying details about a connectionStat", + "desc":"This API is used to query details about a connection.GET /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}Status code: 200Querying a connectionStatus code: 200OK", "product_code":"dc", "title":"Querying Details About a Connection", "uri":"ShowDirectConnect.html", @@ -333,7 +333,7 @@ "code":"37" }, { - "desc":"This API is used to update a connection, including updating its name and description.PUT /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}Status code: 200Updatin", + "desc":"This API is used to update a connection, such as its name and description.PUT /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}Status code: 200Updating the name ", "product_code":"dc", "title":"Updating a Connection", "uri":"UpdateDirectConnect.html", @@ -342,7 +342,7 @@ "code":"38" }, { - "desc":"This API is used to delete pay-per-use connections only. To delete yearly/monthly connections, you need to first unsubscribe them.DELETE /v3/{project_id}/dcaas/direct-con", + "desc":"This API is used to delete a connection.DELETE /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}NoneDeleting a connectionNoneSee Error Codes.", "product_code":"dc", "title":"Deleting a Connection", "uri":"DeleteDirectConnect.html", @@ -351,7 +351,7 @@ "code":"39" }, { - "desc":"This API is used to query all direct connections created by a tenant.GET /v3/{project_id}/dcaas/direct-connectsStatus code: 200Querying the connection listStatus code: 20", + "desc":"This API is used to query the connection list.GET /v3/{project_id}/dcaas/direct-connectsStatus code: 200Querying the connection listStatus code: 200OKThe connection list ", "product_code":"dc", "title":"Querying the Connection List", "uri":"ListDirectConnects.html", @@ -360,7 +360,7 @@ "code":"40" }, { - "desc":"This API is used to query hosted connections created by partners.GET /v3/{project_id}/dcaas/hosted-connectsStatus code: 200Querying the list of hosted connections created", + "desc":"This API is used to query hosted connections created by partners.GET /v3/{project_id}/dcaas/hosted-connectsStatus code: 200Querying the hosted connection listStatus code:", "product_code":"dc", "title":"Querying the Hosted Connection List", "uri":"ListHostedDirectConnects.html", @@ -369,7 +369,7 @@ "code":"41" }, { - "desc":"This API is used by partners to create hosted connections for their users. The creator must have the partner qualification and have an operations connection.POST /v3/{pro", + "desc":"This API is used by partners to create a hosted connection for their users. The creator must have the partner qualification and have an operations connection.POST /v3/{pr", "product_code":"dc", "title":"Creating a Hosted Connection", "uri":"CreateHostedDirectConnect.html", @@ -378,7 +378,7 @@ "code":"42" }, { - "desc":"This API is used to query a hosted connection of a partner.GET /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}Status code: 200Querying details about a hosted c", + "desc":"This API is used by partners to query a hosted connection.GET /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}Status code: 200Querying details about a hosted co", "product_code":"dc", "title":"Querying Details About a Hosted Connection", "uri":"ShowHostedDirectConnect.html", @@ -387,7 +387,7 @@ "code":"43" }, { - "desc":"Updating a hosted connection by a partnerPUT /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}Status code: 200Updating the name and description of a hosted conne", + "desc":"This API is used by partners to update a hosted connection.PUT /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}Status code: 200Updating the name and description", "product_code":"dc", "title":"Updating a Hosted Connection", "uri":"UpdateHostedDirectConnect.html", @@ -396,7 +396,7 @@ "code":"44" }, { - "desc":"This API is used by partners to delete hosted connections.DELETE /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}NoneDeleting a hosted connectionNoneSee Error C", + "desc":"This API is used by partners to delete a hosted connection.DELETE /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}NoneDeleting a hosted connectionNoneSee Error ", "product_code":"dc", "title":"Deleting a Hosted Connection", "uri":"DeleteHostedDirectConnect.html", @@ -407,14 +407,14 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dc", - "title":"Virtual Gateway", + "title":"Virtual Gateways", "uri":"topic_300000001.html", "doc_type":"api", "p_code":"35", "code":"46" }, { - "desc":"This API is used to query details about a specified virtual gateway.GET /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}Status code: 200Querying a virtual gat", + "desc":"This API is used to query details about a specific virtual gateway.GET /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}Status code: 200Querying a virtual gate", "product_code":"dc", "title":"Querying Details About a Virtual Gateway", "uri":"ShowVirtualGateway.html", @@ -432,7 +432,7 @@ "code":"48" }, { - "desc":"The API is used to delete a specified virtual gateway.DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}NoneDeleting a virtual gatewayNoneSee Error Codes", + "desc":"The API is used to delete a specific virtual gateway.DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}NoneDeleting a virtual gatewayNoneSee Error Codes.", "product_code":"dc", "title":"Deleting a Virtual Gateway", "uri":"DeleteVirtualGateway.html", @@ -441,9 +441,9 @@ "code":"49" }, { - "desc":"This API is used to query virtual gateways.GET /v3/{project_id}/dcaas/virtual-gatewaysStatus code: 200Querying the virtual gateway listStatus code: 200OKThe list of virtu", + "desc":"This API is used to query the virtual gateway list.GET /v3/{project_id}/dcaas/virtual-gatewaysStatus code: 200Querying the virtual gateway listStatus code: 200OKThe list ", "product_code":"dc", - "title":"Querying Virtual Gateways", + "title":"Querying the Virtual Gateway List", "uri":"ListVirtualGateways.html", "doc_type":"api", "p_code":"46", @@ -461,7 +461,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dc", - "title":"Virtual Interface", + "title":"Virtual Interfaces", "uri":"topic_300000002.html", "doc_type":"api", "p_code":"35", @@ -495,7 +495,7 @@ "code":"55" }, { - "desc":"This API is used to query all virtual interfaces of a tenant.GET /v3/{project_id}/dcaas/virtual-interfacesStatus code: 200Querying the virtual interface listStatus code: ", + "desc":"This API is used to query the virtual interface list.GET /v3/{project_id}/dcaas/virtual-interfacesStatus code: 200Querying the virtual interface listStatus code: 200OKSee", "product_code":"dc", "title":"Querying the Virtual Interface List", "uri":"ListVirtualInterfaces.html", @@ -512,6 +512,69 @@ "p_code":"52", "code":"57" }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dc", + "title":"Tag Management", + "uri":"topic_300000003.html", + "doc_type":"api", + "p_code":"35", + "code":"58" + }, + { + "desc":"This API is used to query all resource tags of a resource in a specified project.TMS uses this API to list tags created by a tenant to ease tag creation and resource filt", + "product_code":"dc", + "title":"Querying Tags by Project", + "uri":"ListProjectTags.html", + "doc_type":"api", + "p_code":"58", + "code":"59" + }, + { + "desc":"This API is used to query the tags of a resource.GET /v3/{project_id}/{resource_type}/{resource_id}/tagsNoneStatus code: 200Querying tags of a resourceStatus code: 200OKS", + "product_code":"dc", + "title":"Querying Tags of a Resource", + "uri":"ShowResourceTag.html", + "doc_type":"api", + "p_code":"58", + "code":"60" + }, + { + "desc":"A resource can have a maximum of 20 tags.The API is idempotent.If a tag to be added has the same key as an existing tag, the tag will be added and overwrite the existing ", + "product_code":"dc", + "title":"Adding a Resource Tag", + "uri":"CreateResourceTag.html", + "doc_type":"api", + "p_code":"58", + "code":"61" + }, + { + "desc":"This API is used to add or delete tags of a specific resource in batches.TMS may use this API to manage service resource tags.A resource can have a maximum of 20 tags.POS", + "product_code":"dc", + "title":"Adding or Deleting Tags in Batches", + "uri":"BatchCreateResourceTags.html", + "doc_type":"api", + "p_code":"58", + "code":"62" + }, + { + "desc":"When a tag is deleted, the tag character set is not verified. Before calling this API, perform the encodeURI operation. The server must perform decodeURI on the API URI. ", + "product_code":"dc", + "title":"Deleting a Resource Tag", + "uri":"DeleteResourceTag.html", + "doc_type":"api", + "p_code":"58", + "code":"63" + }, + { + "desc":"This API is used to query resources by tag.POST /v3/{project_id}/{resource_type}/resource-instances/actionStatus code: 200Querying resources (action set to filter)https:/", + "product_code":"dc", + "title":"Querying Resources by Tag", + "uri":"ListTagResourceInstances.html", + "doc_type":"api", + "p_code":"58", + "code":"64" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dc", @@ -519,7 +582,7 @@ "uri":"dc_08_0000.html", "doc_type":"api", "p_code":"", - "code":"58" + "code":"65" }, { "desc":"This chapter describes fine-grained permissions management for Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, ", @@ -527,8 +590,8 @@ "title":"Introduction", "uri":"dc_08_0001.html", "doc_type":"api", - "p_code":"58", - "code":"59" + "p_code":"65", + "code":"66" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -536,8 +599,8 @@ "title":"Connections", "uri":"dc_08_0002.html", "doc_type":"api", - "p_code":"58", - "code":"60" + "p_code":"65", + "code":"67" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -545,8 +608,8 @@ "title":"Virtual Gateways", "uri":"dc_08_0003.html", "doc_type":"api", - "p_code":"58", - "code":"61" + "p_code":"65", + "code":"68" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -554,8 +617,8 @@ "title":"Virtual Interfaces", "uri":"dc_08_0004.html", "doc_type":"api", - "p_code":"58", - "code":"62" + "p_code":"65", + "code":"69" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -564,7 +627,7 @@ "uri":"dc_08_3000.html", "doc_type":"api", "p_code":"", - "code":"63" + "code":"70" }, { "desc":"This topic describes fine-grained permissions management for Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, yo", @@ -572,8 +635,8 @@ "title":"Introduction", "uri":"dc_08_3001.html", "doc_type":"api", - "p_code":"63", - "code":"64" + "p_code":"70", + "code":"71" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -581,8 +644,8 @@ "title":"Connections", "uri":"dc_08_3002.html", "doc_type":"api", - "p_code":"63", - "code":"65" + "p_code":"70", + "code":"72" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -590,8 +653,8 @@ "title":"Virtual Gateways", "uri":"dc_08_3003.html", "doc_type":"api", - "p_code":"63", - "code":"66" + "p_code":"70", + "code":"73" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -599,8 +662,17 @@ "title":"Virtual Interfaces", "uri":"dc_08_3004.html", "doc_type":"api", - "p_code":"63", - "code":"67" + "p_code":"70", + "code":"74" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dc", + "title":"Tags", + "uri":"dc_08_3007.html", + "doc_type":"api", + "p_code":"70", + "code":"75" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -609,7 +681,7 @@ "uri":"en-us_topic_0055025341.html", "doc_type":"api", "p_code":"", - "code":"68" + "code":"76" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -617,8 +689,8 @@ "title":"Common Status Codes", "uri":"en-us_topic_0055025342.html", "doc_type":"api", - "p_code":"68", - "code":"69" + "p_code":"76", + "code":"77" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -626,8 +698,8 @@ "title":"Error Codes (APIs v2.0)", "uri":"en-us_topic_0055025343.html", "doc_type":"api", - "p_code":"68", - "code":"70" + "p_code":"76", + "code":"78" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -635,8 +707,8 @@ "title":"Error Codes (APIs v3)", "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"68", - "code":"71" + "p_code":"76", + "code":"79" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -645,6 +717,6 @@ "uri":"en-us_topic_0055025347.html", "doc_type":"api", "p_code":"", - "code":"72" + "code":"80" } ] \ No newline at end of file diff --git a/docs/dc/api-ref/CreateHostedDirectConnect.html b/docs/dc/api-ref/CreateHostedDirectConnect.html index 513f0fe59..1f0b1c84d 100644 --- a/docs/dc/api-ref/CreateHostedDirectConnect.html +++ b/docs/dc/api-ref/CreateHostedDirectConnect.html @@ -1,357 +1,357 @@

Creating a Hosted Connection

-

Function

This API is used by partners to create hosted connections for their users. The creator must have the partner qualification and have an operations connection.

+

Function

This API is used by partners to create a hosted connection for their users. The creator must have the partner qualification and have an operations connection.

-

URI

POST /v3/{project_id}/dcaas/hosted-connects

+

URI

POST /v3/{project_id}/dcaas/hosted-connects

-
Table 1 Path Parameters

Parameter

+
- - - - - - -
Table 1 URI parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Specifies the project ID.

+

Specifies the project ID.

-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

-

Minimum: 0

-

Maximum: 10240

+

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

+

Minimum: 0

+

Maximum: 10240

-
Table 3 Request body parameters

Parameter

+
- - - - - - -
Table 3 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

hosted_connect

+

hosted_connect

Yes

+

Yes

CreateHostedDirectConnect object

+

CreateHostedDirectConnect object

Specifies the parameters for creating a hosted connection.

+

Specifies the hosted connection to be created.

-
Table 4 CreateHostedDirectConnect

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateHostedDirectConnect

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

No

+

No

String

+

String

Specifies the hosted connection name.

-

Minimum: 0

-

Maximum: 64

+

Specifies the hosted connection name.

+

Minimum: 0

+

Maximum: 64

description

+

description

No

+

No

String

+

String

Provides supplementary information about the hosted connection.

-

Minimum: 0

-

Maximum: 128

+

Provides supplementary information about the hosted connection.

+

Minimum: 0

+

Maximum: 128

bandwidth

+

bandwidth

Yes

+

Yes

Integer

+

Integer

Specifies the bandwidth size of the hosted connection in Mbit/s.

-

Minimum: 2

-

Maximum: 400000

+

Specifies the bandwidth of the hosted connection, in Mbit/s.

+

Minimum: 2

+

Maximum: 400000

hosting_id

+

hosting_id

Yes

+

Yes

String

+

String

Specifies the ID of the operations connection on which the hosted connection is created.

+

Specifies the ID of the operations connection on which the hosted connection is created.

vlan

+

vlan

Yes

+

Yes

Integer

+

Integer

Specifies the VLAN allocated to the hosted connection.

-

Minimum: 0

-

Maximum: 3999

+

Specifies the VLAN allocated to the hosted connection.

+

Minimum: 0

+

Maximum: 3999

resource_tenant_id

+

resource_tenant_id

Yes

+

Yes

String

+

String

Specifies the project ID of the specified tenant for whom a hosted connection is to be created.

-

Minimum: 0

-

Maximum: 32

+

Specifies the project ID of the specified tenant for whom a hosted connection is to be created.

+

Minimum: 0

+

Maximum: 32

peer_location

+

peer_location

No

+

No

String

+

String

Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

-

Minimum: 0

-

Maximum: 255

+

Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

+

Minimum: 0

+

Maximum: 255

-

Response Parameters

Status code: 201

+

Response Parameters

Status code: 201

-
Table 5 Response body parameters

Parameter

+
- - - - - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

request_id

+

request_id

String

+

String

Specifies the request ID.

+

Specifies the request ID.

hosted_connect

+

hosted_connect

HostedDirectConnect object

+

HostedDirectConnect object

Specifies the parameters for creating a hosted connection.

+

Specifies the hosted connection.

-
Table 6 HostedDirectConnect

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 HostedDirectConnect

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Specifies the hosted connection ID.

-

Minimum: 36

-

Maximum: 36

+

Specifies the hosted connection ID.

+

Minimum: 36

+

Maximum: 36

tenant_id

+

tenant_id

String

+

String

Specifies the ID of the project that the instance belongs to.

+

Specifies the project ID.

name

+

name

String

+

String

Specifies the connection name.

-

Minimum: 0

-

Maximum: 64

+

Specifies the connection name.

+

Minimum: 0

+

Maximum: 64

description

+

description

String

+

String

Provides supplementary information about the connection.

-

Minimum: 0

-

Maximum: 128

+

Provides supplementary information about the connection.

+

Minimum: 0

+

Maximum: 128

bandwidth

+

bandwidth

Integer

+

Integer

Specifies the connection bandwidth in Mbit/s.

-

Minimum: 2

-

Maximum: 400000

+

Specifies the connection bandwidth, in Mbit/s.

+

Minimum: 2

+

Maximum: 400000

location

+

location

String

+

String

Specifies information about the Direct Connect location.

-

Minimum: 0

-

Maximum: 255

+

Specifies information about the Direct Connect location.

+

Minimum: 0

+

Maximum: 255

peer_location

+

peer_location

String

+

String

Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

-

Minimum: 0

-

Maximum: 255

+

Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

+

Minimum: 0

+

Maximum: 255

hosting_id

+

hosting_id

String

+

String

Specifies the ID of the operations connection on which the hosted connection is created.

+

Specifies the ID of the operations connection on which the hosted connection is created.

provider

+

provider

String

+

String

Specifies the provider of the leased line.

+

Specifies the provider of the leased line.

admin_state_up

+

admin_state_up

Boolean

+

Boolean

Specifies the administrative status, which can be true or false.

-

Default: true

+

Specifies the administrative status. The value can be true or false.

+

Default: true

vlan

+

vlan

Integer

+

Integer

Specifies the VLAN allocated to the hosted connection.

-

Minimum: 0

-

Maximum: 3999

+

Specifies the VLAN allocated to the hosted connection.

+

Minimum: 0

+

Maximum: 3999

status

+

status

String

+

String

Specifies the operating status of the hosted connection. The options are as follows:

-
  • BUILD: The hosted connection has been created.
  • ACTIVE: The associated virtual gateway is normal.
  • DOWN: The port used by the hosted connection is down, indicating that there may be line faults.
  • ERROR: The associated virtual gateway is abnormal.
  • PENDING_DELETE: The hosted connection is being deleted.
  • PENDING_UPDATE: The hosted connection is being updated.
  • PENDING_CREATE: The hosted connection is being created.
-

Enumeration values:

-
  • BUILD
  • ACTIVE
  • DOWN
  • ERROR
  • PENDING_DELETE
  • PENDING_UPDATE
  • PENDING_CREATE
+

Specifies the operating status.

+
  • BUILD: The hosted connection has been created.
  • ACTIVE: The hosted connection is normal.
  • DOWN: The port used by the hosted connection is down, indicating that there may be line faults.
  • ERROR: The hosted connection is abnormal.
  • PENDING_DELETE: The hosted connection is being deleted.
  • PENDING_UPDATE: The hosted connection is being updated.
  • PENDING_CREATE: The hosted connection is being created.
+

Enumeration values:

+
  • BUILD
  • ACTIVE
  • DOWN
  • ERROR
  • PENDING_DELETE
  • PENDING_UPDATE
  • PENDING_CREATE

apply_time

+

apply_time

String

+

String

Specifies when the connection was requested. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

+

Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

create_time

+

create_time

String

+

String

Specifies when the connection was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

+

Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

provider_status

+

provider_status

String

+

String

Specifies the status of the carrier's leased line. The status can be ACTIVE or DOWN.

-

Enumeration values:

-
  • ACTIVE
  • DOWN
+

Specifies the carrier status. The status can be ACTIVE or DOWN.

+

Enumeration values:

+
  • ACTIVE
  • DOWN

port_type

+

port_type

String

+

String

Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

-

Enumeration values:

-
  • 1G
  • 10G
  • 40G
  • 100G
+

Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

+

Enumeration values:

+
  • 1G
  • 10G
  • 40G
  • 100G
    NOTE:

    The port type of a hosted connection is the same as that of the operations connection that the hosted connection relies on.

    +
    +

type

+

type

String

+

String

Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

-

Default: standard

-

Enumeration values:

-
  • standard
  • hosting
  • hosted
  • onestop_standard
  • onestop_hosted
+

Specifies the type of the connection. The value is hosted.

+

Default: hosted

-

Example Requests

Creating a hosting connection with the bandwidth set to 10 Mbit/s and VLAN to 441

-
POST https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects
+

Example Requests

Creating a hosting connection with the bandwidth set to 10 Mbit/s and VLAN to 441

+
POST https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects
 
 {
   "hosted_connect" : {
@@ -364,9 +364,9 @@
   }
 }
-

Example Responses

Status code: 201

-

Created

-
  • The hosted connection is created.
    {
    +

    Example Responses

    Status code: 201

    +

    Created

    +
    • The hosted connection is created.
      {
         "hosted_connect" : {
           "id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6",
           "name" : "client-dc-faf1",
      @@ -390,28 +390,28 @@
       }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    201

    +

    201

    Created

    +

    Created

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/dc/api-ref/CreateResourceTag.html b/docs/dc/api-ref/CreateResourceTag.html new file mode 100644 index 000000000..83e55e2e4 --- /dev/null +++ b/docs/dc/api-ref/CreateResourceTag.html @@ -0,0 +1,147 @@ + + +

    Adding a Resource Tag

    +

    Function

    • A resource can have a maximum of 20 tags.
    • The API is idempotent.
    • If a tag to be added has the same key as an existing tag, the tag will be added and overwrite the existing one.
    +
    +

    URI

    POST /v3/{project_id}/{resource_type}/{resource_id}/tags

    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 1 URI parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Specifies the project ID.

    +

    resource_id

    +

    Yes

    +

    String

    +

    Specifies the resource ID.

    +

    resource_type

    +

    Yes

    +

    String

    +
    • Specifies the Direct Connect resource type. The value can be dc-directconnect, dc-vgw, or dc-vif.
    • dc-directconnect: Direct Connect connection
    • dc-vgw: virtual gateway
    • dc-vif: virtual interface
    +

    Enumeration values:

    +
    • dc-directconnect
    • dc-vgw
    • dc-vif
    +
    +
    +
    +

    Request Parameters

    +
    + + + + + + + + + + + +
    Table 2 Request body parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tag

    +

    Yes

    +

    Tag object

    +

    Specifies the tag.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 Tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +
    Specifies the tag key. The key:
    • Cannot be left blank.
    • Must be unique for each resource.
    • Can contain a maximum of 36 Unicode characters.
    • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
    +
    +

    value

    +

    No

    +

    String

    +
    Specifies the tag value. The value:
    • Can be left blank.
    • Can contain a maximum of 43 Unicode characters.
    • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
    +
    +
    +
    +
    +

    Response Parameters

    None

    +
    +

    Example Requests

    Adding a resource tag

    +
    POST https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags
    +
    +{
    +  "tag" : {
    +    "key" : "key1",
    +    "value" : "value1"
    +  }
    +}
    +
    +

    Example Responses

    None

    +
    +

    Status Code

    +
    + + + + + + + +

    Status Code

    +

    Description

    +

    204

    +

    No Content

    +
    +
    +
    +

    Error Codes

    See Error Codes.

    +
    +
    +
    + +
    + diff --git a/docs/dc/api-ref/CreateVirtualGateway.html b/docs/dc/api-ref/CreateVirtualGateway.html index c64c20b04..ce6e26b12 100644 --- a/docs/dc/api-ref/CreateVirtualGateway.html +++ b/docs/dc/api-ref/CreateVirtualGateway.html @@ -1,341 +1,421 @@

    Creating a Virtual Gateway

    -

    Function

    This API is used to create a virtual gateway.

    +

    Function

    This API is used to create a virtual gateway.

    -

    URI

    POST /v3/{project_id}/dcaas/virtual-gateways

    +

    URI

    POST /v3/{project_id}/dcaas/virtual-gateways

    -
    Table 1 Path Parameters

    Parameter

    +
    - - - - - - -
    Table 1 URI parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Specifies the project ID.

    +

    Specifies the project ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

    -

    Minimum: 0

    -

    Maximum: 10240

    +

    Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

    +

    Minimum: 0

    +

    Maximum: 10240

    -
    Table 3 Request body parameters

    Parameter

    +
    - - - - - - -
    Table 3 Request body parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    virtual_gateway

    +

    virtual_gateway

    No

    +

    No

    CreateVirtualGateway object

    +

    CreateVirtualGateway object

    Specifies parameters for creating a virtual gateway.

    +

    Specifies the virtual gateway to be created.

    -
    Table 4 CreateVirtualGateway

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 4 CreateVirtualGateway

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    vpc_id

    +

    vpc_id

    Yes

    +

    Yes

    String

    +

    String

    Specifies the ID of the VPC that the virtual gateway is associated with. This parameter is mandatory when a virtual gateway is used by a connection for accessing a VPC.

    +

    Specifies the ID of the VPC that the virtual gateway is associated with. This parameter is mandatory when a virtual gateway is used by a connection for accessing a VPC.

    enterprise_router_id

    +

    enterprise_router_id

    No

    +

    No

    String

    +

    String

    Specifies the ID of the enterprise router that the virtual gateway is attached to. This parameter is mandatory when a virtual gateway is attached to an enterprise router.

    +

    Specifies the ID of the enterprise router that the virtual gateway is attached to. This parameter is mandatory when a virtual gateway is attached to an enterprise router.

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Specifies the virtual gateway name.

    -

    Minimum: 0

    -

    Maximum: 64

    +

    Specifies the virtual gateway name.

    +

    Minimum: 0

    +

    Maximum: 64

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Provides supplementary information about the virtual gateway.

    -

    Minimum: 0

    -

    Maximum: 128

    +

    Provides supplementary information about the virtual gateway.

    +

    Minimum: 0

    +

    Maximum: 128

    local_ep_group

    +

    local_ep_group

    Yes

    +

    Yes

    Array of strings

    +

    Array of strings

    Lists the IPv4 subnets that can be accessed over the virtual gateway. Generally, the list contains the subnet CIDR blocks of the associated VPC. This parameter is mandatory when a virtual gateway is used by a connection for accessing a VPC.

    +

    Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway. This parameter is mandatory when a virtual gateway is used by a connection for accessing a VPC.

    local_ep_group_ipv6

    +

    local_ep_group_ipv6

    No

    +

    No

    Array of strings

    +

    Array of strings

    Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field.

    +

    Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. This is a reserved field.

    bgp_asn

    +

    bgp_asn

    No

    +

    No

    Integer

    +

    Integer

    Specifies the local BGP autonomous system number (ASN) of the virtual gateway.

    -

    Minimum: 1

    -

    Maximum: 4294967295

    +

    Specifies the local BGP autonomous system number (ASN) of the virtual gateway.

    +

    Minimum: 1

    +

    Maximum: 4294967295

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Specifies the ID of the enterprise project that the virtual gateway belongs to.

    -

    Minimum: 36

    -

    Maximum: 36

    +

    Specifies the ID of the enterprise project that the virtual gateway belongs to.

    +

    Minimum: 36

    +

    Maximum: 36

    -
    - -

    Response Parameters

    Status code: 201

    - -
    - - - - - - - - - - -
    Table 5 Response body parameters

    Parameter

    -

    Type

    -

    Description

    -

    virtual_gateway

    +

    tags

    VirtualGateway object

    +

    No

    Specifies parameters for creating a virtual gateway.

    +

    Array of Tag objects

    request_id

    -

    String

    -

    Specifies the request ID.

    +

    Specifies the tags.

    +

    Array length: 0–10

    -
    Table 6 VirtualGateway

    Parameter

    +
    - - + - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 Tag

    Parameter

    Type

    +

    Mandatory

    Description

    +

    Type

    +

    Description

    id

    +

    key

    String

    +

    Yes

    Specifies the virtual gateway ID.

    +

    String

    +
    Specifies the tag key. The key:
    • Cannot be left blank.
    • Must be unique for each resource.
    • Can contain a maximum of 36 Unicode characters.
    • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
    +

    vpc_id

    +

    value

    String

    +

    No

    Specifies the ID of the VPC connected by the virtual gateway.

    +

    String

    enterprise_router_id

    -

    String

    -

    Specifies the ID of the enterprise router that the virtual gateway is attached to.

    -

    tenant_id

    -

    String

    -

    Specifies the ID of the project that the instance belongs to.

    -

    Minimum: 32

    -

    Maximum: 32

    -

    name

    -

    String

    -

    Specifies the virtual gateway name.

    -

    Minimum: 0

    -

    Maximum: 64

    -

    description

    -

    String

    -

    Provides supplementary information about the virtual gateway.

    -

    Minimum: 0

    -

    Maximum: 128

    -

    type

    -

    String

    -

    Specifies the virtual gateway type. The value can only be default.

    -

    Default: default

    -

    local_ep_group

    -

    Array of strings

    -

    Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC.

    -

    local_ep_group_ipv6

    -

    Array of strings

    -

    Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field.

    -

    admin_state_up

    -

    Boolean

    -

    Specifies the administrative status, which can be true or false.

    -

    Default: true

    -

    status

    -

    String

    -

    Specifies the virtual gateway status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

    -

    bgp_asn

    -

    Integer

    -

    Specifies the local BGP ASN of the virtual gateway.

    -

    Minimum: 1

    -

    Maximum: 4294967295

    -

    enterprise_project_id

    -

    String

    -

    Specifies the ID of the enterprise project that the virtual gateway belongs to.

    -

    Minimum: 36

    -

    Maximum: 36

    -

    device_id

    -

    String

    -

    Specifies the ID of the device that the virtual interface belongs to.

    -

    redundant_device_id

    -

    String

    -

    Specifies the ID of the redundant device.

    -

    public_border_group

    -

    String

    -

    Specifies the public border group of the AZ, indicating whether the site is a HomeZones site.

    +
    Specifies the tag value. The value:
    • Can be left blank.
    • Can contain a maximum of 43 Unicode characters.
    • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
    +
    -

    Example Requests

    • Creating a virtual gateway that will be used to access a VPC, with the local BGP ASN set to 64512 and the IPv4 subnet to 192.168.1.0/24
      POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways
      +

      Response Parameters

      Status code: 201

      + +
      + + + + + + + + + + + + + +
      Table 6 Response body parameters

      Parameter

      +

      Type

      +

      Description

      +

      virtual_gateway

      +

      VirtualGateway object

      +

      Specifies the virtual gateway.

      +

      request_id

      +

      String

      +

      Specifies the request ID.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 7 VirtualGateway

      Parameter

      +

      Type

      +

      Description

      +

      id

      +

      String

      +

      Specifies the virtual gateway ID.

      +

      vpc_id

      +

      String

      +

      Specifies the ID of the VPC connected using the virtual gateway.

      +

      enterprise_router_id

      +

      String

      +

      Specifies the ID of the enterprise router that the virtual gateway is attached to.

      +

      tenant_id

      +

      String

      +

      Specifies the project ID.

      +

      Minimum: 32

      +

      Maximum: 32

      +

      name

      +

      String

      +

      Specifies the virtual gateway name.

      +

      Minimum: 0

      +

      Maximum: 64

      +

      description

      +

      String

      +

      Provides supplementary information about the virtual gateway.

      +

      Minimum: 0

      +

      Maximum: 128

      +

      type

      +

      String

      +

      Specifies the virtual gateway type. The value can only be default.

      +

      Default: default

      +

      local_ep_group

      +

      Array of strings

      +

      Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway.

      +

      local_ep_group_ipv6

      +

      Array of strings

      +

      Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. This is a reserved field.

      +

      admin_state_up

      +

      Boolean

      +

      Specifies the administrative status. The value can be true or false.

      +

      Default: true

      +

      status

      +

      String

      +

      Specifies the operating status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

      +

      bgp_asn

      +

      Integer

      +

      Specifies the local BGP ASN of the virtual gateway.

      +

      Minimum: 1

      +

      Maximum: 4294967295

      +

      enterprise_project_id

      +

      String

      +

      Specifies the ID of the enterprise project that the virtual gateway belongs to.

      +

      Minimum: 36

      +

      Maximum: 36

      +

      device_id

      +

      String

      +

      Specifies the ID of the device that the virtual interface belongs to.

      +

      redundant_device_id

      +

      String

      +

      Specifies the ID of the redundant device.

      +

      public_border_group

      +

      String

      +

      Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

      +

      tags

      +

      Array of Tag objects

      +

      Specifies the tags.

      +

      Array length: 0–10

      +
      +
      + +
      + + + + + + + + + + + + + +
      Table 8 Tag

      Parameter

      +

      Type

      +

      Description

      +

      key

      +

      String

      +
      Specifies the tag key. The key:
      • Cannot be left blank.
      • Must be unique for each resource.
      • Can contain a maximum of 36 Unicode characters.
      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
      +
      +

      value

      +

      String

      +
      Specifies the tag value. The value:
      • Can be left blank.
      • Can contain a maximum of 43 Unicode characters.
      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
      +
      +
      +
      +
      +

      Example Requests

      • Creating a virtual gateway that will be used to access a VPC, with the local BGP ASN set to 64512 and the IPv4 subnet to 192.168.1.0/24
        POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways
         
         {
           "virtual_gateway" : {
        @@ -346,7 +426,7 @@
             "local_ep_group" : [ "192.168.1.0/24" ]
           }
         }
        -
      • Creating a virtual gateway that will be attached to an enterprise router and set the BGP ASN to 64512
        POST https://{dc_endpoint}/v3/92ea72fe26294aa180a2712c28e43c21/dcaas/virtual-gateways
        +
      • Creating a virtual gateway that will be attached to an enterprise router and set the BGP ASN to 64512
        POST https://{dc_endpoint}/v3/92ea72fe26294aa180a2712c28e43c21/dcaas/virtual-gateways
         
         {
           "virtual_gateway" : {
        @@ -356,18 +436,20 @@
             "enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
             "bgp_asn" : 64512
           }
        -}
        +} +
    -

    Example Responses

    Status code: 201

    -

    Created

    -
    • The virtual gateway for accessing the VPC is created
      {
      +

      Example Responses

      Status code: 201

      +

      Created

      +
      • The virtual gateway for accessing the VPC is created
        {
           "virtual_gateway" : {
             "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
             "name" : "vgw-c7b22",
             "description" : "",
             "tenant_id" : "0605768a3300d5762f82c01180692873",
             "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
        +    "tags": [],
             "device_id" : "26.151.63.100",
             "redundant_device_id" : "26.152.128.20",
             "type" : "default",
        @@ -379,7 +461,7 @@
             "public_border_group" : "center"
           }
         }
        -
      • The virtual gateway that will be attached to an enterprise router is created
        {
        +
      • The virtual gateway that will be attached to an enterprise router is created
        {
           "virtual_gateway" : {
             "name" : "vgw-er",
             "id" : "7a91797a-cbda-42ff-9f42-73f26c993dd9",
        @@ -387,6 +469,7 @@
             "tenant_id" : "92ea72fe26294aa180a2712c28e43c21",
             "vpc_id" : null,
             "enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
        +    "tags": [],
             "device_id" : "26.151.63.100",
             "redundant_device_id" : "26.152.128.20",
             "type" : "default",
        @@ -400,28 +483,28 @@
         }
      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - -

      Status Code

      Description

      +

      Description

      201

      +

      201

      Created

      +

      Created

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/dc/api-ref/CreateVirtualInterface.html b/docs/dc/api-ref/CreateVirtualInterface.html index 8a1d81b9c..c47d57480 100644 --- a/docs/dc/api-ref/CreateVirtualInterface.html +++ b/docs/dc/api-ref/CreateVirtualInterface.html @@ -1,879 +1,943 @@

      Creating a Virtual Interface

      -

      Function

      This API is used to create a virtual interface.

      +

      Function

      This API is used to create a virtual interface.

      -

      URI

      POST /v3/{project_id}/dcaas/virtual-interfaces

      +

      URI

      POST /v3/{project_id}/dcaas/virtual-interfaces

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - -
      Table 1 URI parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the project ID.

      +

      Specifies the project ID.

      -

      Request Parameters

      -
      Table 2 Request header parameters

      Parameter

      +

      Request Parameters

      +
      - - - - - - -
      Table 2 Request header parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      -

      Minimum: 0

      -

      Maximum: 10240

      +

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      +

      Minimum: 0

      +

      Maximum: 10240

      -
      Table 3 Request body parameters

      Parameter

      +
      - - - - - - -
      Table 3 Request body parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      virtual_interface

      +

      virtual_interface

      Yes

      +

      Yes

      CreateVirtualInterface object

      +

      CreateVirtualInterface object

      Specifies parameters for creating a virtual interface.

      +

      Specifies the virtual interface to be created.

      -
      Table 4 CreateVirtualInterface

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 4 CreateVirtualInterface

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      name

      +

      name

      No

      +

      No

      String

      +

      String

      Specifies the virtual interface name.

      -

      Minimum: 0

      -

      Maximum: 64

      +

      Specifies the virtual interface name.

      +

      Minimum: 0

      +

      Maximum: 64

      description

      +

      description

      No

      +

      No

      String

      +

      String

      Provides supplementary information about the virtual interface.

      -

      Minimum: 0

      -

      Maximum: 128

      +

      Provides supplementary information about the virtual interface.

      +

      Minimum: 0

      +

      Maximum: 128

      direct_connect_id

      +

      direct_connect_id

      No

      +

      No

      String

      +

      String

      Specifies the ID of the connection associated with the virtual interface. When creating a virtual interface, you need to specify direct_connect_id or lag_id. This parameter is mandatory when LAG is not supported at the site.

      +

      Specifies the ID of the connection associated with the virtual interface. When creating a virtual interface, you need to specify direct_connect_id or lag_id. This parameter is mandatory when LAG is not supported at the site.

      type

      +

      type

      Yes

      +

      Yes

      String

      +

      String

      Specifies the type of the virtual interface. The value is private.

      -

      Enumeration values:

      -
      • private
      • public
      +

      Specifies the type of the virtual interface. The value is private.

      +

      Enumeration values: private

      service_type

      +

      vlan

      No

      +

      Yes

      String

      +

      Integer

      Specifies the gateway type, which can be VGW, GDGW, or LGW.

      -

      Enumeration values:

      -
      • VGW
      • GDGW
      • LGW
      +

      Specifies the customer VLAN to be connected. If you select a hosted connection, the VLAN must be the same as that of the hosted connection.

      +

      Minimum: 0

      +

      Maximum: 3999

      vlan

      +

      bandwidth

      Yes

      +

      Yes

      Integer

      +

      Integer

      Specifies the customer VLAN to be connected. If you select a hosted connection, the VLAN must be the same as that of the hosted connection.

      -

      Minimum: 0

      -

      Maximum: 3999

      +

      Specifies the virtual interface bandwidth.

      +

      Minimum: 2

      +

      Maximum: 2147483647

      bandwidth

      +

      local_gateway_v4_ip

      Yes

      +

      No

      Integer

      +

      String

      Specifies the virtual interface bandwidth.

      -

      Minimum: 2

      -

      Maximum: 2147483647

      +

      Specifies the IPv4 interface address of the gateway used on the cloud. This parameter is mandatory if address_family is set to an IPv4 address.

      local_gateway_v4_ip

      +

      remote_gateway_v4_ip

      No

      +

      No

      String

      +

      String

      Specifies the IPv4 interface address of the gateway used on the cloud. This parameter is mandatory if address_family is set to an IPv4 address.

      +

      Specifies the IPv4 interface address of the gateway on the on-premises network. This parameter is mandatory if address_family is set to an IPv4 address.

      remote_gateway_v4_ip

      +

      address_family

      No

      +

      No

      String

      +

      String

      Specifies the IPv4 interface address of the gateway on the on-premises network. This parameter is mandatory if address_family is set to an IPv4 address.

      +

      Specifies the address family of the virtual interface. The value can be IPv4 or IPv6.

      +

      Default: ipv4

      address_family

      +

      local_gateway_v6_ip

      No

      +

      No

      String

      +

      String

      Specifies the address family type of the virtual interface, which can be IPv4 or IPv6.

      -

      Default: ipv4

      +

      Specifies the IPv6 interface address of the gateway used on the cloud. This parameter is mandatory if address_family is set to an IPv6 address.

      local_gateway_v6_ip

      +

      remote_gateway_v6_ip

      No

      +

      No

      String

      +

      String

      Specifies the IPv6 interface address of the gateway used on the cloud. This parameter is mandatory if address_family is set to an IPv6 address.

      +

      Specifies the IPv6 interface address of the gateway on the on-premises network. This parameter is mandatory if address_family is set to an IPv6 address.

      remote_gateway_v6_ip

      +

      vgw_id

      No

      +

      No

      String

      +

      String

      Specifies the IPv6 interface address of the gateway on the on-premises network. This parameter is mandatory if address_family is set to an IPv6 address.

      +

      Specifies the ID of the virtual gateway connected by the virtual interface.

      vgw_id

      +

      route_mode

      Yes

      +

      Yes

      String

      +

      String

      Specifies the ID of the virtual gateway connected by the virtual interface.

      +

      Specifies the routing mode. The value can be static or bgp.

      +

      Default: static

      +

      Enumeration values:

      +
      • static
      • bgp

      route_mode

      +

      bgp_asn

      Yes

      +

      No

      String

      +

      Integer

      Specifies the routing mode, which can be static or bgp.

      -

      Default: static

      -

      Enumeration values:

      -
      • static
      • bgp
      +

      Specifies the ASN of the BGP peer on the customer side.

      +

      Minimum: 1

      +

      Maximum: 4294967295

      bgp_asn

      +

      bgp_md5

      No

      +

      No

      Integer

      +

      String

      Specifies the ASN of the BGP peer on the customer side.

      -

      Minimum: 1

      -

      Maximum: 4294967295

      +

      Specifies the MD5 password of the BGP peer.

      bgp_md5

      +

      remote_ep_group

      No

      +

      Yes

      String

      +

      Array of strings

      Specifies the MD5 password of the BGP peer.

      +

      Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

      remote_ep_group

      +

      service_ep_group

      Yes

      +

      No

      Array of strings

      +

      Array of strings

      Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

      +

      Specifies the subnets that access Internet services through a connection.

      service_ep_group

      +

      enable_bfd

      No

      +

      No

      Array of strings

      +

      Boolean

      Specifies the subnets that access Internet services through a direct connection.

      +

      Specifies whether to enable BFD (Bidirectional Forwarding Detection). The value can be true or false. (This is a reserved parameter and is not supported currently.)

      +

      Default: false

      enable_bfd

      +

      enable_nqa

      No

      +

      No

      Boolean

      +

      Boolean

      Specifies whether to enable Bidirectional Forwarding Detection (BFD). The value can be true or false. (This is a reserved parameter and is not supported currently.)

      -

      Default: false

      +

      Specifies whether to enable NQA (Network Quality Analysis). The value can be true or false. (This is a reserved parameter and is not supported currently.)

      +

      Default: false

      enable_nqa

      +

      lag_id

      No

      +

      No

      Boolean

      +

      String

      Specifies whether to enable NQA. The value can be true or false. (This is a reserved parameter and is not supported currently.)

      -

      Default: false

      +

      Specifies the ID of the LAG associated with the virtual interface.

      +

      Minimum: 36

      +

      Maximum: 36

      lag_id

      +

      resource_tenant_id

      No

      +

      No

      String

      +

      String

      Specifies the ID of the LAG associated with the virtual interface.

      -

      Minimum: 36

      -

      Maximum: 36

      +

      Specifies the project ID of another tenant, which is used to create virtual interfaces across tenants.

      resource_tenant_id

      +

      enterprise_project_id

      No

      +

      No

      String

      +

      String

      Specifies the project ID of another tenant, which is used to create virtual interfaces across tenants.

      +

      Specifies the ID of the enterprise project that the virtual interface belongs to.

      +

      Minimum: 36

      +

      Maximum: 36

      enterprise_project_id

      +

      tags

      No

      +

      No

      String

      +

      Array of Tag objects

      Specifies the ID of the enterprise project that the resource belongs to.

      -

      Minimum: 36

      -

      Maximum: 36

      -
      -
      - -

      Response Parameters

      Status code: 201

      - -
      - - - - - - - - - - -
      Table 5 Response body parameters

      Parameter

      -

      Type

      -

      Description

      -

      request_id

      -

      String

      -

      Specifies the request ID.

      -

      virtual_interface

      -

      VirtualInterface object

      -

      Specifies parameters for creating a virtual interface.

      +

      Specifies the tags.

      +

      Array length: 0–10

      -
      Table 6 VirtualInterface

      Parameter

      +
      - - + - - - + - - - + - +
      Table 5 Tag

      Parameter

      Type

      +

      Mandatory

      Description

      +

      Type

      +

      Description

      id

      +

      key

      String

      +

      Yes

      Specifies the virtual interface ID.

      -

      Maximum: 36

      +

      String

      +
      Specifies the tag key. The key:
      • Cannot be left blank.
      • Must be unique for each resource.
      • Can contain a maximum of 36 Unicode characters.
      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
      +

      name

      +

      value

      String

      +

      No

      Specifies the virtual interface name.

      -

      Maximum: 64

      +

      String

      +
      Specifies the tag value. The value:
      • Can be left blank.
      • Can contain a maximum of 43 Unicode characters.
      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
      +

      admin_state_up

      +
      +
      + +

      Response Parameters

      Status code: 201

      + +
      + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 6 Response body parameters

      Parameter

      +

      Type

      +

      Description

      +

      request_id

      Boolean

      +

      String

      Specifies the administrative status, which can be true or false.

      +

      Specifies the request ID.

      bandwidth

      +

      virtual_interface

      Integer

      +

      VirtualInterface object

      Specifies the virtual interface bandwidth.

      -

      Minimum: 2

      -

      Maximum: 2147483647

      -

      create_time

      -

      String

      -

      Specifies the time when the virtual interface was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

      -

      Maximum: 255

      -

      description

      -

      String

      -

      Provides supplementary information about the virtual interface.

      -

      Maximum: 128

      -

      direct_connect_id

      -

      String

      -

      Specifies the connection ID.

      -

      Maximum: 36

      -

      service_type

      -

      String

      -

      Specifies the gateway type, which can be VGW, GDGW, or LGW.

      -

      Enumeration values:

      -
      • VGW
      • GDGW
      • LGW
      -

      status

      -

      String

      -

      Specifies the operating status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.

      -

      tenant_id

      -

      String

      -

      Specifies the project ID.

      -

      Minimum: 32

      -

      Maximum: 32

      -

      type

      -

      String

      -

      Specifies the type of the virtual interface. The value is private.

      -

      Default: private

      -

      Maximum: 255

      -

      Enumeration values:

      -
      • private
      • public
      -

      vgw_id

      -

      String

      -

      Specifies the virtual gateway ID.

      -

      Minimum: 36

      -

      Maximum: 36

      -

      vlan

      -

      Integer

      -

      Specifies the VLAN for connecting to the user gateway. The value ranges from 0 to 3999.

      -

      Minimum: 0

      -

      Maximum: 3999

      -

      route_limit

      -

      Integer

      -

      Specifies the remote subnet route configurations of the virtual interface.

      -

      Minimum: 1

      -

      Maximum: 200

      -

      Default: 50

      -

      enable_nqa

      -

      Boolean

      -

      Specifies whether to enable NQA. The value can be true or false.

      -

      enable_bfd

      -

      Boolean

      -

      Specifies whether to enable Bidirectional Forwarding Detection (BFD). The value can be true or false.

      -

      lag_id

      -

      String

      -

      Specifies the ID of the LAG associated with the virtual interface.

      -

      Minimum: 36

      -

      Maximum: 36

      -

      device_id

      -

      String

      -

      Specifies the ID of the device that the virtual interface belongs to.

      -

      enterprise_project_id

      -

      String

      -

      Specifies the ID of the enterprise project that the virtual interface belongs to.

      -

      Minimum: 36

      -

      Maximum: 36

      -

      local_gateway_v4_ip

      -

      String

      -

      Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      -

      remote_gateway_v4_ip

      -

      String

      -

      Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      -

      ies_id

      -

      String

      -

      Specifies the ID of an IES edge site. (This parameter is not supported currently.)

      -

      reason

      -

      String

      -

      Displays error information if the status of a line is Error.

      -

      rate_limit

      -

      Boolean

      -

      Specifies whether rate limiting is enabled on a virtual interface.

      -

      address_family

      -

      String

      -

      Specifies the address family of the virtual interface, which can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      -

      local_gateway_v6_ip

      -

      String

      -

      Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      -

      remote_gateway_v6_ip

      -

      String

      -

      Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      -

      lgw_id

      -

      String

      -

      Specifies the ID of the local gateway, which is used in IES scenarios. (This parameter is not supported currently.)

      -

      gateway_id

      -

      String

      -

      Specifies the ID of the gateway associated with the virtual interface.

      -

      remote_ep_group

      -

      Array of strings

      -

      Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      -

      service_ep_group

      -

      Array of strings

      -

      Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      -

      bgp_route_limit

      -

      Integer

      -

      Specifies the BGP route configuration.

      -

      priority

      -

      String

      -

      Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing.

      -

      Default: normal

      -

      Enumeration values:

      -
      • normal
      • low
      -

      vif_peers

      -

      Array of VifPeer objects

      -

      Provides information about virtual interface peers. (This is a reserved parameter and is not supported currently.)

      -

      extend_attribute

      -

      VifExtendAttribute object

      -

      Provides extended parameter information. (This is a reserved parameter and is not supported currently.)

      +

      Specifies the virtual interface.

      -
      Table 7 VifPeer

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 7 VirtualInterface

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Specifies the resource ID.

      -

      Minimum: 36

      -

      Maximum: 36

      +

      Specifies the virtual interface ID.

      +

      Maximum: 36

      tenant_id

      +

      name

      String

      +

      String

      Specifies the ID of the project that the virtual interface peer belongs to.

      -

      Minimum: 36

      -

      Maximum: 36

      +

      Specifies the virtual interface name.

      +

      Maximum: 64

      name

      +

      admin_state_up

      String

      +

      Boolean

      Specifies the name of the virtual interface peer.

      -

      Minimum: 0

      -

      Maximum: 64

      +

      Specifies the administrative status. The value can be true or false.

      description

      +

      bandwidth

      String

      +

      Integer

      Provides supplementary information about the virtual interface peer.

      -

      Minimum: 0

      -

      Maximum: 128

      +

      Specifies the virtual interface bandwidth.

      +

      Minimum: 2

      +

      Maximum: 2147483647

      address_family

      +

      create_time

      String

      +

      String

      Specifies the address family type of the virtual interface, which can be IPv4 or IPv6.

      +

      Specifies when the virtual interface was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

      +

      Maximum: 255

      local_gateway_ip

      +

      description

      String

      +

      String

      Specifies the address of the virtual interface peer used on the cloud.

      +

      Provides supplementary information about the virtual interface.

      +

      Maximum: 128

      remote_gateway_ip

      +

      direct_connect_id

      String

      +

      String

      Specifies the address of the virtual interface peer used in the on-premises data center.

      +

      Specifies the connection ID.

      +

      Maximum: 36

      route_mode

      +

      service_type

      String

      +

      String

      Specifies the routing mode, which can be static or bgp.

      -

      Maximum: 255

      -

      Enumeration values:

      -
      • bgp
      • static
      +

      Specifies the gateway type. The value is VGW.

      bgp_asn

      +

      status

      Integer

      +

      String

      Specifies the ASN of the BGP peer.

      -

      Minimum: 1

      -

      Maximum: 4294967295

      +

      Specifies the operating status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.

      bgp_md5

      +

      tenant_id

      String

      +

      String

      Specifies the MD5 password of the BGP peer.

      +

      Specifies the project ID.

      +

      Minimum: 32

      +

      Maximum: 32

      remote_ep_group

      +

      type

      Array of strings

      +

      String

      Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

      +

      Specifies the type of the virtual interface. The value is private.

      +

      Default: private

      +

      Maximum: 255

      +

      Enumeration values: private

      service_ep_group

      +

      vgw_id

      Array of strings

      +

      String

      Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.

      +

      Specifies the virtual gateway ID.

      +

      Minimum: 36

      +

      Maximum: 36

      device_id

      +

      vlan

      String

      +

      Integer

      Specifies the ID of the device that the virtual interface peer belongs to.

      +

      Specifies the VLAN for connecting to the customer gateway. The value ranges from 0 to 3999.

      +

      Minimum: 0

      +

      Maximum: 3999

      bgp_route_limit

      +

      route_limit

      Integer

      +

      Integer

      Specifies the BGP route configuration.

      +

      Specifies the remote subnet route configurations of the virtual interface.

      +

      Minimum: 1

      +

      Maximum: 200

      +

      Default: 50

      bgp_status

      +

      enable_nqa

      String

      +

      Boolean

      Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.

      -

      Maximum: 10

      +

      Specifies whether to enable NQA (Network Quality Analysis). The value can be true or false. (This is a reserved parameter and is not supported currently.)

      status

      +

      enable_bfd

      String

      +

      Boolean

      Specifies the status of the virtual interface peer.

      +

      Specifies whether to enable BFD (Bidirectional Forwarding Detection). The value can be true or false. (This is a reserved parameter and is not supported currently.)

      vif_id

      +

      lag_id

      String

      +

      String

      Specifies the ID of the virtual interface corresponding to the virtual interface peer.

      -

      Minimum: 36

      -

      Maximum: 36

      +

      Specifies the ID of the LAG associated with the virtual interface.

      +

      Minimum: 36

      +

      Maximum: 36

      receive_route_num

      +

      device_id

      Integer

      +

      String

      Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. Note: If this parameter cannot be obtained, contact customer service to migrate your ports.

      +

      Specifies the ID of the device that the virtual interface belongs to.

      enable_nqa

      +

      enterprise_project_id

      Boolean

      +

      String

      Specifies whether to enable NQA. The value can be true or false.

      +

      Specifies the ID of the enterprise project that the virtual interface belongs to.

      +

      Minimum: 36

      +

      Maximum: 36

      enable_bfd

      +

      tags

      Boolean

      +

      Array of Tag objects

      Specifies whether to enable BFD. The value can be true or false.

      +

      Specifies the tags.

      +

      Array length: 0–10

      +

      local_gateway_v4_ip

      +

      String

      +

      Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      +

      remote_gateway_v4_ip

      +

      String

      +

      Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      +

      ies_id

      +

      String

      +

      Specifies the edge site ID. (This parameter is not supported currently.)

      +

      reason

      +

      String

      +

      Displays error information if the status of a line is Error.

      +

      rate_limit

      +

      Boolean

      +

      Specifies whether rate limiting is enabled on a virtual interface.

      +

      address_family

      +

      String

      +

      Specifies the address family of the virtual interface. The value can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      +

      local_gateway_v6_ip

      +

      String

      +

      Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      +

      remote_gateway_v6_ip

      +

      String

      +

      Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      +

      lgw_id

      +

      String

      +

      Specifies the ID of the local gateway, which is used in IES scenarios. (This parameter is not supported currently.)

      +

      gateway_id

      +

      String

      +

      Specifies the ID of the gateway associated with the virtual interface. (This is a reserved parameter and is not supported currently.)

      +

      remote_ep_group

      +

      Array of strings

      +

      Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      +

      service_ep_group

      +

      Array of strings

      +

      Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

      +

      bgp_route_limit

      +

      Integer

      +

      Specifies the BGP route configuration.

      +

      priority

      +

      String

      +

      Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing.

      +

      Default: normal

      +

      Enumeration values:

      +
      • normal
      • low
      +

      vif_peers

      +

      Array of VifPeer objects

      +

      Provides information about virtual interface peers. (This is a reserved parameter and is not supported currently.)

      +

      extend_attribute

      +

      VifExtendAttribute object

      +

      Provides extended parameter information. (This is a reserved parameter and is not supported currently.)

      -
      Table 8 VifExtendAttribute

      Parameter

      +
      - - - - - - - - - +
      Table 8 Tag

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      ha_type

      +

      key

      String

      +

      String

      Specifies the availability detection type of the virtual interface.

      -

      Enumeration values:

      -
      • nqa
      • bfd
      +
      Specifies the tag key. The key:
      • Cannot be left blank.
      • Must be unique for each resource.
      • Can contain a maximum of 36 Unicode characters.
      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
      +

      ha_mode

      +

      value

      String

      +

      String

      Specifies the availability detection mode.

      -

      Enumeration values:

      -
      • auto_single
      • auto_multi
      • static_single
      • static_multi
      • enhance_nqa
      +
      Specifies the tag value. The value:
      • Can be left blank.
      • Can contain a maximum of 43 Unicode characters.
      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
      +

      detect_multiplier

      +
      +
      + +
      + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 9 VifPeer

      Parameter

      +

      Type

      +

      Description

      +

      id

      Integer

      +

      String

      Specifies the number of detection retries.

      -

      Default: 5

      +

      Specifies the resource ID.

      +

      Minimum: 36

      +

      Maximum: 36

      min_rx_interval

      +

      tenant_id

      Integer

      +

      String

      Specifies the interval for receiving detection packets.

      -

      Default: 1000

      +

      Specifies the ID of the project that the virtual interface peer belongs to.

      +

      Minimum: 36

      +

      Maximum: 36

      min_tx_interval

      +

      name

      Integer

      +

      String

      Specifies the interval for sending detection packets.

      -

      Default: 1000

      +

      Specifies the name of the virtual interface peer.

      +

      Minimum: 0

      +

      Maximum: 64

      remote_disclaim

      +

      description

      Integer

      +

      String

      Specifies the remote identifier of the static BFD session.

      +

      Provides supplementary information about the virtual interface peer.

      +

      Minimum: 0

      +

      Maximum: 128

      local_disclaim

      +

      address_family

      Integer

      +

      String

      Specifies the local identifier of the static BFD session.

      +

      Specifies the address family of the virtual interface. The value can be IPv4 or IPv6.

      +

      local_gateway_ip

      +

      String

      +

      Specifies the gateway address of the virtual interface peer used on the cloud.

      +

      remote_gateway_ip

      +

      String

      +

      Specifies the gateway of the virtual interface peer used in the on-premises data center.

      +

      route_mode

      +

      String

      +

      Specifies the routing mode. The value can be static or bgp.

      +

      Maximum: 255

      +

      Enumeration values:

      +
      • bgp
      • static
      +

      bgp_asn

      +

      Integer

      +

      Specifies the ASN of the BGP peer.

      +

      Minimum: 1

      +

      Maximum: 4294967295

      +

      bgp_md5

      +

      String

      +

      Specifies the MD5 password of the BGP peer.

      +

      remote_ep_group

      +

      Array of strings

      +

      Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

      +

      service_ep_group

      +

      Array of strings

      +

      Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.

      +

      device_id

      +

      String

      +

      Specifies the ID of the device that the virtual interface peer belongs to.

      +

      bgp_route_limit

      +

      Integer

      +

      Specifies the BGP route configuration.

      +

      bgp_status

      +

      String

      +

      Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.

      +

      Maximum: 10

      +

      status

      +

      String

      +

      Specifies the status of the virtual interface peer.

      +

      vif_id

      +

      String

      +

      Specifies the ID of the virtual interface corresponding to the virtual interface peer.

      +

      Minimum: 36

      +

      Maximum: 36

      +

      receive_route_num

      +

      Integer

      +

      Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. If this parameter cannot be obtained, contact customer service to migrate your ports.

      +

      enable_nqa

      +

      Boolean

      +

      Specifies whether to enable NQA (Network Quality Analysis). The value can be true or false. (This is a reserved parameter and is not supported currently.)

      +

      enable_bfd

      +

      Boolean

      +

      Specifies whether to enable BFD (Bidirectional Forwarding Detection). The value can be true or false. (This is a reserved parameter and is not supported currently.)

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 10 VifExtendAttribute

      Parameter

      +

      Type

      +

      Description

      +

      ha_type

      +

      String

      +

      Specifies the availability detection type of the virtual interface.

      +

      Enumeration values:

      +
      • nqa
      • bfd
      +

      ha_mode

      +

      String

      +

      Specifies the availability detection mode.

      +

      Enumeration values:

      +
      • auto_single
      • auto_multi
      • static_single
      • static_multi
      • enhance_nqa
      +

      detect_multiplier

      +

      Integer

      +

      Specifies the number of detection retries.

      +

      Default: 5

      +

      min_rx_interval

      +

      Integer

      +

      Specifies the interval for receiving detection packets.

      +

      Default: 1000

      +

      min_tx_interval

      +

      Integer

      +

      Specifies the interval for sending detection packets.

      +

      Default: 1000

      +

      remote_disclaim

      +

      Integer

      +

      Specifies the remote identifier of the static BFD session.

      +

      local_disclaim

      +

      Integer

      +

      Specifies the local identifier of the static BFD session.

      -

      Example Requests

      Creating a private virtual interface, with the bandwidth set to 2 Mbit/s, VLAN to 332, local gateway to 1.1.1.1/30, and remote gateway to 1.1.1.2/30, and routing mode to static routing

      -
      POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces
      +

      Example Requests

      • Creating a private virtual interface, with the bandwidth set to 2 Mbit/s, VLAN to 332, local gateway to 1.1.1.1/30, and remote gateway to 1.1.1.2/30, and routing mode to static routing
        POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces
         
         {
           "virtual_interface" : {
        @@ -890,10 +954,10 @@
             "remote_ep_group" : [ "1.1.2.0/30" ]
           }
         }
        +
      -

      Example Responses

      Status code: 201

      -

      Created

      -
      {
      +

      Example Responses

      Status code: 201

      +
      Created
      {
         "virtual_interface" : {
           "id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
           "name" : "vif-0819",
      @@ -922,6 +986,7 @@
           "lgw_id" : null,
           "lag_id" : null,
           "priority" : "normal",
      +    "tags": [],
           "vif_peers" : [ {
             "id" : "c768eb52-12a8-4859-9b43-81194643040c",
             "tenant_id" : "0605768a3300d5762f82c01180692873",
      @@ -949,28 +1014,29 @@
         "request_id" : "5633df7af874576d819a481c76673236"
       }
      -

      Status Codes

      -

      Status Code

      + +

      Status Codes

      +
      - - -

      Status Code

      Description

      +

      Description

      201

      +

      201

      Created

      +

      Created

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/dc/api-ref/DeleteDirectConnect.html b/docs/dc/api-ref/DeleteDirectConnect.html index f3cd46a42..8e5cf6c9e 100644 --- a/docs/dc/api-ref/DeleteDirectConnect.html +++ b/docs/dc/api-ref/DeleteDirectConnect.html @@ -1,99 +1,99 @@

      Deleting a Connection

      -

      Function

      This API is used to delete pay-per-use connections only. To delete yearly/monthly connections, you need to first unsubscribe them.

      +

      Function

      This API is used to delete a connection.

      -

      URI

      DELETE /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}

      +

      URI

      DELETE /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - -
      Table 1 URI parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      direct_connect_id

      +

      direct_connect_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the connection ID.

      -

      Minimum: 36

      -

      Maximum: 36

      +

      Specifies the connection ID.

      +

      Minimum: 36

      +

      Maximum: 36

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the project ID.

      +

      Specifies the project ID.

      -

      Request Parameters

      -
      Table 2 Request header parameters

      Parameter

      +

      Request Parameters

      +
      - - - - - - -
      Table 2 Request header parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      -

      Minimum: 0

      -

      Maximum: 10240

      +

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      +

      Minimum: 0

      +

      Maximum: 10240

      -

      Response Parameters

      None

      +

      Response Parameters

      None

      -

      Example Requests

      Deleting a connection

      -
      DELETE https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects/6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
      +

      Example Requests

      Deleting a connection

      +
      DELETE https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects/6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
      -

      Example Responses

      None

      +

      Example Responses

      None

      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - -

      Status Code

      Description

      +

      Description

      204

      +

      204

      No Content

      +

      No Content

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/dc/api-ref/DeleteHostedDirectConnect.html b/docs/dc/api-ref/DeleteHostedDirectConnect.html index 66026e8b5..f64b813b7 100644 --- a/docs/dc/api-ref/DeleteHostedDirectConnect.html +++ b/docs/dc/api-ref/DeleteHostedDirectConnect.html @@ -1,99 +1,99 @@

      Deleting a Hosted Connection

      -

      Function

      This API is used by partners to delete hosted connections.

      +

      Function

      This API is used by partners to delete a hosted connection.

      -

      URI

      DELETE /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}

      +

      URI

      DELETE /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - -
      Table 1 URI parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the project ID.

      +

      Specifies the project ID.

      hosted_connect_id

      +

      hosted_connect_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the hosted connection ID.

      -

      Minimum: 36

      -

      Maximum: 36

      +

      Specifies the hosted connection ID.

      +

      Minimum: 36

      +

      Maximum: 36

      -

      Request Parameters

      -
      Table 2 Request header parameters

      Parameter

      +

      Request Parameters

      +
      - - - - - - -
      Table 2 Request header parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      -

      Minimum: 0

      -

      Maximum: 10240

      +

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      +

      Minimum: 0

      +

      Maximum: 10240

      -

      Response Parameters

      None

      +

      Response Parameters

      None

      -

      Example Requests

      Deleting a hosted connection

      -
      DELETE https://{dc_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/dcaas/hosted-connects/94c2b814-99dc-939a-e811-ae84c61ea3ff
      +

      Example Requests

      Deleting a hosted connection

      +
      DELETE https://{dc_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/dcaas/hosted-connects/94c2b814-99dc-939a-e811-ae84c61ea3ff
      -

      Example Responses

      None

      +

      Example Responses

      None

      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - -

      Status Code

      Description

      +

      Description

      204

      +

      204

      No Content

      +

      No Content

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/dc/api-ref/DeleteResourceTag.html b/docs/dc/api-ref/DeleteResourceTag.html new file mode 100644 index 000000000..92dc7b5a1 --- /dev/null +++ b/docs/dc/api-ref/DeleteResourceTag.html @@ -0,0 +1,93 @@ + + +

      Deleting a Resource Tag

      +

      Function

      When a tag is deleted, the tag character set is not verified. Before calling this API, perform the encodeURI operation. The server must perform decodeURI on the API URI. The tag key cannot be left blank or be an empty string. If the key of the tag to be deleted is not found, 404 will be returned.

      +
      +

      URI

      DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key}

      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 1 URI parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      key

      +

      Yes

      +

      String

      +

      Specifies the tag key.

      +

      project_id

      +

      Yes

      +

      String

      +

      Specifies the project ID.

      +

      resource_id

      +

      Yes

      +

      String

      +

      Specifies the resource ID.

      +

      resource_type

      +

      Yes

      +

      String

      +
      • Specifies the Direct Connect resource type. The value can be dc-directconnect, dc-vgw, or dc-vif.
      • dc-directconnect: Direct Connect connection
      • dc-vgw: virtual gateway
      • dc-vif: virtual interface
      +

      Enumeration values:

      +
      • dc-directconnect
      • dc-vgw
      • dc-vif
      +
      +
      +
      +

      Request Parameters

      None

      +
      +

      Response Parameters

      None

      +
      +

      Example Requests

      Deleting a resource tag

      +
      DELETE https://{dc-endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/key1
      +
      +

      Example Responses

      None

      +
      +

      Status Code

      +
      + + + + + + + +

      Status Code

      +

      Description

      +

      204

      +

      No Content

      +
      +
      +
      +

      Error Codes

      See Error Codes.

      +
      +
      +
      + +
      + diff --git a/docs/dc/api-ref/DeleteVirtualGateway.html b/docs/dc/api-ref/DeleteVirtualGateway.html index 111383927..bd616f5b7 100644 --- a/docs/dc/api-ref/DeleteVirtualGateway.html +++ b/docs/dc/api-ref/DeleteVirtualGateway.html @@ -1,97 +1,97 @@

      Deleting a Virtual Gateway

      -

      Function

      The API is used to delete a specified virtual gateway.

      +

      Function

      The API is used to delete a specific virtual gateway.

      -

      URI

      DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}

      +

      URI

      DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - -
      Table 1 URI parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the project ID.

      +

      Specifies the project ID.

      virtual_gateway_id

      +

      virtual_gateway_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the virtual gateway ID.

      +

      Specifies the virtual gateway ID.

      -

      Request Parameters

      -
      Table 2 Request header parameters

      Parameter

      +

      Request Parameters

      +
      - - - - - - -
      Table 2 Request header parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      -

      Minimum: 0

      -

      Maximum: 10240

      +

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      +

      Minimum: 0

      +

      Maximum: 10240

      -

      Response Parameters

      None

      +

      Response Parameters

      None

      -

      Example Requests

      Deleting a virtual gateway

      -
      DELETE https://{dc_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0
      +

      Example Requests

      Deleting a virtual gateway

      +
      DELETE https://{dc_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0
      -

      Example Responses

      None

      +

      Example Responses

      None

      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - -

      Status Code

      Description

      +

      Description

      204

      +

      204

      No Content

      +

      No Content

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/dc/api-ref/DeleteVirtualInterface.html b/docs/dc/api-ref/DeleteVirtualInterface.html index 26cae80e5..e9ccfad5a 100644 --- a/docs/dc/api-ref/DeleteVirtualInterface.html +++ b/docs/dc/api-ref/DeleteVirtualInterface.html @@ -1,99 +1,99 @@

      Deleting a Virtual Interface

      -

      Function

      This API is used to delete a virtual interface.

      +

      Function

      This API is used to delete a virtual interface.

      -

      URI

      DELETE /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}

      +

      URI

      DELETE /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - -
      Table 1 URI parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the project ID.

      +

      Specifies the project ID.

      virtual_interface_id

      +

      virtual_interface_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the virtual interface ID.

      -

      Minimum: 36

      -

      Maximum: 36

      +

      Specifies the virtual interface ID.

      +

      Minimum: 36

      +

      Maximum: 36

      -

      Request Parameters

      -
      Table 2 Request header parameters

      Parameter

      +

      Request Parameters

      +
      - - - - - - -
      Table 2 Request header parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      -

      Minimum: 0

      -

      Maximum: 10240

      +

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      +

      Minimum: 0

      +

      Maximum: 10240

      -

      Response Parameters

      None

      +

      Response Parameters

      None

      -

      Example Requests

      Deleting a virtual interface

      -
      DELETE https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/0d0fdf63-f2c4-491c-8866-d504796189be
      +

      Example Requests

      Deleting a virtual interface

      +
      DELETE https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/0d0fdf63-f2c4-491c-8866-d504796189be
      -

      Example Responses

      None

      +

      Example Responses

      None

      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - -

      Status Code

      Description

      +

      Description

      204

      +

      204

      No Content

      +

      No Content

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/dc/api-ref/ListDirectConnects.html b/docs/dc/api-ref/ListDirectConnects.html index 562ff03a7..d1f31faf6 100644 --- a/docs/dc/api-ref/ListDirectConnects.html +++ b/docs/dc/api-ref/ListDirectConnects.html @@ -1,630 +1,667 @@

      Querying the Connection List

      -

      Function

      This API is used to query all direct connections created by a tenant.

      +

      Function

      This API is used to query the connection list.

      -

      URI

      GET /v3/{project_id}/dcaas/direct-connects

      +

      URI

      GET /v3/{project_id}/dcaas/direct-connects

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - -
      Table 1 URI parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the project ID.

      +

      Specifies the project ID.

      -
      Table 2 Query Parameters

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 2 Query parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      limit

      +

      limit

      No

      +

      No

      Integer

      +

      Integer

      Specifies the number of records returned on each page. Value range: 1 to 2000

      -

      Minimum: 1

      -

      Maximum: 2000

      -

      Default: 2000

      +

      Specifies the number of records returned on each page. Value range: 1–2000

      +

      Minimum: 1

      +

      Maximum: 2000

      +

      Default: 2000

      marker

      +

      marker

      No

      +

      No

      String

      +

      String

      Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

      -

      Minimum: 0

      -

      Maximum: 36

      +

      Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

      +

      Minimum: 0

      +

      Maximum: 36

      fields

      +

      fields

      No

      +

      No

      Array

      +

      Array

      Specifies the list of fields to be displayed.

      -

      Array Length: 1 - 5

      +

      Specifies the list of fields to be displayed.

      +

      Array length: 1–5

      sort_key

      +

      sort_key

      No

      +

      No

      String

      +

      String

      Specifies the sorting field.

      -

      Default: id

      -

      Minimum: 0

      -

      Maximum: 36

      +

      Specifies the field for sorting.

      +

      Default: id

      +

      Minimum: 0

      +

      Maximum: 36

      sort_dir

      +

      sort_dir

      No

      +

      No

      Array

      +

      Array

      Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

      +

      Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

      hosting_id

      +

      hosting_id

      No

      +

      No

      Array

      +

      Array

      Specifies operations connection ID by which hosted connections are filtered.

      -

      Array Length: 0 - 5

      +

      Specifies operations connection ID by which hosted connections are queried.

      +

      Array length: 0–5

      enterprise_project_id

      +

      enterprise_project_id

      No

      +

      No

      Array

      +

      Array

      Filters resource instances by enterprise project ID.

      -

      Array Length: 1 - 10

      +

      Filters resource instances by enterprise project ID.

      +

      Array length: 1–10

      id

      +

      id

      No

      +

      No

      Array

      +

      Array

      Specifies the resource ID by which instances are filtered.

      -

      Array Length: 1 - 5

      +

      Specifies the resource ID by which instances are queried.

      +

      Array length: 1–5

      name

      +

      name

      No

      +

      No

      Array

      +

      Array

      Specifies the resource name by which instances are filtered. You can specify multiple names.

      -

      Array Length: 1 - 5

      +

      Specifies the resource name by which instances are queried. You can specify multiple names.

      +

      Array length: 1–5

      -

      Request Parameters

      -
      Table 3 Request header parameters

      Parameter

      +

      Request Parameters

      +
      - - - - - - -
      Table 3 Request header parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      -

      Minimum: 0

      -

      Maximum: 10240

      +

      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

      +

      Minimum: 0

      +

      Maximum: 10240

      -

      Response Parameters

      Status code: 200

      +

      Response Parameters

      Status code: 200

      -
      Table 4 Response body parameters

      Parameter

      +
      - - - - - - - - - - -
      Table 4 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      request_id

      +

      request_id

      String

      +

      String

      Specifies the request ID.

      +

      Specifies the request ID.

      direct_connects

      +

      direct_connects

      Array of DirectConnect objects

      +

      Array of DirectConnect objects

      Specifies parameters for creating a connection.

      +

      Specifies the connection list.

      page_info

      +

      page_info

      PageInfo object

      +

      PageInfo object

      Specifies the pagination query information.

      +

      Specifies the pagination query information.

      -
      Table 5 DirectConnect

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
      Table 5 DirectConnect

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Specifies the connection ID.

      +

      Specifies the connection ID.

      tenant_id

      +

      tenant_id

      String

      +

      String

      Specifies the ID of the project that the instance belongs to.

      +

      Specifies the project ID.

      name

      +

      name

      String

      +

      String

      Specifies the connection name.

      -

      Minimum: 0

      -

      Maximum: 64

      +

      Specifies the connection name.

      +

      Minimum: 0

      +

      Maximum: 64

      description

      +

      description

      String

      +

      String

      Provides supplementary information about the connection.

      -

      Minimum: 0

      -

      Maximum: 128

      +

      Provides supplementary information about the connection.

      +

      Minimum: 0

      +

      Maximum: 128

      port_type

      +

      port_type

      String

      +

      String

      Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

      -

      Enumeration values:

      -
      • 1G
      • 10G
      • 40G
      • 100G
      +

      Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

      +

      Enumeration values:

      +
      • 1G
      • 10G
      • 40G
      • 100G
      +
      NOTE:

      The port type of a hosted connection is the same as that of the operations connection that the hosted connection relies on.

      +

      bandwidth

      +

      bandwidth

      Integer

      +

      Integer

      Specifies the connection bandwidth in Mbit/s.

      -

      Minimum: 2

      -

      Maximum: 100000

      +

      Specifies the connection bandwidth, in Mbit/s.

      +

      Minimum: 2

      +

      Maximum: 100000

      location

      +

      location

      String

      +

      String

      Specifies information about the Direct Connect location.

      -

      Minimum: 0

      -

      Maximum: 255

      +

      Specifies information about the Direct Connect location.

      +

      Minimum: 0

      +

      Maximum: 255

      peer_location

      +

      peer_location

      String

      +

      String

      Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

      -

      Minimum: 0

      -

      Maximum: 255

      +

      Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

      +

      Minimum: 0

      +

      Maximum: 255

      device_id

      +

      device_id

      String

      +

      String

      Specifies the ID of the device connected to the connection.

      -

      Minimum: 0

      -

      Maximum: 36

      +

      Specifies the ID of the device connected to the connection.

      +

      Minimum: 0

      +

      Maximum: 36

      type

      +

      type

      String

      +

      String

      Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

      -

      Default: standard

      -

      Enumeration values:

      -
      • standard
      • hosting
      • hosted
      • onestop_standard
      • onestop_hosted
      +

      Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

      +

      Default: standard

      +

      Enumeration values:

      +
      • standard
      • hosting
      • hosted

      hosting_id

      +

      hosting_id

      String

      +

      String

      Specifies the ID of the operations connection on which the hosted connection is created.

      +

      Specifies the ID of the operations connection on which the hosted connection is created.

      charge_mode

      +

      charge_mode

      String

      +

      String

      Specifies the billing mode, which can be prepayment, bandwidth, or traffic.

      -

      Enumeration values:

      -
      • prepayment
      • bandwidth
      • traffic
      +

      Specifies the billing mode. The value can be prepayment, bandwidth, or traffic.

      +

      Enumeration values:

      +
      • prepayment
      • bandwidth
      • traffic

      provider

      +

      provider

      String

      +

      String

      Specifies the line carrier of a connection.

      +

      Specifies the line carrier of a connection.

      admin_state_up

      +

      admin_state_up

      Boolean

      +

      Boolean

      Specifies the administrative status, which can be true or false.

      -

      Default: true

      +

      Specifies the administrative status. The value can be true or false.

      +

      Default: true

      vlan

      +

      vlan

      Integer

      +

      Integer

      Specifies the VLAN allocated to the hosted connection.

      -

      Minimum: 0

      -

      Maximum: 3999

      +

      Specifies the VLAN allocated to the hosted connection.

      +

      Minimum: 0

      +

      Maximum: 3999

      status

      +

      status

      String

      +

      String

      Specifies the connection status. The options are as follows: ACTIVE: The connection is in the normal state. DOWN: The port for the connection is in the down state, which may cause line faults. BUILD: Operations related to the connection are being performed. ERROR: The connection configuration is incorrect. Contact customer service to rectify the fault. PENDING_DELETE: The connection is being deleted. DELETED: The connection has been deleted. APPLY: A request for a connection is submitted. DENY: A site survey is rejected because the customer fails to meet the requirements. PENDING_PAY: The order for the connection is to be paid. PAID: The order for the connection has been paid. PENDING_SURVEY: A site survey is required for the connection.

      -

      Enumeration values:

      -
      • BUILD
      • PAID
      • APPLY
      • PENDING_SURVEY
      • ACTIVE
      • DOWN
      • ERROR
      • PENDING_DELETE
      • DELETED
      • DENY
      • PENDING_PAY
      +

      Specifies the connection status.

      +
      • ACTIVE: The connection is in the normal state.
      • DOWN: The port for the connection is in the down state, which may cause line faults.
      • BUILD: Operations related to the connection are being performed.
      • ERROR: The connection configuration is incorrect. Contact customer service to rectify the fault.
      • PENDING_DELETE: The connection is being deleted.
      • DELETED: The connection has been deleted.
      • APPLY: A request for a connection is submitted.
      • DENY: A site survey is rejected because the customer fails to meet the requirements.
      • PENDING_PAY: The order for the connection is to be paid.
      • PAID: The order for the connection has been paid.
      • PENDING_SURVEY: A site survey is required for the connection.
      +

      Enumeration values:

      +
      • BUILD
      • PAID
      • APPLY
      • PENDING_SURVEY
      • ACTIVE
      • DOWN
      • ERROR
      • PENDING_DELETE
      • DELETED
      • DENY
      • PENDING_PAY

      apply_time

      +

      apply_time

      String

      +

      String

      Specifies when the connection was requested. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

      +

      Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

      create_time

      +

      create_time

      String

      +

      String

      Specifies when the connection was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

      +

      Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

      provider_status

      +

      provider_status

      String

      +

      String

      Specifies the status of the carrier's leased line. The status can be ACTIVE or DOWN.

      -

      Enumeration values:

      -
      • ACTIVE
      • DOWN
      +

      Specifies the carrier status. The status can be ACTIVE or DOWN.

      +

      Enumeration values:

      +
      • ACTIVE
      • DOWN

      peer_port_type

      +

      peer_port_type

      String

      +

      String

      Specifies the peer port type.

      +

      Specifies the peer port type.

      peer_provider

      +

      peer_provider

      String

      +

      String

      Specifies the carrier connected to the connection.

      +

      Specifies the carrier of the leased line.

      order_id

      +

      order_id

      String

      +

      String

      Specifies the connection order ID, which is used to support duration-based billing and identify user orders.

      +

      Specifies the connection order ID, which is used to support duration-based billing and identify user orders.

      product_id

      +

      product_id

      String

      +

      String

      Specifies the product ID corresponding to the connection's order, which is used to custom billing policies such as duration-based packages.

      +

      Specifies the product ID corresponding to the connection's order. The product ID is used to specify billing policies such as duration-based packages.

      spec_code

      +

      spec_code

      String

      +

      String

      Specifies the product specifications corresponding to the connection's order, which is used to custom billing policies such as duration-based packages.

      +

      Specifies the product specifications corresponding to the connection's order. The specifications are used to specify billing policies such as duration-based packages.

      period_type

      +

      period_type

      Integer

      +

      Integer

      Specifies whether a connection in a specified order is billed by year or month.

      +

      Specifies whether a connection in a specified order is billed by year or month.

      period_num

      +

      period_num

      Integer

      +

      Integer

      Specifies the required service duration of a yearly/monthly connection.

      +

      Specifies the required service duration of a yearly/monthly connection.

      vgw_type

      +

      vgw_type

      String

      +

      String

      Specifies the gateway type required by a direct connection.

      -

      Default: default

      -

      Enumeration values:

      -
      • default
      +

      Specifies the gateway type required by a connection.

      +

      Default: default

      +

      Enumeration values:

      +
      • default

      lag_id

      +

      lag_id

      String

      +

      String

      Specifies the ID of the LAG that the connection belongs to.

      +

      Specifies the ID of the LAG that the connection belongs to.

      enterprise_project_id

      +

      signed_agreement_time

      String

      +

      String

      Specifies the ID of the enterprise project that the connection belongs to.

      -

      Minimum: 36

      -

      Maximum: 36

      +

      Specifies when the Direct Connect Disclaimers were signed.

      locales

      +

      enterprise_project_id

      LocalesBody object

      +

      String

      Specifies the region of the connection. (This parameter is not supported currently.)

      +

      Specifies the ID of the enterprise project that the connection belongs to.

      +

      Minimum: 36

      +

      Maximum: 36

      support_feature

      +

      tags

      Array of strings

      +

      Array of Tag objects

      Lists the features supported by the connection. (This parameter is not supported currently.)

      +

      Specifies the tags.

      +

      Array length: 0–10

      ies_id

      +

      locales

      String

      +

      LocalesBody object

      Specifies the ID of an IES edge site. (This parameter is not supported currently.)

      +

      Specifies the region of the connection. (This parameter is not supported currently.)

      reason

      +

      support_feature

      String

      +

      Array of strings

      Displays error information if the status of a line is Error. (This parameter is not supported currently.)

      +

      Lists the features supported by the connection. (This parameter is not supported currently.)

      email

      +

      ies_id

      String

      +

      String

      Specifies the customer email information. (This parameter is not supported currently.)

      +

      Specifies the edge site ID. (This parameter is not supported currently.)

      onestop_product_id

      +

      reason

      String

      +

      String

      Specifies the product ID of a full-service connection. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

      +

      Displays error information if the status of a line is Error. (This parameter is not supported currently.)

      building_line_product_id

      +

      email

      String

      +

      String

      Specifies the product ID of the line resource used in the equipment room. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

      +

      Specifies the customer email information. (This parameter is not supported currently.)

      last_onestop_product_id

      +

      onestop_product_id

      String

      +

      String

      Specifies the product ID of a full-service connection before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

      +

      Specifies the product ID if the connection is a full-service connection. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

      last_building_line_product_id

      +

      building_line_product_id

      String

      +

      String

      Specifies the product ID of the line resource used in the equipment room before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

      +

      Specifies the product ID of the line resource used in the equipment room. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

      modified_bandwidth

      +

      last_onestop_product_id

      Integer

      +

      String

      Specifies the new bandwidth after the line bandwidth is changed. (This parameter is not supported currently.)

      +

      Specifies the product ID of a full-service connection before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

      change_mode

      +

      last_building_line_product_id

      Integer

      +

      String

      Specifies the status of a renewal change. (This parameter is not supported currently.)

      +

      Specifies the product ID of the line resource used in the equipment room before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

      onestopdc_status

      +

      modified_bandwidth

      String

      +

      Integer

      Specifies the status of a full-service connection. (This parameter is not supported currently.)

      +

      Specifies the new bandwidth after the line bandwidth is changed. (This parameter is not supported currently.)

      public_border_group

      +

      change_mode

      String

      +

      Integer

      Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

      +

      Specifies the status of a renewal change. (This parameter is not supported currently.)

      auto_renew

      +

      onestopdc_status

      Integer

      +

      String

      Specifies whether to automatically renew a yearly/monthly subscription. (This parameter is not supported currently.)

      +

      Specifies the status of a full-service connection. (This parameter is not supported currently.)

      ratio_95peak

      +

      public_border_group

      Integer

      +

      String

      Specifies the percentage of the minimum bandwidth for 95th percentile billing. (This parameter is not supported currently.)

      -

      Minimum: 0

      -

      Maximum: 100

      +

      Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

      +

      auto_renew

      +

      Integer

      +

      Specifies whether to automatically renew a yearly/monthly subscription. (This parameter is not supported currently.)

      +

      ratio_95peak

      +

      Integer

      +

      Specifies the percentage of the minimum bandwidth for 95th percentile billing. (This parameter is not supported currently.)

      +

      Minimum: 0

      +

      Maximum: 100

      -
      Table 6 LocalesBody

      Parameter

      +
      - - - - - - - -
      Table 6 Tag

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      en_us

      +

      key

      String

      +

      String

      Specifies the region name in English.

      -

      Minimum: 0

      -

      Maximum: 255

      +
      Specifies the tag key. The key:
      • Cannot be left blank.
      • Must be unique for each resource.
      • Can contain a maximum of 36 Unicode characters.
      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
      +

      zh_cn

      +

      value

      String

      +

      String

      Specifies the region name in Chinese.

      -

      Minimum: 0

      -

      Maximum: 255

      +
      Specifies the tag value. The value:
      • Can be left blank.
      • Can contain a maximum of 43 Unicode characters.
      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
      +
      -
      Table 7 PageInfo

      Parameter

      +
      - - - - - - +
      Table 7 LocalesBody

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      previous_marker

      +

      en_us

      String

      +

      String

      Specifies the marker of the previous page. The value is the resource UUID.

      -

      Minimum: 0

      -

      Maximum: 36

      +

      Specifies the region name in English.

      +

      Minimum: 0

      +

      Maximum: 255

      current_count

      +
      +
      + +
      + + + + + - - - - - + + + +
      Table 8 PageInfo

      Parameter

      +

      Type

      +

      Description

      +

      previous_marker

      Integer

      +

      String

      Specifies the number of resources in the current list.

      -

      Minimum: 0

      -

      Maximum: 2000

      +

      Specifies the marker of the previous page. The value is the resource UUID.

      +

      Minimum: 0

      +

      Maximum: 36

      next_marker

      +

      current_count

      String

      +

      Integer

      Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

      -

      Minimum: 0

      -

      Maximum: 36

      +

      Specifies the number of resources in the current list.

      +

      Minimum: 0

      +

      Maximum: 2000

      +

      next_marker

      +

      String

      +

      Specifies the marker of the next page. The value is the resource UUID. If this parameter is left empty, the resource is on the last page.

      +

      Minimum: 0

      +

      Maximum: 36

      -

      Example Requests

      Querying the connection list

      -
      GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects
      +

      Example Requests

      Querying the connection list

      +
      GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects
      -

      Example Responses

      Status code: 200

      -

      OK

      -
      • The connection list is queried.
        {
        +

        Example Responses

        Status code: 200

        +

        OK

        +
        • The connection list is queried.
          {
             "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535",
             "direct_connects" : [ {
               "bandwidth" : 100,
          @@ -638,6 +675,7 @@
               "location" : "Biere",
               "provider" : "OTC",
               "type" : "standard",
          +    "tags": [],
               "status" : "BUILD",
               "description" : "",
               "provider_status" : "ACTIVE",
          @@ -650,6 +688,10 @@
               "hosting_id" : null,
               "product_id" : "",
               "vgw_type" : "default",
          +    "locales": null,
          +    "period_type": null,
          +    "period_num": null,
          +    "lag_id": null,
               "spec_code" : "100ge",
               "charge_mode" : null,
               "support_feature" : [ ],
          @@ -670,28 +712,28 @@
           }
        -

        Status Codes

        -

        Status Code

        +

        Status Codes

        +
        - - -

        Status Code

        Description

        +

        Description

        200

        +

        200

        OK

        +

        OK

        -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/dc/api-ref/ListHostedDirectConnects.html b/docs/dc/api-ref/ListHostedDirectConnects.html index 567492913..bd02376a0 100644 --- a/docs/dc/api-ref/ListHostedDirectConnects.html +++ b/docs/dc/api-ref/ListHostedDirectConnects.html @@ -1,393 +1,393 @@

        Querying the Hosted Connection List

        -

        Function

        This API is used to query hosted connections created by partners.

        +

        Function

        This API is used to query hosted connections created by partners.

        -

        URI

        GET /v3/{project_id}/dcaas/hosted-connects

        +

        URI

        GET /v3/{project_id}/dcaas/hosted-connects

        -
        Table 1 Path Parameters

        Parameter

        +
        - - - - - - -
        Table 1 URI parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        project_id

        +

        project_id

        Yes

        +

        Yes

        String

        +

        String

        Specifies the project ID.

        +

        Specifies the project ID.

        -
        Table 2 Query Parameters

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Table 2 Query parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        limit

        +

        limit

        No

        +

        No

        Integer

        +

        Integer

        Specifies the number of records returned on each page. Value range: 1 to 2000

        -

        Minimum: 1

        -

        Maximum: 2000

        -

        Default: 2000

        +

        Specifies the number of records returned on each page. Value range: 1–2000

        +

        Minimum: 1

        +

        Maximum: 2000

        +

        Default: 2000

        marker

        +

        marker

        No

        +

        No

        String

        +

        String

        Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

        -

        Minimum: 0

        -

        Maximum: 36

        +

        Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

        +

        Minimum: 0

        +

        Maximum: 36

        fields

        +

        fields

        No

        +

        No

        Array

        +

        Array

        Specifies the list of fields to be displayed.

        -

        Array Length: 1 - 5

        +

        Specifies the list of fields to be displayed.

        +

        Array length: 1–5

        sort_dir

        +

        sort_dir

        No

        +

        No

        Array

        +

        Array

        Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

        +

        Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

        sort_key

        +

        sort_key

        No

        +

        No

        String

        +

        String

        Specifies the sorting field.

        -

        Default: id

        -

        Minimum: 0

        -

        Maximum: 36

        +

        Specifies the field for sorting.

        +

        Default: id

        +

        Minimum: 0

        +

        Maximum: 36

        hosting_id

        +

        hosting_id

        No

        +

        No

        Array

        +

        Array

        Specifies operations connection ID by which hosted connections are filtered.

        -

        Array Length: 0 - 5

        +

        Specifies operations connection ID by which hosted connections are queried.

        +

        Array length: 0–5

        id

        +

        id

        No

        +

        No

        Array

        +

        Array

        Specifies the resource ID by which instances are filtered.

        -

        Array Length: 1 - 5

        +

        Specifies the resource ID by which instances are queried.

        +

        Array length: 1–5

        name

        +

        name

        No

        +

        No

        Array

        +

        Array

        Specifies the resource name by which instances are filtered. You can specify multiple names.

        -

        Array Length: 1 - 5

        +

        Specifies the resource name by which instances are queried. You can specify multiple names.

        +

        Array length: 1–5

        -

        Request Parameters

        -
        Table 3 Request header parameters

        Parameter

        +

        Request Parameters

        +
        - - - - - - -
        Table 3 Request header parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        X-Auth-Token

        +

        X-Auth-Token

        Yes

        +

        Yes

        String

        +

        String

        Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

        -

        Minimum: 0

        -

        Maximum: 10240

        +

        Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

        +

        Minimum: 0

        +

        Maximum: 10240

        -

        Response Parameters

        Status code: 200

        +

        Response Parameters

        Status code: 200

        -
        Table 4 Response body parameters

        Parameter

        +
        - - - - - - - - - - -
        Table 4 Response body parameters

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        request_id

        +

        request_id

        String

        +

        String

        Specifies the request ID of the current operation.

        +

        Specifies the request ID of the current operation.

        hosted_connects

        +

        hosted_connects

        Array of HostedDirectConnect objects

        +

        Array of HostedDirectConnect objects

        Specifies the parameters for creating a hosted connection.

        +

        Specifies the hosted connection.

        page_info

        +

        page_info

        PageInfo object

        +

        PageInfo object

        Specifies the pagination query information.

        +

        Specifies the pagination query information.

        -
        Table 5 HostedDirectConnect

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Table 5 HostedDirectConnect

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        id

        +

        id

        String

        +

        String

        Specifies the hosted connection ID.

        -

        Minimum: 36

        -

        Maximum: 36

        +

        Specifies the hosted connection ID.

        +

        Minimum: 36

        +

        Maximum: 36

        tenant_id

        +

        tenant_id

        String

        +

        String

        Specifies the ID of the project that the instance belongs to.

        +

        Specifies the project ID.

        name

        +

        name

        String

        +

        String

        Specifies the connection name.

        -

        Minimum: 0

        -

        Maximum: 64

        +

        Specifies the connection name.

        +

        Minimum: 0

        +

        Maximum: 64

        description

        +

        description

        String

        +

        String

        Provides supplementary information about the connection.

        -

        Minimum: 0

        -

        Maximum: 128

        +

        Provides supplementary information about the connection.

        +

        Minimum: 0

        +

        Maximum: 128

        bandwidth

        +

        bandwidth

        Integer

        +

        Integer

        Specifies the connection bandwidth in Mbit/s.

        -

        Minimum: 2

        -

        Maximum: 400000

        +

        Specifies the connection bandwidth, in Mbit/s.

        +

        Minimum: 2

        +

        Maximum: 400000

        location

        +

        location

        String

        +

        String

        Specifies information about the Direct Connect location.

        -

        Minimum: 0

        -

        Maximum: 255

        +

        Specifies information about the Direct Connect location.

        +

        Minimum: 0

        +

        Maximum: 255

        peer_location

        +

        peer_location

        String

        +

        String

        Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

        -

        Minimum: 0

        -

        Maximum: 255

        +

        Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

        +

        Minimum: 0

        +

        Maximum: 255

        hosting_id

        +

        hosting_id

        String

        +

        String

        Specifies the ID of the operations connection on which the hosted connection is created.

        +

        Specifies the ID of the operations connection on which the hosted connection is created.

        provider

        +

        provider

        String

        +

        String

        Specifies the provider of the leased line.

        +

        Specifies the provider of the leased line.

        admin_state_up

        +

        admin_state_up

        Boolean

        +

        Boolean

        Specifies the administrative status, which can be true or false.

        -

        Default: true

        +

        Specifies the administrative status. The value can be true or false.

        +

        Default: true

        vlan

        +

        vlan

        Integer

        +

        Integer

        Specifies the VLAN allocated to the hosted connection.

        -

        Minimum: 0

        -

        Maximum: 3999

        +

        Specifies the VLAN allocated to the hosted connection.

        +

        Minimum: 0

        +

        Maximum: 3999

        status

        +

        status

        String

        +

        String

        Specifies the operating status of the hosted connection. The options are as follows:

        -
        • BUILD: The hosted connection has been created.
        • ACTIVE: The associated virtual gateway is normal.
        • DOWN: The port used by the hosted connection is down, indicating that there may be line faults.
        • ERROR: The associated virtual gateway is abnormal.
        • PENDING_DELETE: The hosted connection is being deleted.
        • PENDING_UPDATE: The hosted connection is being updated.
        • PENDING_CREATE: The hosted connection is being created.
        -

        Enumeration values:

        -
        • BUILD
        • ACTIVE
        • DOWN
        • ERROR
        • PENDING_DELETE
        • PENDING_UPDATE
        • PENDING_CREATE
        +

        Specifies the operating status.

        +
        • BUILD: The hosted connection has been created.
        • ACTIVE: The hosted connection is normal.
        • DOWN: The port used by the hosted connection is down, indicating that there may be line faults.
        • ERROR: The hosted connection is abnormal.
        • PENDING_DELETE: The hosted connection is being deleted.
        • PENDING_UPDATE: The hosted connection is being updated.
        • PENDING_CREATE: The hosted connection is being created.
        +

        Enumeration values:

        +
        • BUILD
        • ACTIVE
        • DOWN
        • ERROR
        • PENDING_DELETE
        • PENDING_UPDATE
        • PENDING_CREATE

        apply_time

        +

        apply_time

        String

        +

        String

        Specifies when the connection was requested. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

        +

        Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

        create_time

        +

        create_time

        String

        +

        String

        Specifies when the connection was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

        +

        Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

        provider_status

        +

        provider_status

        String

        +

        String

        Specifies the status of the carrier's leased line. The status can be ACTIVE or DOWN.

        -

        Enumeration values:

        -
        • ACTIVE
        • DOWN
        +

        Specifies the carrier status. The status can be ACTIVE or DOWN.

        +

        Enumeration values:

        +
        • ACTIVE
        • DOWN

        port_type

        +

        port_type

        String

        +

        String

        Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

        -

        Enumeration values:

        -
        • 1G
        • 10G
        • 40G
        • 100G
        +

        Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

        +

        Enumeration values:

        +
        • 1G
        • 10G
        • 40G
        • 100G
          NOTE:

          The port type of a hosted connection is the same as that of the operations connection that the hosted connection relies on.

          +
          +

        type

        +

        type

        String

        +

        String

        Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

        -

        Default: standard

        -

        Enumeration values:

        -
        • standard
        • hosting
        • hosted
        • onestop_standard
        • onestop_hosted
        +

        Specifies the type of the connection. The value is hosted.

        +

        Default: hosted

        -
        Table 6 PageInfo

        Parameter

        +
        - - - - - - - - - - -
        Table 6 PageInfo

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        previous_marker

        +

        previous_marker

        String

        +

        String

        Specifies the marker of the previous page. The value is the resource UUID.

        -

        Minimum: 0

        -

        Maximum: 36

        +

        Specifies the marker of the previous page. The value is the resource UUID.

        +

        Minimum: 0

        +

        Maximum: 36

        current_count

        +

        current_count

        Integer

        +

        Integer

        Specifies the number of resources in the current list.

        -

        Minimum: 0

        -

        Maximum: 2000

        +

        Specifies the number of resources in the current list.

        +

        Minimum: 0

        +

        Maximum: 2000

        next_marker

        +

        next_marker

        String

        +

        String

        Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

        -

        Minimum: 0

        -

        Maximum: 36

        +

        Specifies the marker of the next page. The value is the resource UUID. If this parameter is left empty, the resource is on the last page.

        +

        Minimum: 0

        +

        Maximum: 36

        -

        Example Requests

        Querying the list of hosted connections created by a partner

        -
        POST https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects
        +

        Example Requests

        Querying the hosted connection list

        +
        GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects
        -

        Example Responses

        Status code: 200

        -

        OK

        -
        • The list of hosted connections is queried.
          {
          +

          Example Responses

          Status code: 200

          +

          OK

          +
          • The hosted connection list is queried.
            {
               "request_id" : "a59a3776faa1d055f8124dc7b0977a90",
               "hosted_connects" : [ {
                 "id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6",
            @@ -411,28 +411,28 @@
             }
          -

          Status Codes

          -

          Status Code

          +

          Status Codes

          +
          - - -

          Status Code

          Description

          +

          Description

          200

          +

          200

          OK

          +

          OK

          -

          Error Codes

          See Error Codes.

          +

          Error Codes

          See Error Codes.

          diff --git a/docs/dc/api-ref/ListProjectTags.html b/docs/dc/api-ref/ListProjectTags.html new file mode 100644 index 000000000..f0a3f35ca --- /dev/null +++ b/docs/dc/api-ref/ListProjectTags.html @@ -0,0 +1,135 @@ + + +

          Querying Tags by Project

          +

          Function

          • This API is used to query all resource tags of a resource in a specified project.
          • TMS uses this API to list tags created by a tenant to ease tag creation and resource filtering.
          +
          +

          URI

          GET /v3/{project_id}/{resource_type}/tags

          + +
          + + + + + + + + + + + + + + + + +
          Table 1 URI parameters

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          project_id

          +

          Yes

          +

          String

          +

          Specifies the project ID.

          +

          resource_type

          +

          Yes

          +

          String

          +
          • Specifies the Direct Connect resource type. The value can be dc-directconnect, dc-vgw, or dc-vif.
          • dc-directconnect: Direct Connect connection
          • dc-vgw: virtual gateway
          • dc-vif: virtual interface
          +

          Enumeration values:

          +
          • dc-directconnect
          • dc-vgw
          • dc-vif
          +
          +
          +
          +

          Request Parameters

          None

          +
          +

          Response Parameters

          Status code: 200

          + +
          + + + + + + + + + + + + + +
          Table 2 Response body parameters

          Parameter

          +

          Type

          +

          Description

          +

          tags

          +

          Array of Tag objects

          +

          Specifies the tag list.

          +

          request_id

          +

          String

          +

          Specifies the request ID.

          +
          +
          + +
          + + + + + + + + + + + + + +
          Table 3 Tag

          Parameter

          +

          Type

          +

          Description

          +

          key

          +

          String

          +
          Specifies the tag key. The key:
          • Cannot be left blank.
          • Must be unique for each resource.
          • Can contain a maximum of 36 Unicode characters.
          • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
          +
          +

          value

          +

          String

          +
          Specifies the tag value. The value:
          • Can be left blank.
          • Can contain a maximum of 43 Unicode characters.
          • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
          +
          +
          +
          +
          +

          Example Requests

          GET https://{dc_endpoint}/v3/ed28c294165741faaeccab26913122a1/dc-directconnect/tags
          +
          +

          Example Responses

          Status code: 200

          +

          OK

          +
          {
          +  "tags" : [ {
          +    "key" : "department",
          +    "value" : "finance"
          +  } ]
          +}
          +
          +

          Status Code

          +
          + + + + + + + +

          Status Code

          +

          Description

          +

          200

          +

          OK

          +
          +
          +
          +

          Error Codes

          See Error Codes.

          +
          +
          +
          + +
          + diff --git a/docs/dc/api-ref/ListTagResourceInstances.html b/docs/dc/api-ref/ListTagResourceInstances.html new file mode 100644 index 000000000..5d343c5a5 --- /dev/null +++ b/docs/dc/api-ref/ListTagResourceInstances.html @@ -0,0 +1,407 @@ + + +

          Querying Resources by Tag

          +

          Function

          This API is used to query resources by tag.

          +
          +

          URI

          POST /v3/{project_id}/{resource_type}/resource-instances/action

          + +
          + + + + + + + + + + + + + + + + +
          Table 1 URI parameters

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          project_id

          +

          Yes

          +

          String

          +

          Specifies the project ID.

          +

          resource_type

          +

          Yes

          +

          String

          +
          • Specifies the Direct Connect resource type. The value can be dc-directconnect, dc-vgw, or dc-vif.
          • dc-directconnect: Direct Connect connection
          • dc-vgw: virtual gateway
          • dc-vif: virtual interface
          +

          Enumeration values:

          +
          • dc-directconnect
          • dc-vgw
          • dc-vif
          +
          +
          +
          +

          Request Parameters

          +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 2 Request body parameters

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          offset

          +

          No

          +

          String

          +

          Specifies the index position. The query starts from the next image indexed by this parameter. This parameter is not required when you query data on the first page. The value in the response returned for querying data on the previous page will be included in this parameter for querying data on subsequent pages. This parameter is not available when action is set to count. If action is set to filter, the value must be a number, and the default value is 0. The value cannot be a negative number.

          +

          limit

          +

          No

          +

          String

          +

          Number of records. This parameter is not available when action is set to count. The default value is 1000 when action is set to filter. The maximum value is 1000, and the minimum value is 1. The value cannot be a negative number.

          +

          action

          +

          Yes

          +

          String

          +

          The value can only be filter or count. The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned. Returning other fields is not allowed.

          +

          Enumeration values:

          +
          • filter
          • count
          +

          matches

          +

          No

          +

          Array of Match objects

          +

          Specifies the search criteria. The tag key is the parameter to match, for example, resource_name. The tag value indicates the value to be matched. This field is a fixed dictionary value. Determine whether fuzzy match is required based on different fields. For example, if key is resource_name, fuzzy search (case insensitive) is used by default. If value is an empty string, exact match is used. If key is resource_id, exact match is used. Only resource_name for key is supported. Other key values will be available later.

          +

          not_tags

          +

          No

          +

          Array of Tags objects

          +

          Specifies the excluded tags. Each tag contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value of a tag must also be unique. Resources not identified by different keys are in AND relationship, and values in one tag are in OR relationship. If not_tags_any is not specified, all resources will be returned.

          +

          tags

          +

          No

          +

          Array of Tags objects

          +

          A maximum of 10 keys can be queried at a time, and each key can contain a maximum of 10 values. The structure body must be included. The tag key cannot be left blank or be an empty string. Each tag key must be unique, and each tag value of a tag must also be unique. Resources identified by different keys are in AND relationship, and values in one tag are in OR relationship. If no tag filtering criteria is specified, full data is returned.

          +

          tags_any

          +

          No

          +

          Array of Tags objects

          +

          Specifies any included tags. Each tag contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value of a tag must also be unique. Resources identified by different keys are in OR relationship, and values in one tag are in OR relationship. If not_tags_any is not specified, all resources will be returned.

          +

          not_tags_any

          +

          No

          +

          Array of Tags objects

          +

          Specifies any excluded tags. Each tag contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value of a tag must also be unique. Resources not identified by different keys are in OR relationship, and values in one tag are in OR relationship. If not_tags_any is not specified, all resources will be returned.

          +

          sys_tags

          +

          No

          +

          Array of Tags objects

          +

          Only users with the op_service permission can use this parameter to filter resources. Only one tag structure is contained when this API is called by Tag Management Service (TMS). The key is _sys_enterprise_project_id, and the value is the enterprise project ID list. Currently, each key can contain only one value. 0 indicates the default enterprise project. sys_tags and tenant tag filtering conditions (without_any_tag, tags, tags_any, not_tags, and not_tags_any) cannot be used at the same time.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 3 Match

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          key

          +

          Yes

          +

          String

          +

          Specifies the tag key. The value can be dc-directconnect, dc-vgw, or dc-vif.

          +

          value

          +

          Yes

          +

          String

          +

          Specifies the tag value. It can contain a maximum of 255 Unicode characters.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 4 Tags

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          key

          +

          Yes

          +

          String

          +

          Specifies the tag key. A key can contain a maximum of 127 Unicode characters. The tag key cannot be left blank.

          +

          values

          +

          Yes

          +

          Array of strings

          +

          Lists the tag values. It can contain a maximum of 255 Unicode characters.

          +
          +
          +
          +

          Response Parameters

          Status code: 200

          + +
          + + + + + + + + + + + + + + + + + +
          Table 5 Response body parameters

          Parameter

          +

          Type

          +

          Description

          +

          resources

          +

          Array of Resource objects

          +

          Specifies the resource list.

          +

          total_count

          +

          Integer

          +

          Specifies the total number of resources.

          +

          request_id

          +

          String

          +

          Specifies the request ID.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 6 Resource

          Parameter

          +

          Type

          +

          Description

          +

          resource_detail

          +

          Object

          +

          Provides details about the resource. The value is a resource object, used for extension. resource_detail is left blank by default.

          +

          resource_id

          +

          String

          +

          Specifies the resource ID.

          +

          resource_name

          +

          String

          +

          Resource name. This parameter is an empty string by default if there is no resource name.

          +

          tags

          +

          Array of Tag objects

          +

          Specifies the list of queried tags. If no tag is matched, an empty array is returned.

          +

          sys_tags

          +

          Array of Tag objects

          +

          Specifies the list of queried tags. If no tag is matched, an empty array is returned.

          +
          +
          + +
          + + + + + + + + + + + + + +
          Table 7 Tag

          Parameter

          +

          Type

          +

          Description

          +

          key

          +

          String

          +
          Specifies the tag key. The key:
          • Cannot be left blank.
          • Must be unique for each resource.
          • Can contain a maximum of 36 Unicode characters.
          • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
          +
          +

          value

          +

          String

          +
          Specifies the tag value. The value:
          • Can be left blank.
          • Can contain a maximum of 43 Unicode characters.
          • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
          +
          +
          +
          +
          +

          Example Requests

          • Querying resources (action set to filter)
            https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource-instances/action
            +
            +{
            +  "offset" : "10",
            +  "limit" : "10",
            +  "action" : "filter",
            +  "matches" : [ {
            +    "key" : "resource_name",
            +    "value" : "resource1"
            +  } ],
            +  "not_tags" : [ {
            +    "key" : "key1",
            +    "values" : [ "*value1", "value2" ]
            +  } ],
            +  "tags" : [ {
            +    "key" : "key1",
            +    "values" : [ "*value1", "value2" ]
            +  } ],
            +  "tags_any" : [ {
            +    "key" : "key1",
            +    "values" : [ "value1", "value2" ]
            +  } ],
            +  "not_tags_any" : [ {
            +    "key" : "key1",
            +    "values" : [ "value1", "value2" ]
            +  } ]
            +}
            +
          • Querying the total number of resources (action set to count)
            https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource_instances/action
            +
            +{
            +  "action" : "count",
            +  "not_tags" : [ {
            +    "key" : "key1",
            +    "values" : [ "value1", "*value2" ]
            +  } ],
            +  "tags" : [ {
            +    "key" : "key1",
            +    "values" : [ "value1", "value2" ]
            +  }, {
            +    "key" : "key2",
            +    "values" : [ "value1", "value2" ]
            +  } ],
            +  "tags_any" : [ {
            +    "key" : "key1",
            +    "values" : [ "value1", "value2" ]
            +  } ],
            +  "not_tags_any" : [ {
            +    "key" : "key1",
            +    "values" : [ "value1", "value2" ]
            +  } ],
            +  "sys_tags" : [ {
            +    "key" : "_sys_enterprise_project_id",
            +    "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ]
            +  } ],
            +  "matches" : [ {
            +    "key" : "resource_name",
            +    "value" : "resource1"
            +  } ]
            +}
            +
          +
          +

          Example Responses

          Status code: 200

          +

          OK

          +
          {
          +  "resources" : [ ],
          +  "total_count" : 0,
          +  "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535"
          +}
          +
          +

          Status Code

          +
          + + + + + + + +

          Status Code

          +

          Description

          +

          200

          +

          OK

          +
          +
          +
          +

          Error Codes

          See Error Codes.

          +
          +
          +
          + +
          + diff --git a/docs/dc/api-ref/ListVirtualGateways.html b/docs/dc/api-ref/ListVirtualGateways.html index c7ecfab5c..1c740646f 100644 --- a/docs/dc/api-ref/ListVirtualGateways.html +++ b/docs/dc/api-ref/ListVirtualGateways.html @@ -1,378 +1,415 @@ -

          Querying Virtual Gateways

          -

          Function

          This API is used to query virtual gateways.

          +

          Querying the Virtual Gateway List

          +

          Function

          This API is used to query the virtual gateway list.

          -

          URI

          GET /v3/{project_id}/dcaas/virtual-gateways

          +

          URI

          GET /v3/{project_id}/dcaas/virtual-gateways

          -
          Table 1 Path Parameters

          Parameter

          +
          - - - - - - -
          Table 1 URI parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          project_id

          +

          project_id

          Yes

          +

          Yes

          String

          +

          String

          Specifies the project ID.

          +

          Specifies the project ID.

          -
          Table 2 Query Parameters

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 2 Query parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          limit

          +

          limit

          No

          +

          No

          Integer

          +

          Integer

          Specifies the number of records returned on each page. Value range: 1 to 2000

          -

          Minimum: 1

          -

          Maximum: 2000

          -

          Default: 2000

          +

          Specifies the number of records returned on each page. Value range: 1–2000

          +

          Minimum: 1

          +

          Maximum: 2000

          +

          Default: 2000

          marker

          +

          marker

          No

          +

          No

          String

          +

          String

          Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

          -

          Minimum: 0

          -

          Maximum: 36

          +

          Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

          +

          Minimum: 0

          +

          Maximum: 36

          fields

          +

          fields

          No

          +

          No

          Array

          +

          Array

          Specifies the list of fields to be displayed.

          -

          Array Length: 1 - 5

          +

          Specifies the list of fields to be displayed.

          +

          Array length: 1–5

          sort_dir

          +

          sort_dir

          No

          +

          No

          Array

          +

          Array

          Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

          +

          Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

          sort_key

          +

          sort_key

          No

          +

          No

          String

          +

          String

          Specifies the sorting field.

          -

          Default: id

          -

          Minimum: 0

          -

          Maximum: 36

          +

          Specifies the field for sorting.

          +

          Default: id

          +

          Minimum: 0

          +

          Maximum: 36

          id

          +

          id

          No

          +

          No

          Array

          +

          Array

          Specifies the resource ID by which instances are filtered.

          -

          Array Length: 1 - 5

          +

          Specifies the resource ID by which instances are queried.

          +

          Array length: 1–5

          enterprise_project_id

          +

          enterprise_project_id

          No

          +

          No

          Array

          +

          Array

          Filters resource instances by enterprise project ID.

          -

          Array Length: 1 - 10

          +

          Filters resource instances by enterprise project ID.

          +

          Array length: 1–10

          vpc_id

          +

          vpc_id

          No

          +

          No

          Array

          +

          Array

          Specifies the VPC ID by which virtual gateways are filtered.

          +

          Specifies the VPC ID by which virtual gateways are queried.

          -

          Request Parameters

          -
          Table 3 Request header parameters

          Parameter

          +

          Request Parameters

          +
          - - - - - - -
          Table 3 Request header parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          X-Auth-Token

          +

          X-Auth-Token

          Yes

          +

          Yes

          String

          +

          String

          Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

          -

          Minimum: 0

          -

          Maximum: 10240

          +

          Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

          +

          Minimum: 0

          +

          Maximum: 10240

          -

          Response Parameters

          Status code: 200

          +

          Response Parameters

          Status code: 200

          -
          Table 4 Response body parameters

          Parameter

          +
          - - - - - - - - - - -
          Table 4 Response body parameters

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          request_id

          +

          request_id

          String

          +

          String

          Specifies the request ID.

          +

          Specifies the request ID.

          virtual_gateways

          +

          virtual_gateways

          Array of VirtualGateway objects

          +

          Array of VirtualGateway objects

          Specifies parameters for creating a virtual gateway.

          +

          Specifies the virtual gateway list.

          page_info

          +

          page_info

          PageInfo object

          +

          PageInfo object

          Specifies the pagination query information.

          +

          Specifies the pagination query information.

          -
          Table 5 VirtualGateway

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
          Table 5 VirtualGateway

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Specifies the virtual gateway ID.

          +

          Specifies the virtual gateway ID.

          vpc_id

          +

          vpc_id

          String

          +

          String

          Specifies the ID of the VPC connected by the virtual gateway.

          +

          Specifies the ID of the VPC connected using the virtual gateway.

          enterprise_router_id

          +

          enterprise_router_id

          String

          +

          String

          Specifies the ID of the enterprise router that the virtual gateway is attached to.

          +

          Specifies the ID of the enterprise router that the virtual gateway is attached to.

          tenant_id

          +

          tenant_id

          String

          +

          String

          Specifies the ID of the project that the instance belongs to.

          -

          Minimum: 32

          -

          Maximum: 32

          +

          Specifies the project ID.

          +

          Minimum: 32

          +

          Maximum: 32

          name

          +

          name

          String

          +

          String

          Specifies the virtual gateway name.

          -

          Minimum: 0

          -

          Maximum: 64

          +

          Specifies the virtual gateway name.

          +

          Minimum: 0

          +

          Maximum: 64

          description

          +

          description

          String

          +

          String

          Provides supplementary information about the virtual gateway.

          -

          Minimum: 0

          -

          Maximum: 128

          +

          Provides supplementary information about the virtual gateway.

          +

          Minimum: 0

          +

          Maximum: 128

          type

          +

          type

          String

          +

          String

          Specifies the virtual gateway type. The value can only be default.

          -

          Default: default

          +

          Specifies the virtual gateway type. The value can only be default.

          +

          Default: default

          local_ep_group

          +

          local_ep_group

          Array of strings

          +

          Array of strings

          Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC.

          +

          Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway.

          local_ep_group_ipv6

          +

          local_ep_group_ipv6

          Array of strings

          +

          Array of strings

          Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field.

          +

          Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. This is a reserved field.

          admin_state_up

          +

          admin_state_up

          Boolean

          +

          Boolean

          Specifies the administrative status, which can be true or false.

          -

          Default: true

          +

          Specifies the administrative status. The value can be true or false.

          +

          Default: true

          status

          +

          status

          String

          +

          String

          Specifies the virtual gateway status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

          +

          Specifies the operating status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

          bgp_asn

          +

          bgp_asn

          Integer

          +

          Integer

          Specifies the local BGP ASN of the virtual gateway.

          -

          Minimum: 1

          -

          Maximum: 4294967295

          +

          Specifies the local BGP ASN of the virtual gateway.

          +

          Minimum: 1

          +

          Maximum: 4294967295

          enterprise_project_id

          +

          enterprise_project_id

          String

          +

          String

          Specifies the ID of the enterprise project that the virtual gateway belongs to.

          -

          Minimum: 36

          -

          Maximum: 36

          +

          Specifies the ID of the enterprise project that the virtual gateway belongs to.

          +

          Minimum: 36

          +

          Maximum: 36

          device_id

          +

          device_id

          String

          +

          String

          Specifies the ID of the device that the virtual interface belongs to.

          +

          Specifies the ID of the device that the virtual interface belongs to.

          redundant_device_id

          +

          redundant_device_id

          String

          +

          String

          Specifies the ID of the redundant device.

          +

          Specifies the ID of the redundant device.

          public_border_group

          +

          public_border_group

          String

          +

          String

          Specifies the public border group of the AZ, indicating whether the site is a HomeZones site.

          +

          Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

          +

          tags

          +

          Array of Tag objects

          +

          Specifies the tags.

          +

          Array length: 0–10

          -
          Table 6 PageInfo

          Parameter

          +
          - - - - - - - - - +
          Table 6 Tag

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          previous_marker

          +

          key

          String

          +

          String

          Specifies the marker of the previous page. The value is the resource UUID.

          -

          Minimum: 0

          -

          Maximum: 36

          +
          Specifies the tag key. The key:
          • Cannot be left blank.
          • Must be unique for each resource.
          • Can contain a maximum of 36 Unicode characters.
          • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
          +

          current_count

          +

          value

          Integer

          +

          String

          Specifies the number of resources in the current list.

          -

          Minimum: 0

          -

          Maximum: 2000

          +
          Specifies the tag value. The value:
          • Can be left blank.
          • Can contain a maximum of 43 Unicode characters.
          • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
          +

          next_marker

          +
          +
          + +
          + + + + + - - + + + + + + + +
          Table 7 PageInfo

          Parameter

          +

          Type

          +

          Description

          +

          previous_marker

          String

          +

          String

          Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

          -

          Minimum: 0

          -

          Maximum: 36

          +

          Specifies the marker of the previous page. The value is the resource UUID.

          +

          Minimum: 0

          +

          Maximum: 36

          +

          current_count

          +

          Integer

          +

          Specifies the number of resources in the current list.

          +

          Minimum: 0

          +

          Maximum: 2000

          +

          next_marker

          +

          String

          +

          Specifies the marker of the next page. The value is the resource UUID. If this parameter is left empty, the resource is on the last page.

          +

          Minimum: 0

          +

          Maximum: 36

          -

          Example Requests

          Querying the virtual gateway list

          -
          GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways
          +

          Example Requests

          Querying the virtual gateway list

          +
          GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways
          -

          Example Responses

          Status code: 200

          -

          OK

          -
          • The list of virtual gateways associated with VPCs is queried.
            {
            +

            Example Responses

            Status code: 200

            +

            OK

            +
            • The list of virtual gateways associated with VPCs is queried.
              {
                 "virtual_gateways" : [ {
                   "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
                   "name" : "vgw-c7b22",
                   "description" : "",
                   "tenant_id" : "0605768a3300d5762f82c01180692873",
                   "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
              +    "tags": [],
                   "device_id" : "26.151.63.100",
                   "redundant_device_id" : "26.152.128.20",
                   "type" : "default",
              @@ -385,7 +422,7 @@
                 } ],
                 "request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
               }
              -
            • The list of virtual gateways attached to enterprise routers is queried.
              {
              +
            • The list of virtual gateways attached to enterprise routers is queried.
              {
                 "virtual_gateways" : [ {
                   "name" : "vgw-er",
                   "id" : "7a91797a-cbda-42ff-9f42-73f26c993dd9",
              @@ -393,6 +430,7 @@
                   "tenant_id" : "92ea72fe26294aa180a2712c28e43c21",
                   "vpc_id" : null,
                   "enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
              +    "tags": [],
                   "device_id" : "26.151.63.100",
                   "redundant_device_id" : "26.152.128.20",
                   "type" : "default",
              @@ -407,28 +445,28 @@
               }
            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            OK

            +

            OK

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/dc/api-ref/ListVirtualInterfaces.html b/docs/dc/api-ref/ListVirtualInterfaces.html index 4ec34e2fb..29cd2971d 100644 --- a/docs/dc/api-ref/ListVirtualInterfaces.html +++ b/docs/dc/api-ref/ListVirtualInterfaces.html @@ -1,779 +1,812 @@

            Querying the Virtual Interface List

            -

            Function

            This API is used to query all virtual interfaces of a tenant.

            +

            Function

            This API is used to query the virtual interface list.

            -

            URI

            GET /v3/{project_id}/dcaas/virtual-interfaces

            +

            URI

            GET /v3/{project_id}/dcaas/virtual-interfaces

            -
            Table 1 Path Parameters

            Parameter

            +
            - - - - - - -
            Table 1 URI parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Specifies the project ID.

            +

            Specifies the project ID.

            -
            Table 2 Query Parameters

            Parameter

            +
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            Table 2 Query parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            limit

            +

            limit

            No

            +

            No

            Integer

            +

            Integer

            Specifies the number of records returned on each page. Value range: 1 to 2000

            -

            Minimum: 1

            -

            Maximum: 2000

            -

            Default: 2000

            +

            Specifies the number of records returned on each page. Value range: 1–2000

            +

            Minimum: 1

            +

            Maximum: 2000

            +

            Default: 2000

            marker

            +

            marker

            No

            +

            No

            String

            +

            String

            Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

            -

            Minimum: 0

            -

            Maximum: 36

            +

            Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

            +

            Minimum: 0

            +

            Maximum: 36

            fields

            +

            fields

            No

            +

            No

            Array

            +

            Array

            Specifies the list of fields to be displayed.

            -

            Array Length: 1 - 5

            +

            Specifies the list of fields to be displayed.

            +

            Array length: 1–5

            sort_dir

            +

            sort_dir

            No

            +

            No

            Array

            +

            Array

            Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

            +

            Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

            sort_key

            +

            sort_key

            No

            +

            No

            String

            +

            String

            Specifies the sorting field.

            -

            Default: id

            -

            Minimum: 0

            -

            Maximum: 36

            +

            Specifies the field for sorting.

            +

            Default: id

            +

            Minimum: 0

            +

            Maximum: 36

            enterprise_project_id

            +

            enterprise_project_id

            No

            +

            No

            Array

            +

            Array

            Filters resource instances by enterprise project ID.

            -

            Array Length: 1 - 10

            +

            Filters resource instances by enterprise project ID.

            +

            Array length: 1–10

            id

            +

            id

            No

            +

            No

            Array

            +

            Array

            Specifies the resource ID by which instances are filtered.

            -

            Array Length: 1 - 5

            +

            Specifies the resource ID by which instances are queried.

            +

            Array length: 1–5

            status

            +

            status

            No

            +

            No

            Array

            +

            Array

            Specifies the status by which instances are filtered.

            -

            Array Length: 1 - 5

            +

            Specifies the status by which instances are queried.

            +

            Array length: 1–5

            direct_connect_id

            +

            direct_connect_id

            No

            +

            No

            Array

            +

            Array

            Specifies the connection ID by which connections are filtered and queried.

            -

            Array Length: 1 - 5

            +

            Specifies the connection ID by which virtual interfaces are queried.

            +

            Array length: 1–5

            vgw_id

            +

            vgw_id

            No

            +

            No

            Array

            +

            Array

            Specifies the virtual gateway ID by which virtual gateways are filtered and queried.

            -

            Array Length: 1 - 5

            +

            Specifies the virtual gateway ID by which virtual interfaces are queried.

            +

            Array length: 1–5

            -

            Request Parameters

            -
            Table 3 Request header parameters

            Parameter

            +

            Request Parameters

            +
            - - - - - - -
            Table 3 Request header parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            X-Auth-Token

            +

            X-Auth-Token

            Yes

            +

            Yes

            String

            +

            String

            Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

            -

            Minimum: 0

            -

            Maximum: 10240

            +

            Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

            +

            Minimum: 0

            +

            Maximum: 10240

            -

            Response Parameters

            Status code: 200

            +

            Response Parameters

            Status code: 200

            -
            Table 4 Response body parameters

            Parameter

            +
            - - - - - - - - - - -
            Table 4 Response body parameters

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            request_id

            +

            request_id

            String

            +

            String

            Specifies the request ID.

            +

            Specifies the request ID.

            virtual_interfaces

            +

            virtual_interfaces

            Array of VirtualInterface objects

            +

            Array of VirtualInterface objects

            Specifies parameters for creating a virtual interface.

            +

            Specifies the virtual interface.

            page_info

            +

            page_info

            PageInfo object

            +

            PageInfo object

            Specifies the pagination query information.

            +

            Specifies the pagination query information.

            -
            Table 5 VirtualInterface

            Parameter

            +
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
            Table 5 VirtualInterface

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            id

            +

            id

            String

            +

            String

            Specifies the virtual interface ID.

            -

            Maximum: 36

            +

            Specifies the virtual interface ID.

            +

            Maximum: 36

            name

            +

            name

            String

            +

            String

            Specifies the virtual interface name.

            -

            Maximum: 64

            +

            Specifies the virtual interface name.

            +

            Maximum: 64

            admin_state_up

            +

            admin_state_up

            Boolean

            +

            Boolean

            Specifies the administrative status, which can be true or false.

            +

            Specifies the administrative status. The value can be true or false.

            bandwidth

            +

            bandwidth

            Integer

            +

            Integer

            Specifies the virtual interface bandwidth.

            -

            Minimum: 2

            -

            Maximum: 2147483647

            +

            Specifies the virtual interface bandwidth.

            +

            Minimum: 2

            +

            Maximum: 2147483647

            create_time

            +

            create_time

            String

            +

            String

            Specifies the time when the virtual interface was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

            -

            Maximum: 255

            +

            Specifies when the virtual interface was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

            +

            Maximum: 255

            description

            +

            description

            String

            +

            String

            Provides supplementary information about the virtual interface.

            -

            Maximum: 128

            +

            Provides supplementary information about the virtual interface.

            +

            Maximum: 128

            direct_connect_id

            +

            direct_connect_id

            String

            +

            String

            Specifies the connection ID.

            -

            Maximum: 36

            +

            Specifies the connection ID.

            +

            Maximum: 36

            service_type

            +

            service_type

            String

            +

            String

            Specifies the gateway type, which can be VGW, GDGW, or LGW.

            -

            Enumeration values:

            -
            • VGW
            • GDGW
            • LGW
            +

            Specifies the gateway type. The value is VGW.

            status

            +

            status

            String

            +

            String

            Specifies the operating status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.

            +

            Specifies the operating status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.

            tenant_id

            +

            tenant_id

            String

            +

            String

            Specifies the project ID.

            -

            Minimum: 32

            -

            Maximum: 32

            +

            Specifies the project ID.

            +

            Minimum: 32

            +

            Maximum: 32

            type

            +

            type

            String

            +

            String

            Specifies the type of the virtual interface. The value is private.

            -

            Default: private

            -

            Maximum: 255

            -

            Enumeration values:

            -
            • private
            • public
            +

            Specifies the type of the virtual interface. The value is private.

            +

            Default: private

            +

            Maximum: 255

            +

            Enumeration values: private

            vgw_id

            +

            vgw_id

            String

            +

            String

            Specifies the virtual gateway ID.

            -

            Minimum: 36

            -

            Maximum: 36

            +

            Specifies the virtual gateway ID.

            +

            Minimum: 36

            +

            Maximum: 36

            vlan

            +

            vlan

            Integer

            +

            Integer

            Specifies the VLAN for connecting to the user gateway. The value ranges from 0 to 3999.

            -

            Minimum: 0

            -

            Maximum: 3999

            +

            Specifies the VLAN for connecting to the customer gateway. The value ranges from 0 to 3999.

            +

            Minimum: 0

            +

            Maximum: 3999

            route_limit

            +

            route_limit

            Integer

            +

            Integer

            Specifies the remote subnet route configurations of the virtual interface.

            -

            Minimum: 1

            -

            Maximum: 200

            -

            Default: 50

            +

            Specifies the remote subnet route configurations of the virtual interface.

            +

            Minimum: 1

            +

            Maximum: 200

            +

            Default: 50

            enable_nqa

            +

            enable_nqa

            Boolean

            +

            Boolean

            Specifies whether to enable NQA. The value can be true or false.

            +

            Specifies whether NQA (Network Quality Analysis) is enabled. The value can be true or false. (This is a reserved parameter and is not supported currently.)

            enable_bfd

            +

            enable_bfd

            Boolean

            +

            Boolean

            Specifies whether to enable Bidirectional Forwarding Detection (BFD). The value can be true or false.

            +

            Specifies whether BFD (Bidirectional Forwarding Detection) is enabled. The value can be true or false. (This is a reserved parameter and is not supported currently.)

            lag_id

            +

            lag_id

            String

            +

            String

            Specifies the ID of the LAG associated with the virtual interface.

            -

            Minimum: 36

            -

            Maximum: 36

            +

            Specifies the ID of the LAG associated with the virtual interface.

            +

            Minimum: 36

            +

            Maximum: 36

            device_id

            +

            device_id

            String

            +

            String

            Specifies the ID of the device that the virtual interface belongs to.

            +

            Specifies the ID of the device that the virtual interface belongs to.

            enterprise_project_id

            +

            enterprise_project_id

            String

            +

            String

            Specifies the ID of the enterprise project that the virtual interface belongs to.

            -

            Minimum: 36

            -

            Maximum: 36

            +

            Specifies the ID of the enterprise project that the virtual interface belongs to.

            +

            Minimum: 36

            +

            Maximum: 36

            local_gateway_v4_ip

            +

            tags

            String

            +

            Array of Tag objects

            Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            +

            Specifies the tags.

            +

            Array length: 0–10

            remote_gateway_v4_ip

            +

            local_gateway_v4_ip

            String

            +

            String

            Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            +

            Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            ies_id

            +

            remote_gateway_v4_ip

            String

            +

            String

            Specifies the ID of an IES edge site. (This parameter is not supported currently.)

            +

            Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            reason

            +

            ies_id

            String

            +

            String

            Displays error information if the status of a line is Error.

            +

            Specifies the edge site ID. (This parameter is not supported currently.)

            rate_limit

            +

            reason

            Boolean

            +

            String

            Specifies whether rate limiting is enabled on a virtual interface.

            +

            Displays error information if the status of a line is Error.

            address_family

            +

            rate_limit

            String

            +

            Boolean

            Specifies the address family of the virtual interface, which can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            +

            Specifies whether rate limiting is enabled on a virtual interface.

            local_gateway_v6_ip

            +

            address_family

            String

            +

            String

            Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            +

            Specifies the address family of the virtual interface. The value can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            remote_gateway_v6_ip

            +

            local_gateway_v6_ip

            String

            +

            String

            Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            +

            Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            lgw_id

            +

            remote_gateway_v6_ip

            String

            +

            String

            Specifies the ID of the local gateway, which is used in IES scenarios. (This parameter is not supported currently.)

            +

            Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            gateway_id

            +

            lgw_id

            String

            +

            String

            Specifies the ID of the gateway associated with the virtual interface.

            +

            Specifies the ID of the local gateway, which is used in IES scenarios. (This parameter is not supported currently.)

            remote_ep_group

            +

            gateway_id

            Array of strings

            +

            String

            Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            +

            Specifies the ID of the gateway associated with the virtual interface. (This is a reserved parameter and is not supported currently.)

            service_ep_group

            +

            remote_ep_group

            Array of strings

            +

            Array of strings

            Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            +

            Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            bgp_route_limit

            +

            service_ep_group

            Integer

            +

            Array of strings

            Specifies the BGP route configuration.

            +

            Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

            priority

            +

            bgp_route_limit

            String

            +

            Integer

            Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing.

            -

            Default: normal

            -

            Enumeration values:

            -
            • normal
            • low
            +

            Specifies the BGP route configuration.

            vif_peers

            +

            priority

            Array of VifPeer objects

            +

            String

            Provides information about virtual interface peers. (This is a reserved parameter and is not supported currently.)

            +

            Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing.

            +

            Default: normal

            +

            Enumeration values:

            +
            • normal
            • low

            extend_attribute

            +

            vif_peers

            VifExtendAttribute object

            +

            Array of VifPeer objects

            Provides extended parameter information. (This is a reserved parameter and is not supported currently.)

            +

            Provides information about virtual interface peers. (This is a reserved parameter and is not supported currently.)

            +

            extend_attribute

            +

            VifExtendAttribute object

            +

            Provides extended parameter information. (This is a reserved parameter and is not supported currently.)

            -
            Table 6 VifPeer

            Parameter

            +
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            Table 6 Tag

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            id

            +

            key

            String

            +

            String

            Specifies the resource ID.

            -

            Minimum: 36

            -

            Maximum: 36

            +
            Specifies the tag key. The key:
            • Cannot be left blank.
            • Must be unique for each resource.
            • Can contain a maximum of 36 Unicode characters.
            • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
            +

            tenant_id

            +

            value

            String

            +

            String

            Specifies the ID of the project that the virtual interface peer belongs to.

            -

            Minimum: 36

            -

            Maximum: 36

            -

            name

            -

            String

            -

            Specifies the name of the virtual interface peer.

            -

            Minimum: 0

            -

            Maximum: 64

            -

            description

            -

            String

            -

            Provides supplementary information about the virtual interface peer.

            -

            Minimum: 0

            -

            Maximum: 128

            -

            address_family

            -

            String

            -

            Specifies the address family type of the virtual interface, which can be IPv4 or IPv6.

            -

            local_gateway_ip

            -

            String

            -

            Specifies the address of the virtual interface peer used on the cloud.

            -

            remote_gateway_ip

            -

            String

            -

            Specifies the address of the virtual interface peer used in the on-premises data center.

            -

            route_mode

            -

            String

            -

            Specifies the routing mode, which can be static or bgp.

            -

            Maximum: 255

            -

            Enumeration values:

            -
            • bgp
            • static
            -

            bgp_asn

            -

            Integer

            -

            Specifies the ASN of the BGP peer.

            -

            Minimum: 1

            -

            Maximum: 4294967295

            -

            bgp_md5

            -

            String

            -

            Specifies the MD5 password of the BGP peer.

            -

            remote_ep_group

            -

            Array of strings

            -

            Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

            -

            service_ep_group

            -

            Array of strings

            -

            Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.

            -

            device_id

            -

            String

            -

            Specifies the ID of the device that the virtual interface peer belongs to.

            -

            bgp_route_limit

            -

            Integer

            -

            Specifies the BGP route configuration.

            -

            bgp_status

            -

            String

            -

            Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.

            -

            Maximum: 10

            -

            status

            -

            String

            -

            Specifies the status of the virtual interface peer.

            -

            vif_id

            -

            String

            -

            Specifies the ID of the virtual interface corresponding to the virtual interface peer.

            -

            Minimum: 36

            -

            Maximum: 36

            -

            receive_route_num

            -

            Integer

            -

            Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. Note: If this parameter cannot be obtained, contact customer service to migrate your ports.

            -

            enable_nqa

            -

            Boolean

            -

            Specifies whether to enable NQA. The value can be true or false.

            -

            enable_bfd

            -

            Boolean

            -

            Specifies whether to enable BFD. The value can be true or false.

            +
            Specifies the tag value. The value:
            • Can be left blank.
            • Can contain a maximum of 43 Unicode characters.
            • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
            +
            -
            Table 7 VifExtendAttribute

            Parameter

            +
            - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Table 7 VifPeer

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            ha_type

            +

            id

            String

            +

            String

            Specifies the availability detection type of the virtual interface.

            -

            Enumeration values:

            -
            • nqa
            • bfd
            +

            Specifies the resource ID.

            +

            Minimum: 36

            +

            Maximum: 36

            ha_mode

            +

            tenant_id

            String

            +

            String

            Specifies the availability detection mode.

            -

            Enumeration values:

            -
            • auto_single
            • auto_multi
            • static_single
            • static_multi
            • enhance_nqa
            +

            Specifies the ID of the project that the virtual interface peer belongs to.

            +

            Minimum: 36

            +

            Maximum: 36

            detect_multiplier

            +

            name

            Integer

            +

            String

            Specifies the number of detection retries.

            -

            Default: 5

            +

            Specifies the name of the virtual interface peer.

            +

            Minimum: 0

            +

            Maximum: 64

            min_rx_interval

            +

            description

            Integer

            +

            String

            Specifies the interval for receiving detection packets.

            -

            Default: 1000

            +

            Provides supplementary information about the virtual interface peer.

            +

            Minimum: 0

            +

            Maximum: 128

            min_tx_interval

            +

            address_family

            Integer

            +

            String

            Specifies the interval for sending detection packets.

            -

            Default: 1000

            +

            Specifies the address family of the virtual interface. The value can be IPv4 or IPv6.

            remote_disclaim

            +

            local_gateway_ip

            Integer

            +

            String

            Specifies the remote identifier of the static BFD session.

            +

            Specifies the gateway address of the virtual interface peer used on the cloud.

            local_disclaim

            +

            remote_gateway_ip

            Integer

            +

            String

            Specifies the local identifier of the static BFD session.

            +

            Specifies the gateway of the virtual interface peer used in the on-premises data center.

            +

            route_mode

            +

            String

            +

            Specifies the routing mode. The value can be static or bgp.

            +

            Maximum: 255

            +

            Enumeration values:

            +
            • bgp
            • static
            +

            bgp_asn

            +

            Integer

            +

            Specifies the ASN of the BGP peer.

            +

            Minimum: 1

            +

            Maximum: 4294967295

            +

            bgp_md5

            +

            String

            +

            Specifies the MD5 password of the BGP peer.

            +

            remote_ep_group

            +

            Array of strings

            +

            Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

            +

            service_ep_group

            +

            Array of strings

            +

            Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.

            +

            device_id

            +

            String

            +

            Specifies the ID of the device that the virtual interface peer belongs to.

            +

            bgp_route_limit

            +

            Integer

            +

            Specifies the BGP route configuration.

            +

            bgp_status

            +

            String

            +

            Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.

            +

            Maximum: 10

            +

            status

            +

            String

            +

            Specifies the status of the virtual interface peer.

            +

            vif_id

            +

            String

            +

            Specifies the ID of the virtual interface corresponding to the virtual interface peer.

            +

            Minimum: 36

            +

            Maximum: 36

            +

            receive_route_num

            +

            Integer

            +

            Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. If this parameter cannot be obtained, contact customer service to migrate your ports.

            +

            enable_nqa

            +

            Boolean

            +

            Specifies whether NQA (Network Quality Analysis) is enabled. The value can be true or false. (This is a reserved parameter and is not supported currently.)

            +

            enable_bfd

            +

            Boolean

            +

            Specifies whether BFD (Bidirectional Forwarding Detection) is enabled. The value can be true or false. (This is a reserved parameter and is not supported currently.)

            -
            Table 8 PageInfo

            Parameter

            +
            - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
            Table 8 VifExtendAttribute

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            previous_marker

            +

            ha_type

            String

            +

            String

            Specifies the marker of the previous page. The value is the resource UUID.

            -

            Minimum: 0

            -

            Maximum: 36

            +

            Specifies the availability detection type of the virtual interface.

            +

            Enumeration values:

            +
            • nqa
            • bfd

            current_count

            +

            ha_mode

            Integer

            +

            String

            Specifies the number of resources in the current list.

            -

            Minimum: 0

            -

            Maximum: 2000

            +

            Specifies the availability detection mode.

            +

            Enumeration values:

            +
            • auto_single
            • auto_multi
            • static_single
            • static_multi
            • enhance_nqa

            next_marker

            +

            detect_multiplier

            String

            +

            Integer

            Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

            -

            Minimum: 0

            -

            Maximum: 36

            +

            Specifies the number of detection retries.

            +

            Default: 5

            +

            min_rx_interval

            +

            Integer

            +

            Specifies the interval for receiving detection packets.

            +

            Default: 1000

            +

            min_tx_interval

            +

            Integer

            +

            Specifies the interval for sending detection packets.

            +

            Default: 1000

            +

            remote_disclaim

            +

            Integer

            +

            Specifies the remote identifier of the static BFD session.

            +

            local_disclaim

            +

            Integer

            +

            Specifies the local identifier of the static BFD session.

            +
            +
            + +
            + + + + + + + + + + + + + + +
            Table 9 PageInfo

            Parameter

            +

            Type

            +

            Description

            +

            previous_marker

            +

            String

            +

            Specifies the marker of the previous page. The value is the resource UUID.

            +

            Minimum: 0

            +

            Maximum: 36

            +

            current_count

            +

            Integer

            +

            Specifies the number of resources in the current list.

            +

            Minimum: 0

            +

            Maximum: 2000

            +

            next_marker

            +

            String

            +

            Specifies the marker of the next page. The value is the resource UUID. If this parameter is left empty, the resource is on the last page.

            +

            Minimum: 0

            +

            Maximum: 36

            -

            Example Requests

            Querying the virtual interface list

            -
            GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces
            +

            Example Requests

            Querying the virtual interface list

            +
            GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces
            -

            Example Responses

            Status code: 200

            -

            OK

            -
            {
            +

            Example Responses

            Status code: 200

            +

            OK

            +
            {
               "virtual_interfaces" : [ {
                 "id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
                 "name" : "vif-0819",
            @@ -805,6 +838,7 @@
                 "service_ep_group" : [ ],
                 "bgp_route_limit" : 100,
                 "priority" : "normal",
            +    "tags": [],
                 "vif_peers" : [ {
                   "id" : "c768eb52-12a8-4859-9b43-81194643040c",
                   "tenant_id" : "0605768a3300d5762f82c01180692873",
            @@ -832,28 +866,28 @@
               "request_id" : "5633df7af874576d819a481c76673236"
             }
            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            OK

            +

            OK

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/dc/api-ref/ShowDirectConnect.html b/docs/dc/api-ref/ShowDirectConnect.html index e60711bee..b6dfca7f3 100644 --- a/docs/dc/api-ref/ShowDirectConnect.html +++ b/docs/dc/api-ref/ShowDirectConnect.html @@ -1,511 +1,548 @@

            Querying Details About a Connection

            -

            Function

            This API is used to query details about a connection.

            +

            Function

            This API is used to query details about a connection.

            -

            URI

            GET /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}

            +

            URI

            GET /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}

            -
            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - -
            Table 1 URI parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            direct_connect_id

            +

            direct_connect_id

            Yes

            +

            Yes

            String

            +

            String

            Specifies the connection ID.

            -

            Minimum: 36

            -

            Maximum: 36

            +

            Specifies the connection ID.

            +

            Minimum: 36

            +

            Maximum: 36

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Specifies the project ID.

            +

            Specifies the project ID.

            -
            Table 2 Query Parameters

            Parameter

            +
            - - - - - - -
            Table 2 Query parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            fields

            +

            fields

            No

            +

            No

            Array

            +

            Array

            Specifies the list of fields to be displayed.

            -

            Array Length: 1 - 5

            +

            Specifies the list of fields to be displayed.

            +

            Array length: 1–5

            -

            Request Parameters

            -
            Table 3 Request header parameters

            Parameter

            +

            Request Parameters

            +
            - - - - - - -
            Table 3 Request header parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            X-Auth-Token

            +

            X-Auth-Token

            Yes

            +

            Yes

            String

            +

            String

            Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

            -

            Minimum: 0

            -

            Maximum: 10240

            +

            Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

            +

            Minimum: 0

            +

            Maximum: 10240

            -

            Response Parameters

            Status code: 200

            +

            Response Parameters

            Status code: 200

            -
            Table 4 Response body parameters

            Parameter

            +
            - - - - - - - -
            Table 4 Response body parameters

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            request_id

            +

            request_id

            String

            +

            String

            Specifies the request ID.

            +

            Specifies the request ID.

            direct_connect

            +

            direct_connect

            DirectConnect object

            +

            DirectConnect object

            Specifies parameters for creating a connection.

            +

            Specifies the connection.

            -
            Table 5 DirectConnect

            Parameter

            +
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
            Table 5 DirectConnect

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            id

            +

            id

            String

            +

            String

            Specifies the connection ID.

            +

            Specifies the connection ID.

            tenant_id

            +

            tenant_id

            String

            +

            String

            Specifies the ID of the project that the instance belongs to.

            +

            Specifies the project ID.

            name

            +

            name

            String

            +

            String

            Specifies the connection name.

            -

            Minimum: 0

            -

            Maximum: 64

            +

            Specifies the connection name.

            +

            Minimum: 0

            +

            Maximum: 64

            description

            +

            description

            String

            +

            String

            Provides supplementary information about the connection.

            -

            Minimum: 0

            -

            Maximum: 128

            +

            Provides supplementary information about the connection.

            +

            Minimum: 0

            +

            Maximum: 128

            port_type

            +

            port_type

            String

            +

            String

            Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

            -

            Enumeration values:

            -
            • 1G
            • 10G
            • 40G
            • 100G
            +

            Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

            +

            Enumeration values:

            +
            • 1G
            • 10G
            • 40G
            • 100G
            +
            NOTE:

            The port type of a hosted connection is the same as that of the operations connection that the hosted connection relies on.

            +

            bandwidth

            +

            bandwidth

            Integer

            +

            Integer

            Specifies the connection bandwidth in Mbit/s.

            -

            Minimum: 2

            -

            Maximum: 100000

            +

            Specifies the connection bandwidth, in Mbit/s.

            +

            Minimum: 2

            +

            Maximum: 100000

            location

            +

            location

            String

            +

            String

            Specifies information about the Direct Connect location.

            -

            Minimum: 0

            -

            Maximum: 255

            +

            Specifies information about the Direct Connect location.

            +

            Minimum: 0

            +

            Maximum: 255

            peer_location

            +

            peer_location

            String

            +

            String

            Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

            -

            Minimum: 0

            -

            Maximum: 255

            +

            Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

            +

            Minimum: 0

            +

            Maximum: 255

            device_id

            +

            device_id

            String

            +

            String

            Specifies the ID of the device connected to the connection.

            -

            Minimum: 0

            -

            Maximum: 36

            +

            Specifies the ID of the device connected to the connection.

            +

            Minimum: 0

            +

            Maximum: 36

            type

            +

            type

            String

            +

            String

            Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

            -

            Default: standard

            -

            Enumeration values:

            -
            • standard
            • hosting
            • hosted
            • onestop_standard
            • onestop_hosted
            +

            Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

            +

            Default: standard

            +

            Enumeration values:

            +
            • standard
            • hosting
            • hosted

            hosting_id

            +

            hosting_id

            String

            +

            String

            Specifies the ID of the operations connection on which the hosted connection is created.

            +

            Specifies the ID of the operations connection on which the hosted connection is created.

            charge_mode

            +

            charge_mode

            String

            +

            String

            Specifies the billing mode, which can be prepayment, bandwidth, or traffic.

            -

            Enumeration values:

            -
            • prepayment
            • bandwidth
            • traffic
            +

            Specifies the billing mode. The value can be prepayment, bandwidth, or traffic.

            +

            Enumeration values:

            +
            • prepayment
            • bandwidth
            • traffic

            provider

            +

            provider

            String

            +

            String

            Specifies the line carrier of a connection.

            +

            Specifies the line carrier of a connection.

            admin_state_up

            +

            admin_state_up

            Boolean

            +

            Boolean

            Specifies the administrative status, which can be true or false.

            -

            Default: true

            +

            Specifies the administrative status. The value can be true or false.

            +

            Default: true

            vlan

            +

            vlan

            Integer

            +

            Integer

            Specifies the VLAN allocated to the hosted connection.

            -

            Minimum: 0

            -

            Maximum: 3999

            +

            Specifies the VLAN allocated to the hosted connection.

            +

            Minimum: 0

            +

            Maximum: 3999

            status

            +

            status

            String

            +

            String

            Specifies the connection status. The options are as follows: ACTIVE: The connection is in the normal state. DOWN: The port for the connection is in the down state, which may cause line faults. BUILD: Operations related to the connection are being performed. ERROR: The connection configuration is incorrect. Contact customer service to rectify the fault. PENDING_DELETE: The connection is being deleted. DELETED: The connection has been deleted. APPLY: A request for a connection is submitted. DENY: A site survey is rejected because the customer fails to meet the requirements. PENDING_PAY: The order for the connection is to be paid. PAID: The order for the connection has been paid. PENDING_SURVEY: A site survey is required for the connection.

            -

            Enumeration values:

            -
            • BUILD
            • PAID
            • APPLY
            • PENDING_SURVEY
            • ACTIVE
            • DOWN
            • ERROR
            • PENDING_DELETE
            • DELETED
            • DENY
            • PENDING_PAY
            +

            Specifies the connection status.

            +
            • ACTIVE: The connection is in the normal state.
            • DOWN: The port for the connection is in the down state, which may cause line faults.
            • BUILD: Operations related to the connection are being performed.
            • ERROR: The connection configuration is incorrect. Contact customer service to rectify the fault.
            • PENDING_DELETE: The connection is being deleted.
            • DELETED: The connection has been deleted.
            • APPLY: A request for a connection is submitted.
            • DENY: A site survey is rejected because the customer fails to meet the requirements.
            • PENDING_PAY: The order for the connection is to be paid.
            • PAID: The order for the connection has been paid.
            • PENDING_SURVEY: A site survey is required for the connection.
            +

            Enumeration values:

            +
            • BUILD
            • PAID
            • APPLY
            • PENDING_SURVEY
            • ACTIVE
            • DOWN
            • ERROR
            • PENDING_DELETE
            • DELETED
            • DENY
            • PENDING_PAY

            apply_time

            +

            apply_time

            String

            +

            String

            Specifies when the connection was requested. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

            +

            Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

            create_time

            +

            create_time

            String

            +

            String

            Specifies when the connection was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

            +

            Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

            provider_status

            +

            provider_status

            String

            +

            String

            Specifies the status of the carrier's leased line. The status can be ACTIVE or DOWN.

            -

            Enumeration values:

            -
            • ACTIVE
            • DOWN
            +

            Specifies the carrier status. The status can be ACTIVE or DOWN.

            +

            Enumeration values:

            +
            • ACTIVE
            • DOWN

            peer_port_type

            +

            peer_port_type

            String

            +

            String

            Specifies the peer port type.

            +

            Specifies the peer port type.

            peer_provider

            +

            peer_provider

            String

            +

            String

            Specifies the carrier connected to the connection.

            +

            Specifies the carrier of the leased line.

            order_id

            +

            order_id

            String

            +

            String

            Specifies the connection order ID, which is used to support duration-based billing and identify user orders.

            +

            Specifies the connection order ID, which is used to support duration-based billing and identify user orders.

            product_id

            +

            product_id

            String

            +

            String

            Specifies the product ID corresponding to the connection's order, which is used to custom billing policies such as duration-based packages.

            +

            Specifies the product ID corresponding to the connection's order. The product ID is used to specify billing policies such as duration-based packages.

            spec_code

            +

            spec_code

            String

            +

            String

            Specifies the product specifications corresponding to the connection's order, which is used to custom billing policies such as duration-based packages.

            +

            Specifies the product specifications corresponding to the connection's order. The specifications are used to specify billing policies such as duration-based packages.

            period_type

            +

            period_type

            Integer

            +

            Integer

            Specifies whether a connection in a specified order is billed by year or month.

            +

            Specifies whether a connection in a specified order is billed by year or month.

            period_num

            +

            period_num

            Integer

            +

            Integer

            Specifies the required service duration of a yearly/monthly connection.

            +

            Specifies the required service duration of a yearly/monthly connection.

            vgw_type

            +

            vgw_type

            String

            +

            String

            Specifies the gateway type required by a direct connection.

            -

            Default: default

            -

            Enumeration values:

            -
            • default
            +

            Specifies the gateway type required by a connection.

            +

            Default: default

            +

            Enumeration values:

            +
            • default

            lag_id

            +

            lag_id

            String

            +

            String

            Specifies the ID of the LAG that the connection belongs to.

            +

            Specifies the ID of the LAG that the connection belongs to.

            enterprise_project_id

            +

            signed_agreement_time

            String

            +

            String

            Specifies the ID of the enterprise project that the connection belongs to.

            -

            Minimum: 36

            -

            Maximum: 36

            +

            Specifies when the Direct Connect Disclaimers were signed.

            locales

            +

            enterprise_project_id

            LocalesBody object

            +

            String

            Specifies the region of the connection. (This parameter is not supported currently.)

            +

            Specifies the ID of the enterprise project that the connection belongs to.

            +

            Minimum: 36

            +

            Maximum: 36

            support_feature

            +

            tags

            Array of strings

            +

            Array of Tag objects

            Lists the features supported by the connection. (This parameter is not supported currently.)

            +

            Specifies the tags.

            +

            Array length: 0–10

            ies_id

            +

            locales

            String

            +

            LocalesBody object

            Specifies the ID of an IES edge site. (This parameter is not supported currently.)

            +

            Specifies the region of the connection. (This parameter is not supported currently.)

            reason

            +

            support_feature

            String

            +

            Array of strings

            Displays error information if the status of a line is Error. (This parameter is not supported currently.)

            +

            Lists the features supported by the connection. (This parameter is not supported currently.)

            email

            +

            ies_id

            String

            +

            String

            Specifies the customer email information. (This parameter is not supported currently.)

            +

            Specifies the edge site ID. (This parameter is not supported currently.)

            onestop_product_id

            +

            reason

            String

            +

            String

            Specifies the product ID of a full-service connection. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

            +

            Displays error information if the status of a line is Error. (This parameter is not supported currently.)

            building_line_product_id

            +

            email

            String

            +

            String

            Specifies the product ID of the line resource used in the equipment room. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

            +

            Specifies the customer email information. (This parameter is not supported currently.)

            last_onestop_product_id

            +

            onestop_product_id

            String

            +

            String

            Specifies the product ID of a full-service connection before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

            +

            Specifies the product ID if the connection is a full-service connection. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

            last_building_line_product_id

            +

            building_line_product_id

            String

            +

            String

            Specifies the product ID of the line resource used in the equipment room before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

            +

            Specifies the product ID of the line resource used in the equipment room. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

            modified_bandwidth

            +

            last_onestop_product_id

            Integer

            +

            String

            Specifies the new bandwidth after the line bandwidth is changed. (This parameter is not supported currently.)

            +

            Specifies the product ID of a full-service connection before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

            change_mode

            +

            last_building_line_product_id

            Integer

            +

            String

            Specifies the status of a renewal change. (This parameter is not supported currently.)

            +

            Specifies the product ID of the line resource used in the equipment room before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

            onestopdc_status

            +

            modified_bandwidth

            String

            +

            Integer

            Specifies the status of a full-service connection. (This parameter is not supported currently.)

            +

            Specifies the new bandwidth after the line bandwidth is changed. (This parameter is not supported currently.)

            public_border_group

            +

            change_mode

            String

            +

            Integer

            Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

            +

            Specifies the status of a renewal change. (This parameter is not supported currently.)

            auto_renew

            +

            onestopdc_status

            Integer

            +

            String

            Specifies whether to automatically renew a yearly/monthly subscription. (This parameter is not supported currently.)

            +

            Specifies the status of a full-service connection. (This parameter is not supported currently.)

            ratio_95peak

            +

            public_border_group

            Integer

            +

            String

            Specifies the percentage of the minimum bandwidth for 95th percentile billing. (This parameter is not supported currently.)

            -

            Minimum: 0

            -

            Maximum: 100

            +

            Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

            +

            auto_renew

            +

            Integer

            +

            Specifies whether to automatically renew a yearly/monthly subscription. (This parameter is not supported currently.)

            +

            ratio_95peak

            +

            Integer

            +

            Specifies the percentage of the minimum bandwidth for 95th percentile billing. (This parameter is not supported currently.)

            +

            Minimum: 0

            +

            Maximum: 100

            -
            Table 6 LocalesBody

            Parameter

            +
            - - - - - - - - + + +
            Table 6 Tag

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            en_us

            +

            key

            String

            +

            String

            Specifies the region name in English.

            -

            Minimum: 0

            -

            Maximum: 255

            +
            Specifies the tag key. The key:
            • Cannot be left blank.
            • Must be unique for each resource.
            • Can contain a maximum of 36 Unicode characters.
            • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
            +

            zh_cn

            +

            value

            String

            +

            String

            Specifies the region name in Chinese.

            -

            Minimum: 0

            -

            Maximum: 255

            +
            Specifies the tag value. The value:
            • Can be left blank.
            • Can contain a maximum of 43 Unicode characters.
            • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
            +
            +
            +
            + +
            + + + + + + +
            Table 7 LocalesBody

            Parameter

            +

            Type

            +

            Description

            +

            en_us

            +

            String

            +

            Specifies the region name in English.

            +

            Minimum: 0

            +

            Maximum: 255

            -

            Example Requests

            Querying details about a connection

            -
            GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects/6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
            +

            Example Requests

            Querying a connection

            +
            GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects/6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
            -

            Example Responses

            Status code: 200

            -

            OK

            -
            • The details of the connection are queried.
              {
              +

              Example Responses

              Status code: 200

              +

              OK

              +
              • The details of the connection are queried.
                {
                   "direct_connect" : {
                     "bandwidth" : 100,
                     "create_time" : "2018-10-19T09:53:26.000Z",
                @@ -530,7 +567,12 @@
                     "hosting_id" : null,
                     "product_id" : "",
                     "vgw_type" : "default",
                +    "locales": null,
                +    "period_type": null,
                +    "period_num": null,
                +    "lag_id": null,
                     "spec_code" : "100ge",
                +    "tags": [],
                     "charge_mode" : null,
                     "support_feature" : [ ],
                     "ies_id" : null,
                @@ -550,28 +592,28 @@
                 }
              -

              Status Codes

              -

              Status Code

              +

              Status Codes

              +
              - - -

              Status Code

              Description

              +

              Description

              200

              +

              200

              OK

              +

              OK

              -

              Error Codes

              See Error Codes.

              +

              Error Codes

              See Error Codes.

              diff --git a/docs/dc/api-ref/ShowHostedDirectConnect.html b/docs/dc/api-ref/ShowHostedDirectConnect.html index 72d962c8c..7f8ee0bfd 100644 --- a/docs/dc/api-ref/ShowHostedDirectConnect.html +++ b/docs/dc/api-ref/ShowHostedDirectConnect.html @@ -1,338 +1,338 @@

              Querying Details About a Hosted Connection

              -

              Function

              This API is used to query a hosted connection of a partner.

              +

              Function

              This API is used by partners to query a hosted connection.

              -

              URI

              GET /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}

              +

              URI

              GET /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}

              -
              Table 1 Path Parameters

              Parameter

              +
              - - - - - - - - - - -
              Table 1 URI parameters

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              project_id

              +

              project_id

              Yes

              +

              Yes

              String

              +

              String

              Specifies the project ID.

              +

              Specifies the project ID.

              hosted_connect_id

              +

              hosted_connect_id

              Yes

              +

              Yes

              String

              +

              String

              Specifies the hosted connection ID.

              -

              Minimum: 36

              -

              Maximum: 36

              +

              Specifies the hosted connection ID.

              +

              Minimum: 36

              +

              Maximum: 36

              -
              Table 2 Query Parameters

              Parameter

              +
              - - - - - - - - - - - - - - - - - - - - - - - - - - -
              Table 2 Query parameters

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              limit

              +

              limit

              No

              +

              No

              Integer

              +

              Integer

              Specifies the number of records returned on each page. Value range: 1 to 2000

              -

              Minimum: 1

              -

              Maximum: 2000

              -

              Default: 2000

              +

              Specifies the number of records returned on each page. Value range: 1–2000

              +

              Minimum: 1

              +

              Maximum: 2000

              +

              Default: 2000

              marker

              +

              marker

              No

              +

              No

              String

              +

              String

              Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

              -

              Minimum: 0

              -

              Maximum: 36

              +

              Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

              +

              Minimum: 0

              +

              Maximum: 36

              fields

              +

              fields

              No

              +

              No

              Array

              +

              Array

              Specifies the list of fields to be displayed.

              -

              Array Length: 1 - 5

              +

              Specifies the list of fields to be displayed.

              +

              Array length: 1–5

              sort_dir

              +

              sort_dir

              No

              +

              No

              Array

              +

              Array

              Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

              +

              Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

              sort_key

              +

              sort_key

              No

              +

              No

              String

              +

              String

              Specifies the sorting field.

              -

              Default: id

              -

              Minimum: 0

              -

              Maximum: 36

              +

              Specifies the field for sorting.

              +

              Default: id

              +

              Minimum: 0

              +

              Maximum: 36

              hosting_id

              +

              hosting_id

              No

              +

              No

              Array

              +

              Array

              Specifies operations connection ID by which hosted connections are filtered.

              -

              Array Length: 0 - 5

              +

              Specifies operations connection ID by which hosted connections are queried.

              +

              Array length: 0–5

              -

              Request Parameters

              -
              Table 3 Request header parameters

              Parameter

              +

              Request Parameters

              +
              - - - - - - -
              Table 3 Request header parameters

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              X-Auth-Token

              +

              X-Auth-Token

              Yes

              +

              Yes

              String

              +

              String

              Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

              -

              Minimum: 0

              -

              Maximum: 10240

              +

              Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

              +

              Minimum: 0

              +

              Maximum: 10240

              -

              Response Parameters

              Status code: 200

              +

              Response Parameters

              Status code: 200

              -
              Table 4 Response body parameters

              Parameter

              +
              - - - - - - - -
              Table 4 Response body parameters

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              request_id

              +

              request_id

              String

              +

              String

              Specifies the request ID.

              +

              Specifies the request ID.

              hosted_connect

              +

              hosted_connect

              HostedDirectConnect object

              +

              HostedDirectConnect object

              Specifies the parameters for creating a hosted connection.

              +

              Specifies the hosted connection.

              -
              Table 5 HostedDirectConnect

              Parameter

              +
              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              Table 5 HostedDirectConnect

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              id

              +

              id

              String

              +

              String

              Specifies the hosted connection ID.

              -

              Minimum: 36

              -

              Maximum: 36

              +

              Specifies the hosted connection ID.

              +

              Minimum: 36

              +

              Maximum: 36

              tenant_id

              +

              tenant_id

              String

              +

              String

              Specifies the ID of the project that the instance belongs to.

              +

              Specifies the project ID.

              name

              +

              name

              String

              +

              String

              Specifies the connection name.

              -

              Minimum: 0

              -

              Maximum: 64

              +

              Specifies the connection name.

              +

              Minimum: 0

              +

              Maximum: 64

              description

              +

              description

              String

              +

              String

              Provides supplementary information about the connection.

              -

              Minimum: 0

              -

              Maximum: 128

              +

              Provides supplementary information about the connection.

              +

              Minimum: 0

              +

              Maximum: 128

              bandwidth

              +

              bandwidth

              Integer

              +

              Integer

              Specifies the connection bandwidth in Mbit/s.

              -

              Minimum: 2

              -

              Maximum: 400000

              +

              Specifies the connection bandwidth, in Mbit/s.

              +

              Minimum: 2

              +

              Maximum: 400000

              location

              +

              location

              String

              +

              String

              Specifies information about the Direct Connect location.

              -

              Minimum: 0

              -

              Maximum: 255

              +

              Specifies information about the Direct Connect location.

              +

              Minimum: 0

              +

              Maximum: 255

              peer_location

              +

              peer_location

              String

              +

              String

              Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

              -

              Minimum: 0

              -

              Maximum: 255

              +

              Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

              +

              Minimum: 0

              +

              Maximum: 255

              hosting_id

              +

              hosting_id

              String

              +

              String

              Specifies the ID of the operations connection on which the hosted connection is created.

              +

              Specifies the ID of the operations connection on which the hosted connection is created.

              provider

              +

              provider

              String

              +

              String

              Specifies the provider of the leased line.

              +

              Specifies the provider of the leased line.

              admin_state_up

              +

              admin_state_up

              Boolean

              +

              Boolean

              Specifies the administrative status, which can be true or false.

              -

              Default: true

              +

              Specifies the administrative status. The value can be true or false.

              +

              Default: true

              vlan

              +

              vlan

              Integer

              +

              Integer

              Specifies the VLAN allocated to the hosted connection.

              -

              Minimum: 0

              -

              Maximum: 3999

              +

              Specifies the VLAN allocated to the hosted connection.

              +

              Minimum: 0

              +

              Maximum: 3999

              status

              +

              status

              String

              +

              String

              Specifies the operating status of the hosted connection. The options are as follows:

              -
              • BUILD: The hosted connection has been created.
              • ACTIVE: The associated virtual gateway is normal.
              • DOWN: The port used by the hosted connection is down, indicating that there may be line faults.
              • ERROR: The associated virtual gateway is abnormal.
              • PENDING_DELETE: The hosted connection is being deleted.
              • PENDING_UPDATE: The hosted connection is being updated.
              • PENDING_CREATE: The hosted connection is being created.
              -

              Enumeration values:

              -
              • BUILD
              • ACTIVE
              • DOWN
              • ERROR
              • PENDING_DELETE
              • PENDING_UPDATE
              • PENDING_CREATE
              +

              Specifies the operating status.

              +
              • BUILD: The hosted connection has been created.
              • ACTIVE: The hosted connection is normal.
              • DOWN: The port used by the hosted connection is down, indicating that there may be line faults.
              • ERROR: The hosted connection is abnormal.
              • PENDING_DELETE: The hosted connection is being deleted.
              • PENDING_UPDATE: The hosted connection is being updated.
              • PENDING_CREATE: The hosted connection is being created.
              +

              Enumeration values:

              +
              • BUILD
              • ACTIVE
              • DOWN
              • ERROR
              • PENDING_DELETE
              • PENDING_UPDATE
              • PENDING_CREATE

              apply_time

              +

              apply_time

              String

              +

              String

              Specifies when the connection was requested. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

              +

              Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

              create_time

              +

              create_time

              String

              +

              String

              Specifies when the connection was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

              +

              Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

              provider_status

              +

              provider_status

              String

              +

              String

              Specifies the status of the carrier's leased line. The status can be ACTIVE or DOWN.

              -

              Enumeration values:

              -
              • ACTIVE
              • DOWN
              +

              Specifies the carrier status. The status can be ACTIVE or DOWN.

              +

              Enumeration values:

              +
              • ACTIVE
              • DOWN

              port_type

              +

              port_type

              String

              +

              String

              Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

              -

              Enumeration values:

              -
              • 1G
              • 10G
              • 40G
              • 100G
              +

              Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

              +

              Enumeration values:

              +
              • 1G
              • 10G
              • 40G
              • 100G
                NOTE:

                The port type of a hosted connection is the same as that of the operations connection that the hosted connection relies on.

                +
                +

              type

              +

              type

              String

              +

              String

              Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

              -

              Default: standard

              -

              Enumeration values:

              -
              • standard
              • hosting
              • hosted
              • onestop_standard
              • onestop_hosted
              +

              Specifies the type of the connection. The value is hosted.

              +

              Default: hosted

              -

              Example Requests

              Querying details about a hosted connection created by a partner

              -
              GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects/0278b472-ffa5-4eb3-8c0d-979d479f8ef6
              +

              Example Requests

              Querying details about a hosted connection created by a partner

              +
              GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects/0278b472-ffa5-4eb3-8c0d-979d479f8ef6
              -

              Example Responses

              Status code: 200

              -

              OK

              -
              • The details of the hosted connection are queried.
                {
                +

                Example Responses

                Status code: 200

                +

                OK

                +
                • The details of the hosted connection are queried.
                  {
                     "hosted_connect" : {
                       "id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6",
                       "name" : "client-dc-faf1",
                  @@ -356,28 +356,28 @@
                   }
                -

                Status Codes

                -

                Status Code

                +

                Status Codes

                +
                - - -

                Status Code

                Description

                +

                Description

                200

                +

                200

                OK

                +

                OK

                -

                Error Codes

                See Error Codes.

                +

                Error Codes

                See Error Codes.

                diff --git a/docs/dc/api-ref/ShowResourceTag.html b/docs/dc/api-ref/ShowResourceTag.html new file mode 100644 index 000000000..f34b32cbe --- /dev/null +++ b/docs/dc/api-ref/ShowResourceTag.html @@ -0,0 +1,159 @@ + + +

                Querying Tags of a Resource

                +

                Function

                This API is used to query the tags of a resource.

                +
                +

                URI

                GET /v3/{project_id}/{resource_type}/{resource_id}/tags

                + +
                + + + + + + + + + + + + + + + + + + + + + +
                Table 1 URI parameters

                Parameter

                +

                Mandatory

                +

                Type

                +

                Description

                +

                project_id

                +

                Yes

                +

                String

                +

                Specifies the project ID.

                +

                resource_type

                +

                Yes

                +

                String

                +
                • Specifies the Direct Connect resource type. The value can be dc-directconnect, dc-vgw, or dc-vif.
                • dc-directconnect: Direct Connect connection
                • dc-vgw: virtual gateway
                • dc-vif: virtual interface
                +

                Enumeration values:

                +
                • dc-directconnect
                • dc-vgw
                • dc-vif
                +

                resource_id

                +

                Yes

                +

                String

                +

                Specifies the resource ID.

                +
                +
                +
                +

                Request Parameters

                None

                +
                +

                Response Parameters

                Status code: 200

                + +
                + + + + + + + + + + + + + + + + + +
                Table 2 Response body parameters

                Parameter

                +

                Type

                +

                Description

                +

                tags

                +

                Array of Tag objects

                +

                Specifies the tag list.

                +

                sys_tags

                +

                Array of Tag objects

                +

                Specifies the list of queried tags. If no tag is matched, an empty array is returned.

                +

                request_id

                +

                String

                +

                Specifies the request ID.

                +
                +
                + +
                + + + + + + + + + + + + + +
                Table 3 Tag

                Parameter

                +

                Type

                +

                Description

                +

                key

                +

                String

                +
                Specifies the tag key. The key:
                • Cannot be left blank.
                • Must be unique for each resource.
                • Can contain a maximum of 36 Unicode characters.
                • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                +
                +

                value

                +

                String

                +
                Specifies the tag value. The value:
                • Can be left blank.
                • Can contain a maximum of 43 Unicode characters.
                • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                +
                +
                +
                +
                +

                Example Requests

                Querying tags of a resource

                +
                https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource-instances/action
                +
                +

                Example Responses

                Status code: 200

                +

                OK

                +
                {
                +  "request_id" : "80ef5f21-b81a-4546-b23d-84272507d330",
                +  "tags" : [ {
                +    "key" : "key2",
                +    "value" : "value2"
                +  }, {
                +    "key" : "key1",
                +    "value" : "value1"
                +  }, {
                +    "key" : "key3",
                +    "value" : "value3"
                +  } ]
                +}
                +
                +

                Status Code

                +
                + + + + + + + +

                Status Code

                +

                Description

                +

                200

                +

                OK

                +
                +
                +
                +

                Error Codes

                See Error Codes.

                +
                +
                +
                + +
                + diff --git a/docs/dc/api-ref/ShowVirtualGateway.html b/docs/dc/api-ref/ShowVirtualGateway.html index f960e3a9b..8f9ae11ab 100644 --- a/docs/dc/api-ref/ShowVirtualGateway.html +++ b/docs/dc/api-ref/ShowVirtualGateway.html @@ -1,268 +1,305 @@

                Querying Details About a Virtual Gateway

                -

                Function

                This API is used to query details about a specified virtual gateway.

                +

                Function

                This API is used to query details about a specific virtual gateway.

                -

                URI

                GET /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}

                +

                URI

                GET /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}

                -
                Table 1 Path Parameters

                Parameter

                +
                - - - - - - - - - - -
                Table 1 URI parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                project_id

                +

                project_id

                Yes

                +

                Yes

                String

                +

                String

                Specifies the project ID.

                +

                Specifies the project ID.

                virtual_gateway_id

                +

                virtual_gateway_id

                Yes

                +

                Yes

                String

                +

                String

                Specifies the virtual gateway ID.

                +

                Specifies the virtual gateway ID.

                -
                Table 2 Query Parameters

                Parameter

                +
                - - - - - - -
                Table 2 Query parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                fields

                +

                fields

                No

                +

                No

                Array

                +

                Array

                Specifies the list of fields to be displayed.

                -

                Array Length: 1 - 5

                +

                Specifies the list of fields to be displayed.

                +

                Array length: 1–5

                -

                Request Parameters

                -
                Table 3 Request header parameters

                Parameter

                +

                Request Parameters

                +
                - - - - - - -
                Table 3 Request header parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                X-Auth-Token

                +

                X-Auth-Token

                Yes

                +

                Yes

                String

                +

                String

                Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                -

                Minimum: 0

                -

                Maximum: 10240

                +

                Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                +

                Minimum: 0

                +

                Maximum: 10240

                -

                Response Parameters

                Status code: 200

                +

                Response Parameters

                Status code: 200

                -
                Table 4 Response body parameters

                Parameter

                +
                - - - - - - - -
                Table 4 Response body parameters

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                virtual_gateway

                +

                virtual_gateway

                VirtualGateway object

                +

                VirtualGateway object

                Specifies parameters for creating a virtual gateway.

                +

                Specifies the virtual gateway.

                request_id

                +

                request_id

                String

                +

                String

                Specifies the request ID.

                +

                Specifies the request ID.

                -
                Table 5 VirtualGateway

                Parameter

                +
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + +
                Table 5 VirtualGateway

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                id

                +

                id

                String

                +

                String

                Specifies the virtual gateway ID.

                +

                Specifies the virtual gateway ID.

                vpc_id

                +

                vpc_id

                String

                +

                String

                Specifies the ID of the VPC connected by the virtual gateway.

                +

                Specifies the ID of the VPC connected using the virtual gateway.

                enterprise_router_id

                +

                enterprise_router_id

                String

                +

                String

                Specifies the ID of the enterprise router that the virtual gateway is attached to.

                +

                Specifies the ID of the enterprise router that the virtual gateway is attached to.

                tenant_id

                +

                tenant_id

                String

                +

                String

                Specifies the ID of the project that the instance belongs to.

                -

                Minimum: 32

                -

                Maximum: 32

                +

                Specifies the project ID.

                +

                Minimum: 32

                +

                Maximum: 32

                name

                +

                name

                String

                +

                String

                Specifies the virtual gateway name.

                -

                Minimum: 0

                -

                Maximum: 64

                +

                Specifies the virtual gateway name.

                +

                Minimum: 0

                +

                Maximum: 64

                description

                +

                description

                String

                +

                String

                Provides supplementary information about the virtual gateway.

                -

                Minimum: 0

                -

                Maximum: 128

                +

                Provides supplementary information about the virtual gateway.

                +

                Minimum: 0

                +

                Maximum: 128

                type

                +

                type

                String

                +

                String

                Specifies the virtual gateway type. The value can only be default.

                -

                Default: default

                +

                Specifies the virtual gateway type. The value can only be default.

                +

                Default: default

                local_ep_group

                +

                local_ep_group

                Array of strings

                +

                Array of strings

                Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC.

                +

                Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway.

                local_ep_group_ipv6

                +

                local_ep_group_ipv6

                Array of strings

                +

                Array of strings

                Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field.

                +

                Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. This is a reserved field.

                admin_state_up

                +

                admin_state_up

                Boolean

                +

                Boolean

                Specifies the administrative status, which can be true or false.

                -

                Default: true

                +

                Specifies the administrative status. The value can be true or false.

                +

                Default: true

                status

                +

                status

                String

                +

                String

                Specifies the virtual gateway status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

                +

                Specifies the operating status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

                bgp_asn

                +

                bgp_asn

                Integer

                +

                Integer

                Specifies the local BGP ASN of the virtual gateway.

                -

                Minimum: 1

                -

                Maximum: 4294967295

                +

                Specifies the local BGP ASN of the virtual gateway.

                +

                Minimum: 1

                +

                Maximum: 4294967295

                enterprise_project_id

                +

                enterprise_project_id

                String

                +

                String

                Specifies the ID of the enterprise project that the virtual gateway belongs to.

                -

                Minimum: 36

                -

                Maximum: 36

                +

                Specifies the ID of the enterprise project that the virtual gateway belongs to.

                +

                Minimum: 36

                +

                Maximum: 36

                device_id

                +

                device_id

                String

                +

                String

                Specifies the ID of the device that the virtual interface belongs to.

                +

                Specifies the ID of the device that the virtual interface belongs to.

                redundant_device_id

                +

                redundant_device_id

                String

                +

                String

                Specifies the ID of the redundant device.

                +

                Specifies the ID of the redundant device.

                public_border_group

                +

                public_border_group

                String

                +

                String

                Specifies the public border group of the AZ, indicating whether the site is a HomeZones site.

                +

                Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

                +

                tags

                +

                Array of Tag objects

                +

                Specifies the tags.

                +

                Array length: 0–10

                +
                +
                + +
                + + + + + + + + + + +
                Table 6 Tag

                Parameter

                +

                Type

                +

                Description

                +

                key

                +

                String

                +
                Specifies the tag key. The key:
                • Cannot be left blank.
                • Must be unique for each resource.
                • Can contain a maximum of 36 Unicode characters.
                • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                +
                +

                value

                +

                String

                +
                Specifies the tag value. The value:
                • Can be left blank.
                • Can contain a maximum of 43 Unicode characters.
                • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                +
                -

                Example Requests

                Querying a virtual gateway

                -
                GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0
                +

                Example Requests

                Querying a virtual gateway

                +
                GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0
                -

                Example Responses

                Status code: 200

                -

                OK

                -
                • The details of the virtual gateway associated with a VPC are queried.
                  {
                  +

                  Example Responses

                  Status code: 200

                  +

                  OK

                  +
                  • The details of the virtual gateway associated with a VPC are queried.
                    {
                       "virtual_gateway" : {
                         "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
                         "name" : "vgw-c7b22",
                         "description" : "",
                         "tenant_id" : "0605768a3300d5762f82c01180692873",
                         "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
                    +    "tags": [],
                         "device_id" : "26.151.63.100",
                         "redundant_device_id" : "26.152.128.20",
                         "type" : "default",
                    @@ -275,7 +312,7 @@
                       },
                       "request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
                     }
                    -
                  • The details of the virtual gateway attached to an enterprise router are queried.
                    {
                    +
                  • The details of the virtual gateway attached to an enterprise router are queried.
                    {
                       "virtual_gateway" : {
                         "name" : "vgw-er",
                         "id" : "7a91797a-cbda-42ff-9f42-73f26c993dd9",
                    @@ -283,6 +320,7 @@
                         "tenant_id" : "92ea72fe26294aa180a2712c28e43c21",
                         "vpc_id" : null,
                         "enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
                    +    "tags": [],
                         "device_id" : "26.151.63.100",
                         "redundant_device_id" : "26.152.128.20",
                         "type" : "default",
                    @@ -297,28 +335,28 @@
                     }
                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  OK

                  +

                  OK

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/dc/api-ref/ShowVirtualInterface.html b/docs/dc/api-ref/ShowVirtualInterface.html index 75e9907c0..0e0820e69 100644 --- a/docs/dc/api-ref/ShowVirtualInterface.html +++ b/docs/dc/api-ref/ShowVirtualInterface.html @@ -1,650 +1,683 @@

                  Querying Details About a Virtual Interface

                  -

                  Function

                  This API is used to querying details about a virtual interface.

                  +

                  Function

                  This API is used to querying details about a virtual interface.

                  -

                  URI

                  GET /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}

                  +

                  URI

                  GET /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}

                  -
                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 1 URI parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  virtual_interface_id

                  +

                  virtual_interface_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the virtual interface ID.

                  -

                  Minimum: 36

                  -

                  Maximum: 36

                  +

                  Specifies the virtual interface ID.

                  +

                  Minimum: 36

                  +

                  Maximum: 36

                  -
                  Table 2 Query Parameters

                  Parameter

                  +
                  - - - - - - -
                  Table 2 Query parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  fields

                  +

                  fields

                  No

                  +

                  No

                  Array

                  +

                  Array

                  Specifies the list of fields to be displayed.

                  -

                  Array Length: 1 - 5

                  +

                  Specifies the list of fields to be displayed.

                  +

                  Array length: 1–5

                  -

                  Request Parameters

                  -
                  Table 3 Request header parameters

                  Parameter

                  +

                  Request Parameters

                  +
                  - - - - - - -
                  Table 3 Request header parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  X-Auth-Token

                  +

                  X-Auth-Token

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                  -

                  Minimum: 0

                  -

                  Maximum: 10240

                  +

                  Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                  +

                  Minimum: 0

                  +

                  Maximum: 10240

                  -

                  Response Parameters

                  Status code: 200

                  +

                  Response Parameters

                  Status code: 200

                  -
                  Table 4 Response body parameters

                  Parameter

                  +
                  - - - - - - - -
                  Table 4 Response body parameters

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID.

                  +

                  Specifies the request ID.

                  virtual_interface

                  +

                  virtual_interface

                  VirtualInterface object

                  +

                  VirtualInterface object

                  Specifies parameters for creating a virtual interface.

                  +

                  Specifies the virtual interface.

                  -
                  Table 5 VirtualInterface

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
                  Table 5 VirtualInterface

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the virtual interface ID.

                  -

                  Maximum: 36

                  +

                  Specifies the virtual interface ID.

                  +

                  Maximum: 36

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the virtual interface name.

                  -

                  Maximum: 64

                  +

                  Specifies the virtual interface name.

                  +

                  Maximum: 64

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

                  Specifies the administrative status, which can be true or false.

                  +

                  Specifies the administrative status. The value can be true or false.

                  bandwidth

                  +

                  bandwidth

                  Integer

                  +

                  Integer

                  Specifies the virtual interface bandwidth.

                  -

                  Minimum: 2

                  -

                  Maximum: 2147483647

                  +

                  Specifies the virtual interface bandwidth.

                  +

                  Minimum: 2

                  +

                  Maximum: 2147483647

                  create_time

                  +

                  create_time

                  String

                  +

                  String

                  Specifies the time when the virtual interface was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

                  -

                  Maximum: 255

                  +

                  Specifies when the virtual interface was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

                  +

                  Maximum: 255

                  description

                  +

                  description

                  String

                  +

                  String

                  Provides supplementary information about the virtual interface.

                  -

                  Maximum: 128

                  +

                  Provides supplementary information about the virtual interface.

                  +

                  Maximum: 128

                  direct_connect_id

                  +

                  direct_connect_id

                  String

                  +

                  String

                  Specifies the connection ID.

                  -

                  Maximum: 36

                  +

                  Specifies the connection ID.

                  +

                  Maximum: 36

                  service_type

                  +

                  service_type

                  String

                  +

                  String

                  Specifies the gateway type, which can be VGW, GDGW, or LGW.

                  -

                  Enumeration values:

                  -
                  • VGW
                  • GDGW
                  • LGW
                  +

                  Specifies the gateway type. The value is VGW.

                  status

                  +

                  status

                  String

                  +

                  String

                  Specifies the operating status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.

                  +

                  Specifies the operating status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.

                  tenant_id

                  +

                  tenant_id

                  String

                  +

                  String

                  Specifies the project ID.

                  -

                  Minimum: 32

                  -

                  Maximum: 32

                  +

                  Specifies the project ID.

                  +

                  Minimum: 32

                  +

                  Maximum: 32

                  type

                  +

                  type

                  String

                  +

                  String

                  Specifies the type of the virtual interface. The value is private.

                  -

                  Default: private

                  -

                  Maximum: 255

                  -

                  Enumeration values:

                  -
                  • private
                  • public
                  +

                  Specifies the type of the virtual interface. The value is private.

                  +

                  Default: private

                  +

                  Maximum: 255

                  +

                  Enumeration values: private

                  vgw_id

                  +

                  vgw_id

                  String

                  +

                  String

                  Specifies the virtual gateway ID.

                  -

                  Minimum: 36

                  -

                  Maximum: 36

                  +

                  Specifies the virtual gateway ID.

                  +

                  Minimum: 36

                  +

                  Maximum: 36

                  vlan

                  +

                  vlan

                  Integer

                  +

                  Integer

                  Specifies the VLAN for connecting to the user gateway. The value ranges from 0 to 3999.

                  -

                  Minimum: 0

                  -

                  Maximum: 3999

                  +

                  Specifies the VLAN for connecting to the customer gateway. The value ranges from 0 to 3999.

                  +

                  Minimum: 0

                  +

                  Maximum: 3999

                  route_limit

                  +

                  route_limit

                  Integer

                  +

                  Integer

                  Specifies the remote subnet route configurations of the virtual interface.

                  -

                  Minimum: 1

                  -

                  Maximum: 200

                  -

                  Default: 50

                  +

                  Specifies the remote subnet route configurations of the virtual interface.

                  +

                  Minimum: 1

                  +

                  Maximum: 200

                  +

                  Default: 50

                  enable_nqa

                  +

                  enable_nqa

                  Boolean

                  +

                  Boolean

                  Specifies whether to enable NQA. The value can be true or false.

                  +

                  Specifies whether NQA (Network Quality Analysis) is enabled. The value can be true or false. (This is a reserved parameter and is not supported currently.)

                  enable_bfd

                  +

                  enable_bfd

                  Boolean

                  +

                  Boolean

                  Specifies whether to enable Bidirectional Forwarding Detection (BFD). The value can be true or false.

                  +

                  Specifies whether BFD (Bidirectional Forwarding Detection) is enabled. The value can be true or false. (This is a reserved parameter and is not supported currently.)

                  lag_id

                  +

                  lag_id

                  String

                  +

                  String

                  Specifies the ID of the LAG associated with the virtual interface.

                  -

                  Minimum: 36

                  -

                  Maximum: 36

                  +

                  Specifies the ID of the LAG associated with the virtual interface.

                  +

                  Minimum: 36

                  +

                  Maximum: 36

                  device_id

                  +

                  device_id

                  String

                  +

                  String

                  Specifies the ID of the device that the virtual interface belongs to.

                  +

                  Specifies the ID of the device that the virtual interface belongs to.

                  enterprise_project_id

                  +

                  enterprise_project_id

                  String

                  +

                  String

                  Specifies the ID of the enterprise project that the virtual interface belongs to.

                  -

                  Minimum: 36

                  -

                  Maximum: 36

                  +

                  Specifies the ID of the enterprise project that the virtual interface belongs to.

                  +

                  Minimum: 36

                  +

                  Maximum: 36

                  local_gateway_v4_ip

                  +

                  tags

                  String

                  +

                  Array of Tag objects

                  Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  +

                  Specifies the tags.

                  +

                  Array length: 0–10

                  remote_gateway_v4_ip

                  +

                  local_gateway_v4_ip

                  String

                  +

                  String

                  Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  +

                  Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  ies_id

                  +

                  remote_gateway_v4_ip

                  String

                  +

                  String

                  Specifies the ID of an IES edge site. (This parameter is not supported currently.)

                  +

                  Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  reason

                  +

                  ies_id

                  String

                  +

                  String

                  Displays error information if the status of a line is Error.

                  +

                  Specifies the edge site ID. (This parameter is not supported currently.)

                  rate_limit

                  +

                  reason

                  Boolean

                  +

                  String

                  Specifies whether rate limiting is enabled on a virtual interface.

                  +

                  Displays error information if the status of a line is Error.

                  address_family

                  +

                  rate_limit

                  String

                  +

                  Boolean

                  Specifies the address family of the virtual interface, which can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  +

                  Specifies whether rate limiting is enabled on a virtual interface.

                  local_gateway_v6_ip

                  +

                  address_family

                  String

                  +

                  String

                  Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  +

                  Specifies the address family of the virtual interface. The value can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  remote_gateway_v6_ip

                  +

                  local_gateway_v6_ip

                  String

                  +

                  String

                  Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  +

                  Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  lgw_id

                  +

                  remote_gateway_v6_ip

                  String

                  +

                  String

                  Specifies the ID of the local gateway, which is used in IES scenarios. (This parameter is not supported currently.)

                  +

                  Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  gateway_id

                  +

                  lgw_id

                  String

                  +

                  String

                  Specifies the ID of the gateway associated with the virtual interface.

                  +

                  Specifies the ID of the local gateway, which is used in IES scenarios. (This parameter is not supported currently.)

                  remote_ep_group

                  +

                  gateway_id

                  Array of strings

                  +

                  String

                  Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  +

                  Specifies the ID of the gateway associated with the virtual interface. (This is a reserved parameter and is not supported currently.)

                  service_ep_group

                  +

                  remote_ep_group

                  Array of strings

                  +

                  Array of strings

                  Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  +

                  Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  bgp_route_limit

                  +

                  service_ep_group

                  Integer

                  +

                  Array of strings

                  Specifies the BGP route configuration.

                  +

                  Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                  priority

                  +

                  bgp_route_limit

                  String

                  +

                  Integer

                  Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing.

                  -

                  Default: normal

                  -

                  Enumeration values:

                  -
                  • normal
                  • low
                  +

                  Specifies the BGP route configuration.

                  vif_peers

                  +

                  priority

                  Array of VifPeer objects

                  +

                  String

                  Provides information about virtual interface peers. (This is a reserved parameter and is not supported currently.)

                  +

                  Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing.

                  +

                  Default: normal

                  +

                  Enumeration values:

                  +
                  • normal
                  • low

                  extend_attribute

                  +

                  vif_peers

                  VifExtendAttribute object

                  +

                  Array of VifPeer objects

                  Provides extended parameter information. (This is a reserved parameter and is not supported currently.)

                  +

                  Provides information about virtual interface peers. (This is a reserved parameter and is not supported currently.)

                  +

                  extend_attribute

                  +

                  VifExtendAttribute object

                  +

                  Provides extended parameter information. (This is a reserved parameter and is not supported currently.)

                  -
                  Table 6 VifPeer

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 6 Tag

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  key

                  String

                  +

                  String

                  Specifies the resource ID.

                  -

                  Minimum: 36

                  -

                  Maximum: 36

                  +
                  Specifies the tag key. The key:
                  • Cannot be left blank.
                  • Must be unique for each resource.
                  • Can contain a maximum of 36 Unicode characters.
                  • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                  +

                  tenant_id

                  +

                  value

                  String

                  +

                  String

                  Specifies the ID of the project that the virtual interface peer belongs to.

                  -

                  Minimum: 36

                  -

                  Maximum: 36

                  -

                  name

                  -

                  String

                  -

                  Specifies the name of the virtual interface peer.

                  -

                  Minimum: 0

                  -

                  Maximum: 64

                  -

                  description

                  -

                  String

                  -

                  Provides supplementary information about the virtual interface peer.

                  -

                  Minimum: 0

                  -

                  Maximum: 128

                  -

                  address_family

                  -

                  String

                  -

                  Specifies the address family type of the virtual interface, which can be IPv4 or IPv6.

                  -

                  local_gateway_ip

                  -

                  String

                  -

                  Specifies the address of the virtual interface peer used on the cloud.

                  -

                  remote_gateway_ip

                  -

                  String

                  -

                  Specifies the address of the virtual interface peer used in the on-premises data center.

                  -

                  route_mode

                  -

                  String

                  -

                  Specifies the routing mode, which can be static or bgp.

                  -

                  Maximum: 255

                  -

                  Enumeration values:

                  -
                  • bgp
                  • static
                  -

                  bgp_asn

                  -

                  Integer

                  -

                  Specifies the ASN of the BGP peer.

                  -

                  Minimum: 1

                  -

                  Maximum: 4294967295

                  -

                  bgp_md5

                  -

                  String

                  -

                  Specifies the MD5 password of the BGP peer.

                  -

                  remote_ep_group

                  -

                  Array of strings

                  -

                  Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

                  -

                  service_ep_group

                  -

                  Array of strings

                  -

                  Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.

                  -

                  device_id

                  -

                  String

                  -

                  Specifies the ID of the device that the virtual interface peer belongs to.

                  -

                  bgp_route_limit

                  -

                  Integer

                  -

                  Specifies the BGP route configuration.

                  -

                  bgp_status

                  -

                  String

                  -

                  Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.

                  -

                  Maximum: 10

                  -

                  status

                  -

                  String

                  -

                  Specifies the status of the virtual interface peer.

                  -

                  vif_id

                  -

                  String

                  -

                  Specifies the ID of the virtual interface corresponding to the virtual interface peer.

                  -

                  Minimum: 36

                  -

                  Maximum: 36

                  -

                  receive_route_num

                  -

                  Integer

                  -

                  Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. Note: If this parameter cannot be obtained, contact customer service to migrate your ports.

                  -

                  enable_nqa

                  -

                  Boolean

                  -

                  Specifies whether to enable NQA. The value can be true or false.

                  -

                  enable_bfd

                  -

                  Boolean

                  -

                  Specifies whether to enable BFD. The value can be true or false.

                  +
                  Specifies the tag value. The value:
                  • Can be left blank.
                  • Can contain a maximum of 43 Unicode characters.
                  • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                  +
                  -
                  Table 7 VifExtendAttribute

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  Table 7 VifPeer

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  ha_type

                  +

                  id

                  String

                  +

                  String

                  Specifies the availability detection type of the virtual interface.

                  -

                  Enumeration values:

                  -
                  • nqa
                  • bfd
                  +

                  Specifies the resource ID.

                  +

                  Minimum: 36

                  +

                  Maximum: 36

                  ha_mode

                  +

                  tenant_id

                  String

                  +

                  String

                  Specifies the availability detection mode.

                  -

                  Enumeration values:

                  -
                  • auto_single
                  • auto_multi
                  • static_single
                  • static_multi
                  • enhance_nqa
                  +

                  Specifies the ID of the project that the virtual interface peer belongs to.

                  +

                  Minimum: 36

                  +

                  Maximum: 36

                  detect_multiplier

                  +

                  name

                  Integer

                  +

                  String

                  Specifies the number of detection retries.

                  -

                  Default: 5

                  +

                  Specifies the name of the virtual interface peer.

                  +

                  Minimum: 0

                  +

                  Maximum: 64

                  min_rx_interval

                  +

                  description

                  Integer

                  +

                  String

                  Specifies the interval for receiving detection packets.

                  -

                  Default: 1000

                  +

                  Provides supplementary information about the virtual interface peer.

                  +

                  Minimum: 0

                  +

                  Maximum: 128

                  min_tx_interval

                  +

                  address_family

                  Integer

                  +

                  String

                  Specifies the interval for sending detection packets.

                  -

                  Default: 1000

                  +

                  Specifies the address family of the virtual interface. The value can be IPv4 or IPv6.

                  remote_disclaim

                  +

                  local_gateway_ip

                  Integer

                  +

                  String

                  Specifies the remote identifier of the static BFD session.

                  +

                  Specifies the gateway address of the virtual interface peer used on the cloud.

                  local_disclaim

                  +

                  remote_gateway_ip

                  Integer

                  +

                  String

                  Specifies the local identifier of the static BFD session.

                  +

                  Specifies the gateway of the virtual interface peer used in the on-premises data center.

                  +

                  route_mode

                  +

                  String

                  +

                  Specifies the routing mode. The value can be static or bgp.

                  +

                  Maximum: 255

                  +

                  Enumeration values:

                  +
                  • bgp
                  • static
                  +

                  bgp_asn

                  +

                  Integer

                  +

                  Specifies the ASN of the BGP peer.

                  +

                  Minimum: 1

                  +

                  Maximum: 4294967295

                  +

                  bgp_md5

                  +

                  String

                  +

                  Specifies the MD5 password of the BGP peer.

                  +

                  remote_ep_group

                  +

                  Array of strings

                  +

                  Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

                  +

                  service_ep_group

                  +

                  Array of strings

                  +

                  Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.

                  +

                  device_id

                  +

                  String

                  +

                  Specifies the ID of the device that the virtual interface peer belongs to.

                  +

                  bgp_route_limit

                  +

                  Integer

                  +

                  Specifies the BGP route configuration.

                  +

                  bgp_status

                  +

                  String

                  +

                  Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.

                  +

                  Maximum: 10

                  +

                  status

                  +

                  String

                  +

                  Specifies the status of the virtual interface peer.

                  +

                  vif_id

                  +

                  String

                  +

                  Specifies the ID of the virtual interface corresponding to the virtual interface peer.

                  +

                  Minimum: 36

                  +

                  Maximum: 36

                  +

                  receive_route_num

                  +

                  Integer

                  +

                  Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. If this parameter cannot be obtained, contact customer service to migrate your ports.

                  +

                  enable_nqa

                  +

                  Boolean

                  +

                  Specifies whether NQA (Network Quality Analysis) is enabled. The value can be true or false. (This is a reserved parameter and is not supported currently.)

                  +

                  enable_bfd

                  +

                  Boolean

                  +

                  Specifies whether BFD (Bidirectional Forwarding Detection) is enabled. The value can be true or false. (This is a reserved parameter and is not supported currently.)

                  +
                  +
                  + +
                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  Table 8 VifExtendAttribute

                  Parameter

                  +

                  Type

                  +

                  Description

                  +

                  ha_type

                  +

                  String

                  +

                  Specifies the availability detection type of the virtual interface.

                  +

                  Enumeration values:

                  +
                  • nqa
                  • bfd
                  +

                  ha_mode

                  +

                  String

                  +

                  Specifies the availability detection mode.

                  +

                  Enumeration values:

                  +
                  • auto_single
                  • auto_multi
                  • static_single
                  • static_multi
                  • enhance_nqa
                  +

                  detect_multiplier

                  +

                  Integer

                  +

                  Specifies the number of detection retries.

                  +

                  Default: 5

                  +

                  min_rx_interval

                  +

                  Integer

                  +

                  Specifies the interval for receiving detection packets.

                  +

                  Default: 1000

                  +

                  min_tx_interval

                  +

                  Integer

                  +

                  Specifies the interval for sending detection packets.

                  +

                  Default: 1000

                  +

                  remote_disclaim

                  +

                  Integer

                  +

                  Specifies the remote identifier of the static BFD session.

                  +

                  local_disclaim

                  +

                  Integer

                  +

                  Specifies the local identifier of the static BFD session.

                  -

                  Example Requests

                  Querying a virtual interface

                  -
                  POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/0d0fdf63-f2c4-491c-8866-d504796189be
                  +

                  Example Requests

                  Querying a virtual interface

                  +
                  POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/0d0fdf63-f2c4-491c-8866-d504796189be
                  -

                  Example Responses

                  Status code: 200

                  -

                  OK

                  -
                  {
                  +

                  Example Responses

                  Status code: 200

                  +

                  OK

                  +
                  {
                     "virtual_interface" : {
                       "id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
                       "name" : "vif-0819",
                  @@ -677,6 +710,7 @@
                       "service_ep_group" : [ ],
                       "bgp_route_limit" : 100,
                       "priority" : "normal",
                  +    "tags": [],
                       "vif_peers" : [ {
                         "id" : "c768eb52-12a8-4859-9b43-81194643040c",
                         "tenant_id" : "0605768a3300d5762f82c01180692873",
                  @@ -704,28 +738,28 @@
                     "request_id" : "5633df7af874576d819a481c76673236"
                   }
                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  OK

                  +

                  OK

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/dc/api-ref/UpdateDirectConnect.html b/docs/dc/api-ref/UpdateDirectConnect.html index aee69bd61..1c0a17d69 100644 --- a/docs/dc/api-ref/UpdateDirectConnect.html +++ b/docs/dc/api-ref/UpdateDirectConnect.html @@ -1,586 +1,622 @@

                  Updating a Connection

                  -

                  Function

                  This API is used to update a connection, including updating its name and description.

                  +

                  Function

                  This API is used to update a connection, such as its name and description.

                  -

                  URI

                  PUT /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}

                  +

                  URI

                  PUT /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}

                  -
                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 1 URI parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  direct_connect_id

                  +

                  direct_connect_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the connection ID.

                  -

                  Minimum: 36

                  -

                  Maximum: 36

                  +

                  Specifies the connection ID.

                  +

                  Minimum: 36

                  +

                  Maximum: 36

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  -

                  Request Parameters

                  -
                  Table 2 Request header parameters

                  Parameter

                  +

                  Request Parameters

                  +
                  - - - - - - -
                  Table 2 Request header parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  X-Auth-Token

                  +

                  X-Auth-Token

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                  -

                  Minimum: 0

                  -

                  Maximum: 10240

                  +

                  Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                  +

                  Minimum: 0

                  +

                  Maximum: 10240

                  -
                  Table 3 Request body parameters

                  Parameter

                  +
                  - - - - - - -
                  Table 3 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  direct_connect

                  +

                  direct_connect

                  No

                  +

                  No

                  UpdateDirectConnect object

                  +

                  UpdateDirectConnect object

                  Specifies parameters required for updating a connection.

                  +

                  Specifies the connection to be updated.

                  -
                  Table 4 UpdateDirectConnect

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 4 UpdateDirectConnect

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  name

                  +

                  name

                  No

                  +

                  No

                  String

                  +

                  String

                  Specifies the connection name.

                  -

                  Minimum: 0

                  -

                  Maximum: 64

                  +

                  Specifies the connection name.

                  +

                  Minimum: 0

                  +

                  Maximum: 64

                  description

                  +

                  description

                  No

                  +

                  No

                  String

                  +

                  String

                  Provides supplementary information about the connection.

                  -

                  Minimum: 0

                  -

                  Maximum: 128

                  +

                  Provides supplementary information about the connection.

                  +

                  Minimum: 0

                  +

                  Maximum: 128

                  bandwidth

                  +

                  bandwidth

                  No

                  +

                  No

                  Integer

                  +

                  Integer

                  Specifies the bandwidth size of the hosted connection in Mbit/s. The bandwidth of a standard or operations connection cannot be reduced.

                  -

                  Minimum: 2

                  -

                  Maximum: 100000

                  +

                  Specifies the bandwidth of the hosted connection, in Mbit/s. The bandwidth of a standard or operations connection cannot be reduced.

                  +

                  Minimum: 2

                  +

                  Maximum: 100000

                  peer_location

                  +

                  peer_location

                  No

                  +

                  No

                  String

                  +

                  String

                  Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

                  -

                  Minimum: 0

                  -

                  Maximum: 255

                  +

                  Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

                  +

                  Minimum: 0

                  +

                  Maximum: 255

                  status

                  +

                  status

                  No

                  +

                  No

                  String

                  +

                  String

                  Specifies the resource status, which can be PENDING_PAY or APPLY.

                  -

                  Enumeration values:

                  -
                  • PENDING_PAY
                  • APPLY
                  +

                  Specifies the resource status. The value can be PENDING_PAY or APPLY.

                  +

                  Enumeration values:

                  +
                  • PENDING_PAY
                  • APPLY

                  provider_status

                  +

                  provider_status

                  No

                  +

                  No

                  String

                  +

                  String

                  Specifies the carrier status, which can be ACTIVE or DOWN.

                  -

                  Enumeration values:

                  -
                  • ACTIVE
                  • DOWN
                  +

                  Specifies the carrier status. The value can be ACTIVE or DOWN.

                  +

                  Enumeration values:

                  +
                  • ACTIVE
                  • DOWN
                  -

                  Response Parameters

                  Status code: 200

                  +

                  Response Parameters

                  Status code: 200

                  -
                  Table 5 Response body parameters

                  Parameter

                  +
                  - - - - - - - -
                  Table 5 Response body parameters

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID.

                  +

                  Specifies the request ID.

                  direct_connect

                  +

                  direct_connect

                  DirectConnect object

                  +

                  DirectConnect object

                  Specifies parameters for creating a connection.

                  +

                  Specifies the connection.

                  -
                  Table 6 DirectConnect

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
                  Table 6 DirectConnect

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the connection ID.

                  +

                  Specifies the connection ID.

                  tenant_id

                  +

                  tenant_id

                  String

                  +

                  String

                  Specifies the ID of the project that the instance belongs to.

                  +

                  Specifies the project ID.

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the connection name.

                  -

                  Minimum: 0

                  -

                  Maximum: 64

                  +

                  Specifies the connection name.

                  +

                  Minimum: 0

                  +

                  Maximum: 64

                  description

                  +

                  description

                  String

                  +

                  String

                  Provides supplementary information about the connection.

                  -

                  Minimum: 0

                  -

                  Maximum: 128

                  +

                  Provides supplementary information about the connection.

                  +

                  Minimum: 0

                  +

                  Maximum: 128

                  port_type

                  +

                  port_type

                  String

                  +

                  String

                  Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

                  -

                  Enumeration values:

                  -
                  • 1G
                  • 10G
                  • 40G
                  • 100G
                  +

                  Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

                  +

                  Enumeration values:

                  +
                  • 1G
                  • 10G
                  • 40G
                  • 100G
                    NOTE:

                    The port type of a hosted connection is the same as that of the operations connection that the hosted connection relies on.

                    +
                    +

                  bandwidth

                  +

                  bandwidth

                  Integer

                  +

                  Integer

                  Specifies the connection bandwidth in Mbit/s.

                  -

                  Minimum: 2

                  -

                  Maximum: 100000

                  +

                  Specifies the connection bandwidth, in Mbit/s.

                  +

                  Minimum: 2

                  +

                  Maximum: 100000

                  location

                  +

                  location

                  String

                  +

                  String

                  Specifies information about the Direct Connect location.

                  -

                  Minimum: 0

                  -

                  Maximum: 255

                  +

                  Specifies information about the Direct Connect location.

                  +

                  Minimum: 0

                  +

                  Maximum: 255

                  peer_location

                  +

                  peer_location

                  String

                  +

                  String

                  Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

                  -

                  Minimum: 0

                  -

                  Maximum: 255

                  +

                  Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

                  +

                  Minimum: 0

                  +

                  Maximum: 255

                  device_id

                  +

                  device_id

                  String

                  +

                  String

                  Specifies the ID of the device connected to the connection.

                  -

                  Minimum: 0

                  -

                  Maximum: 36

                  +

                  Specifies the ID of the device connected to the connection.

                  +

                  Minimum: 0

                  +

                  Maximum: 36

                  type

                  +

                  type

                  String

                  +

                  String

                  Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

                  -

                  Default: standard

                  -

                  Enumeration values:

                  -
                  • standard
                  • hosting
                  • hosted
                  • onestop_standard
                  • onestop_hosted
                  +

                  Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

                  +

                  Default: standard

                  +

                  Enumeration values:

                  +
                  • standard
                  • hosting
                  • hosted

                  hosting_id

                  +

                  hosting_id

                  String

                  +

                  String

                  Specifies the ID of the operations connection on which the hosted connection is created.

                  +

                  Specifies the ID of the operations connection on which the hosted connection is created.

                  charge_mode

                  +

                  charge_mode

                  String

                  +

                  String

                  Specifies the billing mode, which can be prepayment, bandwidth, or traffic.

                  -

                  Enumeration values:

                  -
                  • prepayment
                  • bandwidth
                  • traffic
                  +

                  Specifies the billing mode. The value can be prepayment, bandwidth, or traffic.

                  +

                  Enumeration values:

                  +
                  • prepayment
                  • bandwidth
                  • traffic

                  provider

                  +

                  provider

                  String

                  +

                  String

                  Specifies the line carrier of a connection.

                  +

                  Specifies the line carrier of a connection.

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

                  Specifies the administrative status, which can be true or false.

                  -

                  Default: true

                  +

                  Specifies the administrative status. The value can be true (default) or false.

                  vlan

                  +

                  vlan

                  Integer

                  +

                  Integer

                  Specifies the VLAN allocated to the hosted connection.

                  -

                  Minimum: 0

                  -

                  Maximum: 3999

                  +

                  Specifies the VLAN allocated to the hosted connection.

                  +

                  Minimum: 0

                  +

                  Maximum: 3999

                  status

                  +

                  status

                  String

                  +

                  String

                  Specifies the connection status. The options are as follows: ACTIVE: The connection is in the normal state. DOWN: The port for the connection is in the down state, which may cause line faults. BUILD: Operations related to the connection are being performed. ERROR: The connection configuration is incorrect. Contact customer service to rectify the fault. PENDING_DELETE: The connection is being deleted. DELETED: The connection has been deleted. APPLY: A request for a connection is submitted. DENY: A site survey is rejected because the customer fails to meet the requirements. PENDING_PAY: The order for the connection is to be paid. PAID: The order for the connection has been paid. PENDING_SURVEY: A site survey is required for the connection.

                  -

                  Enumeration values:

                  -
                  • BUILD
                  • PAID
                  • APPLY
                  • PENDING_SURVEY
                  • ACTIVE
                  • DOWN
                  • ERROR
                  • PENDING_DELETE
                  • DELETED
                  • DENY
                  • PENDING_PAY
                  +

                  Specifies the connection status.

                  +
                  • ACTIVE: The connection is in the normal state.
                  • DOWN: The port for the connection is in the down state, which may cause line faults.
                  • BUILD: Operations related to the connection are being performed.
                  • ERROR: The connection configuration is incorrect. Contact customer service to rectify the fault.
                  • PENDING_DELETE: The connection is being deleted.
                  • DELETED: The connection has been deleted.
                  • APPLY: A request for a connection is submitted.
                  • DENY: A site survey is rejected because the customer fails to meet the requirements.
                  • PENDING_PAY: The order for the connection is to be paid.
                  • PAID: The order for the connection has been paid.
                  • PENDING_SURVEY: A site survey is required for the connection.
                  +

                  Enumeration values:

                  +
                  • BUILD
                  • PAID
                  • APPLY
                  • PENDING_SURVEY
                  • ACTIVE
                  • DOWN
                  • ERROR
                  • PENDING_DELETE
                  • DELETED
                  • DENY
                  • PENDING_PAY

                  apply_time

                  +

                  apply_time

                  String

                  +

                  String

                  Specifies when the connection was requested. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

                  +

                  Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

                  create_time

                  +

                  create_time

                  String

                  +

                  String

                  Specifies when the connection was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

                  +

                  Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

                  provider_status

                  +

                  provider_status

                  String

                  +

                  String

                  Specifies the status of the carrier's leased line. The status can be ACTIVE or DOWN.

                  -

                  Enumeration values:

                  -
                  • ACTIVE
                  • DOWN
                  +

                  Specifies the carrier status. The status can be ACTIVE or DOWN.

                  +

                  Enumeration values:

                  +
                  • ACTIVE
                  • DOWN

                  peer_port_type

                  +

                  peer_port_type

                  String

                  +

                  String

                  Specifies the peer port type.

                  +

                  Specifies the peer port type.

                  peer_provider

                  +

                  peer_provider

                  String

                  +

                  String

                  Specifies the carrier connected to the connection.

                  +

                  Specifies the carrier of the leased line.

                  order_id

                  +

                  order_id

                  String

                  +

                  String

                  Specifies the connection order ID, which is used to support duration-based billing and identify user orders.

                  +

                  Specifies the connection order ID, which is used to support duration-based billing and identify user orders.

                  product_id

                  +

                  product_id

                  String

                  +

                  String

                  Specifies the product ID corresponding to the connection's order, which is used to custom billing policies such as duration-based packages.

                  +

                  Specifies the product ID corresponding to the connection's order. The product ID is used to specify billing policies such as duration-based packages.

                  spec_code

                  +

                  spec_code

                  String

                  +

                  String

                  Specifies the product specifications corresponding to the connection's order, which is used to custom billing policies such as duration-based packages.

                  +

                  Specifies the product specifications corresponding to the connection's order. The specifications are used to specify billing policies such as duration-based packages.

                  period_type

                  +

                  period_type

                  Integer

                  +

                  Integer

                  Specifies whether a connection in a specified order is billed by year or month.

                  +

                  Specifies whether a connection in a specified order is billed by year or month.

                  period_num

                  +

                  period_num

                  Integer

                  +

                  Integer

                  Specifies the required service duration of a yearly/monthly connection.

                  +

                  Specifies the required service duration of a yearly/monthly connection.

                  vgw_type

                  +

                  vgw_type

                  String

                  +

                  String

                  Specifies the gateway type required by a direct connection.

                  -

                  Default: default

                  -

                  Enumeration values:

                  -
                  • default
                  +

                  Specifies the gateway type required by a connection.

                  +

                  Default: default

                  +

                  Enumeration values:

                  +
                  • default

                  lag_id

                  +

                  lag_id

                  String

                  +

                  String

                  Specifies the ID of the LAG that the connection belongs to.

                  +

                  Specifies the ID of the LAG that the connection belongs to.

                  enterprise_project_id

                  +

                  signed_agreement_time

                  String

                  +

                  String

                  Specifies the ID of the enterprise project that the connection belongs to.

                  -

                  Minimum: 36

                  -

                  Maximum: 36

                  +

                  Specifies when the Direct Connect Disclaimers were signed.

                  locales

                  +

                  enterprise_project_id

                  LocalesBody object

                  +

                  String

                  Specifies the region of the connection. (This parameter is not supported currently.)

                  +

                  Specifies the ID of the enterprise project that the connection belongs to.

                  +

                  Minimum: 36

                  +

                  Maximum: 36

                  support_feature

                  +

                  tags

                  Array of strings

                  +

                  Array of Tag objects

                  Lists the features supported by the connection. (This parameter is not supported currently.)

                  +

                  Specifies the tags.

                  +

                  Array length: 0–10

                  ies_id

                  +

                  locales

                  String

                  +

                  LocalesBody object

                  Specifies the ID of an IES edge site. (This parameter is not supported currently.)

                  +

                  Specifies the region of the connection. (This parameter is not supported currently.)

                  reason

                  +

                  support_feature

                  String

                  +

                  Array of strings

                  Displays error information if the status of a line is Error. (This parameter is not supported currently.)

                  +

                  Lists the features supported by the connection. (This parameter is not supported currently.)

                  email

                  +

                  ies_id

                  String

                  +

                  String

                  Specifies the customer email information. (This parameter is not supported currently.)

                  +

                  Specifies the edge site ID. (This parameter is not supported currently.)

                  onestop_product_id

                  +

                  reason

                  String

                  +

                  String

                  Specifies the product ID of a full-service connection. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

                  +

                  Displays error information if the status of a line is Error. (This parameter is not supported currently.)

                  building_line_product_id

                  +

                  email

                  String

                  +

                  String

                  Specifies the product ID of the line resource used in the equipment room. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

                  +

                  Specifies the customer email information. (This parameter is not supported currently.)

                  last_onestop_product_id

                  +

                  onestop_product_id

                  String

                  +

                  String

                  Specifies the product ID of a full-service connection before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

                  +

                  Specifies the product ID if the connection is a full-service connection. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

                  last_building_line_product_id

                  +

                  building_line_product_id

                  String

                  +

                  String

                  Specifies the product ID of the line resource used in the equipment room before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

                  +

                  Specifies the product ID of the line resource used in the equipment room. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

                  modified_bandwidth

                  +

                  last_onestop_product_id

                  Integer

                  +

                  String

                  Specifies the new bandwidth after the line bandwidth is changed. (This parameter is not supported currently.)

                  +

                  Specifies the product ID of a full-service connection before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

                  change_mode

                  +

                  last_building_line_product_id

                  Integer

                  +

                  String

                  Specifies the status of a renewal change. (This parameter is not supported currently.)

                  +

                  Specifies the product ID of the line resource used in the equipment room before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

                  onestopdc_status

                  +

                  modified_bandwidth

                  String

                  +

                  Integer

                  Specifies the status of a full-service connection. (This parameter is not supported currently.)

                  +

                  Specifies the new bandwidth after the line bandwidth is changed. (This parameter is not supported currently.)

                  public_border_group

                  +

                  change_mode

                  String

                  +

                  Integer

                  Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

                  +

                  Specifies the status of a renewal change. (This parameter is not supported currently.)

                  auto_renew

                  +

                  onestopdc_status

                  Integer

                  +

                  String

                  Specifies whether to automatically renew a yearly/monthly subscription. (This parameter is not supported currently.)

                  +

                  Specifies the status of a full-service connection. (This parameter is not supported currently.)

                  ratio_95peak

                  +

                  public_border_group

                  Integer

                  +

                  String

                  Specifies the percentage of the minimum bandwidth for 95th percentile billing. (This parameter is not supported currently.)

                  -

                  Minimum: 0

                  -

                  Maximum: 100

                  +

                  Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

                  +

                  auto_renew

                  +

                  Integer

                  +

                  Specifies whether to automatically renew a yearly/monthly subscription. (This parameter is not supported currently.)

                  +

                  ratio_95peak

                  +

                  Integer

                  +

                  Specifies the percentage of the minimum bandwidth for 95th percentile billing. (This parameter is not supported currently.)

                  +

                  Minimum: 0

                  +

                  Maximum: 100

                  -
                  Table 7 LocalesBody

                  Parameter

                  +
                  - - - - - - - - + + +
                  Table 7 Tag

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  en_us

                  +

                  key

                  String

                  +

                  String

                  Specifies the region name in English.

                  -

                  Minimum: 0

                  -

                  Maximum: 255

                  +
                  Specifies the tag key. The key:
                  • Cannot be left blank.
                  • Must be unique for each resource.
                  • Can contain a maximum of 36 Unicode characters.
                  • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                  +

                  zh_cn

                  +

                  value

                  String

                  +

                  String

                  Specifies the region name in Chinese.

                  -

                  Minimum: 0

                  -

                  Maximum: 255

                  +
                  Specifies the tag value. The value:
                  • Can be left blank.
                  • Can contain a maximum of 43 Unicode characters.
                  • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                  +
                  +
                  +
                  + +
                  + + + + + + +
                  Table 8 LocalesBody

                  Parameter

                  +

                  Type

                  +

                  Description

                  +

                  en_us

                  +

                  String

                  +

                  Specifies the region name in English.

                  +

                  Minimum: 0

                  +

                  Maximum: 255

                  -

                  Example Requests

                  Updating the name and description of a connection

                  -
                  PUT https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects/6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
                  +

                  Example Requests

                  Updating the name and description of a connection

                  +
                  PUT https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects/6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
                   
                   {
                     "direct_connect" : {
                  @@ -589,9 +625,9 @@
                     }
                   }
                  -

                  Example Responses

                  Status code: 200

                  -

                  OK

                  -
                  • The connection is updated.
                    {
                    +

                    Example Responses

                    Status code: 200

                    +

                    OK

                    +
                    • The connection is updated.
                      {
                         "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535",
                         "direct_connect" : {
                           "bandwidth" : 100,
                      @@ -599,6 +635,7 @@
                           "port_type" : "10G",
                           "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
                           "apply_time" : "2018-10-19T09:53:26.000Z",
                      +    "locales": null,
                           "peer_location" : "",
                           "peer_port_type" : null,
                           "peer_provider" : null,
                      @@ -606,6 +643,7 @@
                           "provider" : "OTC",
                           "type" : "standard",
                           "status" : "BUILD",
                      +    "tags": [],
                           "description" : "",
                           "provider_status" : "ACTIVE",
                           "order_id" : "",
                      @@ -627,6 +665,9 @@
                           "building_line_product_id" : null,
                           "last_building_line_product_id" : null,
                           "last_onestop_product_id" : null,
                      +    "period_type": null,
                      +    "period_num": null,
                      +    "lag_id": null,
                           "modified_bandwidth" : null,
                           "change_mode" : null,
                           "onestopdc_status" : null,
                      @@ -637,28 +678,28 @@
                       }
                    -

                    Status Codes

                    -

                    Status Code

                    +

                    Status Codes

                    +
                    - - -

                    Status Code

                    Description

                    +

                    Description

                    200

                    +

                    200

                    OK

                    +

                    OK

                    -

                    Error Codes

                    See Error Codes.

                    +

                    Error Codes

                    See Error Codes.

                    diff --git a/docs/dc/api-ref/UpdateHostedDirectConnect.html b/docs/dc/api-ref/UpdateHostedDirectConnect.html index 9a8e2f930..1bdbd2cd1 100644 --- a/docs/dc/api-ref/UpdateHostedDirectConnect.html +++ b/docs/dc/api-ref/UpdateHostedDirectConnect.html @@ -1,337 +1,337 @@

                    Updating a Hosted Connection

                    -

                    Function

                    Updating a hosted connection by a partner

                    +

                    Function

                    This API is used by partners to update a hosted connection.

                    -

                    URI

                    PUT /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}

                    +

                    URI

                    PUT /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}

                    -
                    Table 1 Path Parameters

                    Parameter

                    +
                    - - - - - - - - - - -
                    Table 1 URI parameters

                    Parameter

                    Mandatory

                    +

                    Mandatory

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    project_id

                    +

                    project_id

                    Yes

                    +

                    Yes

                    String

                    +

                    String

                    Specifies the project ID.

                    +

                    Specifies the project ID.

                    hosted_connect_id

                    +

                    hosted_connect_id

                    Yes

                    +

                    Yes

                    String

                    +

                    String

                    Specifies the hosted connection ID.

                    -

                    Minimum: 36

                    -

                    Maximum: 36

                    +

                    Specifies the hosted connection ID.

                    +

                    Minimum: 36

                    +

                    Maximum: 36

                    -

                    Request Parameters

                    -
                    Table 2 Request header parameters

                    Parameter

                    +

                    Request Parameters

                    +
                    - - - - - - -
                    Table 2 Request header parameters

                    Parameter

                    Mandatory

                    +

                    Mandatory

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    X-Auth-Token

                    +

                    X-Auth-Token

                    Yes

                    +

                    Yes

                    String

                    +

                    String

                    Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                    -

                    Minimum: 0

                    -

                    Maximum: 10240

                    +

                    Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                    +

                    Minimum: 0

                    +

                    Maximum: 10240

                    -
                    Table 3 Request body parameters

                    Parameter

                    +
                    - - - - - - -
                    Table 3 Request body parameters

                    Parameter

                    Mandatory

                    +

                    Mandatory

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    hosted_connect

                    +

                    hosted_connect

                    No

                    +

                    No

                    UpdateHostedDirectConnect object

                    +

                    UpdateHostedDirectConnect object

                    Specifies parameters required for updating a hosted connection.

                    +

                    Specifies the hosted connection to be updated.

                    -
                    Table 4 UpdateHostedDirectConnect

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - - - -
                    Table 4 UpdateHostedDirectConnect

                    Parameter

                    Mandatory

                    +

                    Mandatory

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    name

                    +

                    name

                    No

                    +

                    No

                    String

                    +

                    String

                    Specifies the connection name.

                    -

                    Minimum: 0

                    -

                    Maximum: 64

                    +

                    Specifies the connection name.

                    +

                    Minimum: 0

                    +

                    Maximum: 64

                    description

                    +

                    description

                    No

                    +

                    No

                    String

                    +

                    String

                    Provides supplementary information about the connection.

                    -

                    Minimum: 0

                    -

                    Maximum: 128

                    +

                    Provides supplementary information about the connection.

                    +

                    Minimum: 0

                    +

                    Maximum: 128

                    bandwidth

                    +

                    bandwidth

                    No

                    +

                    No

                    Integer

                    +

                    Integer

                    Specifies the bandwidth size of the hosted connection in Mbit/s.

                    -

                    Minimum: 2

                    -

                    Maximum: 400000

                    +

                    Specifies the bandwidth of the hosted connection, in Mbit/s.

                    +

                    Minimum: 2

                    +

                    Maximum: 400000

                    peer_location

                    +

                    peer_location

                    No

                    +

                    No

                    String

                    +

                    String

                    Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

                    -

                    Minimum: 0

                    -

                    Maximum: 255

                    +

                    Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

                    +

                    Minimum: 0

                    +

                    Maximum: 255

                    -

                    Response Parameters

                    Status code: 200

                    +

                    Response Parameters

                    Status code: 200

                    -
                    Table 5 Response body parameters

                    Parameter

                    +
                    - - - - - - - -
                    Table 5 Response body parameters

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    request_id

                    +

                    request_id

                    String

                    +

                    String

                    Specifies the request ID.

                    +

                    Specifies the request ID.

                    hosted_connect

                    +

                    hosted_connect

                    HostedDirectConnect object

                    +

                    HostedDirectConnect object

                    Specifies the parameters for creating a hosted connection.

                    +

                    Specifies the hosted connection.

                    -
                    Table 6 HostedDirectConnect

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    Table 6 HostedDirectConnect

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the hosted connection ID.

                    -

                    Minimum: 36

                    -

                    Maximum: 36

                    +

                    Specifies the hosted connection ID.

                    +

                    Minimum: 36

                    +

                    Maximum: 36

                    tenant_id

                    +

                    tenant_id

                    String

                    +

                    String

                    Specifies the ID of the project that the instance belongs to.

                    +

                    Specifies the project ID.

                    name

                    +

                    name

                    String

                    +

                    String

                    Specifies the connection name.

                    -

                    Minimum: 0

                    -

                    Maximum: 64

                    +

                    Specifies the connection name.

                    +

                    Minimum: 0

                    +

                    Maximum: 64

                    description

                    +

                    description

                    String

                    +

                    String

                    Provides supplementary information about the connection.

                    -

                    Minimum: 0

                    -

                    Maximum: 128

                    +

                    Provides supplementary information about the connection.

                    +

                    Minimum: 0

                    +

                    Maximum: 128

                    bandwidth

                    +

                    bandwidth

                    Integer

                    +

                    Integer

                    Specifies the connection bandwidth in Mbit/s.

                    -

                    Minimum: 2

                    -

                    Maximum: 400000

                    +

                    Specifies the connection bandwidth, in Mbit/s.

                    +

                    Minimum: 2

                    +

                    Maximum: 400000

                    location

                    +

                    location

                    String

                    +

                    String

                    Specifies information about the Direct Connect location.

                    -

                    Minimum: 0

                    -

                    Maximum: 255

                    +

                    Specifies information about the Direct Connect location.

                    +

                    Minimum: 0

                    +

                    Maximum: 255

                    peer_location

                    +

                    peer_location

                    String

                    +

                    String

                    Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

                    -

                    Minimum: 0

                    -

                    Maximum: 255

                    +

                    Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name.

                    +

                    Minimum: 0

                    +

                    Maximum: 255

                    hosting_id

                    +

                    hosting_id

                    String

                    +

                    String

                    Specifies the ID of the operations connection on which the hosted connection is created.

                    +

                    Specifies the ID of the operations connection on which the hosted connection is created.

                    provider

                    +

                    provider

                    String

                    +

                    String

                    Specifies the provider of the leased line.

                    +

                    Specifies the provider of the leased line.

                    admin_state_up

                    +

                    admin_state_up

                    Boolean

                    +

                    Boolean

                    Specifies the administrative status, which can be true or false.

                    -

                    Default: true

                    +

                    Specifies the administrative status. The value can be true or false.

                    +

                    Default: true

                    vlan

                    +

                    vlan

                    Integer

                    +

                    Integer

                    Specifies the VLAN allocated to the hosted connection.

                    -

                    Minimum: 0

                    -

                    Maximum: 3999

                    +

                    Specifies the VLAN allocated to the hosted connection.

                    +

                    Minimum: 0

                    +

                    Maximum: 3999

                    status

                    +

                    status

                    String

                    +

                    String

                    Specifies the operating status of the hosted connection. The options are as follows:

                    -
                    • BUILD: The hosted connection has been created.
                    • ACTIVE: The associated virtual gateway is normal.
                    • DOWN: The port used by the hosted connection is down, indicating that there may be line faults.
                    • ERROR: The associated virtual gateway is abnormal.
                    • PENDING_DELETE: The hosted connection is being deleted.
                    • PENDING_UPDATE: The hosted connection is being updated.
                    • PENDING_CREATE: The hosted connection is being created.
                    -

                    Enumeration values:

                    -
                    • BUILD
                    • ACTIVE
                    • DOWN
                    • ERROR
                    • PENDING_DELETE
                    • PENDING_UPDATE
                    • PENDING_CREATE
                    +

                    Specifies the operating status.

                    +
                    • BUILD: The hosted connection has been created.
                    • ACTIVE: The hosted connection is normal.
                    • DOWN: The port used by the hosted connection is down, indicating that there may be line faults.
                    • ERROR: The hosted connection is abnormal.
                    • PENDING_DELETE: The hosted connection is being deleted.
                    • PENDING_UPDATE: The hosted connection is being updated.
                    • PENDING_CREATE: The hosted connection is being created.
                    +

                    Enumeration values:

                    +
                    • BUILD
                    • ACTIVE
                    • DOWN
                    • ERROR
                    • PENDING_DELETE
                    • PENDING_UPDATE
                    • PENDING_CREATE

                    apply_time

                    +

                    apply_time

                    String

                    +

                    String

                    Specifies when the connection was requested. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

                    +

                    Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

                    create_time

                    +

                    create_time

                    String

                    +

                    String

                    Specifies when the connection was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

                    +

                    Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

                    provider_status

                    +

                    provider_status

                    String

                    +

                    String

                    Specifies the status of the carrier's leased line. The status can be ACTIVE or DOWN.

                    -

                    Enumeration values:

                    -
                    • ACTIVE
                    • DOWN
                    +

                    Specifies the carrier status. The status can be ACTIVE or DOWN.

                    +

                    Enumeration values:

                    +
                    • ACTIVE
                    • DOWN

                    port_type

                    +

                    port_type

                    String

                    +

                    String

                    Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

                    -

                    Enumeration values:

                    -
                    • 1G
                    • 10G
                    • 40G
                    • 100G
                    +

                    Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

                    +

                    Enumeration values:

                    +
                    • 1G
                    • 10G
                    • 40G
                    • 100G
                      NOTE:

                      The port type of a hosted connection is the same as that of the operations connection that the hosted connection relies on.

                      +
                      +

                    type

                    +

                    type

                    String

                    +

                    String

                    Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

                    -

                    Default: standard

                    -

                    Enumeration values:

                    -
                    • standard
                    • hosting
                    • hosted
                    • onestop_standard
                    • onestop_hosted
                    +

                    Specifies the type of the connection. The value is hosted.

                    +

                    Default: hosted

                    -

                    Example Requests

                    Updating the name and description of a hosted connection

                    -
                    PUT https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects/0278b472-ffa5-4eb3-8c0d-979d479f8ef6
                    +

                    Example Requests

                    Updating the name and description of a hosted connection

                    +
                    PUT https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects/0278b472-ffa5-4eb3-8c0d-979d479f8ef6
                     
                     {
                       "hosted_connect" : {
                    @@ -340,9 +340,9 @@
                       }
                     }
                    -

                    Example Responses

                    Status code: 200

                    -

                    OK

                    -
                    • The hosted connection is updated.
                      {
                      +

                      Example Responses

                      Status code: 200

                      +

                      OK

                      +
                      • The hosted connection is updated.
                        {
                           "hosted_connect" : {
                             "id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6",
                             "name" : "client-dc-faf1",
                        @@ -366,28 +366,28 @@
                         }
                      -

                      Status Codes

                      -

                      Status Code

                      +

                      Status Codes

                      +
                      - - -

                      Status Code

                      Description

                      +

                      Description

                      200

                      +

                      200

                      OK

                      +

                      OK

                      -

                      Error Codes

                      See Error Codes.

                      +

                      Error Codes

                      See Error Codes.

                      diff --git a/docs/dc/api-ref/UpdateVirtualGateway.html b/docs/dc/api-ref/UpdateVirtualGateway.html index ea490e5f3..406d6b89e 100644 --- a/docs/dc/api-ref/UpdateVirtualGateway.html +++ b/docs/dc/api-ref/UpdateVirtualGateway.html @@ -1,313 +1,349 @@

                      Updating a Virtual Gateway

                      -

                      Function

                      This API is used to update a virtual gateway.

                      +

                      Function

                      This API is used to update a virtual gateway.

                      -

                      URI

                      PUT /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}

                      +

                      URI

                      PUT /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}

                      -
                      Table 1 Path Parameters

                      Parameter

                      +
                      - - - - - - - - - - -
                      Table 1 URI parameters

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      project_id

                      +

                      project_id

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Specifies the project ID.

                      +

                      Specifies the project ID.

                      virtual_gateway_id

                      +

                      virtual_gateway_id

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Specifies the virtual gateway ID.

                      +

                      Specifies the virtual gateway ID.

                      -

                      Request Parameters

                      -
                      Table 2 Request header parameters

                      Parameter

                      +

                      Request Parameters

                      +
                      - - - - - - -
                      Table 2 Request header parameters

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      X-Auth-Token

                      +

                      X-Auth-Token

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                      -

                      Minimum: 0

                      -

                      Maximum: 10240

                      +

                      Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                      +

                      Minimum: 0

                      +

                      Maximum: 10240

                      -
                      Table 3 Request body parameters

                      Parameter

                      +
                      - - - - - - -
                      Table 3 Request body parameters

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      virtual_gateway

                      +

                      virtual_gateway

                      No

                      +

                      No

                      UpdateVirtualGateway object

                      +

                      UpdateVirtualGateway object

                      Specifies the virtual gateway to be updated.

                      +

                      Specifies the virtual gateway to be updated.

                      -
                      Table 4 UpdateVirtualGateway

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - -
                      Table 4 UpdateVirtualGateway

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      name

                      +

                      name

                      No

                      +

                      No

                      String

                      +

                      String

                      Specifies the virtual gateway name.

                      -

                      Minimum: 0

                      -

                      Maximum: 64

                      +

                      Specifies the virtual gateway name.

                      +

                      Minimum: 0

                      +

                      Maximum: 64

                      description

                      +

                      description

                      No

                      +

                      No

                      String

                      +

                      String

                      Provides supplementary information about the virtual gateway.

                      -

                      Minimum: 0

                      -

                      Maximum: 128

                      +

                      Provides supplementary information about the virtual gateway.

                      +

                      Minimum: 0

                      +

                      Maximum: 128

                      local_ep_group

                      +

                      local_ep_group

                      No

                      +

                      No

                      Array of strings

                      +

                      Array of strings

                      Lists the IPv4 subnets that can be accessed over the virtual gateway. Generally, the list contains the subnet CIDR blocks of the associated VPC. The list can be updated only when the virtual gateway is associated with the VPC.

                      -

                      Array Length: 1 - 200

                      +

                      Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway. The list can be updated only when the virtual gateway is associated with the VPC.

                      +

                      Array length: 1–200

                      local_ep_group_ipv6

                      +

                      local_ep_group_ipv6

                      No

                      +

                      No

                      Array of strings

                      +

                      Array of strings

                      Lists the IPv6 subnets that can be accessed using the virtual gateway. Usually, the subnets are those in the VPC associated with the virtual gateway. (This is a reserved parameter and is not supported currently.)

                      -

                      Array Length: 1 - 50

                      +

                      Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. (This is a reserved parameter and is not supported currently.)

                      +

                      Array length: 1–50

                      -

                      Response Parameters

                      Status code: 200

                      +

                      Response Parameters

                      Status code: 200

                      -
                      Table 5 Response body parameters

                      Parameter

                      +
                      - - - - - - - -
                      Table 5 Response body parameters

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      virtual_gateway

                      +

                      virtual_gateway

                      VirtualGateway object

                      +

                      VirtualGateway object

                      Specifies parameters for creating a virtual gateway.

                      +

                      Specifies the virtual gateway.

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID.

                      +

                      Specifies the request ID.

                      -
                      Table 6 VirtualGateway

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + +
                      Table 6 VirtualGateway

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the virtual gateway ID.

                      +

                      Specifies the virtual gateway ID.

                      vpc_id

                      +

                      vpc_id

                      String

                      +

                      String

                      Specifies the ID of the VPC connected by the virtual gateway.

                      +

                      Specifies the ID of the VPC connected using the virtual gateway.

                      enterprise_router_id

                      +

                      enterprise_router_id

                      String

                      +

                      String

                      Specifies the ID of the enterprise router that the virtual gateway is attached to.

                      +

                      Specifies the ID of the enterprise router that the virtual gateway is attached to.

                      tenant_id

                      +

                      tenant_id

                      String

                      +

                      String

                      Specifies the ID of the project that the instance belongs to.

                      -

                      Minimum: 32

                      -

                      Maximum: 32

                      +

                      Specifies the project ID.

                      +

                      Minimum: 32

                      +

                      Maximum: 32

                      name

                      +

                      name

                      String

                      +

                      String

                      Specifies the virtual gateway name.

                      -

                      Minimum: 0

                      -

                      Maximum: 64

                      +

                      Specifies the virtual gateway name.

                      +

                      Minimum: 0

                      +

                      Maximum: 64

                      description

                      +

                      description

                      String

                      +

                      String

                      Provides supplementary information about the virtual gateway.

                      -

                      Minimum: 0

                      -

                      Maximum: 128

                      +

                      Provides supplementary information about the virtual gateway.

                      +

                      Minimum: 0

                      +

                      Maximum: 128

                      type

                      +

                      type

                      String

                      +

                      String

                      Specifies the virtual gateway type. The value can only be default.

                      -

                      Default: default

                      +

                      Specifies the virtual gateway type. The value can only be default.

                      +

                      Default: default

                      local_ep_group

                      +

                      local_ep_group

                      Array of strings

                      +

                      Array of strings

                      Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC.

                      +

                      Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway.

                      local_ep_group_ipv6

                      +

                      local_ep_group_ipv6

                      Array of strings

                      +

                      Array of strings

                      Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field.

                      +

                      Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. This is a reserved field.

                      admin_state_up

                      +

                      admin_state_up

                      Boolean

                      +

                      Boolean

                      Specifies the administrative status, which can be true or false.

                      -

                      Default: true

                      +

                      Specifies the administrative status. The value can be true or false.

                      +

                      Default: true

                      status

                      +

                      status

                      String

                      +

                      String

                      Specifies the virtual gateway status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

                      +

                      Specifies the operating status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

                      bgp_asn

                      +

                      bgp_asn

                      Integer

                      +

                      Integer

                      Specifies the local BGP ASN of the virtual gateway.

                      -

                      Minimum: 1

                      -

                      Maximum: 4294967295

                      +

                      Specifies the local BGP ASN of the virtual gateway.

                      +

                      Minimum: 1

                      +

                      Maximum: 4294967295

                      enterprise_project_id

                      +

                      enterprise_project_id

                      String

                      +

                      String

                      Specifies the ID of the enterprise project that the virtual gateway belongs to.

                      -

                      Minimum: 36

                      -

                      Maximum: 36

                      +

                      Specifies the ID of the enterprise project that the virtual gateway belongs to.

                      +

                      Minimum: 36

                      +

                      Maximum: 36

                      device_id

                      +

                      device_id

                      String

                      +

                      String

                      Specifies the ID of the device that the virtual interface belongs to.

                      +

                      Specifies the ID of the device that the virtual interface belongs to.

                      redundant_device_id

                      +

                      redundant_device_id

                      String

                      +

                      String

                      Specifies the ID of the redundant device.

                      +

                      Specifies the ID of the redundant device.

                      public_border_group

                      +

                      public_border_group

                      String

                      +

                      String

                      Specifies the public border group of the AZ, indicating whether the site is a HomeZones site.

                      +

                      Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

                      +

                      tags

                      +

                      Array of Tag objects

                      +

                      Specifies the tags.

                      +

                      Array length: 0–10

                      +
                      +
                      + +
                      + + + + + + + + + + +
                      Table 7 Tag

                      Parameter

                      +

                      Type

                      +

                      Description

                      +

                      key

                      +

                      String

                      +
                      Specifies the tag key. The key:
                      • Cannot be left blank.
                      • Must be unique for each resource.
                      • Can contain a maximum of 36 Unicode characters.
                      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                      +
                      +

                      value

                      +

                      String

                      +
                      Specifies the tag value. The value:
                      • Can be left blank.
                      • Can contain a maximum of 43 Unicode characters.
                      • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                      +
                      -

                      Example Requests

                      Updating the name and description of a virtual gateway and changing its IPv4 subnet to 192.168.3.0/24

                      -
                      PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0
                      +

                      Example Requests

                      Updating the name and description of a virtual gateway and changing its IPv4 subnet to 192.168.3.0/24

                      +
                      PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0
                       
                       {
                         "virtual_gateway" : {
                      @@ -317,15 +353,16 @@
                         }
                       }
                      -

                      Example Responses

                      Status code: 200

                      -

                      OK

                      -
                      • The virtual gateway associated with a VPC is updated.
                        {
                        +

                        Example Responses

                        Status code: 200

                        +

                        OK

                        +
                        • The virtual gateway associated with a VPC is updated.
                          {
                             "virtual_gateway" : {
                               "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
                               "name" : "update-vgw-c7b22",
                               "description" : "",
                               "tenant_id" : "0605768a3300d5762f82c01180692873",
                               "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
                          +    "tags": [],
                               "device_id" : "26.151.63.100",
                               "redundant_device_id" : "26.152.128.20",
                               "type" : "default",
                          @@ -338,7 +375,7 @@
                             },
                             "request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
                           }
                          -
                        • The virtual gateway that will be attached to an enterprise router is created.
                          {
                          +
                        • The virtual gateway attached to an enterprise router is updated.
                          {
                             "virtual_gateway" : {
                               "name" : "update-vgw-c7b22",
                               "id" : "7a91797a-cbda-42ff-9f42-73f26c993dd9",
                          @@ -346,6 +383,7 @@
                               "tenant_id" : "92ea72fe26294aa180a2712c28e43c21",
                               "vpc_id" : null,
                               "enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
                          +    "tags": [],
                               "device_id" : "26.151.63.100",
                               "redundant_device_id" : "26.152.128.20",
                               "type" : "default",
                          @@ -360,28 +398,28 @@
                           }
                        -

                        Status Codes

                        -

                        Status Code

                        +

                        Status Codes

                        +
                        - - -

                        Status Code

                        Description

                        +

                        Description

                        200

                        +

                        200

                        OK

                        +

                        OK

                        -

                        Error Codes

                        See Error Codes.

                        +

                        Error Codes

                        See Error Codes.

                        diff --git a/docs/dc/api-ref/UpdateVirtualInterface.html b/docs/dc/api-ref/UpdateVirtualInterface.html index a1ff965bc..6e0eb6406 100644 --- a/docs/dc/api-ref/UpdateVirtualInterface.html +++ b/docs/dc/api-ref/UpdateVirtualInterface.html @@ -1,739 +1,772 @@

                        Updating a Virtual Interface

                        -

                        Function

                        This API is used to update a virtual interface.

                        +

                        Function

                        This API is used to update a virtual interface.

                        -

                        URI

                        PUT /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}

                        +

                        URI

                        PUT /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}

                        -
                        Table 1 Path Parameters

                        Parameter

                        +
                        - - - - - - - - - - -
                        Table 1 URI parameters

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        project_id

                        +

                        project_id

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        Specifies the project ID.

                        +

                        Specifies the project ID.

                        virtual_interface_id

                        +

                        virtual_interface_id

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        Specifies the virtual interface ID.

                        -

                        Minimum: 36

                        -

                        Maximum: 36

                        +

                        Specifies the virtual interface ID.

                        +

                        Minimum: 36

                        +

                        Maximum: 36

                        -

                        Request Parameters

                        -
                        Table 2 Request header parameters

                        Parameter

                        +

                        Request Parameters

                        +
                        - - - - - - -
                        Table 2 Request header parameters

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        X-Auth-Token

                        +

                        X-Auth-Token

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                        -

                        Minimum: 0

                        -

                        Maximum: 10240

                        +

                        Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

                        +

                        Minimum: 0

                        +

                        Maximum: 10240

                        -
                        Table 3 Request body parameters

                        Parameter

                        +
                        - - - - - - -
                        Table 3 Request body parameters

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        virtual_interface

                        +

                        virtual_interface

                        Yes

                        +

                        Yes

                        UpdateVirtualInterface object

                        +

                        UpdateVirtualInterface object

                        Virtual interface objects to be updated

                        +

                        Specifies the virtual interface to be updated.

                        -
                        Table 4 UpdateVirtualInterface

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                        Table 4 UpdateVirtualInterface

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        name

                        +

                        name

                        No

                        +

                        No

                        String

                        +

                        String

                        Specifies the virtual interface name.

                        -

                        Minimum: 0

                        -

                        Maximum: 64

                        +

                        Specifies the virtual interface name.

                        +

                        Minimum: 0

                        +

                        Maximum: 64

                        description

                        +

                        description

                        No

                        +

                        No

                        String

                        +

                        String

                        Provides supplementary information about the virtual interface.

                        -

                        Minimum: 0

                        -

                        Maximum: 128

                        +

                        Provides supplementary information about the virtual interface.

                        +

                        Minimum: 0

                        +

                        Maximum: 128

                        bandwidth

                        +

                        bandwidth

                        No

                        +

                        No

                        Integer

                        +

                        Integer

                        Specifies the virtual interface bandwidth configuration.

                        -

                        Minimum: 2

                        -

                        Maximum: 2147483647

                        +

                        Specifies the virtual interface bandwidth configuration.

                        +

                        Minimum: 2

                        +

                        Maximum: 2147483647

                        remote_ep_group

                        +

                        remote_ep_group

                        No

                        +

                        No

                        Array of strings

                        +

                        Array of strings

                        Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

                        +

                        Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

                        service_ep_group

                        +

                        service_ep_group

                        No

                        +

                        No

                        Array of strings

                        +

                        Array of strings

                        Specifies the local endpoint group that is connected to the public network over a connection. (This is a reserved parameter and is not supported currently.)

                        +

                        Specifies the local endpoint group that is connected to the public network over a connection. (This is a reserved parameter and is not supported currently.)

                        enable_bfd

                        +

                        enable_bfd

                        No

                        +

                        No

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable BFD. The value can be true or false. (This is a reserved parameter and is not supported currently.)

                        +

                        Specifies whether to enable BFD (Bidirectional Forwarding Detection). The value can be true or false. (This is a reserved parameter and is not supported currently.)

                        enable_nqa

                        +

                        enable_nqa

                        No

                        +

                        No

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable NQA. The value can be true or false. (This is a reserved parameter and is not supported currently.)

                        +

                        Specifies whether to enable NQA (Network Quality Analysis). The value can be true or false. (This is a reserved parameter and is not supported currently.)

                        status

                        +

                        status

                        No

                        +

                        No

                        String

                        +

                        String

                        Confirms the virtual interfaces created by other users. The value can be ACCEPTED or REJECTED.

                        -

                        Enumeration values:

                        -
                        • ACCEPTED
                        • REJECTED
                        +

                        Confirms the virtual interfaces created by other users. The value can be ACCEPTED or REJECTED.

                        +

                        Enumeration values:

                        +
                        • ACCEPTED
                        • REJECTED
                        -

                        Response Parameters

                        Status code: 200

                        +

                        Response Parameters

                        Status code: 200

                        -
                        Table 5 Response body parameters

                        Parameter

                        +
                        - - - - - - - -
                        Table 5 Response body parameters

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        request_id

                        +

                        request_id

                        String

                        +

                        String

                        Specifies the request ID.

                        +

                        Specifies the request ID.

                        virtual_interface

                        +

                        virtual_interface

                        VirtualInterface object

                        +

                        VirtualInterface object

                        Specifies parameters for creating a virtual interface.

                        +

                        Specifies the virtual interface.

                        -
                        Table 6 VirtualInterface

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
                        Table 6 VirtualInterface

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the virtual interface ID.

                        -

                        Maximum: 36

                        +

                        Specifies the virtual interface ID.

                        +

                        Maximum: 36

                        name

                        +

                        name

                        String

                        +

                        String

                        Specifies the virtual interface name.

                        -

                        Maximum: 64

                        +

                        Specifies the virtual interface name.

                        +

                        Maximum: 64

                        admin_state_up

                        +

                        admin_state_up

                        Boolean

                        +

                        Boolean

                        Specifies the administrative status, which can be true or false.

                        +

                        Specifies the administrative status. The value can be true or false.

                        bandwidth

                        +

                        bandwidth

                        Integer

                        +

                        Integer

                        Specifies the virtual interface bandwidth.

                        -

                        Minimum: 2

                        -

                        Maximum: 2147483647

                        +

                        Specifies the virtual interface bandwidth.

                        +

                        Minimum: 2

                        +

                        Maximum: 2147483647

                        create_time

                        +

                        create_time

                        String

                        +

                        String

                        Specifies the time when the virtual interface was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.

                        -

                        Maximum: 255

                        +

                        Specifies when the virtual interface was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

                        +

                        Maximum: 255

                        description

                        +

                        description

                        String

                        +

                        String

                        Provides supplementary information about the virtual interface.

                        -

                        Maximum: 128

                        +

                        Provides supplementary information about the virtual interface.

                        +

                        Maximum: 128

                        direct_connect_id

                        +

                        direct_connect_id

                        String

                        +

                        String

                        Specifies the connection ID.

                        -

                        Maximum: 36

                        +

                        Specifies the connection ID.

                        +

                        Maximum: 36

                        service_type

                        +

                        service_type

                        String

                        +

                        String

                        Specifies the gateway type, which can be VGW, GDGW, or LGW.

                        -

                        Enumeration values:

                        -
                        • VGW
                        • GDGW
                        • LGW
                        +

                        Specifies the gateway type. The value is VGW.

                        status

                        +

                        status

                        String

                        +

                        String

                        Specifies the operating status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.

                        +

                        Specifies the operating status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.

                        tenant_id

                        +

                        tenant_id

                        String

                        +

                        String

                        Specifies the project ID.

                        -

                        Minimum: 32

                        -

                        Maximum: 32

                        +

                        Specifies the project ID.

                        +

                        Minimum: 32

                        +

                        Maximum: 32

                        type

                        +

                        type

                        String

                        +

                        String

                        Specifies the type of the virtual interface. The value is private.

                        -

                        Default: private

                        -

                        Maximum: 255

                        -

                        Enumeration values:

                        -
                        • private
                        • public
                        +

                        Specifies the type of the virtual interface. The value is private.

                        +

                        Default: private

                        +

                        Maximum: 255

                        +

                        Enumeration values: private

                        vgw_id

                        +

                        vgw_id

                        String

                        +

                        String

                        Specifies the virtual gateway ID.

                        -

                        Minimum: 36

                        -

                        Maximum: 36

                        +

                        Specifies the virtual gateway ID.

                        +

                        Minimum: 36

                        +

                        Maximum: 36

                        vlan

                        +

                        vlan

                        Integer

                        +

                        Integer

                        Specifies the VLAN for connecting to the user gateway. The value ranges from 0 to 3999.

                        -

                        Minimum: 0

                        -

                        Maximum: 3999

                        +

                        Specifies the VLAN for connecting to the customer gateway. The value ranges from 0 to 3999.

                        +

                        Minimum: 0

                        +

                        Maximum: 3999

                        route_limit

                        +

                        route_limit

                        Integer

                        +

                        Integer

                        Specifies the remote subnet route configurations of the virtual interface.

                        -

                        Minimum: 1

                        -

                        Maximum: 200

                        -

                        Default: 50

                        +

                        Specifies the remote subnet route configurations of the virtual interface.

                        +

                        Minimum: 1

                        +

                        Maximum: 200

                        +

                        Default: 50

                        enable_nqa

                        +

                        enable_nqa

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable NQA. The value can be true or false.

                        +

                        Specifies whether to enable NQA (Network Quality Analysis). The value can be true or false. (This is a reserved parameter and is not supported currently.)

                        enable_bfd

                        +

                        enable_bfd

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable Bidirectional Forwarding Detection (BFD). The value can be true or false.

                        +

                        Specifies whether to enable BFD (Bidirectional Forwarding Detection). The value can be true or false. (This is a reserved parameter and is not supported currently.)

                        lag_id

                        +

                        lag_id

                        String

                        +

                        String

                        Specifies the ID of the LAG associated with the virtual interface.

                        -

                        Minimum: 36

                        -

                        Maximum: 36

                        +

                        Specifies the ID of the LAG associated with the virtual interface.

                        +

                        Minimum: 36

                        +

                        Maximum: 36

                        device_id

                        +

                        device_id

                        String

                        +

                        String

                        Specifies the ID of the device that the virtual interface belongs to.

                        +

                        Specifies the ID of the device that the virtual interface belongs to.

                        enterprise_project_id

                        +

                        enterprise_project_id

                        String

                        +

                        String

                        Specifies the ID of the enterprise project that the virtual interface belongs to.

                        -

                        Minimum: 36

                        -

                        Maximum: 36

                        +

                        Specifies the ID of the enterprise project that the virtual interface belongs to.

                        +

                        Minimum: 36

                        +

                        Maximum: 36

                        local_gateway_v4_ip

                        +

                        tags

                        String

                        +

                        Array of Tag objects

                        Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        +

                        Specifies the tags.

                        +

                        Array length: 0–10

                        remote_gateway_v4_ip

                        +

                        local_gateway_v4_ip

                        String

                        +

                        String

                        Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        +

                        Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        ies_id

                        +

                        remote_gateway_v4_ip

                        String

                        +

                        String

                        Specifies the ID of an IES edge site. (This parameter is not supported currently.)

                        +

                        Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        reason

                        +

                        ies_id

                        String

                        +

                        String

                        Displays error information if the status of a line is Error.

                        +

                        Specifies the edge site ID. (This parameter is not supported currently.)

                        rate_limit

                        +

                        reason

                        Boolean

                        +

                        String

                        Specifies whether rate limiting is enabled on a virtual interface.

                        +

                        Displays error information if the status of a line is Error.

                        address_family

                        +

                        rate_limit

                        String

                        +

                        Boolean

                        Specifies the address family of the virtual interface, which can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        +

                        Specifies whether rate limiting is enabled on a virtual interface.

                        local_gateway_v6_ip

                        +

                        address_family

                        String

                        +

                        String

                        Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        +

                        Specifies the address family of the virtual interface. The value can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        remote_gateway_v6_ip

                        +

                        local_gateway_v6_ip

                        String

                        +

                        String

                        Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        +

                        Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        lgw_id

                        +

                        remote_gateway_v6_ip

                        String

                        +

                        String

                        Specifies the ID of the local gateway, which is used in IES scenarios. (This parameter is not supported currently.)

                        +

                        Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        gateway_id

                        +

                        lgw_id

                        String

                        +

                        String

                        Specifies the ID of the gateway associated with the virtual interface.

                        +

                        Specifies the ID of the local gateway, which is used in IES scenarios. (This parameter is not supported currently.)

                        remote_ep_group

                        +

                        gateway_id

                        Array of strings

                        +

                        String

                        Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        +

                        Specifies the ID of the gateway associated with the virtual interface. (This is a reserved parameter and is not supported currently.)

                        service_ep_group

                        +

                        remote_ep_group

                        Array of strings

                        +

                        Array of strings

                        Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        +

                        Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        bgp_route_limit

                        +

                        service_ep_group

                        Integer

                        +

                        Array of strings

                        Specifies the BGP route configuration.

                        +

                        Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.

                        priority

                        +

                        bgp_route_limit

                        String

                        +

                        Integer

                        Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing.

                        -

                        Default: normal

                        -

                        Enumeration values:

                        -
                        • normal
                        • low
                        +

                        Specifies the BGP route configuration.

                        vif_peers

                        +

                        priority

                        Array of VifPeer objects

                        +

                        String

                        Provides information about virtual interface peers. (This is a reserved parameter and is not supported currently.)

                        +

                        Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing.

                        +

                        Default: normal

                        +

                        Enumeration values:

                        +
                        • normal
                        • low

                        extend_attribute

                        +

                        vif_peers

                        VifExtendAttribute object

                        +

                        Array of VifPeer objects

                        Provides extended parameter information. (This is a reserved parameter and is not supported currently.)

                        +

                        Provides information about virtual interface peers. (This is a reserved parameter and is not supported currently.)

                        +

                        extend_attribute

                        +

                        VifExtendAttribute object

                        +

                        Provides extended parameter information. (This is a reserved parameter and is not supported currently.)

                        -
                        Table 7 VifPeer

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                        Table 7 Tag

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        key

                        String

                        +

                        String

                        Specifies the resource ID.

                        -

                        Minimum: 36

                        -

                        Maximum: 36

                        +
                        Specifies the tag key. The key:
                        • Cannot be left blank.
                        • Must be unique for each resource.
                        • Can contain a maximum of 36 Unicode characters.
                        • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                        +

                        tenant_id

                        +

                        value

                        String

                        +

                        String

                        Specifies the ID of the project that the virtual interface peer belongs to.

                        -

                        Minimum: 36

                        -

                        Maximum: 36

                        -

                        name

                        -

                        String

                        -

                        Specifies the name of the virtual interface peer.

                        -

                        Minimum: 0

                        -

                        Maximum: 64

                        -

                        description

                        -

                        String

                        -

                        Provides supplementary information about the virtual interface peer.

                        -

                        Minimum: 0

                        -

                        Maximum: 128

                        -

                        address_family

                        -

                        String

                        -

                        Specifies the address family type of the virtual interface, which can be IPv4 or IPv6.

                        -

                        local_gateway_ip

                        -

                        String

                        -

                        Specifies the address of the virtual interface peer used on the cloud.

                        -

                        remote_gateway_ip

                        -

                        String

                        -

                        Specifies the address of the virtual interface peer used in the on-premises data center.

                        -

                        route_mode

                        -

                        String

                        -

                        Specifies the routing mode, which can be static or bgp.

                        -

                        Maximum: 255

                        -

                        Enumeration values:

                        -
                        • bgp
                        • static
                        -

                        bgp_asn

                        -

                        Integer

                        -

                        Specifies the ASN of the BGP peer.

                        -

                        Minimum: 1

                        -

                        Maximum: 4294967295

                        -

                        bgp_md5

                        -

                        String

                        -

                        Specifies the MD5 password of the BGP peer.

                        -

                        remote_ep_group

                        -

                        Array of strings

                        -

                        Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

                        -

                        service_ep_group

                        -

                        Array of strings

                        -

                        Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.

                        -

                        device_id

                        -

                        String

                        -

                        Specifies the ID of the device that the virtual interface peer belongs to.

                        -

                        bgp_route_limit

                        -

                        Integer

                        -

                        Specifies the BGP route configuration.

                        -

                        bgp_status

                        -

                        String

                        -

                        Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.

                        -

                        Maximum: 10

                        -

                        status

                        -

                        String

                        -

                        Specifies the status of the virtual interface peer.

                        -

                        vif_id

                        -

                        String

                        -

                        Specifies the ID of the virtual interface corresponding to the virtual interface peer.

                        -

                        Minimum: 36

                        -

                        Maximum: 36

                        -

                        receive_route_num

                        -

                        Integer

                        -

                        Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. Note: If this parameter cannot be obtained, contact customer service to migrate your ports.

                        -

                        enable_nqa

                        -

                        Boolean

                        -

                        Specifies whether to enable NQA. The value can be true or false.

                        -

                        enable_bfd

                        -

                        Boolean

                        -

                        Specifies whether to enable BFD. The value can be true or false.

                        +
                        Specifies the tag value. The value:
                        • Can be left blank.
                        • Can contain a maximum of 43 Unicode characters.
                        • Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
                        +
                        -
                        Table 8 VifExtendAttribute

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                        Table 8 VifPeer

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        ha_type

                        +

                        id

                        String

                        +

                        String

                        Specifies the availability detection type of the virtual interface.

                        -

                        Enumeration values:

                        -
                        • nqa
                        • bfd
                        +

                        Specifies the resource ID.

                        +

                        Minimum: 36

                        +

                        Maximum: 36

                        ha_mode

                        +

                        tenant_id

                        String

                        +

                        String

                        Specifies the availability detection mode.

                        -

                        Enumeration values:

                        -
                        • auto_single
                        • auto_multi
                        • static_single
                        • static_multi
                        • enhance_nqa
                        +

                        Specifies the ID of the project that the virtual interface peer belongs to.

                        +

                        Minimum: 36

                        +

                        Maximum: 36

                        detect_multiplier

                        +

                        name

                        Integer

                        +

                        String

                        Specifies the number of detection retries.

                        -

                        Default: 5

                        +

                        Specifies the name of the virtual interface peer.

                        +

                        Minimum: 0

                        +

                        Maximum: 64

                        min_rx_interval

                        +

                        description

                        Integer

                        +

                        String

                        Specifies the interval for receiving detection packets.

                        -

                        Default: 1000

                        +

                        Provides supplementary information about the virtual interface peer.

                        +

                        Minimum: 0

                        +

                        Maximum: 128

                        min_tx_interval

                        +

                        address_family

                        Integer

                        +

                        String

                        Specifies the interval for sending detection packets.

                        -

                        Default: 1000

                        +

                        Specifies the address family of the virtual interface. The value can be IPv4 or IPv6.

                        remote_disclaim

                        +

                        local_gateway_ip

                        Integer

                        +

                        String

                        Specifies the remote identifier of the static BFD session.

                        +

                        Specifies the gateway address of the virtual interface peer used on the cloud.

                        local_disclaim

                        +

                        remote_gateway_ip

                        Integer

                        +

                        String

                        Specifies the local identifier of the static BFD session.

                        +

                        Specifies the gateway of the virtual interface peer used in the on-premises data center.

                        +

                        route_mode

                        +

                        String

                        +

                        Specifies the routing mode. The value can be static or bgp.

                        +

                        Maximum: 255

                        +

                        Enumeration values:

                        +
                        • bgp
                        • static
                        +

                        bgp_asn

                        +

                        Integer

                        +

                        Specifies the ASN of the BGP peer.

                        +

                        Minimum: 1

                        +

                        Maximum: 4294967295

                        +

                        bgp_md5

                        +

                        String

                        +

                        Specifies the MD5 password of the BGP peer.

                        +

                        remote_ep_group

                        +

                        Array of strings

                        +

                        Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

                        +

                        service_ep_group

                        +

                        Array of strings

                        +

                        Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.

                        +

                        device_id

                        +

                        String

                        +

                        Specifies the ID of the device that the virtual interface peer belongs to.

                        +

                        bgp_route_limit

                        +

                        Integer

                        +

                        Specifies the BGP route configuration.

                        +

                        bgp_status

                        +

                        String

                        +

                        Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.

                        +

                        Maximum: 10

                        +

                        status

                        +

                        String

                        +

                        Specifies the status of the virtual interface peer.

                        +

                        vif_id

                        +

                        String

                        +

                        Specifies the ID of the virtual interface corresponding to the virtual interface peer.

                        +

                        Minimum: 36

                        +

                        Maximum: 36

                        +

                        receive_route_num

                        +

                        Integer

                        +

                        Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. If this parameter cannot be obtained, contact customer service to migrate your ports.

                        +

                        enable_nqa

                        +

                        Boolean

                        +

                        Specifies whether to enable NQA (Network Quality Analysis). The value can be true or false. (This is a reserved parameter and is not supported currently.)

                        +

                        enable_bfd

                        +

                        Boolean

                        +

                        Specifies whether to enable BFD (Bidirectional Forwarding Detection). The value can be true or false. (This is a reserved parameter and is not supported currently.)

                        +
                        +
                        + +
                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                        Table 9 VifExtendAttribute

                        Parameter

                        +

                        Type

                        +

                        Description

                        +

                        ha_type

                        +

                        String

                        +

                        Specifies the availability detection type of the virtual interface.

                        +

                        Enumeration values:

                        +
                        • nqa
                        • bfd
                        +

                        ha_mode

                        +

                        String

                        +

                        Specifies the availability detection mode.

                        +

                        Enumeration values:

                        +
                        • auto_single
                        • auto_multi
                        • static_single
                        • static_multi
                        • enhance_nqa
                        +

                        detect_multiplier

                        +

                        Integer

                        +

                        Specifies the number of detection retries.

                        +

                        Default: 5

                        +

                        min_rx_interval

                        +

                        Integer

                        +

                        Specifies the interval for receiving detection packets.

                        +

                        Default: 1000

                        +

                        min_tx_interval

                        +

                        Integer

                        +

                        Specifies the interval for sending detection packets.

                        +

                        Default: 1000

                        +

                        remote_disclaim

                        +

                        Integer

                        +

                        Specifies the remote identifier of the static BFD session.

                        +

                        local_disclaim

                        +

                        Integer

                        +

                        Specifies the local identifier of the static BFD session.

                        -

                        Example Requests

                        Updating the name and description of a virtual interface and changing its bandwidth to 2 Mbit/s

                        -
                        PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/0d0fdf63-f2c4-491c-8866-d504796189be
                        +

                        Example Requests

                        Updating the name and description of a virtual interface and changing its bandwidth to 2 Mbit/s

                        +
                        PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/0d0fdf63-f2c4-491c-8866-d504796189be
                         
                         {
                           "virtual_interface" : {
                        @@ -743,9 +776,9 @@
                           }
                         }
                        -

                        Example Responses

                        Status code: 200

                        -

                        OK

                        -
                        {
                        +

                        Example Responses

                        Status code: 200

                        +

                        OK

                        +
                        {
                           "virtual_interface" : {
                             "id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
                             "name" : "vif-0819",
                        @@ -778,6 +811,7 @@
                             "service_ep_group" : [ ],
                             "bgp_route_limit" : 100,
                             "priority" : "normal",
                        +    "tags": [],
                             "vif_peers" : [ {
                               "id" : "c768eb52-12a8-4859-9b43-81194643040c",
                               "tenant_id" : "0605768a3300d5762f82c01180692873",
                        @@ -805,28 +839,28 @@
                           "request_id" : "5633df7af874576d819a481c76673236"
                         }
                        -

                        Status Codes

                        -
                        - - - - @@ -42,17 +42,17 @@ - - - diff --git a/docs/dc/api-ref/en-us_topic_0055025309.html b/docs/dc/api-ref/en-us_topic_0055025309.html index 31e850548..ba2aa2da9 100644 --- a/docs/dc/api-ref/en-us_topic_0055025309.html +++ b/docs/dc/api-ref/en-us_topic_0055025309.html @@ -1,6 +1,6 @@ -

                        APIs v2.0

                        +

                        API v2.0

                        diff --git a/docs/dc/api-ref/en-us_topic_0055025313.html b/docs/dc/api-ref/en-us_topic_0055025313.html index cbf5ec203..6d7311632 100644 --- a/docs/dc/api-ref/en-us_topic_0055025313.html +++ b/docs/dc/api-ref/en-us_topic_0055025313.html @@ -19,7 +19,7 @@ diff --git a/docs/dc/api-ref/en-us_topic_0055025314.html b/docs/dc/api-ref/en-us_topic_0055025314.html index 0ab7d8696..db97064b9 100644 --- a/docs/dc/api-ref/en-us_topic_0055025314.html +++ b/docs/dc/api-ref/en-us_topic_0055025314.html @@ -1,7 +1,7 @@

                        Overview

                        -

                        Object Introduction

                        This section describes the APIs for managing connections, including the API used to create a hosted connection, the APIs used to query, update, and delete a connection, and the API used to query the connection list.

                        +

                        Object Introduction

                        This topic describes the APIs for managing connections, including the API used to create a hosted connection, the APIs used to query, update, and delete a connection, and the API used to query the connection list.

                        Object Model

                        Status Code

                        +

                        Status Codes

                        +
                        - - -

                        Status Code

                        Description

                        +

                        Description

                        200

                        +

                        200

                        OK

                        +

                        OK

                        -

                        Error Codes

                        See Error Codes.

                        +

                        Error Codes

                        See Error Codes.

                        diff --git a/docs/dc/api-ref/dc_07_0000.html b/docs/dc/api-ref/dc_07_0000.html index 387b213e7..9342cb705 100644 --- a/docs/dc/api-ref/dc_07_0000.html +++ b/docs/dc/api-ref/dc_07_0000.html @@ -1,15 +1,17 @@ -

                        APIs v3

                        +

                        API v3

                        diff --git a/docs/dc/api-ref/dc_08_3000.html b/docs/dc/api-ref/dc_08_3000.html index 386bc988c..4de903a81 100644 --- a/docs/dc/api-ref/dc_08_3000.html +++ b/docs/dc/api-ref/dc_08_3000.html @@ -12,6 +12,8 @@ + diff --git a/docs/dc/api-ref/dc_08_3001.html b/docs/dc/api-ref/dc_08_3001.html index e1353c692..ada0395fe 100644 --- a/docs/dc/api-ref/dc_08_3001.html +++ b/docs/dc/api-ref/dc_08_3001.html @@ -12,7 +12,7 @@

                        Direct Connect supports the following actions that can be defined in custom policies:

                        -
                        • Connections: contains actions supported by the APIs of Direct Connect connections, for example, creating a connection.
                        • Virtual Gateways: contains actions supported by the APIs of Direct Connect virtual gateway, such as creating a virtual gateway.
                        • Virtual Interfaces: contains actions supported by the APIs of Direct Connect virtual interfaces, for example, creating a virtual interface.
                        +
                        • Connections: contains actions supported by the APIs of Direct Connect connections, for example, creating a connection.
                        • Virtual Gateways: contains actions supported by the APIs of Direct Connect virtual gateway, such as creating a virtual gateway.
                        • Virtual Interfaces: contains actions supported by the APIs of Direct Connect virtual interfaces, for example, creating a virtual interface.
                        • Tags: contains actions supported by the APIs of Direct Connect tags, for example, adding a tag to a resource.
                        diff --git a/docs/dc/api-ref/dc_08_3007.html b/docs/dc/api-ref/dc_08_3007.html new file mode 100644 index 000000000..1640a64ad --- /dev/null +++ b/docs/dc/api-ref/dc_08_3007.html @@ -0,0 +1,106 @@ + + +

                        Tags

                        +
                        +
                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                        Table 1 Actions allowed for tags

                        Permission

                        +

                        API

                        +

                        Action

                        +

                        Related Action

                        +

                        IAM Project

                        +

                        Enterprise Project

                        +

                        Adding a resource tag

                        +

                        POST /v3/{project_id}/{resource_type}/{resource_id}/tags

                        +

                        dcaas:resources:tag

                        +

                        -

                        +

                        +

                        ×

                        +

                        Adding or deleting resource tags

                        +

                        POST /v3/{project_id}/{resource_type}/{resource_id}/tags/action

                        +

                        dcaas:resources:batchTagUntag

                        +

                        -

                        +

                        +

                        ×

                        +

                        Querying resources by tag

                        +

                        POST /v3/{project_id}/{resource_type}/resource-instances/action

                        +

                        dcaas:resources:listByTag

                        +

                        -

                        +

                        +

                        ×

                        +

                        Querying tags by resource type

                        +

                        GET /v3/{project_id}/{resource_type}/tags

                        +

                        dcaas:resources:listTag

                        +

                        -

                        +

                        +

                        ×

                        +

                        Querying resource tags

                        +

                        GET /v3/{project_id}/{resource_type}/{resource_id}/tags

                        +

                        dcaas:resources:listResourceTag

                        +

                        -

                        +

                        +

                        ×

                        +

                        Deleting a resource tag

                        +

                        DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key}

                        +

                        dcaas:resources:unTag

                        +

                        -

                        +

                        +

                        ×

                        +
                        +
                        +
                        + + diff --git a/docs/dc/api-ref/en-us_topic_0055025300.html b/docs/dc/api-ref/en-us_topic_0055025300.html index ee973ccf1..22b5aac06 100644 --- a/docs/dc/api-ref/en-us_topic_0055025300.html +++ b/docs/dc/api-ref/en-us_topic_0055025300.html @@ -1,7 +1,7 @@

                        API Usage Guidelines

                        -

                        Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

                        +

                        Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL,uri indicates the resource path, that is, the API access path.

                        Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by application/json.

                        For details about how to use APIs, see API Usage Guidelines.

                        diff --git a/docs/dc/api-ref/en-us_topic_0055025301.html b/docs/dc/api-ref/en-us_topic_0055025301.html index 46bc22f1d..014157ae7 100644 --- a/docs/dc/api-ref/en-us_topic_0055025301.html +++ b/docs/dc/api-ref/en-us_topic_0055025301.html @@ -11,22 +11,22 @@

                        Connection APIs

                        Used to manage connections, including the API used to create a hosted connection, the APIs used to query, delete, and update a connection, and the API to query the connection list.

                        +

                        Used to manage connections, including the API used to create a hosted connection, the APIs used to query, delete, and update a connection, and the API to query the connection list

                        Virtual gateway APIs

                        Used to manage virtual gateways, including the APIs used to create, delete, query, and update a virtual gateway, and the API to query the virtual gateway list.

                        +

                        Used to manage virtual gateways, including the APIs used to create, delete, query, and update a virtual gateway, and the API to query the virtual gateway list

                        Virtual interface APIs

                        Used to manage virtual interfaces, including the APIs used to create, delete, query, and update a virtual interface, and the API to query the virtual interface list.

                        +

                        Used to manage virtual interfaces, including the APIs used to create, delete, query, and update a virtual interface, and the API to query the virtual interface list

                        Direct Connect endpoint group APIs

                        Used to manage Direct Connect endpoint groups, including the APIs used to create, delete, query, and update an endpoint group, and the API used to query the endpoint group list.

                        +

                        Used to manage Direct Connect endpoint groups, including the APIs used to create, delete, query, and update an endpoint group, and the API used to query the endpoint group list

                        Connection APIs

                        APIs for querying connection details, updating connection information, deleting a connection, querying the connection list, querying the hosted connection list, creating a hosted connection, querying hosted connection details, updating hosted connection information, and deleting a hosted connection

                        +

                        APIs for querying connection details, updating connection information, deleting a connection, querying the connection list, querying the hosted connection list, creating a hosted connection, querying hosted connection details, updating a hosted connection, and deleting a hosted connection

                        Virtual gateway APIs

                        APIs for querying virtual gateway details, updating virtual gateway information, deleting a virtual gateway, querying the virtual gateway list, and creating a virtual gateway

                        +

                        APIs for querying virtual gateway details, updating a virtual gateway, deleting a virtual gateway, querying the virtual gateway list, and creating a virtual gateway

                        Virtual interface APIs

                        APIs for querying virtual interface details, updating virtual interface information, deleting a virtual interface, querying the virtual interface list, and creating a virtual interface

                        +

                        APIs for querying virtual interface details, updating a virtual interface, deleting a virtual interface, querying the virtual interface list, and creating a virtual interface

                        - -
                        Table 1 Connection objects

                        Parameter

                        diff --git a/docs/dc/api-ref/en-us_topic_0055025315.html b/docs/dc/api-ref/en-us_topic_0055025315.html index 5b35a6d8c..197ae51ac 100644 --- a/docs/dc/api-ref/en-us_topic_0055025315.html +++ b/docs/dc/api-ref/en-us_topic_0055025315.html @@ -2,7 +2,7 @@

                        Creating a Connection

                        Function

                        This API is used to create a hosted connection.

                        -

                        This API can only be used to create hosted connections.

                        +

                        This API can only be used to create a hosted connection.

                        URI

                        POST /v2.0/dcaas/direct-connects

                        @@ -78,6 +78,8 @@

                        Yes

                        Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.

                        +
                        NOTE:

                        This is a reserved parameter. The actual value is the port type of the operations connection that the hosted connection relies on.

                        +

                        bandwidth

                        @@ -159,7 +161,7 @@

                        No

                        Specifies the connection type. The value can only be hosted.

                        +

                        Specifies the connection type. The value can only be hosted.

                        hosting_id

                        @@ -168,7 +170,7 @@

                        No

                        Specifies the ID of the operations connection on which the hosted connection is created.

                        +

                        Specifies the ID of the operations connection that the hosted connection is created on.

                        charge_mode

                        @@ -227,7 +229,7 @@
                        - diff --git a/docs/dc/api-ref/en-us_topic_0055025320.html b/docs/dc/api-ref/en-us_topic_0055025320.html index 69166ca24..ea4f8aa5f 100644 --- a/docs/dc/api-ref/en-us_topic_0055025320.html +++ b/docs/dc/api-ref/en-us_topic_0055025320.html @@ -23,7 +23,7 @@ diff --git a/docs/dc/api-ref/en-us_topic_0055025327.html b/docs/dc/api-ref/en-us_topic_0055025327.html index 605151099..932e8762f 100644 --- a/docs/dc/api-ref/en-us_topic_0055025327.html +++ b/docs/dc/api-ref/en-us_topic_0055025327.html @@ -23,7 +23,7 @@ diff --git a/docs/dc/api-ref/en-us_topic_0055025334.html b/docs/dc/api-ref/en-us_topic_0055025334.html index f0e29e13a..7f38934b6 100644 --- a/docs/dc/api-ref/en-us_topic_0055025334.html +++ b/docs/dc/api-ref/en-us_topic_0055025334.html @@ -21,7 +21,7 @@ diff --git a/docs/dc/api-ref/en-us_topic_0055025336.html b/docs/dc/api-ref/en-us_topic_0055025336.html index aa6f92bad..ab0a29103 100644 --- a/docs/dc/api-ref/en-us_topic_0055025336.html +++ b/docs/dc/api-ref/en-us_topic_0055025336.html @@ -183,7 +183,7 @@ "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f", "name" : "endpoint group1", - "description" : "", + "description" : null, "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], "type" : "cidr" } diff --git a/docs/dc/api-ref/en-us_topic_0055025337.html b/docs/dc/api-ref/en-us_topic_0055025337.html index 094adef8c..b241afd47 100644 --- a/docs/dc/api-ref/en-us_topic_0055025337.html +++ b/docs/dc/api-ref/en-us_topic_0055025337.html @@ -118,7 +118,7 @@ "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f", "name" : "endpoint group1", - "description" : "", + "description" : null, "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], "type" : "cidr" }] diff --git a/docs/dc/api-ref/en-us_topic_0055025339.html b/docs/dc/api-ref/en-us_topic_0055025339.html index b477033b7..baeec9336 100644 --- a/docs/dc/api-ref/en-us_topic_0055025339.html +++ b/docs/dc/api-ref/en-us_topic_0055025339.html @@ -137,7 +137,7 @@ "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f", "name" : "endpoint group1", - "description" : "", + "description" : null, "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], "type" : "cidr" } diff --git a/docs/dc/api-ref/en-us_topic_0055025347.html b/docs/dc/api-ref/en-us_topic_0055025347.html index c28f3aecc..31ab5df57 100644 --- a/docs/dc/api-ref/en-us_topic_0055025347.html +++ b/docs/dc/api-ref/en-us_topic_0055025347.html @@ -2,16 +2,40 @@

                        Change History

                        -
                        Table 3 Response parameter

                        Parameter

                        Type

                        +

                        Type

                        Description

                        Released On

                        +
                        - + + + + + + + + + + + +

                        Released On

                        What's New

                        2024-03-04

                        +

                        2025-09-04

                        +

                        This release incorporates the following changes:

                        + +

                        2025-07-22

                        +

                        This release incorporates the following changes:

                        +

                        Updated the return values of parameter description in the response examples of Creating an Endpoint Group, Querying the Direct Connect Endpoint Group List, and Querying a Direct Connect Endpoint Group.

                        +

                        2025-02-05

                        +

                        This release incorporates the following changes:

                        +

                        Deleted service_type frm request parameters in Creating a Virtual Interface.

                        +

                        2024-11-30

                        +

                        This release incorporates the following changes:

                        + +

                        2024-03-04

                        This release incorporates the following changes:

                        -

                        Updated the values of apply_time and create_time in the response examples in Querying Details About a Connection, Updating a Connection, Querying the Connection List.

                        +

                        Updated the values of apply_time and create_time in the response examples in Querying Details About a Connection, Updating a Connection, and Querying the Connection List.

                        2024-02-06

                        @@ -29,13 +53,13 @@

                        2023-12-08

                        This release incorporates the following changes:

                        - +

                        2023-10-30

                        This release incorporates the following changes:

                        - +

                        2023-04-17

                        @@ -113,7 +137,7 @@

                        2018-02-18

                        This release incorporates the following changes:

                        - +

                        2017-11-30

                        diff --git a/docs/dc/api-ref/topic_300000000.html b/docs/dc/api-ref/topic_300000000.html index 72da4221f..d662e0b2a 100644 --- a/docs/dc/api-ref/topic_300000000.html +++ b/docs/dc/api-ref/topic_300000000.html @@ -1,7 +1,7 @@ -

                        Connection

                        -

                        +

                        Connections

                        +

                        diff --git a/docs/dc/api-ref/topic_300000001.html b/docs/dc/api-ref/topic_300000001.html index cb24fcdce..667e40060 100644 --- a/docs/dc/api-ref/topic_300000001.html +++ b/docs/dc/api-ref/topic_300000001.html @@ -1,7 +1,7 @@ -

                        Virtual Gateway

                        -

                        +

                        Virtual Gateways

                        +

                        diff --git a/docs/dc/api-ref/topic_300000002.html b/docs/dc/api-ref/topic_300000002.html index 455b48690..e58d70553 100644 --- a/docs/dc/api-ref/topic_300000002.html +++ b/docs/dc/api-ref/topic_300000002.html @@ -1,7 +1,7 @@ -

                        Virtual Interface

                        -

                        +

                        Virtual Interfaces

                        +

                        diff --git a/docs/dc/api-ref/topic_300000003.html b/docs/dc/api-ref/topic_300000003.html new file mode 100644 index 000000000..1c1ec7121 --- /dev/null +++ b/docs/dc/api-ref/topic_300000003.html @@ -0,0 +1,26 @@ + + +

                        Tag Management

                        +

                        +
                        + +