From 00887d3d3cef2859df0ce33d60f6a7db2f3c20c0 Mon Sep 17 00:00:00 2001 From: "Qin Ying, Fan" Date: Tue, 18 Apr 2023 13:55:32 +0000 Subject: [PATCH] DC API 20230106 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: Qin Ying, Fan Co-committed-by: Qin Ying, Fan --- docs/dc/api-ref/.placeholder | 0 docs/dc/api-ref/ALL_META.TXT.json | 90 ++- docs/dc/api-ref/CLASS.TXT.json | 87 ++- docs/dc/api-ref/dc_08_0000.html | 17 + docs/dc/api-ref/dc_08_0001.html | 23 + docs/dc/api-ref/dc_08_0002.html | 94 +++ docs/dc/api-ref/dc_08_0003.html | 95 +++ docs/dc/api-ref/dc_08_0004.html | 95 +++ docs/dc/api-ref/en-dc_topic_0055025301.html | 6 +- docs/dc/api-ref/en-dc_topic_0055025309.html | 2 +- docs/dc/api-ref/en-dc_topic_0055025310.html | 2 +- docs/dc/api-ref/en-dc_topic_0055025311.html | 51 +- docs/dc/api-ref/en-dc_topic_0055025312.html | 12 +- docs/dc/api-ref/en-dc_topic_0055025313.html | 2 +- docs/dc/api-ref/en-dc_topic_0055025314.html | 531 +++++++++---- docs/dc/api-ref/en-dc_topic_0055025315.html | 460 ++++-------- docs/dc/api-ref/en-dc_topic_0055025316.html | 292 ++------ docs/dc/api-ref/en-dc_topic_0055025317.html | 10 +- docs/dc/api-ref/en-dc_topic_0055025318.html | 255 ++----- docs/dc/api-ref/en-dc_topic_0055025319.html | 351 +++------ docs/dc/api-ref/en-dc_topic_0055025320.html | 9 +- docs/dc/api-ref/en-dc_topic_0055025321.html | 208 ++++-- docs/dc/api-ref/en-dc_topic_0055025322.html | 287 +++---- docs/dc/api-ref/en-dc_topic_0055025323.html | 144 +--- docs/dc/api-ref/en-dc_topic_0055025324.html | 38 +- docs/dc/api-ref/en-dc_topic_0055025325.html | 216 ++---- docs/dc/api-ref/en-dc_topic_0055025326.html | 222 ++---- docs/dc/api-ref/en-dc_topic_0055025327.html | 9 +- docs/dc/api-ref/en-dc_topic_0055025328.html | 449 +++++++---- docs/dc/api-ref/en-dc_topic_0055025329.html | 470 +++--------- docs/dc/api-ref/en-dc_topic_0055025330.html | 238 ++---- docs/dc/api-ref/en-dc_topic_0055025331.html | 18 +- docs/dc/api-ref/en-dc_topic_0055025332.html | 268 ++----- docs/dc/api-ref/en-dc_topic_0055025333.html | 321 ++------ docs/dc/api-ref/en-dc_topic_0055025334.html | 9 +- docs/dc/api-ref/en-dc_topic_0055025335.html | 93 +-- docs/dc/api-ref/en-dc_topic_0055025336.html | 126 ++-- docs/dc/api-ref/en-dc_topic_0055025337.html | 78 +- docs/dc/api-ref/en-dc_topic_0055025338.html | 20 +- docs/dc/api-ref/en-dc_topic_0055025339.html | 74 +- docs/dc/api-ref/en-dc_topic_0055025340.html | 100 +-- docs/dc/api-ref/en-dc_topic_0055025341.html | 2 +- docs/dc/api-ref/en-dc_topic_0055025342.html | 14 +- docs/dc/api-ref/en-dc_topic_0055025343.html | 702 +++++++++++++++--- docs/dc/api-ref/en-dc_topic_0055025347.html | 62 +- .../dc/api-ref/public_sys-resources/delta.gif | Bin 58 -> 836 bytes .../api-ref/public_sys-resources/deltaend.gif | Bin 56 -> 834 bytes .../public_sys-resources/icon-arrowdn.gif | Bin 68 -> 1887 bytes .../public_sys-resources/icon-arrowrt.gif | Bin 70 -> 1890 bytes .../public_sys-resources/icon-caution.gif | Bin 580 -> 1086 bytes .../public_sys-resources/icon-danger.gif | Bin 580 -> 1086 bytes .../public_sys-resources/icon-note.gif | Bin 394 -> 983 bytes .../public_sys-resources/icon-notice.gif | Bin 1069 -> 962 bytes .../api-ref/public_sys-resources/icon-tip.gif | Bin 253 -> 879 bytes .../public_sys-resources/icon-warning.gif | Bin 580 -> 1086 bytes 55 files changed, 3172 insertions(+), 3480 deletions(-) delete mode 100644 docs/dc/api-ref/.placeholder create mode 100644 docs/dc/api-ref/dc_08_0000.html create mode 100644 docs/dc/api-ref/dc_08_0001.html create mode 100644 docs/dc/api-ref/dc_08_0002.html create mode 100644 docs/dc/api-ref/dc_08_0003.html create mode 100644 docs/dc/api-ref/dc_08_0004.html diff --git a/docs/dc/api-ref/.placeholder b/docs/dc/api-ref/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/dc/api-ref/ALL_META.TXT.json b/docs/dc/api-ref/ALL_META.TXT.json index 3f779e93..3825e1f3 100644 --- a/docs/dc/api-ref/ALL_META.TXT.json +++ b/docs/dc/api-ref/ALL_META.TXT.json @@ -35,8 +35,8 @@ "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":"API", - "title":"API", + "kw":"APIs", + "title":"APIs", "githuburl":"" }, { @@ -53,7 +53,7 @@ "uri":"en-dc_topic_0055025311.html", "product_code":"dc", "code":"6", - "des":"This API is used to query all API versions supported by Direct Connect.GET /NoneTable 1 lists the response parameters.Example requestGET /Example response{\n \"versions\": [", + "des":"This API is used to query all API versions supported by Direct Connect.GET /NoneTable 1 lists the response parameters.Example requestGET /Example response{\n \"versions\"", "doc_type":"api", "kw":"Querying All API Versions,Obtaining the API Version Information,API Reference", "title":"Querying All API Versions", @@ -83,7 +83,7 @@ "uri":"en-dc_topic_0055025314.html", "product_code":"dc", "code":"9", - "des":"This section describes APIs for managing and operating connections, including the APIs used to create, query, update, and delete a connection, and the API used to query t", + "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", "doc_type":"api", "kw":"Overview,Connection,API Reference", "title":"Overview", @@ -93,7 +93,7 @@ "uri":"en-dc_topic_0055025315.html", "product_code":"dc", "code":"10", - "des":"This API is used to create a connection.When you create a hosted connection that does not need to be confirmed, set Status to ACCEPT.The bandwidth of a hosted connection ", + "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", "doc_type":"api", "kw":"Creating a Connection,Connection,API Reference", "title":"Creating a Connection", @@ -103,7 +103,7 @@ "uri":"en-dc_topic_0055025316.html", "product_code":"dc", "code":"11", - "des":"This API is used to query the connection list.GET /v2.0/dcaas/direct-connectsTable 2 lists the request parameter.Table 3 lists the response parameter.Table 4 lists the di", + "des":"This API is used to query the connection list.GET /v2.0/dcaas/direct-connectsTable 2 lists the request parameter.Table 3 lists the response parameter.For details about th", "doc_type":"api", "kw":"Querying the Connection List,Connection,API Reference", "title":"Querying the Connection List", @@ -113,7 +113,7 @@ "uri":"en-dc_topic_0055025317.html", "product_code":"dc", "code":"12", - "des":"This API is used to delete a connection.DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}NoneNoneExample requestFor details, see section Common Returned Values.", + "des":"This API is used to delete a connection.DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}NoneNoneExample requestFor details, see Common Status Codes.", "doc_type":"api", "kw":"Deleting a Connection,Connection,API Reference", "title":"Deleting a Connection", @@ -123,7 +123,7 @@ "uri":"en-dc_topic_0055025318.html", "product_code":"dc", "code":"13", - "des":"This API is used to query a connection.GET /v2.0/dcaas/direct-connects/{direct_connect_id}NoneTable 2 lists the response parameter.Example requestExample response{\n \"d", + "des":"This API is used to query a connection.GET /v2.0/dcaas/direct-connects/{direct_connect_id}NoneTable 2 lists the response parameter.For details about the direct_connect fi", "doc_type":"api", "kw":"Querying a Connection,Connection,API Reference", "title":"Querying a Connection", @@ -133,7 +133,7 @@ "uri":"en-dc_topic_0055025319.html", "product_code":"dc", "code":"14", - "des":"This API is used to update a connection.You can only increase the connection bandwidth.Bandwidths of the operations connections cannot be modified.PUT /v2.0/dcaas/direct-", + "des":"This API is used to update a connection.PUT /v2.0/dcaas/direct-connects/{direct_connect_id}Table 2 lists the request parameter.Table 4 lists the response parameter.For de", "doc_type":"api", "kw":"Updating a Connection,Connection,API Reference", "title":"Updating a Connection", @@ -163,7 +163,7 @@ "uri":"en-dc_topic_0055025322.html", "product_code":"dc", "code":"17", - "des":"This API is used to create a virtual gateway.POST /v2.0/dcaas/virtual-gatewaysTable 2 lists the virtual_gateway parameters.Table 3 lists the response parameter.Example re", + "des":"This API is used to create a virtual gateway.POST /v2.0/dcaas/virtual-gatewaysFor details about the virtual_gateway field, see Table 2.Table 3 lists the response paramete", "doc_type":"api", "kw":"Creating a Virtual Gateway,Virtual Gateway,API Reference", "title":"Creating a Virtual Gateway", @@ -173,7 +173,7 @@ "uri":"en-dc_topic_0055025323.html", "product_code":"dc", "code":"18", - "des":"This API is used to query the virtual gateway list.GET /v2.0/dcaas/virtual-gatewaysTable 1 lists the request parameter.Table 2 lists the response parameter.Example reques", + "des":"This API is used to query the virtual gateway list.GET /v2.0/dcaas/virtual-gatewaysTable 1 lists the request parameter.Table 2 lists the response parameter.For details ab", "doc_type":"api", "kw":"Querying the Virtual Gateway List,Virtual Gateway,API Reference", "title":"Querying the Virtual Gateway List", @@ -233,7 +233,7 @@ "uri":"en-dc_topic_0055025329.html", "product_code":"dc", "code":"24", - "des":"This API is used to create a virtual interface.POST /v2.0/dcaas/virtual-interfacesTable 1 lists the request parameter.Table 3 lists the response parameter.Example request", + "des":"This API is used to create a virtual interface.POST /v2.0/dcaas/virtual-interfacesTable 1 lists the request parameter.Table 3 lists the response parameter.For details abo", "doc_type":"api", "kw":"Creating a Virtual Interface,Virtual Interface,API Reference", "title":"Creating a Virtual Interface", @@ -243,7 +243,7 @@ "uri":"en-dc_topic_0055025330.html", "product_code":"dc", "code":"25", - "des":"This API is used to query the virtual interface list.GET /v2.0/dcaas/virtual-interfacesTable 1 lists the request parameter.Table 2 lists the response parameter.Example re", + "des":"This API is used to query the virtual interface list.GET /v2.0/dcaas/virtual-interfacesTable 1 lists the request parameter.Table 2 lists the response parameter.For detail", "doc_type":"api", "kw":"Querying the Virtual Interface List,Virtual Interface,API Reference", "title":"Querying the Virtual Interface List", @@ -273,7 +273,7 @@ "uri":"en-dc_topic_0055025333.html", "product_code":"dc", "code":"28", - "des":"This API is used to update a virtual interface.You can only increase the bandwidth.Virtual interface bandwidths of hosted direct connections cannot be updated.PUT /v2.0/d", + "des":"This API is used to update a virtual interface.The bandwidth specified for a virtual interface associated with a standard connection can be increased or decreased, but th", "doc_type":"api", "kw":"Updating a Virtual Interface,Virtual Interface,API Reference", "title":"Updating a Virtual Interface", @@ -350,11 +350,61 @@ "githuburl":"" }, { - "uri":"en-dc_topic_0055025341.html", + "uri":"dc_08_0000.html", "product_code":"dc", "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":"Permissions Policies and Supported Actions", + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"dc_08_0001.html", + "product_code":"dc", + "code":"37", + "des":"This chapter describes fine-grained permissions management for your Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) us", + "doc_type":"api", + "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"dc_08_0002.html", + "product_code":"dc", + "code":"38", + "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,API Reference", + "title":"Connections", + "githuburl":"" + }, + { + "uri":"dc_08_0003.html", + "product_code":"dc", + "code":"39", + "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,API Reference", + "title":"Virtual Gateways", + "githuburl":"" + }, + { + "uri":"dc_08_0004.html", + "product_code":"dc", + "code":"40", + "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,API Reference", + "title":"Virtual Interfaces", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025341.html", + "product_code":"dc", + "code":"41", + "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", "title":"Public Parameters", "githuburl":"" @@ -362,17 +412,17 @@ { "uri":"en-dc_topic_0055025342.html", "product_code":"dc", - "code":"37", + "code":"42", "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 Returned Values,Public Parameters,API Reference", - "title":"Common Returned Values", + "kw":"Common Status Codes,Public Parameters,API Reference", + "title":"Common Status Codes", "githuburl":"" }, { "uri":"en-dc_topic_0055025343.html", "product_code":"dc", - "code":"38", + "code":"43", "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,Public Parameters,API Reference", @@ -382,7 +432,7 @@ { "uri":"en-dc_topic_0055025347.html", "product_code":"dc", - "code":"39", + "code":"44", "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", diff --git a/docs/dc/api-ref/CLASS.TXT.json b/docs/dc/api-ref/CLASS.TXT.json index d68cc966..6dc8e081 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":"API", + "title":"APIs", "uri":"en-dc_topic_0055025309.html", "doc_type":"api", "p_code":"", @@ -45,7 +45,7 @@ "code":"5" }, { - "desc":"This API is used to query all API versions supported by Direct Connect.GET /NoneTable 1 lists the response parameters.Example requestGET /Example response{\n \"versions\": [", + "desc":"This API is used to query all API versions supported by Direct Connect.GET /NoneTable 1 lists the response parameters.Example requestGET /Example response{\n \"versions\"", "product_code":"dc", "title":"Querying All API Versions", "uri":"en-dc_topic_0055025311.html", @@ -72,7 +72,7 @@ "code":"8" }, { - "desc":"This section describes APIs for managing and operating connections, including the APIs used to create, query, update, and delete a connection, and the API used to query t", + "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", "product_code":"dc", "title":"Overview", "uri":"en-dc_topic_0055025314.html", @@ -81,7 +81,7 @@ "code":"9" }, { - "desc":"This API is used to create a connection.When you create a hosted connection that does not need to be confirmed, set Status to ACCEPT.The bandwidth of a hosted connection ", + "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", "product_code":"dc", "title":"Creating a Connection", "uri":"en-dc_topic_0055025315.html", @@ -90,7 +90,7 @@ "code":"10" }, { - "desc":"This API is used to query the connection list.GET /v2.0/dcaas/direct-connectsTable 2 lists the request parameter.Table 3 lists the response parameter.Table 4 lists the di", + "desc":"This API is used to query the connection list.GET /v2.0/dcaas/direct-connectsTable 2 lists the request parameter.Table 3 lists the response parameter.For details about th", "product_code":"dc", "title":"Querying the Connection List", "uri":"en-dc_topic_0055025316.html", @@ -99,7 +99,7 @@ "code":"11" }, { - "desc":"This API is used to delete a connection.DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}NoneNoneExample requestFor details, see section Common Returned Values.", + "desc":"This API is used to delete a connection.DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}NoneNoneExample requestFor details, see Common Status Codes.", "product_code":"dc", "title":"Deleting a Connection", "uri":"en-dc_topic_0055025317.html", @@ -108,7 +108,7 @@ "code":"12" }, { - "desc":"This API is used to query a connection.GET /v2.0/dcaas/direct-connects/{direct_connect_id}NoneTable 2 lists the response parameter.Example requestExample response{\n \"d", + "desc":"This API is used to query a connection.GET /v2.0/dcaas/direct-connects/{direct_connect_id}NoneTable 2 lists the response parameter.For details about the direct_connect fi", "product_code":"dc", "title":"Querying a Connection", "uri":"en-dc_topic_0055025318.html", @@ -117,7 +117,7 @@ "code":"13" }, { - "desc":"This API is used to update a connection.You can only increase the connection bandwidth.Bandwidths of the operations connections cannot be modified.PUT /v2.0/dcaas/direct-", + "desc":"This API is used to update a connection.PUT /v2.0/dcaas/direct-connects/{direct_connect_id}Table 2 lists the request parameter.Table 4 lists the response parameter.For de", "product_code":"dc", "title":"Updating a Connection", "uri":"en-dc_topic_0055025319.html", @@ -144,7 +144,7 @@ "code":"16" }, { - "desc":"This API is used to create a virtual gateway.POST /v2.0/dcaas/virtual-gatewaysTable 2 lists the virtual_gateway parameters.Table 3 lists the response parameter.Example re", + "desc":"This API is used to create a virtual gateway.POST /v2.0/dcaas/virtual-gatewaysFor details about the virtual_gateway field, see Table 2.Table 3 lists the response paramete", "product_code":"dc", "title":"Creating a Virtual Gateway", "uri":"en-dc_topic_0055025322.html", @@ -153,7 +153,7 @@ "code":"17" }, { - "desc":"This API is used to query the virtual gateway list.GET /v2.0/dcaas/virtual-gatewaysTable 1 lists the request parameter.Table 2 lists the response parameter.Example reques", + "desc":"This API is used to query the virtual gateway list.GET /v2.0/dcaas/virtual-gatewaysTable 1 lists the request parameter.Table 2 lists the response parameter.For details ab", "product_code":"dc", "title":"Querying the Virtual Gateway List", "uri":"en-dc_topic_0055025323.html", @@ -207,7 +207,7 @@ "code":"23" }, { - "desc":"This API is used to create a virtual interface.POST /v2.0/dcaas/virtual-interfacesTable 1 lists the request parameter.Table 3 lists the response parameter.Example request", + "desc":"This API is used to create a virtual interface.POST /v2.0/dcaas/virtual-interfacesTable 1 lists the request parameter.Table 3 lists the response parameter.For details abo", "product_code":"dc", "title":"Creating a Virtual Interface", "uri":"en-dc_topic_0055025329.html", @@ -216,7 +216,7 @@ "code":"24" }, { - "desc":"This API is used to query the virtual interface list.GET /v2.0/dcaas/virtual-interfacesTable 1 lists the request parameter.Table 2 lists the response parameter.Example re", + "desc":"This API is used to query the virtual interface list.GET /v2.0/dcaas/virtual-interfacesTable 1 lists the request parameter.Table 2 lists the response parameter.For detail", "product_code":"dc", "title":"Querying the Virtual Interface List", "uri":"en-dc_topic_0055025330.html", @@ -243,7 +243,7 @@ "code":"27" }, { - "desc":"This API is used to update a virtual interface.You can only increase the bandwidth.Virtual interface bandwidths of hosted direct connections cannot be updated.PUT /v2.0/d", + "desc":"This API is used to update a virtual interface.The bandwidth specified for a virtual interface associated with a standard connection can be increased or decreased, but th", "product_code":"dc", "title":"Updating a Virtual Interface", "uri":"en-dc_topic_0055025333.html", @@ -317,17 +317,17 @@ { "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":"Public Parameters", - "uri":"en-dc_topic_0055025341.html", + "title":"Permissions Policies and Supported Actions", + "uri":"dc_08_0000.html", "doc_type":"api", "p_code":"", "code":"36" }, { - "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.", + "desc":"This chapter describes fine-grained permissions management for your Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) us", "product_code":"dc", - "title":"Common Returned Values", - "uri":"en-dc_topic_0055025342.html", + "title":"Introduction", + "uri":"dc_08_0001.html", "doc_type":"api", "p_code":"36", "code":"37" @@ -335,12 +335,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":"Error Codes", - "uri":"en-dc_topic_0055025343.html", + "title":"Connections", + "uri":"dc_08_0002.html", "doc_type":"api", "p_code":"36", "code":"38" }, + { + "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 Gateways", + "uri":"dc_08_0003.html", + "doc_type":"api", + "p_code":"36", + "code":"39" + }, + { + "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 Interfaces", + "uri":"dc_08_0004.html", + "doc_type":"api", + "p_code":"36", + "code":"40" + }, + { + "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":"Public Parameters", + "uri":"en-dc_topic_0055025341.html", + "doc_type":"api", + "p_code":"", + "code":"41" + }, + { + "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":"Common Status Codes", + "uri":"en-dc_topic_0055025342.html", + "doc_type":"api", + "p_code":"41", + "code":"42" + }, + { + "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":"Error Codes", + "uri":"en-dc_topic_0055025343.html", + "doc_type":"api", + "p_code":"41", + "code":"43" + }, { "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", @@ -348,6 +393,6 @@ "uri":"en-dc_topic_0055025347.html", "doc_type":"api", "p_code":"", - "code":"39" + "code":"44" } ] \ No newline at end of file diff --git a/docs/dc/api-ref/dc_08_0000.html b/docs/dc/api-ref/dc_08_0000.html new file mode 100644 index 00000000..7ec4bcfc --- /dev/null +++ b/docs/dc/api-ref/dc_08_0000.html @@ -0,0 +1,17 @@ + + +

Permissions Policies and Supported Actions

+
+
+ +
+ diff --git a/docs/dc/api-ref/dc_08_0001.html b/docs/dc/api-ref/dc_08_0001.html new file mode 100644 index 00000000..5aca5d91 --- /dev/null +++ b/docs/dc/api-ref/dc_08_0001.html @@ -0,0 +1,23 @@ + + +

Introduction

+

This chapter describes fine-grained permissions management for your Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, then you may skip over this chapter.

+

By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.

+

You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.

+

Policy-based authorization is useful if you want to allow or deny the access to an API.

+
+

An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query the connections using an API, the user must have been granted permissions that allow the dcaas:directConnect:list action.

+

Supported Actions

IAM provides system-defined policies that can be directly used. You can also create custom policies to work with system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:

+
  • Permissions: Statements in a policy that allow or deny certain operations.
  • APIs: REST APIs that can be called by a user who has been granted specific permissions.
  • Actions: Specific operations that are allowed or denied.
  • IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. For details about the differences between IAM projects and enterprise projects, see "What Are the Differences Between IAM and Enterprise Management?" in the Identity and Access Management User Guide.

    The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.

    +
    +
+

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 APIs, 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.
+
+
+
+ +
+ diff --git a/docs/dc/api-ref/dc_08_0002.html b/docs/dc/api-ref/dc_08_0002.html new file mode 100644 index 00000000..18f75939 --- /dev/null +++ b/docs/dc/api-ref/dc_08_0002.html @@ -0,0 +1,94 @@ + + +

Connections

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Actions allowed for connections

Permission

+

API

+

Action

+

Related Action

+

IAM Project

+

Enterprise Project

+

Create a connection.

+

POST /v2.0/dcaas/direct-connects

+

dcaas:directConnect:create

+

vpc:vpcs:get

+

vpc:vpcs:list

+

+

×

+

Query the connection list.

+

GET /v2.0/dcaas/direct-connects

+

dcaas:directConnect:list

+

-

+

+

×

+

Delete a connection.

+

DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}

+

dcaas:directConnect:delete

+

-

+

+

×

+

Query a connection.

+

GET /v2.0/dcaas/direct-connects/{direct_connect_id}

+

dcaas:directConnect:get

+

-

+

+

×

+

Update a connection.

+

PUT /v2.0/dcaas/direct-connects/{direct_connect_id}

+

dcaas:directConnect:update

+

-

+

+

×

+
+
+
+
+ +
+ diff --git a/docs/dc/api-ref/dc_08_0003.html b/docs/dc/api-ref/dc_08_0003.html new file mode 100644 index 00000000..d57c1513 --- /dev/null +++ b/docs/dc/api-ref/dc_08_0003.html @@ -0,0 +1,95 @@ + + +

Virtual Gateways

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Actions allowed for virtual gateways

Permission

+

API

+

Action

+

Related Action

+

IAM Project

+

Enterprise Project

+

Create a virtual gateway.

+

POST /v2.0/dcaas/virtual-gateways

+

dcaas:vgw:create

+

vpc:vpcs:get

+

vpc:vpcs:list

+

vpc:subnets:get

+

+

×

+

Query the virtual gateway list.

+

GET /v2.0/dcaas/virtual-gateways

+

dcaas:vgw:list

+

-

+

+

×

+

Delete a virtual gateway.

+

DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}

+

dcaas:vgw:delete

+

-

+

+

×

+

Query a virtual gateway.

+

GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}

+

dcaas:vgw:get

+

-

+

+

×

+

Update a virtual gateway.

+

PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}

+

dcaas:vgw:update

+

-

+

+

×

+
+
+
+
+ +
+ diff --git a/docs/dc/api-ref/dc_08_0004.html b/docs/dc/api-ref/dc_08_0004.html new file mode 100644 index 00000000..7e003513 --- /dev/null +++ b/docs/dc/api-ref/dc_08_0004.html @@ -0,0 +1,95 @@ + + +

Virtual Interfaces

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Actions allowed for virtual interfaces

Permission

+

API

+

Action

+

Related Action

+

IAM Project

+

Enterprise Project

+

Create a virtual interface.

+

POST /v2.0/dcaas/virtual-interfaces

+

dcaas:vif:create

+

vpc:vpcs:get

+

vpc:vpcs:list

+

vpc:subnets:get

+

+

×

+

Query the virtual interface list.

+

GET /v2.0/dcaas/virtual-interfaces

+

dcaas:vif:list

+

-

+

+

×

+

Delete a virtual interface.

+

DELETE /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}

+

dcaas:vif:delete

+

-

+

+

×

+

Query a virtual interface.

+

GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}

+

dcaas:vif:get

+

-

+

+

×

+

Update a virtual interface.

+

PUT /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}

+

dcaas:vif:update

+

-

+

+

×

+
+
+
+
+ +
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025301.html b/docs/dc/api-ref/en-dc_topic_0055025301.html index da39afa7..011765dc 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025301.html +++ b/docs/dc/api-ref/en-dc_topic_0055025301.html @@ -3,9 +3,9 @@

API Overview

Direct Connect APIs allow you to use all Direct Connect functions.

-
Table 1 Direct Connect APIs

Category

+
- @@ -15,7 +15,7 @@ -
Table 1 Direct Connect APIs

Category

Sub-Category

+

Subcategory

Description

Connection

Used to create, query, and update connections.

+

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

diff --git a/docs/dc/api-ref/en-dc_topic_0055025309.html b/docs/dc/api-ref/en-dc_topic_0055025309.html index 45a9f681..9dddc837 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025309.html +++ b/docs/dc/api-ref/en-dc_topic_0055025309.html @@ -1,6 +1,6 @@ -

API

+

APIs

diff --git a/docs/dc/api-ref/en-dc_topic_0055025311.html b/docs/dc/api-ref/en-dc_topic_0055025311.html index 668e115f..6314dfe3 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025311.html +++ b/docs/dc/api-ref/en-dc_topic_0055025311.html @@ -7,7 +7,7 @@

Request

None

-

Response

Table 1 lists the response parameters.

+

Response

Table 1 lists the response parameters.

@@ -28,7 +28,7 @@ - + + + + + + + + + + + +
Table 1 Response parameters

Parameter

String

Specifies the version number, for example, v2.0

+

Specifies the version number, for example, v2.0.

links

@@ -52,6 +52,13 @@

Specifies the relationship between the current API version and the referenced address.

version

+

String

+

Specifies the version. If APIs of this version support minor versions, set this parameter to the supported maximum minor version. If minor versions are not supported, leave this parameter blank.

+

status

String

@@ -60,23 +67,41 @@
  • CURRENT: indicates a primary version.
  • SUPPORTED: indicates an old version that is still supported.
  • DEPRECATED: indicates a deprecated version that may be deleted later.

updated

+

String

+

Specifies the version release time in UTC. For example, the release time format of v2.0 APIs is YYYY-MM-DDTHH:MM:SSZ.

+

min_version

+

String

+

Specifies the version. If APIs of this version support minor versions, set this parameter to the supported minimum minor version. If minor versions are not supported, leave this parameter blank.

+

Examples

  • Example request
    GET /
    -
  • Example response
    {
    - "versions": [
    -    {
    -      "status": "CURRENT",
    -      "id": "v2.0",
    -      "links":[
    +
  • Example response
    {
    +    "versions": [
             {
    -          "href": "https://network.az0.dc0.domainname.com/v2.0","rel": "self"
    -         }
    -      ]
    -    }
    -  ]
    +            "id": "v2.0",
    +            "links": [
    +                {
    +                    "href": "https://dcaas.eu-de.otc.t-systems.com/v2.0",
    +                    "rel": "self"
    +                }
    +            ],
    +            "min_version": "",
    +            "updated": "YYYY-MM-DDTHH:MM:SSZ",
    +            "status": "CURRENT",
    +            "version": ""
    +        }
    +    ]
     }
diff --git a/docs/dc/api-ref/en-dc_topic_0055025312.html b/docs/dc/api-ref/en-dc_topic_0055025312.html index fe67fa04..e03538f5 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025312.html +++ b/docs/dc/api-ref/en-dc_topic_0055025312.html @@ -7,7 +7,7 @@

Request

None

-

Response

Table 1 lists the response parameters.

+

Response

Table 1 lists the response parameters.

@@ -64,14 +64,14 @@ - - @@ -79,16 +79,16 @@

Examples

  • Example request
    GET /v2.0
    -
  • Example response
    {
    +
  • Example response
    {
       "version": {
         "id": "v2.0",
         "links": [
           {
    -        "href": "https://dcaas.***region.myhwclouds.com/v2.0",
    +        "href": "https://dcaas.eu-de.otc.t-systems.com/v2.0",
             "rel": "self"
           }
         ],
    -    "updated": "2017-11-30T00:00:00Z",
    +    "updated": "YYYY-MM-DDTHH:MM:SSZ",
         "status": "CURRENT",
         "version": "",
         "min_version": ""
    diff --git a/docs/dc/api-ref/en-dc_topic_0055025313.html b/docs/dc/api-ref/en-dc_topic_0055025313.html
    index cfd28dd2..d1782aab 100644
    --- a/docs/dc/api-ref/en-dc_topic_0055025313.html
    +++ b/docs/dc/api-ref/en-dc_topic_0055025313.html
    @@ -19,7 +19,7 @@
     
diff --git a/docs/dc/api-ref/en-dc_topic_0055025314.html b/docs/dc/api-ref/en-dc_topic_0055025314.html index d71b77b6..9ec17eaa 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025314.html +++ b/docs/dc/api-ref/en-dc_topic_0055025314.html @@ -1,337 +1,562 @@

Overview

-

Object Introduction

This section describes APIs for managing and operating connections, including the APIs used to create, query, update, and delete a connection, and the API used to query the connection list.

+

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 Model

-
Table 1 Response parameters

Parameter

String

Specifies the version release time in UTC. Specifies the time when v1 APIs are released, for example, 2014-06-28T12:20:21Z.

+

Specifies the version release time in UTC. For example, the release time format of v2.0 APIs is YYYY-MM-DDTHH:MM:SSZ.

min_version

String

Specifies the version. If APIs of this version supports minor versions, set this parameter to the supported minimum minor version. If minor versions are not supported, leave this parameter blank.

+

Specifies the version. If APIs of this version support minor versions, set this parameter to the supported minimum minor version. If minor versions are not supported, leave this parameter blank.

Table 1 Connection objects

Attribute

+

Object Model

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Connection objects

Parameter

Type

+

Type

CRUD

+

CRUD

Default Value

+

Default Value

Constraint

+

Constraint

Description

+

Description

id

+

id

String

+

String

R

+

R

Automatically generated

+

Automatically generated

uuid

+

UUID

Specifies the connection ID.

+

Specifies the connection ID.

tenant_id

+

tenant_id

String

+

String

CR

+

CR

N/A

+

N/A

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the tenant ID.

+

Specifies the tenant ID.

name

+

name

String

+

String

CRU

+

CRU

None

+

None

The value can contain 0 to 64 characters.

-

The name can contain only digits, letters, underscores (_), and hyphens (-).

+

The value can contain 0 to 64 characters.

+

Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

Specifies the connection name.

+

Specifies the connection name.

description

+

description

String

+

String

CRU

+

CRU

None

+

None

The value can contain 0 to 128 characters.

+

The value can contain 0 to 128 characters.

+

Angle brackets (<>) are not allowed.

Provides supplementary information about the connection.

+

Provides supplementary information about the connection.

port_type

+

port_type

String

+

String

CR

+

CR

None

+

None

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

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

+

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

bandwidth

+

bandwidth

Integer

+

Integer

CRU

+

CRU

N/A

+

N/A

Bandwidth range: 2 Mbit/s to 20,000 Mbit/s

+

Bandwidth range: 2 Mbit/s to 20,000 Mbit/s

Specifies the bandwidth of the connection in Mbit/s.

+

Specifies the bandwidth of the connection in Mbit/s.

location

+

location

String

+

String

CR

+

CR

None

+

None

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the connection access location.

+

Specifies the connection access location.

peer_location

+

peer_location

String

+

String

CR

+

CR

None

+

None

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.

+

Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.

device_id

+

device_id

String

+

String

CR

+

CR

None

+

None

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the gateway device ID of the connection.

+

Specifies the gateway device ID of the connection.

interface_name

+

interface_name

String

+

String

CR

+

CR

None

+

None

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the name of the interface accessed by the connection.

+

Specifies the name of the interface accessed by the connection.

redundant_id

+

redundant_id

String

+

String

CR

+

CR

None

+

None

uuid

+

UUID

Specifies the ID of the redundant connection using the same gateway.

+

Specifies the ID of the redundant connection using the same gateway.

provider

+

provider

String

+

String

CR

+

CR

None

+

None

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the carrier who provides the leased line.

+

Specifies the carrier who provides the leased line.

provider_status

+

provider_status

String

+

String

CRU

+

CRU

DOWN

+

DOWN

N/A

+

N/A

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

+

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

type

+

type

String

+

String

CR

+

CR

standard

+

standard

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the connection type. The value can be standard, hosting, or hosted.

+

Specifies the connection type. The value can be standard, hosting, or hosted.

+

You can only create hosted connections by calling APIs.

hosting_id

+

hosting_id

String

+

String

CR

+

CR

None

+

None

uuid

+

UUID

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

Integer

+

Integer

CR

+

CR

N/A

+

N/A

<1, 4063>

+

<1, 4063>

Specifies the pre-allocated Virtual Local Area Network (VLAN) to-of the hosted connection.

+

Specifies the VLAN pre-allocated to the hosted connection.

charge_mode

+

charge_mode

String

+

String

CR

+

CR

prepayment

+

prepayment

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

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

+

Specifies the billing mode. This parameter is not mandatory. The value can only be port for operations connections.

+

This parameter is not possible to be used for hosted connections.

apply_time

+

apply_time

String

+

String

R

+

R

N/A

+

N/A

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the time when the connection is requested.

+

Specifies the time when the connection was requested.

create_time

+

create_time

String

+

String

R

+

R

N/A

+

N/A

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the time when the connection is created.

+

Specifies the time when the connection is created.

delete_time

+

delete_time

String

+

String

R

+

R

N/A

+

N/A

The value can contain 0 to 255 characters.

+

The value can contain 0 to 255 characters.

Specifies the time when the connection is deleted.

+

Specifies the time when the connection was deleted.

order_id

+

order_id

String

+

String

CRU

+

CRU

None

+

None

The value can contain 0 to 64 characters.

+

The value can contain 0 to 64 characters.

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

CRU

+

CRU

None

+

None

The value can contain 0 to 64 characters.

+

The value can contain 0 to 64 characters.

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, which is used to custom billing policies such as duration-based packages.

status

+

status

String

+

String

CR

+

CR

DOWN

+

DOWN

N/A

+

N/A

Specifies the connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT, or REJECTED.

+

Specifies the operating status of the connection. The value can be ACTIVE, DOWN, BUILD, or ERROR.

+
  • ACTIVE: The connection has been created and is normal.
  • DOWN: The port is down.
  • BUILD: The connection is being created.
  • ERROR: The connection is abnormal.

admin_state_up

+

admin_state_up

Boolean

+

Boolean

CR

+

CR

true

+

true

The value can only be true.

+

The value can only be true.

Specifies the administrative status of the connection.

+

Specifies the administrative status of the connection.

The value can be true or false.

spec_code

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

applicant

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

mobile

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

email

+

String

+

CR

+

None

+

The value consists of 1 to 255 characters.

+

This is a reserved field, which is not used currently.

+

region_id

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

service_key

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

cable_label

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

peer_port_type

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

peer_provider

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

onestop_product_id

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

building_line_product_id

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

last_onestop_product_id

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

period_type

+

Integer

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

period_num

+

Integer

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

reason

+

String

+

CR

+

None

+

N/A

+

This is a reserved field, which is not used currently.

+

vgw_type

+

String

+

CR

+

default

+

default

+

Specifies the type of the gateway. Currently, only the default type is supported.

+

lag_id

+

String

+

CR

+

None

+

UUID

+

This is a reserved field, which is not used currently.

+
diff --git a/docs/dc/api-ref/en-dc_topic_0055025315.html b/docs/dc/api-ref/en-dc_topic_0055025315.html index 497d98c2..4e917190 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025315.html +++ b/docs/dc/api-ref/en-dc_topic_0055025315.html @@ -1,227 +1,221 @@ -

Creating a Connection

-

Function

This API is used to create a connection.

-
  1. When you create a hosted connection that does not need to be confirmed, set Status to ACCEPT.
  2. The bandwidth of a hosted connection cannot exceed that of the associated operations connection.
+

Creating a Connection

+

Function

This API is used to create a hosted connection.

+

This API can only be used to create hosted connections.

URI

POST /v2.0/dcaas/direct-connects

-
Table 1 Parameter description

Parameter

+
- - - - - - -
Table 1 Parameter description

Parameter

Type

+

Type

Mandatory

+

Mandatory

Description

+

Description

direct_connect

+

direct_connect

Dictionary data structure

+

Dictionary

Yes

+

Yes

Specifies the direct_connect object.

+

Specifies the direct_connect object.

-

Request

Table 2 lists the direct_connect request parameters.

+

Request

For details about the direct_connect field, see Table 2.

-
Table 2 Request parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -233,7 +227,7 @@
Table 2 Request parameters

Parameter

Type

+

Type

Mandatory

+

Mandatory

Description

+

Description

tenant_id

+

tenant_id

String

+

String

No

+

No

Specifies the project ID.

+

Specifies the project ID.

name

+

name

String

+

String

No

+

No

Specifies the connection name.

+

Specifies the connection name.

+

Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

description

+

description

String

+

String

No

+

No

Provides supplementary information about the connection.

+

Provides supplementary information about the connection.

+

Angle brackets (<>) are not allowed.

port_type

+

port_type

String

+

String

Yes

+

Yes

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

+

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

bandwidth

+

bandwidth

Integer

+

Integer

Yes

+

Yes

Specifies the connection bandwidth in Mbit/s.

+

Specifies the bandwidth of the connection in Mbit/s.

location

+

location

String

+

String

Yes

+

Yes

Specifies the connection access location.

+

Specifies the connection access location.

peer_location

+

peer_location

String

+

String

No

+

No

Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.

+

Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.

device_id

+

device_id

String

+

String

No

+

No

Specifies the gateway device ID of the connection.

+

Specifies the gateway device ID of the connection.

interface_name

+

interface_name

String

+

String

No

+

No

Specifies the name of the interface accessed by the connection.

+

Specifies the name of the interface accessed by the connection.

redundant_id

+

redundant_id

String

+

String

No

+

No

Specifies the ID of the redundant connection using the same gateway.

+

Specifies the ID of the redundant connection using the same gateway.

provider

+

provider

String

+

String

Yes

+

Yes

Specifies the carrier who provides the leased line.

+

Specifies the carrier who provides the leased line.

provider_status

+

provider_status

String

+

String

No

+

No

Specifies the status of the carrier's leased line.

+

Specifies the status of the carrier's leased line.

The value can be ACTIVE or DOWN.

type

+

type

String

+

String

No

+

No

Specifies the connection type. The value can be hosted.

+

Specifies the connection type. The value can only be hosted.

hosting_id

+

hosting_id

String

+

String

No

+

No

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

+

charge_mode

Integer

+

String

No

+

No

Specifies the VLAN pre-allocated to the hosted connection.

+

Specifies the billing mode. This parameter is not mandatory. The value can only be port for operations connections.

+

This parameter is not possible to be used for hosted connections.

charge_mode

+

order_id

String

+

String

No

+

No

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

+

Specifies the order number of the connection.

order_id

+

product_id

String

+

String

No

+

No

Specifies the order number of the connection.

+

Specifies the product ID corresponding to the connection's order.

product_id

+

status

String

+

String

No

+

No

Specifies the product ID corresponding to the connection's order.

-

status

-

String

-

No

-

Specifies the connection status.

+

Specifies the connection status.

The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT, or REJECTED.

admin_state_up

+

admin_state_up

Boolean

+

Boolean

No

+

No

Specifies the administrative status of the connection.

+

Specifies the administrative status of the connection.

The value can be true or false.

- @@ -241,7 +235,7 @@ - @@ -249,230 +243,64 @@
Table 3 Response parameter

Parameter

Type

+

Type

Description

direct_connect

Dictionary data structure

+

Dictionary

Specifies the direct_connect object.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Description of field direct_connect

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the connection ID.

-

tenant_id

-

String

-

Specifies the project ID.

-

name

-

String

-

Specifies the connection name.

-

description

-

String

-

Provides supplementary information about the connection.

-

port_type

-

String

-

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

-

bandwidth

-

Integer

-

Specifies the bandwidth of the connection in Mbit/s.

-

location

-

String

-

Specifies the connection access location.

-

peer_location

-

String

-

Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.

-

device_id

-

String

-

Specifies the gateway device ID of the connection.

-

interface_name

-

String

-

Specifies the name of the interface accessed by the connection.

-

redundant_id

-

String

-

Specifies the ID of the redundant connection using the same gateway.

-

provider

-

String

-

Specifies the carrier who provides the leased line.

-

provider_status

-

String

-

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

-

type

-

String

-

Specifies the connection type. The value can be hosted.

-

hosting_id

-

String

-

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

-

vlan

-

Integer

-

Specifies the pre-allocated VLAN to the hosted connection.

-

charge_mode

-

String

-

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

-

Its value is left blank by default.

-

apply_time

-

String

-

Specifies the time when the connection is requested.

-

create_time

-

String

-

Specifies the time when the connection is created.

-

delete_time

-

String

-

Specifies the time when the connection is deleted.

-

order_id

-

String

-

Specifies the order number of the connection.

-

product_id

-

String

-

Specifies the product ID corresponding to the connection's order.

-

status

-

String

-

Specifies the connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT, or REJECTED.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the connection.

-

The value can be true or false.

-
-
+

For details about the direct_connect field, see Table 1.

Examples

  • Example request
    POST /v2.0/dcaas/direct-connects 
     { 
         "direct_connect" : { 
    -        "name" : "direct connect1", 
    -        "port_type" : "10G", 
    -        "bandwidth" : 100, 
    -        "location" : "Biere", 
    -        "device_id" : "172.16.40.2", 
    -        "provider" : "OTC" 
    +        "name": "client-dc-55df",
    +        "bandwidth": 2,
    +        "description": "",
    +        "type": "hosted",
    +        "vlan": "1234",
    +        "port_type": "1G",
    +        "location": "Biere",
    +        "provider": "OTC",
    +        "hosting_id": "07fa7f82-826f-4bf1-9a90-8364e53b91f4",
    +        "tenant_id": "06057682ed80d5762f25c00b5deb794a"
         } 
     } 
  • Example response
    {
    -    "direct_connect" : {
    -        "bandwidth" : 100,
    -        "create_time": "2018-10-19 09:53:26.389556", 
    -        "port_type" : "10G",
    -        "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
    -        "apply_time": "2018-10-19 09:53:26.389556", 
    -        "peer_location": "",
    -        "delete_time": null, 
    -        "location" : "Biere", 
    -        "provider" : "OTC"
    -        "interface_name": "Eth-Trunk2", 
    -        "type": "standard",
    -        "status": "BUILD",
    -        "description" : "",
    -        "provider_status": "ACTIVE", "order_id": "", "vlan": null,
    -        "device_id" : "172.16.40.2",
    -        "name" : "direct connect1", 
    -        "admin_state_up": true, 
    -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
    -        "redundant_id": null,
    -        "hosting_id": null, 
    -        "product_id": "", 
    -        "charge_mode": ""
    -    }
    +	"direct_connect" : {
    +		"id" : "10a91e67-90e9-4b06-87c8-e762296fada1",
    +		"name" : "client-dc-65de",
    +		"description" : "",
    +		"tenant_id" : "06057682ed80d5762f25c00b5deb794a",
    +		"type" : "hosted",
    +		"hosting_id" : "07fa7f82-826f-4bf1-9a90-8364e53b91f4",
    +		"vlan" : 1234,
    +		"charge_mode" : null,
    +		"port_type" : "1G",
    +		"bandwidth" : 2,
    +		"location" : "Biere",
    +		"peer_location" : "",
    +		"device_id" : "18.8.215.131",
    +		"provider" : "OTC",
    +		"provider_status" : "ACTIVE",
    +		"status" : "BUILD",
    +		"apply_time" : "2023-02-12T23:46:26.000Z",
    +		"reason" : null,
    +		"admin_state_up" : true,
    +		"order_id" : null,
    +		"product_id" : null,
    +		"spec_code" : null,
    +		"create_time" : "2023-02-12T23:46:26.000Z",
    +		"peer_port_type" : null,
    +		"peer_provider" : null,
    +		"onestop_product_id" : null,
    +		"building_line_product_id" : null,
    +		"last_building_line_product_id" : null,
    +		"last_onestop_product_id" : null,
    +		"period_type" : null,
    +		"period_num" : null,
    +		"vgw_type" : "default",
    +		"lag_id" : null
    +	}
     }
-

Returned Value

For details, see section Common Returned Values.

+

Status Codes

For details, see Common Status Codes.

diff --git a/docs/dc/api-ref/en-dc_topic_0055025316.html b/docs/dc/api-ref/en-dc_topic_0055025316.html index 283534f5..38b9882c 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025316.html +++ b/docs/dc/api-ref/en-dc_topic_0055025316.html @@ -3,25 +3,25 @@

Querying the Connection List

Function

This API is used to query the connection list.

-

URI

GET /v2.0/dcaas/direct-connects

+

URI

GET /v2.0/dcaas/direct-connects

-
Table 1 Parameter description

Parameter

+
- - - - - - - @@ -30,23 +30,23 @@

Request

Table 2 lists the request parameter.

-
Table 1 Parameter description

Parameter

Type

+

Type

Mandatory

+

Mandatory

Description

+

Description

direct_connects

+

direct_connects

List data structure

+

List

Yes

+

Yes

Specifies the connection list.

+

Specifies the connection list.

Table 2 Request parameter

Parameter

+
- - - - - - - @@ -54,230 +54,80 @@
Table 2 Request parameter

Parameter

Type

+

Type

Mandatory

+

Mandatory

Description

+

Description

fields

+

fields

String

+

String

No

+

No

Specifies the parameters expected to be returned.

+

Specifies the parameters expected to be returned.

If you do not specify it, all parameters will be returned.

-

Response

Table 3 lists the response parameter.

+

Response

Table 3 lists the response parameter.

-
Table 3 Response parameter

Parameter

+
- - - - -
Table 3 Response parameter

Parameter

Type

+

Type

Description

+

Description

direct_connects

+

direct_connects

List data structure

+

List

Specifies the connection list.

+

Specifies the connection list.

-

Table 4 lists the direct_connects parameters.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the connection ID.

-

tenant_id

-

String

-

Specifies the project ID.

-

name

-

String

-

Specifies the connection name.

-

description

-

String

-

Provides supplementary information about the connection.

-

port_type

-

String

-

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

-

bandwidth

-

Integer

-

Specifies the bandwidth of the connection in Mbit/s.

-

location

-

String

-

Specifies the connection access location.

-

peer_location

-

String

-

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

-

device_id

-

String

-

Specifies the gateway device ID of the connection.

-

interface_name

-

String

-

Specifies the name of the interface accessed by the connection.

-

redundant_id

-

String

-

Specifies the ID of the redundant connection using the same gateway.

-

provider

-

String

-

Specifies the carrier who provides the leased line.

-

provider_status

-

String

-

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

-

type

-

String

-

Specifies the connection type. The value can be hosted.

-

hosting_id

-

String

-

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

-

vlan

-

Integer

-

Specifies the VLAN pre-allocated to the hosted connection.

-

charge_mode

-

String

-

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

-

apply_time

-

String

-

Specifies the time when the connection is requested.

-

create_time

-

String

-

Specifies the time when the connection is created.

-

delete_time

-

String

-

Specifies the time when the connection is deleted.

-

order_id

-

String

-

Specifies the order number of the connection.

-

product_id

-

String

-

Specifies the product ID corresponding to the connection's order.

-

status

-

String

-

Specifies the connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT, or REJECTED.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the connection.

-

The value can be true or false.

-
+

For details about the direct_connects field, see Table 1.

- -

Examples

  • Example request
    1. All parameters are returned:
    +

    Examples

    • Example request
      1. Querying all connections
      GET /v2.0/dcaas/direct-connects
      -
      1. Filtered parameters are returned (for example, the filter is ID):
      +
      1. Querying a connection using its ID
      GET /v2.0/dcaas/direct-connects?id=6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
    -
    • Example response
      {
      -    "direct_connect" : [{
      -        "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",        
      -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
      -        "name" : "direct connect1",
      -        "description" : "",
      -        "port_type" : "10G",
      -        "bandwidth" : 100,
      -        "location" : "Biere", 
      -        "device_id" : "172.16.40.2", 
      -        "provider" : "OTC"
      -    }]
      +
      • Example response
        { 
        +        "direct_connects" : [{ 
        +        "name": "direct connect",
        +        "id": "294ebeeb-62dd-4ece-99f5-73055df6d835",
        +        "description": "",
        +        "tenant_id": "0605768ad980d5762f8ac010b919754c",
        +        "type": "hosted",
        +        "hosting_id": "0e85c677-6eb5-4ef6-87a7-74d4586be895",
        +        "vlan": 228,
        +        "charge_mode": null,
        +        "port_type": "1G",
        +        "bandwidth": 2,
        +        "location": "Biere",
        +        "peer_location": "",
        +        "device_id": "18.8.215.131",
        +        "interface_name": "Eth-Trunk2",
        +        "redundant_id": null,
        +        "provider": "OTC",
        +        "provider_status": "ACTIVE",
        +        "status": "ACTIVE",
        +        "apply_time": "2022-12-08T01:59:36.000Z",
        +        "reason": null,
        +        "admin_state_up": true,
        +        "order_id": null,
        +        "product_id": null,
        +        "spec_code": null,
        +        "applicant": null,
        +        "mobile": null,
        +        "email": null,
        +        "create_time": "2022-12-08T01:59:36.000Z",
        +        "region_id": null,
        +        "service_key": null,
        +        "cable_label": null,
        +        "peer_port_type": null,
        +        "peer_provider": null,
        +        "onestop_product_id": null,
        +        "building_line_product_id": null,
        +        "last_onestop_product_id": null,
        +        "period_type": null,
        +        "period_num": null,
        +        "vgw_type": "default",
        +        "lag_id": null
        +    }] 
         }
      -

      Returned Value

      For details, see section Common Returned Values.

      +

      Status Codes

      For details, see Common Status Codes.

      diff --git a/docs/dc/api-ref/en-dc_topic_0055025317.html b/docs/dc/api-ref/en-dc_topic_0055025317.html index afeeed8f..b009cdc8 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025317.html +++ b/docs/dc/api-ref/en-dc_topic_0055025317.html @@ -1,9 +1,9 @@ -

      Deleting a Connection

      -

      Function

      This API is used to delete a connection.

      +

      Deleting a Connection

      +

      Function

      This API is used to delete a connection.

      -

      URI

      DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}

      +

      URI

      DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}

      @@ -21,7 +21,7 @@ - @@ -35,7 +35,7 @@

      Examples

      • Example request
      DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}
      -

      Returned Value

      For details, see section Common Returned Values.

      +

      Status Codes

      For details, see Common Status Codes.

      diff --git a/docs/dc/api-ref/en-dc_topic_0055025318.html b/docs/dc/api-ref/en-dc_topic_0055025318.html index 42791494..d7f9429e 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025318.html +++ b/docs/dc/api-ref/en-dc_topic_0055025318.html @@ -30,11 +30,11 @@

      Request

      None

      -

      Response

      Table 2 lists the response parameter.

      +

      Response

      Table 2 lists the response parameter.

      Table 1 Parameter description

      Parameter

      Yes

      Indicates the connection ID.

      +

      Specifies the connection ID.

      - @@ -42,7 +42,7 @@ - @@ -50,220 +50,57 @@
      Table 2 Response parameter

      Parameter

      Type

      +

      Type

      Description

      direct_connect

      Dictionary data structure

      +

      Dictionary

      Specifies the direct_connect object.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 3 Description of field direct_connect

      Parameter

      -

      Type

      -

      Description

      -

      id

      -

      String

      -

      Specifies the connection ID.

      -

      tenant_id

      -

      String

      -

      Specifies the project ID.

      -

      name

      -

      String

      -

      Specifies the connection name.

      -

      description

      -

      String

      -

      Provides supplementary information about the connection.

      -

      port_type

      -

      String

      -

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

      -

      bandwidth

      -

      Integer

      -

      Specifies the bandwidth of the connection in Mbit/s.

      -

      location

      -

      String

      -

      Specifies the connection access location.

      -

      peer_location

      -

      String

      -

      Specifies the physical location of the peer device accessed by the connection. The value can be a street, city, and province, or an IDC.

      -

      device_id

      -

      String

      -

      Specifies the gateway device ID of the connection.

      -

      interface_name

      -

      String

      -

      Specifies the name of the interface accessed by the connection.

      -

      redundant_id

      -

      String

      -

      Specifies the ID of the redundant connection using the same gateway.

      -

      provider

      -

      String

      -

      Specifies the carrier who provides the leased line.

      -

      provider_status

      -

      String

      -

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

      -

      type

      -

      String

      -

      Specifies the connection type. The value can be hosted.

      -

      hosting_id

      -

      String

      -

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

      -

      vlan

      -

      Integer

      -

      Specifies the VLAN pre-allocated to the hosted connection.

      -

      charge_mode

      -

      String

      -

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

      -

      apply_time

      -

      String

      -

      Specifies the time when the connection is requested.

      -

      create_time

      -

      String

      -

      Specifies the time when the connection is created.

      -

      delete_time

      -

      String

      -

      Specifies the time when the connection is deleted.

      -

      order_id

      -

      String

      -

      Specifies the order number of the connection.

      -

      product_id

      -

      String

      -

      Specifies the product ID corresponding to the connection's order.

      -

      status

      -

      String

      -

      Specifies the connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT, or REJECTED.

      -

      admin_state_up

      -

      Boolean

      -

      Specifies the administrative status of the connection.

      -

      The value can be true or false.

      -
      -
      +

      For details about the direct_connect field, see Table 1.

      Examples

      • Example request
      GET /v2.0/dcaas/direct-connects/{direct_connect_id}
      -
      • Example response
        {
        -    "direct_connect" : {
        -        "bandwidth" : 100,
        -        "create_time": "2018-10-19 09:53:26.389556", 
        -        "port_type" : "10G",
        -        "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
        -        "apply_time": "2018-10-19 09:53:26.389556", 
        -        "peer_location": "", "delete_time": null, 
        -        "location" : "Biere", 
        -        "provider" : "OTC"
        +
        • Example response
          { 
          +        "direct_connects" : { 
          +        "name": "direct connect",
          +        "id": "294ebeeb-62dd-4ece-99f5-73055df6d835",
          +        "description": "",
          +        "tenant_id": "0605768ad980d5762f8ac010b919754c",
          +        "type": "hosted",
          +        "hosting_id": "0e85c677-6eb5-4ef6-87a7-74d4586be895",
          +        "vlan": 228,
          +        "charge_mode": null,
          +        "port_type": "1G",
          +        "bandwidth": 2,
          +        "location": "Biere",
          +        "peer_location": "",
          +        "device_id": "18.8.215.131",
                   "interface_name": "Eth-Trunk2",
          -        "type": "standard",
          -        "status": "ACTIVE", 
          -        "description" : "",
          -        "provider_status": "ACTIVE",
          -        "order_id": "",
          -        "vlan": null,
          -        "device_id" : "172.16.40.2", 
          -        "name" : "direct connect1",
          -        "admin_state_up": true, 
          -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
                   "redundant_id": null,
          -        "hosting_id": null,
          -        "product_id": "",
          -        "charge_mode": ""
          -    }
          +        "provider": "OTC",
          +        "provider_status": "ACTIVE",
          +        "status": "ACTIVE",
          +        "apply_time": "2022-12-08T01:59:36.000Z",
          +        "reason": null,
          +        "admin_state_up": true,
          +        "order_id": null,
          +        "product_id": null,
          +        "spec_code": null,
          +        "applicant": null,
          +        "mobile": null,
          +        "email": null,
          +        "create_time": "2022-12-08T01:59:36.000Z",
          +        "region_id": null,
          +        "service_key": null,
          +        "cable_label": null,
          +        "peer_port_type": null,
          +        "peer_provider": null,
          +        "onestop_product_id": null,
          +        "building_line_product_id": null,
          +        "last_onestop_product_id": null,
          +        "period_type": null,
          +        "period_num": null,
          +        "vgw_type": "default",
          +        "lag_id": null
          +    } 
           }
        -

        Returned Value

        For details, see section Common Returned Values.

        +

        Status Codes

        For details, see Common Status Codes.

        diff --git a/docs/dc/api-ref/en-dc_topic_0055025319.html b/docs/dc/api-ref/en-dc_topic_0055025319.html index a04ad2b3..06593ac7 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025319.html +++ b/docs/dc/api-ref/en-dc_topic_0055025319.html @@ -1,29 +1,27 @@ -

        Updating a Connection

        -

        Function

        This API is used to update a connection.

        -
        1. You can only increase the connection bandwidth.
        2. Bandwidths of the operations connections cannot be modified.
        -
        +

        Updating a Connection

        +

        Function

        This API is used to update a connection.

        URI

        PUT /v2.0/dcaas/direct-connects/{direct_connect_id}

        -
        Table 1 Parameter description

        Parameter

        +
        - - - - - - - @@ -32,299 +30,103 @@

        Request

        Table 2 lists the request parameter.

        -
        Table 1 Parameter description

        Parameter

        Type

        +

        Type

        Mandatory

        +

        Mandatory

        Description

        +

        Description

        direct_connect_id

        +

        direct_connect_id

        String

        +

        String

        No

        +

        No

        Specifies the connection ID.

        +

        Specifies the connection ID.

        Table 2 Request parameter

        Parameter

        +
        - - - - - - -
        Table 2 Request parameter

        Parameter

        Type

        +

        Type

        Mandatory

        +

        Mandatory

        Description

        +

        Description

        direct_connect

        +

        direct_connect

        Dictionary data structure

        +

        Dictionary

        No

        +

        No

        Specifies the direct_connect object.

        +

        Specifies the direct_connect object.

        -
        Table 3 Description of field direct_connect

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Table 3 Description of field direct_connect

        Parameter

        Type

        +

        Type

        Mandatory

        +

        Mandatory

        Description

        +

        Description

        description

        +

        description

        String

        +

        String

        No

        +

        No

        Provides supplementary information about the connection.

        +

        Provides supplementary information about the connection.

        +

        Angle brackets (<>) are not allowed.

        name

        +

        name

        String

        +

        String

        No

        +

        No

        Specifies the connection name.

        +

        Specifies the connection name.

        +

        Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

        bandwidth

        +

        bandwidth

        Integer

        +

        Integer

        No

        +

        No

        Specifies the bandwidth of the connection in Mbit/s.

        +

        Specifies the bandwidth of the connection in Mbit/s.

        provider_status

        +

        provider_status

        String

        +

        String

        No

        +

        No

        Specifies the status of the carrier's leased line.

        +

        Specifies the status of the carrier's leased line.

        The value can be ACTIVE or DOWN.

        order_id

        -

        String

        -

        No

        -

        Specifies the order number of the connection.

        -

        product_id

        -

        String

        -

        No

        -

        Specifies the product ID corresponding to the connection's order.

        -
        -

        Response

        Table 4 lists the response parameter.

        +

        Response

        Table 4 lists the response parameter.

        -
        Table 4 Response parameter

        Parameter

        +
        - - - - - - - -
        Table 4 Response parameter

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        direct_connect

        +

        direct_connect

        Dictionary data structure

        +

        Dictionary

        Specifies the direct_connect object.

        -
        -
        - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Table 5 Description of field direct_connect

        Parameter

        -

        Type

        -

        Description

        -

        id

        -

        String

        -

        Specifies the connection ID.

        -

        tenant_id

        -

        String

        -

        Specifies the project ID.

        -

        name

        -

        String

        -

        Specifies the connection name.

        -

        description

        -

        String

        -

        Provides supplementary information about the connection.

        -

        port_type

        -

        String

        -

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

        -

        bandwidth

        -

        Integer

        -

        Specifies the bandwidth of the connection in Mbit/s.

        -

        location

        -

        String

        -

        Specifies the connection access location.

        -

        peer_location

        -

        String

        -

        Specifies the physical location of the peer device accessed by the connection. The value can be a street, city, and province, or an IDC.

        -

        device_id

        -

        String

        -

        Specifies the gateway device ID of the connection.

        -

        interface_name

        -

        String

        -

        Specifies the name of the interface accessed by the connection.

        -

        redundant_id

        -

        String

        -

        Specifies the ID of the redundant connection using the same gateway.

        -

        provider

        -

        String

        -

        Specifies the carrier who provides the leased line.

        -

        provider_status

        -

        String

        -

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

        -

        type

        -

        String

        -

        Specifies the connection type. The value can be hosted.

        -

        hosting_id

        -

        String

        -

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

        -

        vlan

        -

        Integer

        -

        Specifies the pre-allocated VLAN to the hosted connection.

        -

        charge_mode

        -

        String

        -

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

        -

        apply_time

        -

        String

        -

        Specifies the time when the connection is requested.

        -

        create_time

        -

        String

        -

        Specifies the time when the connection is created.

        -

        delete_time

        -

        String

        -

        Specifies the time when the connection is deleted.

        -

        order_id

        -

        String

        -

        Specifies the order number of the connection.

        -

        product_id

        -

        String

        -

        Specifies the product ID corresponding to the connection's order.

        -

        status

        -

        String

        -

        Specifies the connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT, or REJECTED.

        -

        admin_state_up

        -

        Boolean

        -

        Specifies the administrative status of the connection.

        -

        The value can be true or false.

        +

        Specifies the direct_connect object.

        +

        For details about the direct_connect field, see Table 1.

        Examples

        • Example request
          PUT /v2.0/dcaas/direct-connects/{direct_connect_id}
           {
          @@ -335,21 +137,52 @@
           }
        -
        • Example response
          {
          -    "direct_connect" : {
          -        "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",        
          -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
          -        "name" : "direct connect1",
          -        "description" : "",
          -        "port_type" : "10G",
          -        "bandwidth" : 100,
          -        "location" : "Biere", 
          -        "device_id" : "172.16.40.2", 
          -        "provider" : "OTC"
          -    }
          +
          • Example response
            { 
            +        "direct_connects" : { 
            +        "name": "direct connect",
            +        "id": "294ebeeb-62dd-4ece-99f5-73055df6d835",
            +        "description": "",
            +        "tenant_id": "0605768ad980d5762f8ac010b919754c",
            +        "type": "hosted",
            +        "hosting_id": "0e85c677-6eb5-4ef6-87a7-74d4586be895",
            +        "vlan": 228,
            +        "charge_mode": null,
            +        "port_type": "1G",
            +        "bandwidth": 2,
            +        "location": "Biere",
            +        "peer_location": "",
            +        "device_id": "18.8.215.131",
            +        "interface_name": "Eth-Trunk2",
            +        "redundant_id": null,
            +        "provider": "OTC",
            +        "provider_status": "ACTIVE",
            +        "status": "ACTIVE",
            +        "apply_time": "2022-12-08T01:59:36.000Z",
            +        "reason": null,
            +        "admin_state_up": true,
            +        "order_id": null,
            +        "product_id": null,
            +        "spec_code": null,
            +        "applicant": null,
            +        "mobile": null,
            +        "email": null,
            +        "create_time": "2022-12-08T01:59:36.000Z",
            +        "region_id": null,
            +        "service_key": null,
            +        "cable_label": null,
            +        "peer_port_type": null,
            +        "peer_provider": null,
            +        "onestop_product_id": null,
            +        "building_line_product_id": null,
            +        "last_onestop_product_id": null,
            +        "period_type": null,
            +        "period_num": null,
            +        "vgw_type": "default",
            +        "lag_id": null
            +    } 
             }
          -

          Returned Value

          For details, see section Common Returned Values.

          +

          Status Codes

          For details, see Common Status Codes.

          diff --git a/docs/dc/api-ref/en-dc_topic_0055025320.html b/docs/dc/api-ref/en-dc_topic_0055025320.html index 83533925..4e539485 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025320.html +++ b/docs/dc/api-ref/en-dc_topic_0055025320.html @@ -1,8 +1,11 @@ -

          Virtual Gateway

          -

          + +

          Virtual Gateway

          + +

          +
          diff --git a/docs/dc/api-ref/en-dc_topic_0055025321.html b/docs/dc/api-ref/en-dc_topic_0055025321.html index e641602f..68a13a0a 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025321.html +++ b/docs/dc/api-ref/en-dc_topic_0055025321.html @@ -1,182 +1,226 @@

          Overview

          -

          Object Introduction

          This section describes the APIs for managing and operating the virtual gateway, including the APIs used to create, query, update, and delete a virtual gateway, and the API used to query the virtual gateway list.

          +

          Object Introduction

          This section describes the APIs for managing and operating the virtual gateway, including the APIs used to create, query, update, and delete a virtual gateway, and the API used to query the virtual gateway list.

          +

          Virtual gateway APIs do not support IPv6 addresses.

          +
          -

          Object Model

          -
          Table 1 Virtual gateway objects

          Attribute

          +

          Object Model

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
          Table 1 Virtual gateway objects

          Parameter

          Type

          +

          Type

          CRUD

          +

          CRUD

          Default Value

          +

          Default Value

          Constraint

          +

          Constraint

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          R

          +

          R

          Automatically generated

          +

          Automatically generated

          uuid

          +

          UUID

          Specifies the virtual gateway ID.

          +

          Specifies the virtual gateway ID.

          tenant_id

          +

          tenant_id

          String

          +

          String

          CR

          +

          CR

          N/A

          +

          N/A

          The value can contain 0 to 255 characters.

          +

          The value can contain 0 to 255 characters.

          Specifies the tenant ID.

          +

          Specifies the tenant ID.

          name

          +

          name

          String

          +

          String

          CRU

          +

          CRU

          None

          +

          None

          The value can contain 0 to 64 characters.

          -

          The name can contain only digits, letters, underscores (_), and hyphens (-).

          +

          The value can contain 0 to 64 characters.

          +

          Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

          Specifies the virtual gateway name.

          +

          Specifies the virtual gateway name.

          description

          +

          description

          String

          +

          String

          CRU

          +

          CRU

          None

          +

          None

          The value can contain 0 to 128 characters.

          +

          The value can contain 0 to 128 characters.

          +

          Angle brackets (<>) are not allowed.

          Provides supplementary information about the virtual gateway.

          +

          Provides supplementary information about the virtual gateway.

          vpc_id

          +

          vpc_id

          String

          +

          String

          CR

          +

          CR

          N/A

          +

          N/A

          uuid

          +

          UUID

          Specifies the ID of the VPC to be accessed.

          +

          Specifies the ID of the VPC to be accessed.

          local_ep_group_id

          +

          local_ep_group_id

          String

          +

          String

          CRU

          +

          CRU

          N/A

          +

          N/A

          uuid

          +

          UUID

          Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

          +

          Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

          device_id

          +

          device_id

          String

          +

          String

          CR

          +

          CR

          None

          +

          None

          The value can contain 0 to 255 characters.

          +

          The value can contain 0 to 255 characters.

          Specifies the ID of the physical device.

          +

          Specifies the ID of the physical device used by the virtual gateway.

          redundant_device_id

          +

          redundant_device_id

          String

          +

          String

          CR

          +

          CR

          None

          +

          None

          The value can contain 0 to 255 characters.

          +

          The value can contain 0 to 255 characters.

          Specifies the ID of the redundant device.

          +

          Specifies the ID of the redundant physical device used by the virtual gateway.

          type

          +

          type

          String

          +

          String

          CR

          +

          CR

          default

          +

          default

          The value can contain 0 to 255 characters.

          +

          The value can contain 0 to 255 characters.

          Specifies the virtual gateway type. The value can be default or double ipsec.

          +

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

          ipsec_bandwidth

          +

          ipsec_bandwidth

          Integer

          +

          Integer

          CR

          +

          CR

          N/A

          +

          1

          Bandwidth range: 1 Mbit/s to 300 Mbit/s

          +

          Bandwidth range: 1 Mbit/s to 300 Mbit/s

          Specifies the bandwidth provided for Internet Protocol security virtual private network (IPsec VPN) in Mbit/s.

          +

          This field is discarded.

          status

          +

          status

          String

          +

          String

          R

          +

          R

          NA

          +

          NA

          N/A

          +

          N/A

          Specifies the virtual gateway status.

          -

          Valid values are: ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, and PENDING_DELETE.

          +

          Specifies the operating status of the virtual gateway. The value can be ACTIVE, ERROR, PENDING_CREATE, or PENDING_UPDATE.

          +
          • ACTIVE: The virtual gateway is normal.
          • ERROR: The virtual gateway is abnormal.
          • PENDING_CREATE: The virtual gateway is being created.
          • PENDING_UPDATE: The virtual gateway is being updated.

          admin_state_up

          +

          admin_state_up

          Boolean

          +

          Boolean

          CR

          +

          CR

          true

          +

          true

          The value can only be true.

          +

          The value can only be true.

          Specifies the administrative status of the virtual gateway.

          +

          Specifies the administrative status of the virtual gateway.

          The value can be true or false.

          bgp_asn

          +

          Integer

          +

          CR

          +

          64512

          +

          N/A

          +

          Specifies the BGP ASN of the virtual gateway. This is a reserved field, which is not used currently.

          +

          region_id

          +

          String

          +

          CRU

          +

          None

          +

          N/A

          +

          This is a reserved field, which is not used currently.

          +

          local_ep_group_ipv6_id

          +

          String

          +

          CR

          +

          None

          +

          UUID

          +

          Specifies the ID of the local endpoint group that records CIDR blocks of the IPv6 VPC subnets.

          +
          NOTE:

          This is a reserved field. It can only be viewed in APIs and cannot be configured or used.

          +
          +
          diff --git a/docs/dc/api-ref/en-dc_topic_0055025322.html b/docs/dc/api-ref/en-dc_topic_0055025322.html index 762764c7..4a86d17e 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025322.html +++ b/docs/dc/api-ref/en-dc_topic_0055025322.html @@ -5,139 +5,132 @@

          URI

          POST /v2.0/dcaas/virtual-gateways

          -
          Table 1 Parameter description

          Parameter

          +
          - - - - - - -
          Table 1 Parameter description

          Parameter

          Type

          +

          Type

          Mandatory

          +

          Mandatory

          Description

          +

          Description

          virtual_gateway

          +

          virtual_gateway

          Dictionary data structure

          +

          Dictionary

          Yes

          +

          Yes

          Specifies the virtual_gateway object.

          +

          Specifies the virtual_gateway object.

          -

          Request

          Table 2 lists the virtual_gateway parameters.

          +

          Request

          For details about the virtual_gateway field, see Table 2.

          -
          Table 2 Request parameters

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -145,160 +138,60 @@
          Table 2 Request parameters

          Parameter

          Type

          +

          Type

          Mandatory

          +

          Mandatory

          Description

          +

          Description

          tenant_id

          +

          tenant_id

          String

          +

          String

          No

          +

          No

          Specifies the project ID.

          +

          Specifies the project ID.

          name

          +

          name

          String

          +

          String

          No

          +

          No

          Specifies the virtual gateway name.

          +

          Specifies the virtual gateway name.

          +

          Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

          description

          +

          description

          String

          +

          String

          No

          +

          No

          Provides supplementary information about the virtual gateway.

          +

          Provides supplementary information about the virtual gateway.

          +

          Angle brackets (<>) are not allowed.

          vpc_id

          +

          vpc_id

          String

          +

          String

          Yes

          +

          Yes

          Specifies the ID of the VPC to be accessed.

          +

          Specifies the ID of the VPC to be accessed.

          local_ep_group_id

          +

          local_ep_group_id

          String

          +

          String

          Yes

          +

          Yes

          Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

          +

          Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

          For details about how to obtain the ID, see section Creating an Endpoint Group.

          device_id

          +

          bgp_asn

          String

          +

          Integer

          No

          +

          No

          Specifies the ID of the physical device used by the virtual gateway.

          +

          Specifies the BGP ASN of the virtual gateway.

          redundant_device_id

          +

          device_id

          String

          +

          String

          No

          +

          No

          Specifies the ID of the redundant physical device used by the virtual gateway.

          +

          Specifies the ID of the physical device used by the virtual gateway.

          type

          +

          redundant_device_id

          String

          +

          String

          No

          +

          No

          Specifies the virtual gateway type. The value can be default or double ipsec.

          +

          Specifies the ID of the redundant physical device used by the virtual gateway.

          ipsec_bandwidth

          +

          type

          Integer

          +

          String

          No

          +

          No

          Specifies the bandwidth provided for IPsec VPN in Mbit/s.

          +

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

          bgp_asn

          +

          admin_state_up

          Integer

          +

          Boolean

          No

          +

          No

          Specifies the BGP ASN of the virtual gateway.

          -

          admin_state_up

          -

          Boolean

          -

          No

          -

          Specifies the administrative status of the virtual gateway.

          +

          Specifies the administrative status of the virtual gateway.

          The value can be true or false.

          -

          Response

          Table 3 lists the response parameter.

          +

          Response

          Table 3 lists the response parameter.

          -
          Table 3 Response parameter

          Parameter

          +
          - - - - -
          Table 3 Response parameter

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          virtual_gateway

          +

          virtual_gateway

          Dictionary data structure

          +

          Dictionary

          Specifies the virtual_gateway object.

          +

          Specifies the virtual_gateway object.

          - -
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 4 Description of field virtual_gateway

          Parameter

          -

          Type

          -

          Description

          -

          id

          -

          String

          -

          Specifies the virtual gateway ID.

          -

          tenant_id

          -

          String

          -

          Specifies the project ID.

          -

          name

          -

          String

          -

          Specifies the virtual gateway name.

          -

          description

          -

          String

          -

          Provides supplementary information about the virtual gateway.

          -

          vpc_id

          -

          String

          -

          Specifies the ID of the VPC to be accessed.

          -

          local_ep_group_id

          -

          String

          -

          Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

          -

          device_id

          -

          String

          -

          Specifies the ID of the physical device used by the virtual gateway.

          -

          redundant_device_id

          -

          String

          -

          Specifies the ID of the redundant physical device used by the virtual gateway.

          -

          type

          -

          String

          -

          Specifies the virtual gateway type. The value can be default or double ipsec.

          -

          ipsec_bandwidth

          -

          Integer

          -

          Specifies the bandwidth provided for IPsec VPN in Mbit/s.

          -

          bgp_asn

          -

          Integer

          -

          Specifies the BGP ASN of the virtual gateway.

          -

          admin_state_up

          -

          Boolean

          -

          Specifies the administrative status of the virtual gateway.

          -

          The value can be true or false.

          -

          status

          -

          String

          -

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

          -
          +

          For details about the virtual_gateway field, see Table 1.

          - -

          Examples

          • Example request
            POST /v2.0/dcaas/virtual-gateways
            -{
            -    "virtual_gateway" : {
            -        "name" : "virtual gateway1",
            -        "vpc_id" : "908d9cf3-da64-4acb-393f-e5eb6b9e838a",
            -        "local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab",
            -        "device_id" : "aaa_01"
            -    }
            +

            Examples

            • Example request
              POST /v2.0/dcaas/virtual-gateways 
              + { 
              +    "virtual_gateway" : { 
              +        "name" : "virtual gateway1", 
              +        "vpc_id" : "5352423b-b4ff-4a9e-839d-02698c2b36af ", 
              +        "local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab", 
              +        "device_id" : "aaa_01" 
              +    } 
               }
            -
            • Example response
              {
              -    "virtual_gateway":{
              -        "status": "PENDING_CREATE",
              -        "redundant_device_id": "", 
              -        "description":"",
              -        "admin_state_up": true,
              -        "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
              -        "name": "virtual gateway1",
              -        "local_ep_group_id":"011856d0-e1b0-4d78-b83a-edd67801764b",
              -        "vpc_id":"908d9cf3-da64-4acb-393f-e5eb6b9e838a",
              -        "device_id":"70.202.5.206",
              -        "type": "default",
              -        "id":"97b87776-49e3-44a4-ac4c-8f9156a360cd",
              -        "ipsec_bandwidth":1
              -    }
              +
              • Example response
                { 
                +    "virtual_gateway":{ 
                +            "id": "0a0888a6-4096-43a6-81c6-923912933451",
                +            "name": "virtual gateway",
                +            "description": null,
                +            "tenant_id": "0605768a3300d5762f82c01180692873",
                +            "vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af",
                +            "local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab",
                +            "local_ep_group_ipv6_id": null,
                +            "device_id": "aaa_01",
                +            "redundant_device_id": null,
                +            "type": "default",
                +            "ipsec_bandwidth": 1,
                +            "status": "PENDING_CREATE",
                +            "admin_state_up": true,
                +            "bgp_asn": null,
                +            "region_id": null
                +    } 
                 }
              -

              Returned Value

              For details, see section Common Returned Values.

              +

              Status Codes

              For details, see Common Status Codes.

              diff --git a/docs/dc/api-ref/en-dc_topic_0055025323.html b/docs/dc/api-ref/en-dc_topic_0055025323.html index 19f06505..46ae90fc 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025323.html +++ b/docs/dc/api-ref/en-dc_topic_0055025323.html @@ -31,7 +31,7 @@
          -

          Response

          Table 2 lists the response parameter.

          +

          Response

          Table 2 lists the response parameter.

          @@ -43,7 +43,7 @@ - @@ -51,131 +51,35 @@
          Table 2 Response parameter

          Parameter

          virtual_gateways

          List data structure

          +

          List

          Specifies the virtual gateway list.

          - -
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 3 Description of field virtual_gateways

          Parameter

          -

          Type

          -

          Description

          -

          id

          -

          String

          -

          Specifies the virtual gateway ID.

          -

          tenant_id

          -

          String

          -

          Specifies the project ID.

          -

          name

          -

          String

          -

          Specifies the virtual gateway name.

          -

          description

          -

          String

          -

          Provides supplementary information about the virtual gateway.

          -

          vpc_id

          -

          String

          -

          Specifies the ID of the VPC to be accessed.

          -

          local_ep_group_id

          -

          String

          -

          Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

          -

          device_id

          -

          String

          -

          Specifies the ID of the physical device used by the virtual gateway.

          -

          redundant_device_id

          -

          String

          -

          Specifies the ID of the redundant physical device used by the virtual gateway.

          -

          type

          -

          String

          -

          Specifies the virtual gateway type. The value can be default or double ipsec.

          -

          bgp_asn

          -

          Integer

          -

          Specifies the BGP ASN of the virtual gateway.

          -

          ipsec_bandwidth

          -

          Integer

          -

          Specifies the bandwidth provided for IPsec VPN in Mbit/s.

          -

          status

          -

          String

          -

          Specifies the virtual gateway status.

          -

          The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

          -

          admin_state_up

          -

          Boolean

          -

          Specifies the administrative status of the virtual gateway.

          -

          The value can be true or false.

          -
          +

          For details about the virtual_gateway field, see Table 1.

          -
          -

          Examples

          • Example request
            1. All parameters are returned:
            +

            Examples

            • Example request
              1. Querying all virtual gateways
              GET /v2.0/dcaas/virtual-gateways
              -
              1. Filtered parameters are returned (for example, the filter is ID):
              +
              1. Querying a virtual gateway by ID
              GET /v2.0/dcaas/virtual-gateways?id=7ec892f3-ca64-46c7-863f-a2eb1b9e8389
            -
            • Example response
              {
              -    "virtual_gateways" : [{
              -        "id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",                       
              -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
              -        "name" : "virtual gateway1",
              -        "description" : "",
              -        "vpc_id" : "908d9cf3-da64-4acb-393f-e5eb6b9e838a",
              -        "local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab",
              -        "device_id" : "aaa_01"
              -    }]
              +
              • Example response
                { 
                +    "virtual_gateways" : [{ 
                +            "id": "0a0888a6-4096-43a6-81c6-923912933451",
                +            "name": "virtual gateway",
                +            "description": null,
                +            "tenant_id": "0605768a3300d5762f82c01180692873",
                +            "vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af",
                +            "local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab",
                +            "local_ep_group_ipv6_id": null,
                +            "device_id": "aaa_01",
                +            "redundant_device_id": null,
                +            "type": "default",
                +            "ipsec_bandwidth": 1,
                +            "status": "PENDING_CREATE",
                +            "admin_state_up": true,
                +            "bgp_asn": 64512,
                +            "region_id": null
                +    }] 
                 }
              -

              Returned Value

              For details, see section Common Returned Values.

              +

              Status Codes

              For details, see Common Status Codes.

              diff --git a/docs/dc/api-ref/en-dc_topic_0055025324.html b/docs/dc/api-ref/en-dc_topic_0055025324.html index fadb6e94..b87c7e9b 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025324.html +++ b/docs/dc/api-ref/en-dc_topic_0055025324.html @@ -3,50 +3,50 @@

              Deleting a Virtual Gateway

              Function

              This API is used to delete a virtual gateway.

              -

              URI

              DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}

              +

              URI

              DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}

              -
              Table 1 Parameter description

              Parameter

              +
              - - - - - - -
              Table 1 Parameter description

              Parameter

              Type

              +

              Type

              Mandatory

              +

              Mandatory

              Description

              +

              Description

              virtual_gateway_id

              +

              virtual_gateway_id

              String

              +

              String

              Yes

              +

              Yes

              Indicates the virtual gateway ID.

              +

              Specifies the virtual gateway ID.

              -

              Request

              Table 2 lists the request parameter.

              +

              Request

              Table 2 lists the request parameter.

              -
              Table 2 Request parameter

              Parameter

              +
              - - - - - - - @@ -60,7 +60,7 @@
              • Response example

                None

              -

              Returned Value

              For details, see section Common Returned Values.

              +

              Status Codes

              For details, see Common Status Codes.

              diff --git a/docs/dc/api-ref/en-dc_topic_0055025325.html b/docs/dc/api-ref/en-dc_topic_0055025325.html index bd88332d..b284905c 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025325.html +++ b/docs/dc/api-ref/en-dc_topic_0055025325.html @@ -5,23 +5,23 @@

              URI

              GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}

              -
              Table 2 Request parameter

              Parameter

              Type

              +

              Type

              Mandatory

              +

              Mandatory

              Description

              +

              Description

              virtual_gateway_id

              +

              virtual_gateway_id

              String

              +

              String

              Yes

              +

              Yes

              Indicates the virtual gateway ID.

              +

              Specifies the virtual gateway ID.

              Table 1 Parameter description

              Parameter

              +
              - - - - - - - @@ -30,203 +30,79 @@

              Request

              Table 2 lists the request parameter.

              -
              Table 1 Parameter description

              Parameter

              Type

              +

              Type

              Mandatory

              +

              Mandatory

              Description

              +

              Description

              virtual_gateway_id

              +

              virtual_gateway_id

              String

              +

              String

              Yes

              +

              Yes

              Specifies the virtual gateway ID.

              +

              Specifies the virtual gateway ID.

              Table 2 Request parameter

              Parameter

              +
              - - - - - - -
              Table 2 Request parameter

              Parameter

              Type

              +

              Type

              Mandatory

              +

              Mandatory

              Description

              +

              Description

              virtual_gateway_id

              +

              virtual_gateway_id

              String

              +

              String

              Yes

              +

              Yes

              Specifies the virtual gateway ID.

              +

              Specifies the virtual gateway ID.

              -

              Response

              Table 3 lists the response parameter.

              +

              Response

              Table 3 lists the response parameter.

              -
              Table 3 Response parameter

              Parameter

              +
              - - - - - - -
              Table 3 Response parameter

              Parameter

              Type

              +

              Type

              Mandatory

              +

              Mandatory

              Description

              +

              Description

              virtual_gateway

              +

              virtual_gateway

              Dictionary data structure

              +

              Dictionary

              Yes

              +

              Yes

              Specifies the virtual_gateway object.

              +

              Specifies the virtual_gateway object.

              - -
              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              Table 4 Description of field virtual_gateway

              Parameter

              -

              Type

              -

              Mandatory

              -

              Description

              -

              id

              -

              String

              -

              Yes

              -

              Specifies the virtual gateway ID.

              -

              tenant_id

              -

              String

              -

              Yes

              -

              Specifies the project ID.

              -

              name

              -

              String

              -

              No

              -

              Specifies the virtual gateway name.

              -

              description

              -

              String

              -

              No

              -

              Provides supplementary information about the virtual gateway.

              -

              vpc_id

              -

              String

              -

              Yes

              -

              Specifies the ID of the VPC to be accessed.

              -

              local_ep_group_id

              -

              String

              -

              Yes

              -

              Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

              -

              device_id

              -

              String

              -

              No

              -

              Specifies the ID of the physical device used by the virtual gateway.

              -

              redundant_device_id

              -

              String

              -

              No

              -

              Specifies the ID of the redundant physical device used by the virtual gateway.

              -

              type

              -

              String

              -

              No

              -

              Specifies the virtual gateway type. The value can be default or double ipsec.

              -

              ipsec_bandwidth

              -

              Integer

              -

              No

              -

              Specifies the bandwidth provided for IPsec VPN in Mbit/s.

              -

              bgp_asn

              -

              Integer

              -

              No

              -

              Specifies the BGP ASN of the virtual gateway.

              -

              status

              -

              String

              -

              No

              -

              Specifies the virtual gateway status.

              -

              The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

              -

              admin_state_up

              -

              Boolean

              -

              No

              -

              Specifies the administrative status of the virtual gateway.

              -

              The value can be true or false.

              -
              +

              For details about the virtual_gateway field, see Table 1.

              - -

              Examples

              • Example request
                GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
                +

                Examples

                • Example request
                  GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
                -
                • Example response
                  {    
                  -    "virtual_gateway" : {
                  -        "id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389", 
                  -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
                  -        "name" : "virtual gateway1",
                  -        "description" : "",
                  -        "vpc_id" : "908d9cf3-da64-4acb-393f-e5eb6b9e838a",
                  -        "local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab",
                  -        "device_id" : "aaa_01"
                  -    }
                  +
                  • Example response
                    {     
                    +    "virtual_gateway" : { 
                    +            "id": "0a0888a6-4096-43a6-81c6-923912933451",
                    +            "name": "virtual gateway",
                    +            "description": null,
                    +            "tenant_id": "0605768a3300d5762f82c01180692873",
                    +            "vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af",
                    +            "local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab",
                    +            "local_ep_group_ipv6_id": null,
                    +            "device_id": "aaa_01",
                    +            "redundant_device_id": null,
                    +            "type": "default",
                    +            "ipsec_bandwidth": 1,
                    +            "status": "PENDING_CREATE",
                    +            "admin_state_up": true,
                    +            "bgp_asn": 64512,
                    +            "region_id": null
                    +    } 
                     }
                  -

                  Returned Value

                  For details, see section Common Returned Values.

                  +

                  Status Codes

                  For details, see Common Status Codes.

                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025326.html b/docs/dc/api-ref/en-dc_topic_0055025326.html index eb0463ef..44eabebc 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025326.html +++ b/docs/dc/api-ref/en-dc_topic_0055025326.html @@ -5,224 +5,120 @@

                  URI

                  PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}

                  -
                  Table 1 Parameter description

                  Parameter

                  +
                  - - - - - - -
                  Table 1 Parameter description

                  Parameter

                  Type

                  +

                  Type

                  Mandatory

                  +

                  Mandatory

                  Description

                  +

                  Description

                  virtual_gateway_id

                  +

                  virtual_gateway_id

                  String

                  +

                  String

                  Yes

                  +

                  Yes

                  Specifies the virtual gateway ID.

                  +

                  Specifies the virtual gateway ID.

                  -

                  Request

                  Table 2 lists the request parameter.

                  +

                  Request

                  Table 2 lists the request parameter.

                  -
                  Table 2 Request parameter

                  Parameter

                  +
                  - - - - - - -
                  Table 2 Request parameter

                  Parameter

                  Type

                  +

                  Type

                  Mandatory

                  +

                  Mandatory

                  Description

                  +

                  Description

                  virtual_gateway

                  +

                  virtual_gateway

                  Dictionary data structure

                  +

                  Dictionary

                  Yes

                  +

                  Yes

                  Specifies the virtual_gateway object.

                  +

                  Specifies the virtual_gateway object.

                  -

                  -

                  Parameter

                  +
                  - - - - - - - - - - - - - - -

                  Parameter

                  Type

                  +

                  Type

                  Mandatory

                  +

                  Mandatory

                  Description

                  +

                  Description

                  description

                  +

                  description

                  String

                  +

                  String

                  No

                  +

                  No

                  Provides supplementary information about the virtual gateway.

                  +

                  Provides supplementary information about the virtual gateway.

                  +

                  Angle brackets (<>) are not allowed.

                  name

                  +

                  name

                  String

                  +

                  String

                  No

                  +

                  No

                  Specifies the virtual gateway name.

                  +

                  Specifies the virtual gateway name.

                  +

                  Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

                  local_ep_group_id

                  +

                  local_ep_group_id

                  String

                  +

                  String

                  No

                  +

                  No

                  Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

                  +

                  Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

                  -

                  Response

                  Table 3 lists the response parameter.

                  +

                  Response

                  Table 3 lists the response parameter.

                  -
                  Table 3 Response parameter

                  Parameter

                  +
                  - - - - -
                  Table 3 Response parameter

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  virtual_gateway

                  +

                  virtual_gateway

                  Dictionary data structure

                  +

                  Dictionary

                  Specifies the virtual_gateway object.

                  +

                  Specifies the virtual_gateway object.

                  -

                  Description of field virtual_gateway

                  - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                  Parameter

                  -

                  Type

                  -

                  Description

                  -

                  id

                  -

                  String

                  -

                  Specifies the virtual gateway ID.

                  -

                  tenant_id

                  -

                  String

                  -

                  Specifies the project ID.

                  -

                  name

                  -

                  String

                  -

                  Specifies the virtual gateway name.

                  -

                  description

                  -

                  String

                  -

                  Provides supplementary information about the virtual gateway.

                  -

                  vpc_id

                  -

                  String

                  -

                  Specifies the ID of the VPC to be accessed.

                  -

                  local_ep_group_id

                  -

                  String

                  -

                  Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.

                  -

                  device_id

                  -

                  String

                  -

                  Specifies the ID of the physical device used by the virtual gateway.

                  -

                  redundant_device_id

                  -

                  String

                  -

                  Specifies the ID of the redundant physical device used by the virtual gateway.

                  -

                  type

                  -

                  String

                  -

                  Specifies the virtual gateway type. The value can be default or double ipsec.

                  -

                  ipsec_bandwidth

                  -

                  Integer

                  -

                  Specifies the bandwidth provided for IPsec VPN in Mbit/s.

                  -

                  bgp_asn

                  -

                  Integer

                  -

                  Specifies the BGP ASN of the virtual gateway.

                  -

                  status

                  -

                  String

                  -

                  Specifies the virtual gateway status.

                  -

                  The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

                  -

                  admin_state_up

                  -

                  Boolean

                  -

                  Specifies the administrative status of the virtual gateway.

                  -

                  The value can be true or false.

                  -
                  +

                  For details about the virtual_gateway field, see Table 1.

                  - -

                  Examples

                  • Example request
                    PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
                    +

                    Examples

                    • Example request
                      PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
                       {
                           "virtual_gateway" : {
                               "name" : "virtual gateway1",
                      @@ -231,19 +127,27 @@
                       }
                    -
                    • Example response
                      {        
                      -     "virtual_gateway" : {
                      -        "id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
                      -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
                      -        "name" : "virtual gateway1",
                      -        "description" : "New description",
                      -        "vpc_id" : "908d9cf3-da64-4acb-393f-e5eb6b9e838a",
                      -        "local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab",
                      -        "device_id" : "aaa_01"
                      -    }
                      +
                      • Example response
                        {         
                        +     "virtual_gateway" : { 
                        +            "id": "0a0888a6-4096-43a6-81c6-923912933451",
                        +            "name": "virtual gateway1",
                        +            "description": "New description",
                        +            "tenant_id": "0605768a3300d5762f82c01180692873",
                        +            "vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af",
                        +            "local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab",
                        +            "local_ep_group_ipv6_id": null,
                        +            "device_id": "aaa_01",
                        +            "redundant_device_id": null,
                        +            "type": "default",
                        +            "ipsec_bandwidth": 1,
                        +            "status": "PENDING_CREATE",
                        +            "admin_state_up": true,
                        +            "bgp_asn": null,
                        +            "region_id": null
                        +    } 
                         }
                      -

                      Returned Value

                      For details, see section Common Returned Values.

                      +

                      Status Codes

                      For details, see Common Status Codes.

                      diff --git a/docs/dc/api-ref/en-dc_topic_0055025327.html b/docs/dc/api-ref/en-dc_topic_0055025327.html index e7211c8c..8cf0e252 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025327.html +++ b/docs/dc/api-ref/en-dc_topic_0055025327.html @@ -1,8 +1,11 @@ -

                      Virtual Interface

                      -

                      + +

                      Virtual Interface

                      + +

                      +
                      diff --git a/docs/dc/api-ref/en-dc_topic_0055025328.html b/docs/dc/api-ref/en-dc_topic_0055025328.html index 38715c2c..00bbf946 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025328.html +++ b/docs/dc/api-ref/en-dc_topic_0055025328.html @@ -1,299 +1,462 @@

                      Overview

                      -

                      Object Introduction

                      This section describes the APIs for managing and operating the virtual interfaces, including the APIs used to create, query, update, and delete a virtual interface, and the API to query the virtual interface list.

                      +

                      Object Introduction

                      This section describes the APIs for managing and operating the virtual interfaces, including the APIs used to create, query, update, and delete a virtual interface, and the API to query the virtual interface list.

                      +

                      Virtual interface APIs do not support IPv6 addresses.

                      +
                      -

                      Object Model

                      -
                      Table 1 Virtual interface objects

                      Attribute

                      +

                      Object Model

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                      Table 1 Virtual interface objects

                      Parameter

                      Type

                      +

                      Type

                      CRUD

                      +

                      CRUD

                      Default Value

                      +

                      Default Value

                      Constraint

                      +

                      Constraint

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      R

                      +

                      R

                      Automatically generated

                      +

                      Automatically generated

                      uuid

                      +

                      UUID

                      Specifies the virtual interface ID.

                      +

                      Specifies the virtual interface ID.

                      tenant_id

                      +

                      tenant_id

                      String

                      +

                      String

                      CR

                      +

                      CR

                      N/A

                      +

                      N/A

                      The value can contain 0 to 255 characters.

                      +

                      The value can contain 0 to 255 characters.

                      Specifies the tenant ID.

                      +

                      Specifies the tenant ID.

                      name

                      +

                      name

                      String

                      +

                      String

                      CRU

                      +

                      CRU

                      None

                      +

                      None

                      The value can contain 0 to 64 characters.

                      -

                      The name can contain only digits, letters, underscores (_), and hyphens (-).

                      +

                      The value can contain 0 to 64 characters.

                      +

                      Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

                      Specifies the virtual interface name.

                      +

                      Specifies the virtual interface name.

                      description

                      +

                      description

                      String

                      +

                      String

                      CRU

                      +

                      CRU

                      None

                      +

                      None

                      The value can contain 0 to 128 characters.

                      +

                      The value can contain 0 to 128 characters.

                      +

                      Angle brackets (<>) are not allowed.

                      Provides supplementary information about the virtual interface.

                      +

                      Provides supplementary information about the virtual interface.

                      direct_connect_id

                      +

                      direct_connect_id

                      String

                      +

                      String

                      CR

                      +

                      CR

                      N/A

                      +

                      N/A

                      uuid

                      +

                      UUID

                      Specifies the connection ID.

                      +

                      Specifies the connection ID.

                      vgw_ id

                      +

                      vgw_id

                      String

                      +

                      String

                      CR

                      +

                      CR

                      N/A

                      +

                      N/A

                      N/A

                      +

                      N/A

                      Specifies the virtual gateway ID.

                      +

                      Specifies the virtual gateway ID.

                      type

                      +

                      type

                      String

                      +

                      String

                      CR

                      +

                      CR

                      None

                      +

                      None

                      The value can contain 0 to 255 characters.

                      +

                      The value can contain 0 to 255 characters.

                      Specifies the interface type: public or private.

                      +

                      Specifies the virtual interface type. The value can only be private.

                      service_type

                      +

                      service_type

                      String

                      +

                      String

                      CR

                      +

                      CR

                      None

                      +

                      None

                      The value can contain 0 to 255 characters.

                      +

                      The value can contain 0 to 255 characters.

                      Specifies the access service type. The value can be vpc, public service, or vpc and public service.

                      +

                      Specifies what is to be accessed over the connection. The value can only be vpc.

                      vlan

                      +

                      vlan

                      Integer

                      +

                      Integer

                      CR

                      +

                      CR

                      N/A

                      +

                      N/A

                      VLAN: 1 to 4063

                      +

                      VLAN: 1 to 4063

                      Specifies the VLAN used by the local gateway to communicate with the remote gateway.

                      +

                      Specifies the VLAN used by the local gateway to communicate with the remote gateway.

                      bandwidth

                      +

                      bandwidth

                      Integer

                      +

                      Integer

                      CRU

                      +

                      CRU

                      N/A

                      +

                      N/A

                      Bandwidth: 2 Mbit/s to 10,000 Mbit/s

                      +

                      Bandwidth: 2 Mbit/s to 10,000 Mbit/s

                      Specifies the virtual interface bandwidth.

                      +

                      Specifies the virtual interface bandwidth.

                      local_gateway_v4_ip

                      +

                      local_gateway_v4_ip

                      String

                      +

                      String

                      CR

                      +

                      CR

                      N/A

                      +

                      N/A

                      The value can contain 0 to 255 characters.

                      +

                      The value can contain 0 to 255 characters.

                      Specifies the IPv4 address of the local gateway.

                      +

                      Specifies the IPv4 address of the local gateway.

                      remote_gateway_v4_ip

                      +

                      remote_gateway_v4_ip

                      String

                      +

                      String

                      CR

                      +

                      CR

                      N/A

                      +

                      N/A

                      The value can contain 0 to 255 characters.

                      +

                      The value can contain 0 to 255 characters.

                      Specifies the IPv4 address of the remote gateway.

                      +

                      Specifies the IPv4 address of the remote gateway.

                      route_mode

                      +

                      route_mode

                      String

                      +

                      String

                      CR

                      +

                      CR

                      static

                      +

                      static

                      The value can contain 0 to 255 characters.

                      +

                      The value can contain 0 to 255 characters.

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

                      +

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

                      bgp_asn

                      +

                      bgp_asn

                      Integer

                      +

                      Integer

                      CR

                      +

                      CR

                      N/A

                      +

                      N/A

                      ASN: 1 to 4294967295

                      +

                      ASN: 1 to 4294967295

                      Specifies the AS number of the BGP peer.

                      +

                      Specifies the AS number of the BGP peer.

                      bgp_md5

                      +

                      bgp_md5

                      String

                      +

                      String

                      CR

                      +

                      CR

                      N/A

                      +

                      N/A

                      The value can contain 0 to 255 characters.

                      +

                      The value can contain 0 to 255 characters.

                      Specifies the message digest algorithm 5 (MD5) key of the BGP peer.

                      +

                      Specifies the message digest algorithm 5 (MD5) key of the BGP peer.

                      remote_ep_group_id

                      +

                      remote_ep_group_id

                      String

                      +

                      String

                      CRU

                      +

                      CRU

                      N/A

                      +

                      N/A

                      uuid

                      +

                      UUID

                      Specifies the ID of the remote endpoint group that records the tenant CIDR blocks.

                      +

                      Specifies the ID of the remote endpoint group that records the CIDR blocks used by the on-premises network.

                      service_ep_group_id

                      +

                      service_ep_group_id

                      String

                      +

                      String

                      CRU

                      +

                      CRU

                      N/A

                      +

                      N/A

                      uuid

                      +

                      UUID

                      Specifies the ID of the service endpoint group that records the public service CIDR blocks.

                      +

                      Specifies the ID of the service endpoint group that records the public service CIDR blocks.

                      +

                      This is a reserved field, which is not used currently.

                      create_time

                      +

                      create_time

                      String

                      +

                      String

                      R

                      +

                      R

                      N/A

                      +

                      N/A

                      The value can contain 0 to 255 characters.

                      +

                      The value can contain 0 to 255 characters.

                      Specifies the time when the virtual interface is created.

                      +

                      Specifies the time when the virtual interface is created.

                      delete_time

                      +

                      status

                      String

                      +

                      String

                      R

                      +

                      R

                      N/A

                      +

                      N/A

                      The value can contain 0 to 255 characters.

                      +

                      N/A

                      Specifies the time when the virtual interface is deleted.

                      +

                      Specifies the operating status of the virtual interface. The value can be ACTIVE, ERROR, PENDING_CREATE, or PENDING_UPDATE.

                      +
                      • ACTIVE: The virtual interface is normal.
                      • ERROR: The virtual interface is abnormal.
                      • PENDING_CREATE: The virtual interface is being created.
                      • PENDING_UPDATE: The virtual interface is being updated.

                      status

                      +

                      admin_state_up

                      String

                      +

                      Boolean

                      R

                      +

                      CR

                      N/A

                      +

                      true

                      N/A

                      +

                      The value can only be true.

                      Specifies the virtual interface status.

                      -

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

                      -

                      admin_state_up

                      -

                      Boolean

                      -

                      CR

                      -

                      true

                      -

                      The value can only be true.

                      -

                      Specifies the administrative status of the virtual interface.

                      +

                      Specifies the administrative status of the virtual interface.

                      The value can be true or false.

                      address_family

                      +

                      String

                      +

                      CR

                      +

                      "ipv4"

                      +

                      N/A

                      +

                      Specifies the IP address family of the virtual interface peer. The value can be ipv4 or ipv6.

                      +

                      IPv6 is not supported in the virtual interface APIs.

                      +

                      enable_bfd

                      +

                      Boolean

                      +

                      CRU

                      +

                      false

                      +

                      N/A

                      +

                      Specifies whether the BFD function is enabled. The value can be true or false.

                      +
                      NOTE:

                      Bidirectional Forwarding Detection (BFD) is a network protocol that is used to detect faults between two routers or switches connected by a link.

                      +
                      +

                      health_check_source_ip

                      +

                      String

                      +

                      CRU

                      +

                      N/A

                      +

                      UUID

                      +

                      This is a reserved field, which is not used currently.

                      +

                      rate_limit

                      +

                      Boolean

                      +

                      CRU

                      +

                      false

                      +

                      N/A

                      +

                      This is a reserved field, which is not used currently.

                      +

                      route_limit

                      +

                      Integer

                      +

                      CRU

                      +

                      50

                      +

                      N/A

                      +

                      This is a reserved field, which is not used currently.

                      +

                      region_id

                      +

                      String

                      +

                      CR

                      +

                      N/A

                      +

                      N/A

                      +

                      This is a reserved field, which is not used currently.

                      +

                      enable_nqa

                      +

                      Boolean

                      +

                      CRU

                      +

                      false

                      +

                      N/A

                      +

                      This is a reserved field, which is not used currently.

                      +

                      enable_gre

                      +

                      Boolean

                      +

                      CRU

                      +

                      false

                      +

                      N/A

                      +

                      This is a reserved field, which is not used currently.

                      +

                      local_gateway_v6_ip

                      +

                      String

                      +

                      CR

                      +

                      N/A

                      +

                      N/A

                      +

                      This is a reserved field, which is not used currently.

                      +

                      remote_gateway_v6_ip

                      +

                      String

                      +

                      CR

                      +

                      N/A

                      +

                      N/A

                      +

                      This is a reserved field, which is not used currently.

                      +

                      local_gre_tunnel_ip

                      +

                      String

                      +

                      CR

                      +

                      N/A

                      +

                      N/A

                      +

                      This is a reserved field, which is not used currently.

                      +

                      remote_gre_tunnel_ip

                      +

                      String

                      +

                      CR

                      +

                      N/A

                      +

                      N/A

                      +

                      This is a reserved field, which is not used currently.

                      +

                      lag_id

                      +

                      String

                      +

                      CR

                      +

                      N/A

                      +

                      UUID

                      +

                      This is a reserved field, which is not used currently.

                      +
                      diff --git a/docs/dc/api-ref/en-dc_topic_0055025329.html b/docs/dc/api-ref/en-dc_topic_0055025329.html index c8a94452..a3032411 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025329.html +++ b/docs/dc/api-ref/en-dc_topic_0055025329.html @@ -5,448 +5,215 @@

                      URI

                      POST /v2.0/dcaas/virtual-interfaces

                      -

                      Request

                      Table 1 lists the request parameter.

                      +

                      Request

                      Table 1 lists the request parameter.

                      -
                      Table 1 Request parameter

                      Parameter

                      +
                      - - - - - - -
                      Table 1 Request parameter

                      Parameter

                      Type

                      +

                      Type

                      Mandatory

                      +

                      Mandatory

                      Description

                      +

                      Description

                      virtual_interface

                      +

                      virtual_interface

                      Dictionary data structure

                      +

                      Dictionary

                      Yes

                      +

                      Yes

                      Specifies the virtual_interface object.

                      +

                      Specifies the virtual_interface object.

                      -
                      Table 2 Description of field virtual_interface

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      Table 2 Description of field virtual_interface

                      Parameter

                      Type

                      +

                      Type

                      Mandatory

                      +

                      Mandatory

                      Description

                      +

                      Description

                      tenant_id

                      +

                      tenant_id

                      String

                      +

                      String

                      No

                      +

                      No

                      Specifies the project ID.

                      +

                      Specifies the project ID.

                      name

                      +

                      name

                      String

                      +

                      String

                      No

                      +

                      No

                      Specifies the virtual interface name.

                      +

                      Specifies the virtual interface name.

                      +

                      Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

                      description

                      +

                      description

                      String

                      +

                      String

                      No

                      +

                      No

                      Provides supplementary information about the virtual interface.

                      +

                      Provides supplementary information about the virtual interface.

                      +

                      Angle brackets (<>) are not allowed.

                      direct_connect_id

                      +

                      direct_connect_id

                      String

                      +

                      String

                      Yes

                      +

                      Yes

                      Specifies the connection ID.

                      +

                      Specifies the connection ID.

                      vgw_ id

                      +

                      vgw_id

                      String

                      +

                      String

                      Yes

                      +

                      Yes

                      Specifies the virtual gateway ID.

                      +

                      Specifies the virtual gateway ID.

                      type

                      +

                      type

                      String

                      +

                      String

                      Yes

                      +

                      Yes

                      Specifies the virtual interface type. The value can be public or private.

                      +

                      Specifies the virtual interface type. The value can only be private.

                      service_type

                      +

                      service_type

                      String

                      +

                      String

                      Yes

                      +

                      Yes

                      Specifies the access service type. The value can be vpc, public service, or vpc and public service.

                      +

                      Specifies what is to be accessed over the connection. The value can only be vpc.

                      vlan

                      +

                      vlan

                      Integer

                      +

                      Integer

                      Yes

                      +

                      Yes

                      Specifies the VLAN used by the local gateway to communicate with the remote gateway.

                      +

                      Specifies the VLAN used by the local gateway to communicate with the remote gateway.

                      bandwidth

                      +

                      bandwidth

                      Integer

                      +

                      Integer

                      Yes

                      +

                      Yes

                      Specifies the virtual interface bandwidth.

                      +

                      Specifies the virtual interface bandwidth.

                      local_gateway_v4_ip

                      +

                      local_gateway_v4_ip

                      String

                      +

                      String

                      Yes

                      +

                      Yes

                      Specifies the IPv4 address of the local gateway.

                      +

                      Specifies the IPv4 address of the local gateway.

                      remote_gateway_v4_ip

                      +

                      remote_gateway_v4_ip

                      String

                      +

                      String

                      Yes

                      +

                      Yes

                      Specifies the IPv4 address of the remote gateway.

                      +

                      Specifies the IPv4 address of the remote gateway.

                      route_mode

                      +

                      route_mode

                      String

                      +

                      String

                      Yes

                      +

                      Yes

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

                      +

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

                      bgp_asn

                      +

                      bgp_asn

                      Integer

                      +

                      Integer

                      No

                      +

                      No

                      Specifies the AS number of the BGP peer.

                      +

                      Specifies the AS number of the BGP peer.

                      bgp_md5

                      +

                      bgp_md5

                      String

                      +

                      String

                      No

                      +

                      No

                      Specifies the MD5 password of the BGP peer.

                      +

                      Specifies the MD5 password of the BGP peer.

                      remote_ep_group_id

                      +

                      remote_ep_group_id

                      String

                      +

                      String

                      Yes

                      +

                      Yes

                      Specifies the ID of the remote endpoint group that records the CIDR blocks used by the on-premises network.

                      +

                      Specifies the ID of the remote endpoint group that records the CIDR blocks used by the on-premises network.

                      service_ep_group_id

                      +

                      admin_state_up

                      String

                      +

                      Boolean

                      No

                      +

                      No

                      Specifies the ID of the service endpoint group that records the public service CIDR blocks.

                      -

                      admin_state_up

                      -

                      Boolean

                      -

                      No

                      -

                      Specifies the administrative status of the virtual interface.

                      +

                      Specifies the administrative status of the virtual interface.

                      The value can be true or false.

                      delete_time

                      -

                      String

                      -

                      No

                      -

                      Specifies the time when the virtual interface is deleted.

                      -

                      rate_limit

                      -

                      Boolean

                      -

                      No

                      -

                      Specifies whether to limit the traffic rate. The value can be true or false.

                      -
                      -

                      Response

                      Table 3 lists the response parameter.

                      +

                      Response

                      Table 3 lists the response parameter.

                      -
                      Table 3 Response parameter

                      Parameter

                      +
                      - - - - - - -
                      Table 3 Response parameter

                      Parameter

                      Type

                      +

                      Type

                      Mandatory

                      -

                      Description

                      +

                      Description

                      virtual_interface

                      +

                      virtual_interface

                      Dictionary data structure

                      +

                      Dictionary

                      Yes

                      -

                      Specifies the virtual_interface object.

                      +

                      Specifies the virtual_interface object.

                      - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      Table 4 Description of field virtual_interface

                      Parameter

                      -

                      Type

                      -

                      Mandatory

                      -

                      Description

                      -

                      id

                      -

                      String

                      -

                      Yes

                      -

                      Specifies the virtual interface ID.

                      -

                      tenant_id

                      -

                      String

                      -

                      Yes

                      -

                      Specifies the project ID.

                      -

                      name

                      -

                      String

                      -

                      No

                      -

                      Specifies the virtual interface name.

                      -

                      description

                      -

                      String

                      -

                      No

                      -

                      Provides supplementary information about the virtual interface.

                      -

                      direct_connect_id

                      -

                      String

                      -

                      Yes

                      -

                      Specifies the connection ID.

                      -

                      vgw_ id

                      -

                      String

                      -

                      Yes

                      -

                      Specifies the virtual gateway ID.

                      -

                      type

                      -

                      String

                      -

                      Yes

                      -

                      Specifies the virtual interface type. The value can be public or private.

                      -

                      service_type

                      -

                      String

                      -

                      Yes

                      -

                      Specifies the access service type. The value can be vpc, public service, or vpc and public service.

                      -

                      vlan

                      -

                      Integer

                      -

                      Yes

                      -

                      Specifies the VLAN used by the local gateway to communicate with the remote gateway.

                      -

                      bandwidth

                      -

                      Integer

                      -

                      Yes

                      -

                      Specifies the virtual interface bandwidth.

                      -

                      local_gateway_v4_ip

                      -

                      String

                      -

                      Yes

                      -

                      Specifies the IPv4 address of the local gateway.

                      -

                      remote_gateway_v4_ip

                      -

                      String

                      -

                      Yes

                      -

                      Specifies the IPv4 address of the remote gateway.

                      -

                      route_mode

                      -

                      String

                      -

                      Yes

                      -

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

                      -

                      bgp_asn

                      -

                      Integer

                      -

                      No

                      -

                      Specifies the AS number of the BGP peer.

                      -

                      bgp_md5

                      -

                      String

                      -

                      No

                      -

                      Specifies the MD5 password of the BGP peer.

                      -

                      remote_ep_group_id

                      -

                      String

                      -

                      Yes

                      -

                      Specifies the ID of the remote endpoint group that records the tenant CIDR blocks.

                      -

                      service_ep_group_id

                      -

                      String

                      -

                      No

                      -

                      Specifies the ID of the service endpoint group that records the public service CIDR blocks.

                      -

                      create_time

                      -

                      String

                      -

                      No

                      -

                      Specifies the time when the virtual interface is created.

                      -

                      status

                      -

                      String

                      -

                      No

                      -

                      Specifies the virtual interface status.

                      -

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

                      -

                      admin_state_up

                      -

                      Boolean

                      -

                      No

                      -

                      Specifies the administrative status of the virtual interface.

                      -

                      The value can be true or false.

                      -

                      rate_limit

                      -

                      Boolean

                      -

                      No

                      -

                      Specifies whether to limit the traffic rate. The value can be true or false.

                      -
                      +

                      For details about the virtual_interface field, see Table 1.

                      - -

                      Examples

                      • Example request
                        POST /v2.0/dcaas/virtual-interfaces
                        +

                        Examples

                        • Example request
                          POST /v2.0/dcaas/virtual-interfaces
                           {
                               "virtual_interface" : {
                                   "name" : "virtual interface1",
                          @@ -464,36 +231,45 @@
                           }
                        -
                        • Example response
                          {
                          -    "virtual_interface" : {
                          -        "id" : "67c59cf4-1a64-46c7-763f-22eb1b9e8986",  
                          -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
                          -        "name" : "virtual interface1",
                          -        "admin_state_up": true, 
                          -        "description" : "",
                          -        "direct_connect_id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
                          -        "vgw_id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
                          -        "type" : "private",
                          -        "status": "PENDING_CREATE", 
                          -        "bgp_md5": ""
                          -        "service_type" : "vpc",
                          -        "vlan" : 100,
                          -        "bandwidth" : 10,
                          -        "create_time": "2018-10-19 09:53:50.335431",
                          -        "bgp_asn": null, 
                          -        "service_ep_group_id": null,
                          -        "delete_time": "None", 
                          -        "local_gateway_v4_ip" : "180.1.1.1/24",
                          -        "remote_gateway_v4_ip"  : "180.1.1.2/24",
                          +
                          • Example response
                            { 
                            +    "virtual_interface" : { 
                            +        "id": "634c61d0-fd7b-4961-adb6-37a2e3c42d08",
                            +        "name": "test-vif",
                            +        "description": null,
                            +        "tenant_id": "06057682ed80d5762f25c00b5deb794a",
                            +        "direct_connect_id": "73707953-df69-4d03-8df5-b46a087c1424",
                            +        "vgw_id": "9b5cab66-7634-4213-8d01-fa37cb908e12",
                            +        "type": "private",
                            +        "service_type": "vpc",
                            +        "vlan": 687,
                            +        "bandwidth": 2,
                            +        "local_gateway_v4_ip": "11.11.11.1/30",
                            +        "remote_gateway_v4_ip": "11.11.11.2/30",
                                     "route_mode": "static",
                            -        "remote_ep_group_id" : "78e34cf1-5468-87c7-223d-56e78b9699ef",
                            +        "bgp_asn": null,
                            +        "bgp_md5": null,
                            +        "remote_ep_group_id": "a2b81f07-826f-40b0-9e8d-17d1af5230cf",
                            +        "service_ep_group_id": null,
                            +        "status": "PENDING_CREATE",
                            +        "create_time": "2021-12-15T00:31:27Z",
                            +        "admin_state_up": true,
                                     "rate_limit": false,
                            -        "bfd": false,
                            -        "route-limit": null
                            -    }
                            +        "enable_bfd": false,
                            +        "health_check_source_ip": null,
                            +        "route_limit": 50,
                            +        "address_family": "ipv4",
                            +        "local_gateway_v6_ip": null,
                            +        "remote_gateway_v6_ip": null,
                            +        "region_id": null,
                            +        "enable_nqa": false,
                            +        "enable_gre": false,
                            +        "local_gre_tunnel_ip": null,
                            +        "remote_gre_tunnel_ip": null,
                            +        "lag_id": null
                            +    } 
                             }
                          -

                          Response code

                          For details, see Common Returned Values.

                          +

                          Status Codes

                          For details, see Common Status Codes.

                          diff --git a/docs/dc/api-ref/en-dc_topic_0055025330.html b/docs/dc/api-ref/en-dc_topic_0055025330.html index 6f351285..ec315346 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025330.html +++ b/docs/dc/api-ref/en-dc_topic_0055025330.html @@ -5,7 +5,7 @@

                          URI

                          GET /v2.0/dcaas/virtual-interfaces

                          -

                          Request

                          Table 1 lists the request parameter.

                          +

                          Request

                          Table 1 lists the request parameter.

                          @@ -31,221 +31,73 @@
                          Table 1 Request parameter

                          Parameter

                          -

                          Response

                          Table 2 lists the response parameter.

                          +

                          Response

                          Table 2 lists the response parameter.

                          - - - -
                          Table 2 Response parameter

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          virtual_interfaces

                          List data structure

                          +

                          List

                          Specifies the virtual interface list.

                          +

                          Specifies the virtual interface list.

                          - -
                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                          Table 3 Description of field virtual_interfaces

                          Parameter

                          -

                          Type

                          -

                          Description

                          -

                          id

                          -

                          String

                          -

                          Specifies the virtual interface ID.

                          -

                          tenant_id

                          -

                          String

                          -

                          Specifies the project ID.

                          -

                          name

                          -

                          String

                          -

                          Specifies the virtual interface name.

                          -

                          description

                          -

                          String

                          -

                          Provides supplementary information about the virtual interface.

                          -

                          direct_connect_id

                          -

                          String

                          -

                          Specifies the connection ID.

                          -

                          vgw_ id

                          -

                          String

                          -

                          Specifies the virtual gateway ID.

                          -

                          type

                          -

                          String

                          -

                          Specifies the virtual interface type. The value can be public or private.

                          -

                          service_type

                          -

                          String

                          -

                          Specifies the access service type. The value can be vpc, public service, or vpc and public service.

                          -

                          vlan

                          -

                          Integer

                          -

                          Specifies the VLAN used by the local gateway to communicate with the remote gateway.

                          -

                          bandwidth

                          -

                          Integer

                          -

                          Specifies the virtual interface bandwidth.

                          -

                          local_gateway_v4_ip

                          -

                          String

                          -

                          Specifies the IPv4 address of the local gateway.

                          -

                          remote_gateway_v4_ip

                          -

                          String

                          -

                          Specifies the IPv4 address of the remote gateway.

                          -

                          route_mode

                          -

                          String

                          -

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

                          -

                          bgp_asn

                          -

                          Integer

                          -

                          Specifies the AS number of the BGP peer.

                          -

                          bgp_md5

                          -

                          String

                          -

                          Specifies the MD5 password of the BGP peer.

                          -

                          remote_ep_group_id

                          -

                          String

                          -

                          Specifies the ID of the remote endpoint group that records the tenant CIDR blocks.

                          -

                          service_ep_group_id

                          -

                          String

                          -

                          Specifies the ID of the service endpoint group that records the public service CIDR blocks.

                          -

                          create_time

                          -

                          String

                          -

                          Specifies the time when the virtual interface is created.

                          -

                          delete_time

                          -

                          String

                          -

                          Specifies the time when the virtual interface is deleted.

                          -

                          status

                          -

                          String

                          -

                          Specifies the virtual interface status.

                          -

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

                          -

                          admin_state_up

                          -

                          Boolean

                          -

                          Specifies the administrative status of the virtual interface.

                          -

                          The value can be true or false.

                          -

                          rate_limit

                          -

                          Boolean

                          -

                          Specifies whether to limit the traffic rate. The value can be true or false.

                          -
                          +

                          For details about the virtual_interfaces field, see Table 1.

                          -
                          -

                          Examples

                          • Example request
                            1. All parameters are returned:
                            +

                            Examples

                            • Example request
                              1. Querying all virtual interfaces
                              GET /v2.0/dcaas/virtual-interfaces
                              -
                              1. Filtered parameters are returned (for example, the filter is ID):
                              +
                              1. Querying a virtual interface by ID
                              GET /v2.0/dcaas/virtual-interfaces?id=67c59cf4-1a64-46c7-763f-22eb1b9e8986
                            -
                            • Example response
                              {
                              +
                              • Example response
                                { 
                                     "virtual_interfaces" : [{
                                -        "id" : "67c59cf4-1a64-46c7-763f-22eb1b9e8986",  
                                -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
                                -        "name" : "virtual interface1",
                                -        "description" : "",
                                -        "direct_connect_id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
                                -        "vgw_id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
                                -        "type" : "private",
                                -        "service_type" : "vpc",
                                -        "vlan" : 100,
                                -        "bandwidth" : 10,
                                -        "local_gateway_v4_ip" : "180.1.1.1/24",
                                -        "remote_gateway_v4_ip"  : "180.1.1.2/24",
                                -        "route_mode"  : "static",
                                -        "remote_ep_group_id" : "78e34cf1-5468-87c7-223d-56e78b9699ef"
                                -    }]
                                +            "id": "026895e2-23bf-44bd-8ef1-93618ab92b99",
                                +            "name": "vif-test",
                                +            "description": null,
                                +            "tenant_id": "06057679cc80d5762fb2c01e71b5a593",
                                +            "direct_connect_id": "b07d42dc-6137-4af3-a93b-853d879ae268",
                                +            "vgw_id": "d27d5bd2-97b3-4bd8-b7e5-189a71c14846",
                                +            "type": "private",
                                +            "service_type": "vpc",
                                +            "vlan": 2202,
                                +            "bandwidth": 6,
                                +            "local_gateway_v4_ip": "16.16.16.1/30",
                                +            "remote_gateway_v4_ip": "16.16.16.2/30",
                                +            "route_mode": "static",
                                +            "bgp_asn": null,
                                +            "bgp_md5": null,
                                +            "remote_ep_group_id": "31dd8536-1ac7-4a38-b2fc-178a69f11b11",
                                +            "service_ep_group_id": null,
                                +            "status": "ACTIVE",
                                +            "create_time": "2021-12-15T06:55:46Z",
                                +            "admin_state_up": true,
                                +            "rate_limit": false,
                                +            "enable_bfd": false,
                                +            "health_check_source_ip": null,
                                +            "route_limit": 50,
                                +            "address_family": "ipv4",
                                +            "local_gateway_v6_ip": null,
                                +            "remote_gateway_v6_ip": null,
                                +            "region_id": null,
                                +            "enable_nqa": false,
                                +            "enable_gre": false,
                                +            "local_gre_tunnel_ip": null,
                                +            "remote_gre_tunnel_ip": null,
                                +            "lag_id": null
                                +        }] 
                                 }
                              -

                              Returned Value

                              For details, see section Common Returned Values.

                              +

                              Status Codes

                              For details, see Common Status Codes.

                              diff --git a/docs/dc/api-ref/en-dc_topic_0055025331.html b/docs/dc/api-ref/en-dc_topic_0055025331.html index 809c895d..74ea02ad 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025331.html +++ b/docs/dc/api-ref/en-dc_topic_0055025331.html @@ -3,25 +3,25 @@

                              Deleting a Virtual Interface

                              Function

                              This API is used to delete a virtual interface.

                              -

                              URI

                              DELETE /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}

                              +

                              URI

                              DELETE /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}

                              - - - - - - @@ -46,7 +46,7 @@ - @@ -60,7 +60,7 @@
                              • Response example

                                None

                              -

                              Returned Value

                              For details, see section Common Returned Values.

                              +

                              Status Codes

                              For details, see Common Status Codes.

                              diff --git a/docs/dc/api-ref/en-dc_topic_0055025332.html b/docs/dc/api-ref/en-dc_topic_0055025332.html index 6003244b..8b985b9c 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025332.html +++ b/docs/dc/api-ref/en-dc_topic_0055025332.html @@ -5,23 +5,23 @@

                              URI

                              GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}

                              -
                              Table 1 Parameter description

                              Parameter

                              Type

                              +

                              Type

                              Mandatory

                              +

                              Mandatory

                              Description

                              +

                              Description

                              virtual_interface_id

                              String

                              +

                              String

                              Yes

                              +

                              Yes

                              Indicates the virtual interface ID.

                              +

                              Specifies the virtual interface ID.

                              Yes

                              Indicates the virtual interface ID.

                              +

                              Specifies the virtual interface ID.

                              Table 1 Parameter description

                              Parameter

                              +
                              - - - - - - - @@ -30,241 +30,93 @@

                              Request

                              Table 2 lists the request parameter.

                              -
                              Table 1 Parameter description

                              Parameter

                              Type

                              +

                              Type

                              Mandatory

                              +

                              Mandatory

                              Description

                              +

                              Description

                              virtual_interface_id

                              +

                              virtual_interface_id

                              String

                              +

                              String

                              Yes

                              +

                              Yes

                              Specifies the virtual interface ID.

                              +

                              Specifies the virtual interface ID.

                              Table 2 Request parameter

                              Parameter

                              +
                              - - - - - - -
                              Table 2 Request parameter

                              Parameter

                              Type

                              +

                              Type

                              Mandatory

                              +

                              Mandatory

                              Description

                              +

                              Description

                              virtual_interface_id

                              +

                              virtual_interface_id

                              String

                              +

                              String

                              Yes

                              +

                              Yes

                              Specifies the virtual interface ID.

                              +

                              Specifies the virtual interface ID.

                              -

                              Response

                              Table 3 lists the response parameter.

                              +

                              Response

                              Table 3 lists the response parameter.

                              - - - -
                              Table 3 Response parameter

                              Parameter

                              Type

                              +

                              Type

                              Description

                              +

                              Description

                              virtual_interface

                              Dictionary data structure

                              +

                              Dictionary

                              Specifies the virtual_interface object.

                              +

                              Specifies the virtual_interface object.

                              - -
                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                              Table 4 Description of field virtual_interface

                              Parameter

                              -

                              Type

                              -

                              Description

                              -

                              id

                              -

                              String

                              -

                              Specifies the virtual interface ID.

                              -

                              tenant_id

                              -

                              String

                              -

                              Specifies the project ID.

                              -

                              name

                              -

                              String

                              -

                              Specifies the virtual interface name.

                              -

                              description

                              -

                              String

                              -

                              Provides supplementary information about the virtual interface.

                              -

                              direct_connect_id

                              -

                              String

                              -

                              Specifies the connection ID.

                              -

                              vgw_ id

                              -

                              String

                              -

                              Specifies the virtual gateway ID.

                              -

                              type

                              -

                              String

                              -

                              Specifies the virtual interface type. The value can be public or private.

                              -

                              service_type

                              -

                              String

                              -

                              Specifies the access service type. The value can be vpc, public service, or vpc and public service.

                              -

                              vlan

                              -

                              Integer

                              -

                              Specifies the VLAN used by the local gateway to communicate with the remote gateway.

                              -

                              bandwidth

                              -

                              Integer

                              -

                              Specifies the virtual interface bandwidth.

                              -

                              local_gateway_v4_ip

                              -

                              String

                              -

                              Specifies the IPv4 address of the local gateway.

                              -

                              remote_gateway_v4_ip

                              -

                              String

                              -

                              Specifies the IPv4 address of the remote gateway.

                              -

                              route_mode

                              -

                              String

                              -

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

                              -

                              bgp_asn

                              -

                              Integer

                              -

                              Specifies the AS number of the BGP peer.

                              -

                              bgp_md5

                              -

                              String

                              -

                              Specifies the MD5 password of the BGP peer.

                              -

                              remote_ep_group_id

                              -

                              String

                              -

                              Specifies the ID of the remote endpoint group that records the tenant CIDR blocks.

                              -

                              service_ep_group_id

                              -

                              String

                              -

                              Specifies the ID of the service endpoint group that records the public service CIDR blocks.

                              -

                              create_time

                              -

                              String

                              -

                              Specifies the time when the virtual interface is created.

                              -

                              delete_time

                              -

                              String

                              -

                              Specifies the time when the virtual interface is deleted.

                              -

                              status

                              -

                              String

                              -

                              Specifies the virtual interface status.

                              -

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

                              -

                              admin_state_up

                              -

                              Boolean

                              -

                              Specifies the administrative status of the virtual interface.

                              -

                              The value can be true or false.

                              -

                              rate_limit

                              -

                              Boolean

                              -

                              Specifies whether to limit the traffic rate. The value can be true or false.

                              -
                              +

                              For details about the virtual_interface field, see Table 1.

                              -
                              -

                              Examples

                              • Example request
                                GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}
                                +

                                Examples

                                • Example request
                                  GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}
                                -
                                • Example response
                                  {    
                                  -    "virtual_interface" : {
                                  -        "id" : "67c59cf4-1a64-46c7-763f-22eb1b9e8986",  
                                  -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
                                  -        "name" : "virtual interface1",
                                  -        "description" : "",
                                  -        "direct_connect_id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
                                  -        "vgw_id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
                                  -        "type" : "private",
                                  -        "service_type" : "vpc",
                                  -        "vlan" : 100,
                                  -        "bandwidth" : 10,
                                  -        "local_gateway_v4_ip" : "180.1.1.1/24",
                                  -        "remote_gateway_v4_ip"  : "180.1.1.2/24",
                                  -        "route_mode"  : "static",
                                  -        "remote_ep_group_id" : "78e34cf1-5468-87c7-223d-56e78b9699ef"
                                  -    }
                                  +
                                  • Example response
                                    {     
                                    +    "virtual_interface" : { 
                                    +        "id": "634c61d0-fd7b-4961-adb6-37a2e3c42d08",
                                    +        "name": "test-vif",
                                    +        "description": null,
                                    +        "tenant_id": "06057682ed80d5762f25c00b5deb794a",
                                    +        "direct_connect_id": "73707953-df69-4d03-8df5-b46a087c1424",
                                    +        "vgw_id": "9b5cab66-7634-4213-8d01-fa37cb908e12",
                                    +        "type": "private",
                                    +        "service_type": "vpc",
                                    +        "vlan": 687,
                                    +        "bandwidth": 2,
                                    +        "local_gateway_v4_ip": "11.11.11.1/30",
                                    +        "remote_gateway_v4_ip": "11.11.11.2/30",
                                    +        "route_mode": "static",
                                    +        "bgp_asn": null,
                                    +        "bgp_md5": null,
                                    +        "remote_ep_group_id": "a2b81f07-826f-40b0-9e8d-17d1af5230cf",
                                    +        "service_ep_group_id": null,
                                    +        "status": "ACTIVE",
                                    +        "create_time": "2021-12-15T08:31:27Z",
                                    +        "admin_state_up": true,
                                    +        "rate_limit": false,
                                    +        "enable_bfd": false,
                                    +        "health_check_source_ip": null,
                                    +        "route_limit": 50,
                                    +        "address_family": "ipv4",
                                    +        "local_gateway_v6_ip": null,
                                    +        "remote_gateway_v6_ip": null,
                                    +        "region_id": null,
                                    +        "enable_nqa": false,
                                    +        "enable_gre": false,
                                    +        "local_gre_tunnel_ip": null,
                                    +        "remote_gre_tunnel_ip": null,
                                    +        "lag_id": null
                                    +    } 
                                     }
                                  -

                                  Returned Value

                                  For details, see section Common Returned Values.

                                  +

                                  Status Codes

                                  For details, see Common Status Codes.

                                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025333.html b/docs/dc/api-ref/en-dc_topic_0055025333.html index 15ffd69f..b12d487c 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025333.html +++ b/docs/dc/api-ref/en-dc_topic_0055025333.html @@ -1,8 +1,9 @@

                                  Updating a Virtual Interface

                                  -

                                  Function

                                  This API is used to update a virtual interface.

                                  -
                                  • You can only increase the bandwidth.
                                  • Virtual interface bandwidths of hosted direct connections cannot be updated.
                                  +

                                  Function

                                  This API is used to update a virtual interface.

                                  +
                                  +

                                  The bandwidth specified for a virtual interface associated with a standard connection can be increased or decreased, but the bandwidth specified for a virtual interface associated with a hosted connection cannot be changed.

                                  URI

                                  PUT /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}

                                  @@ -30,109 +31,93 @@
                              -

                              Request

                              Table 2 lists the request parameter.

                              +

                              Request

                              Table 2 lists the request parameter.

                              -
                              Table 2 Request parameter

                              Parameter

                              +
                              - - - - - - -
                              Table 2 Request parameter

                              Parameter

                              Type

                              +

                              Type

                              Mandatory

                              +

                              Mandatory

                              Description

                              +

                              Description

                              virtual_interface

                              +

                              virtual_interface

                              Dictionary data structure

                              +

                              Dictionary

                              Yes

                              +

                              Yes

                              Specifies the virtual_interface object.

                              +

                              Specifies the virtual_interface object.

                              -
                              Table 3 Description of field virtual_interface

                              Parameter

                              +
                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                              Table 3 Description of field virtual_interface

                              Parameter

                              Type

                              +

                              Type

                              Mandatory

                              +

                              Mandatory

                              Description

                              +

                              Description

                              virtual_interface_id

                              +

                              virtual_interface_id

                              String

                              +

                              String

                              Yes

                              +

                              Yes

                              Specifies the virtual interface ID.

                              +

                              Specifies the virtual interface ID.

                              description

                              +

                              description

                              String

                              +

                              String

                              No

                              +

                              No

                              Provides supplementary information about the virtual interface.

                              +

                              Provides supplementary information about the virtual interface.

                              +

                              Angle brackets (<>) are not allowed.

                              name

                              +

                              name

                              String

                              +

                              String

                              No

                              +

                              No

                              Specifies the virtual interface name.

                              +

                              Specifies the virtual interface name.

                              +

                              Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

                              bandwidth

                              +

                              bandwidth

                              Integer

                              +

                              Integer

                              No

                              +

                              No

                              Specifies the virtual interface bandwidth.

                              +

                              Specifies the virtual interface bandwidth.

                              remote_ep_group_id

                              +

                              remote_ep_group_id

                              String

                              +

                              String

                              No

                              +

                              No

                              Specifies the ID of the remote endpoint group that records the tenant CIDR blocks.

                              -

                              service_ep_group_id

                              -

                              String

                              -

                              No

                              -

                              Specifies the ID of the service endpoint group that records the public service CIDR blocks.

                              -

                              rate_limit

                              -

                              Boolean

                              -

                              No

                              -

                              Specifies whether to limit the traffic rate. The value can be true or false.

                              +

                              Specifies the ID of the remote endpoint group that records the CIDR blocks used by the on-premises network.

                              -

                              Response

                              Table 4 lists the response parameter.

                              +

                              Response

                              Table 4 lists the response parameter.

                              @@ -144,7 +129,7 @@ - @@ -152,176 +137,9 @@
                              Table 4 Response parameter

                              Parameter

                              virtual_interface

                              Dictionary data structure

                              +

                              Dictionary

                              Specifies the virtual_interface object.

                              - -
                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                              Table 5 Description of field virtual_interface

                              Parameter

                              -

                              Type

                              -

                              Description

                              -

                              id

                              -

                              String

                              -

                              Specifies the virtual interface ID.

                              -

                              tenant_id

                              -

                              String

                              -

                              Specifies the project ID.

                              -

                              name

                              -

                              String

                              -

                              Specifies the virtual interface name.

                              -

                              description

                              -

                              String

                              -

                              Provides supplementary information about the virtual interface.

                              -

                              direct_connect_id

                              -

                              String

                              -

                              Specifies the connection ID.

                              -

                              vgw_ id

                              -

                              String

                              -

                              Specifies the virtual gateway ID.

                              -

                              type

                              -

                              String

                              -

                              Specifies the virtual interface type. The value can be public or private.

                              -

                              service_type

                              -

                              String

                              -

                              Specifies the access service type. The value can be vpc, public service, or vpc and public service.

                              -

                              vlan

                              -

                              Integer

                              -

                              Specifies the VLAN used by the local gateway to communicate with the remote gateway.

                              -

                              bandwidth

                              -

                              Integer

                              -

                              Specifies the virtual interface bandwidth.

                              -

                              local_gateway_v4_ip

                              -

                              String

                              -

                              Specifies the IPv4 address of the local gateway.

                              -

                              remote_gateway_v4_ip

                              -

                              String

                              -

                              Specifies the IPv4 address of the remote gateway.

                              -

                              route_mode

                              -

                              String

                              -

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

                              -

                              bgp_asn

                              -

                              Integer

                              -

                              Specifies the AS number of the BGP peer.

                              -

                              bgp_md5

                              -

                              String

                              -

                              Specifies the MD5 password of the BGP peer.

                              -

                              remote_ep_group_id

                              -

                              String

                              -

                              Specifies the ID of the remote endpoint group that records the tenant CIDRs.

                              -

                              service_ep_group_id

                              -

                              String

                              -

                              Specifies the ID of the service endpoint group that records the public service CIDR blocks.

                              -

                              create_time

                              -

                              String

                              -

                              Specifies the time when the virtual interface is created.

                              -

                              delete_time

                              -

                              String

                              -

                              Specifies the time when the virtual interface is deleted.

                              -

                              status

                              -

                              String

                              -

                              Specifies the virtual interface status.

                              -

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

                              -

                              admin_state_up

                              -

                              Boolean

                              -

                              Specifies the administrative status of the virtual interface.

                              -

                              The value can be true or false.

                              -

                              rate_limit

                              -

                              Boolean

                              -

                              Specifies whether to limit the traffic rate. The value can be true or false.

                              -
                              +

                              For details about the virtual_interface field, see Table 1.

                              -
                              -

                              Examples

                              • Example request
                                PUT /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}
                                +

                                Examples

                                • Example request
                                  PUT /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}
                                   {
                                       "virtual_interface" : {
                                           "name" : "virtual interface1",
                                  @@ -330,26 +148,45 @@
                                   }
                                -
                                • Example response
                                  {       
                                  -    "virtual_interface" : {
                                  -        "id" : "67c59cf4-1a64-46c7-763f-22eb1b9e8986",  
                                  -        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
                                  -        "name" : "virtual interface1",
                                  -        "description" : "New description",
                                  -        "direct_connect_id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
                                  -        "vgw_id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
                                  -        "type" : "private",
                                  -        "service_type" : "vpc",
                                  -        "vlan" : 100,
                                  -        "bandwidth" : 10,
                                  -        "local_gateway_v4_ip" : "180.1.1.1/24",
                                  -        "remote_gateway_v4_ip"  : "180.1.1.2/24",
                                  -        "route_mode"  : "static",
                                  -        "remote_ep_group_id" : "78e34cf1-5468-87c7-223d-56e78b9699ef"
                                  -    }
                                  +
                                  • Example response
                                    {        
                                    +    "virtual_interface" : { 
                                    +        "id": "634c61d0-fd7b-4961-adb6-37a2e3c42d08",
                                    +        "name": "virtual-interface1",
                                    +        "description": "New description",
                                    +        "tenant_id": "06057682ed80d5762f25c00b5deb794a",
                                    +        "direct_connect_id": "73707953-df69-4d03-8df5-b46a087c1424",
                                    +        "vgw_id": "9b5cab66-7634-4213-8d01-fa37cb908e12",
                                    +        "type": "private",
                                    +        "service_type": "vpc",
                                    +        "vlan": 687,
                                    +        "bandwidth": 2,
                                    +        "local_gateway_v4_ip": "11.11.11.1/30",
                                    +        "remote_gateway_v4_ip": "11.11.11.2/30",
                                    +        "route_mode": "static",
                                    +        "bgp_asn": null,
                                    +        "bgp_md5": null,
                                    +        "remote_ep_group_id": "a2b81f07-826f-40b0-9e8d-17d1af5230cf",
                                    +        "service_ep_group_id": null,
                                    +        "status": "ACTIVE",
                                    +        "create_time": "2021-12-15T08:31:27Z",
                                    +        "admin_state_up": true,
                                    +        "rate_limit": false,
                                    +        "enable_bfd": false,
                                    +        "health_check_source_ip": null,
                                    +        "route_limit": 50,
                                    +        "address_family": "ipv4",
                                    +        "local_gateway_v6_ip": null,
                                    +        "remote_gateway_v6_ip": null,
                                    +        "region_id": null,
                                    +        "enable_nqa": false,
                                    +        "enable_gre": false,
                                    +        "local_gre_tunnel_ip": null,
                                    +        "remote_gre_tunnel_ip": null,
                                    +        "lag_id": null
                                    +    } 
                                     }
                                  -

                                  Returned Value

                                  For details, see section Common Returned Values.

                                  +

                                  Status Codes

                                  For details, see Common Status Codes.

                                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025334.html b/docs/dc/api-ref/en-dc_topic_0055025334.html index 9fbd31fd..9fe853dd 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025334.html +++ b/docs/dc/api-ref/en-dc_topic_0055025334.html @@ -1,8 +1,11 @@ -

                                  Direct Connect Endpoint Group

                                  -

                                  + +

                                  Direct Connect Endpoint Group

                                  + +

                                  +
                                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025335.html b/docs/dc/api-ref/en-dc_topic_0055025335.html index 7c6d634d..b091cbc4 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025335.html +++ b/docs/dc/api-ref/en-dc_topic_0055025335.html @@ -1,100 +1,103 @@

                                  Overview

                                  -

                                  Object Introduction

                                  This section describes the APIs for managing and operating Direct Connect endpoint groups, including the APIs used to create, query, update, and delete a Direct Connect endpoint group, and the API used to query the Direct Connect endpoint group list.

                                  +

                                  Object Introduction

                                  This section describes the APIs for managing and operating Direct Connect endpoint groups, including the APIs used to create, query, update, and delete a Direct Connect endpoint group, and the API used to query the Direct Connect endpoint group list.

                                  +

                                  Direct Connect endpoint group APIs do not support IPv6 addresses.

                                  +
                                  -

                                  Object Model

                                  -
                                  Table 1 Direct Connect endpoint group objects

                                  Attribute

                                  +

                                  Object Model

                                  +
                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/dc/api-ref/en-dc_topic_0055025336.html b/docs/dc/api-ref/en-dc_topic_0055025336.html index 124e0684..51e8a48b 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025336.html +++ b/docs/dc/api-ref/en-dc_topic_0055025336.html @@ -7,83 +7,85 @@

                                  Request

                                  Table 1 lists the request parameter.

                                  -
                                  Table 1 Direct Connect endpoint group objects

                                  Parameter

                                  Type

                                  +

                                  Type

                                  CRUD

                                  +

                                  CRUD

                                  Default Value

                                  +

                                  Default Value

                                  Constraint

                                  +

                                  Constraint

                                  Description

                                  +

                                  Description

                                  id

                                  +

                                  id

                                  String

                                  +

                                  String

                                  R

                                  +

                                  R

                                  Automatically generated

                                  +

                                  Automatically generated

                                  uuid

                                  +

                                  UUID

                                  Specifies the ID of the Direct Connect endpoint group.

                                  +

                                  Specifies the ID of the Direct Connect endpoint group.

                                  tenant_id

                                  +

                                  tenant_id

                                  String

                                  +

                                  String

                                  CR

                                  +

                                  CR

                                  N/A

                                  +

                                  N/A

                                  The value can contain 0 to 255 characters.

                                  +

                                  The value can contain 0 to 255 characters.

                                  Specifies the project ID.

                                  +

                                  Specifies the tenant ID.

                                  name

                                  +

                                  name

                                  String

                                  +

                                  String

                                  CRU

                                  +

                                  CRU

                                  No

                                  +

                                  No

                                  The value can contain 0 to 64 characters.

                                  +

                                  The value can contain 0 to 64 characters.

                                  +

                                  Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

                                  Specifies the name of the Direct Connect endpoint group.

                                  +

                                  Specifies the name of the Direct Connect endpoint group.

                                  description

                                  +

                                  description

                                  String

                                  +

                                  String

                                  CRU

                                  +

                                  CRU

                                  No

                                  +

                                  No

                                  The value can contain 0 to 128 characters.

                                  +

                                  The value can contain 0 to 128 characters.

                                  +

                                  Angle brackets (<>) are not allowed.

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  +

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  endpoints

                                  +

                                  endpoints

                                  List<String>

                                  +

                                  List<String>

                                  CR

                                  +

                                  CR

                                  N/A

                                  +

                                  N/A

                                  N/A

                                  +

                                  N/A

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  +

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  type

                                  +

                                  type

                                  String

                                  +

                                  String

                                  CR

                                  +

                                  CR

                                  N/A

                                  +

                                  N/A

                                  Only cidr is supported.

                                  +

                                  Only IPv4 CIDR blocks are supported.

                                  Specifies the type of the Direct Connect endpoints.

                                  -

                                  The value can only be cidr.

                                  +

                                  Specifies the type of the Direct Connect endpoints.

                                  Table 1 Request parameter

                                  Parameter

                                  +
                                  - - - - - - -
                                  Table 1 Request parameter

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Mandatory

                                  +

                                  Mandatory

                                  Description

                                  +

                                  Description

                                  dc_endpoint_group

                                  +

                                  dc_endpoint_group

                                  Dictionary data structure

                                  +

                                  Dictionary

                                  Yes

                                  +

                                  Yes

                                  Specifies the dc_endpoint_group object.

                                  +

                                  Specifies the dc_endpoint_group object.

                                  -
                                  Table 2 Description of field dc_endpoint_group

                                  Parameter

                                  +
                                  - - - - - - - - - - - - - - - - - - - - - - - @@ -92,74 +94,74 @@

                                  Response

                                  Table 3 lists the response parameter.

                                  -
                                  Table 2 Description of field dc_endpoint_group

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Mandatory

                                  +

                                  Mandatory

                                  Description

                                  +

                                  Description

                                  tenant_id

                                  +

                                  tenant_id

                                  String

                                  +

                                  String

                                  Yes

                                  +

                                  Yes

                                  Specifies the project ID.

                                  +

                                  Specifies the project ID.

                                  name

                                  +

                                  name

                                  String

                                  +

                                  String

                                  No

                                  +

                                  No

                                  Specifies the name of the Direct Connect endpoint group.

                                  +

                                  Specifies the name of the Direct Connect endpoint group.

                                  +

                                  Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

                                  description

                                  +

                                  description

                                  String

                                  +

                                  String

                                  No

                                  +

                                  No

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  +

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  +

                                  Angle brackets (<>) are not allowed.

                                  endpoints

                                  +

                                  endpoints

                                  List<String>

                                  +

                                  List<String>

                                  Yes

                                  +

                                  Yes

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  +

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  type

                                  +

                                  type

                                  String

                                  +

                                  String

                                  Yes

                                  +

                                  Yes

                                  Specifies the type of the Direct Connect endpoints.

                                  -

                                  The value can only be cidr.

                                  +

                                  Specifies the type of the Direct Connect endpoints. The value can only be cidr.

                                  +

                                  Only IPv4 CIDR blocks are supported.

                                  Table 3 Response parameter

                                  Parameter

                                  +
                                  - - - - -
                                  Table 3 Response parameter

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  dc_endpoint_group

                                  +

                                  dc_endpoint_group

                                  Dictionary data structure

                                  +

                                  Dictionary

                                  Specifies the dc_endpoint_group object.

                                  +

                                  Specifies the dc_endpoint_group object.

                                  -
                                  Table 4 Description of field dc_endpoint_group

                                  Parameter

                                  +
                                  - - - - - - - - - - - - - - - - - - - - @@ -187,7 +189,7 @@ } } -

                                  Returned Value

                                  For details, see section Common Returned Values.

                                  +

                                  Status Codes

                                  For details, see Common Status Codes.

                                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025337.html b/docs/dc/api-ref/en-dc_topic_0055025337.html index 5da609b2..b093112c 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025337.html +++ b/docs/dc/api-ref/en-dc_topic_0055025337.html @@ -7,23 +7,23 @@

                                  Request

                                  Table 1 lists the request parameter.

                                  -
                                  Table 4 Description of field dc_endpoint_group

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  id

                                  +

                                  id

                                  String

                                  +

                                  String

                                  Specifies the ID of the Direct Connect endpoint group.

                                  +

                                  Specifies the ID of the Direct Connect endpoint group.

                                  tenant_id

                                  +

                                  tenant_id

                                  String

                                  +

                                  String

                                  Specifies the project ID.

                                  +

                                  Specifies the project ID.

                                  name

                                  +

                                  name

                                  String

                                  +

                                  String

                                  Specifies the name of the Direct Connect endpoint group.

                                  +

                                  Specifies the name of the Direct Connect endpoint group.

                                  description

                                  +

                                  description

                                  String

                                  +

                                  String

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  +

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  endpoints

                                  +

                                  endpoints

                                  List<String>

                                  +

                                  List<String>

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  +

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  type

                                  +

                                  type

                                  String

                                  +

                                  String

                                  Specifies the type of the Direct Connect endpoints.

                                  -

                                  The value can only be cidr.

                                  +

                                  Specifies the type of the Direct Connect endpoints. The value can only be cidr.

                                  +

                                  Only IPv4 CIDR blocks are supported.

                                  Table 1 Request parameter

                                  Parameter

                                  +
                                  - - - - - - - @@ -33,83 +33,83 @@

                                  Response

                                  Table 2 lists the response parameter.

                                  -
                                  Table 1 Request parameter

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Mandatory

                                  +

                                  Mandatory

                                  Description

                                  +

                                  Description

                                  fields

                                  +

                                  fields

                                  String

                                  +

                                  String

                                  No

                                  +

                                  No

                                  Specifies the parameters expected to be returned.

                                  +

                                  Specifies the parameters expected to be returned.

                                  If you do not specify it, all parameters will be returned.

                                  Table 2 Response parameter

                                  Parameter

                                  +
                                  - - - - -
                                  Table 2 Response parameter

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  dc_endpoint_groups

                                  +

                                  dc_endpoint_groups

                                  List data structure

                                  +

                                  List

                                  Specifies the Direct Connect endpoint group list.

                                  +

                                  Specifies the Direct Connect endpoint group list.

                                  -
                                  - @@ -30,23 +30,23 @@

                                  Request

                                  Table 2 lists the request parameter.

                                  -
                                  Table 3 Description of field dc_endpoint_groups

                                  Parameter

                                  +
                                  - - - - - - - - - - - - - - - - - - - -
                                  Table 3 Description of field dc_endpoint_groups

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  id

                                  +

                                  id

                                  String

                                  +

                                  String

                                  Specifies the ID of the Direct Connect endpoint group.

                                  +

                                  Specifies the ID of the Direct Connect endpoint group.

                                  tenant_id

                                  +

                                  tenant_id

                                  String

                                  +

                                  String

                                  Specifies the project ID.

                                  +

                                  Specifies the project ID.

                                  name

                                  +

                                  name

                                  String

                                  +

                                  String

                                  Specifies the name of the Direct Connect endpoint group.

                                  +

                                  Specifies the name of the Direct Connect endpoint group.

                                  description

                                  +

                                  description

                                  String

                                  +

                                  String

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  +

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  endpoints

                                  +

                                  endpoints

                                  List<String>

                                  +

                                  List<String>

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  +

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  type

                                  +

                                  type

                                  String

                                  +

                                  String

                                  Specifies the type of the Direct Connect endpoints.

                                  -

                                  The value can only be cidr.

                                  +

                                  Specifies the type of the Direct Connect endpoints. The value can only be cidr.

                                  +

                                  Only IPv4 CIDR blocks are supported.

                                  -

                                  Examples

                                  • Example request
                                    1. All parameters are returned:
                                    +

                                    Examples

                                    • Example request
                                      1. Querying all Direct Connect endpoint groups
                                      GET /v2.0/dcaas/dc-endpoint-groups
                                      -
                                      1. Filtered parameters are returned (for example, the filter is ID):
                                      +
                                      1. Querying a Direct Connect endpoint group by ID
                                      GET /v2.0/dcaas/dc-endpoint-groups?id=6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
                                    @@ -124,7 +124,7 @@ }] }
                                  -

                                  Returned Value

                                  For details, see section Common Returned Values.

                                  +

                                  Status Codes

                                  For details, see Common Status Codes.

                                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025338.html b/docs/dc/api-ref/en-dc_topic_0055025338.html index c8bb7411..9fa87e9f 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025338.html +++ b/docs/dc/api-ref/en-dc_topic_0055025338.html @@ -21,7 +21,7 @@

                                  Yes

                                  Indicates the ID of the Direct Connect endpoint group.

                                  +

                                  Specifies the ID of the Direct Connect endpoint group.

                                  Table 2 Request parameter

                                  Parameter

                                  +
                                  - - - - - - - @@ -60,7 +60,7 @@
                                  • Response example

                                    None

                                  -

                                  Returned Value

                                  For details, see section Common Returned Values.

                                  +

                                  Status Codes

                                  For details, see Common Status Codes.

                                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025339.html b/docs/dc/api-ref/en-dc_topic_0055025339.html index 83c2f32d..d3461ad9 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025339.html +++ b/docs/dc/api-ref/en-dc_topic_0055025339.html @@ -30,23 +30,23 @@

                                  Request

                                  Table 2 lists the request parameter.

                                  -
                                  Table 2 Request parameter

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Mandatory

                                  +

                                  Mandatory

                                  Description

                                  +

                                  Description

                                  endpoint_group_id

                                  +

                                  endpoint_group_id

                                  String

                                  +

                                  String

                                  Yes

                                  +

                                  Yes

                                  Indicates the ID of the Direct Connect endpoint group.

                                  +

                                  Specifies the ID of the Direct Connect endpoint group.

                                  Table 2 Request parameter

                                  Parameter

                                  +
                                  - - - - - - - @@ -55,74 +55,74 @@

                                  Response

                                  Table 3 lists the response parameter.

                                  -
                                  Table 2 Request parameter

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Mandatory

                                  +

                                  Mandatory

                                  Description

                                  +

                                  Description

                                  endpoint_group_id

                                  +

                                  endpoint_group_id

                                  String

                                  +

                                  String

                                  Yes

                                  +

                                  Yes

                                  Specifies the ID of the Direct Connect endpoint group.

                                  +

                                  Specifies the ID of the Direct Connect endpoint group.

                                  Table 3 Response parameter

                                  Parameter

                                  +
                                  - - - - -
                                  Table 3 Response parameter

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  dc_endpoint_group

                                  +

                                  dc_endpoint_group

                                  Dictionary data structure

                                  +

                                  Dictionary

                                  Specifies the dc_endpoint_group object.

                                  +

                                  Specifies the dc_endpoint_group object.

                                  -
                                  Table 4 Description of field dc_endpoint_group

                                  Parameter

                                  +
                                  - - - - - - - - - - - - - - - - - - - - @@ -143,7 +143,7 @@ } } -

                                  Returned Value

                                  For details, see section Common Returned Values.

                                  +

                                  Status Codes

                                  For details, see Common Status Codes.

                                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025340.html b/docs/dc/api-ref/en-dc_topic_0055025340.html index ebbd146f..ad3430a2 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025340.html +++ b/docs/dc/api-ref/en-dc_topic_0055025340.html @@ -30,55 +30,57 @@

                                  Request

                                  Table 2 lists the request parameter.

                                  -
                                  Table 4 Description of field dc_endpoint_group

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  id

                                  +

                                  id

                                  String

                                  +

                                  String

                                  Specifies the ID of the Direct Connect endpoint group.

                                  +

                                  Specifies the ID of the Direct Connect endpoint group.

                                  tenant_id

                                  +

                                  tenant_id

                                  String

                                  +

                                  String

                                  Specifies the project ID.

                                  +

                                  Specifies the project ID.

                                  name

                                  +

                                  name

                                  String

                                  +

                                  String

                                  Specifies the name of the Direct Connect endpoint group.

                                  +

                                  Specifies the name of the Direct Connect endpoint group.

                                  description

                                  +

                                  description

                                  String

                                  +

                                  String

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  +

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  endpoints

                                  +

                                  endpoints

                                  List<String>

                                  +

                                  List<String>

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  +

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  type

                                  +

                                  type

                                  String

                                  +

                                  String

                                  Specifies the type of the Direct Connect endpoints.

                                  -

                                  The value can only be cidr.

                                  +

                                  Specifies the type of the Direct Connect endpoints. The value can only be cidr.

                                  +

                                  Only IPv4 CIDR blocks are supported.

                                  Table 2 Request parameter

                                  Parameter

                                  +
                                  - - - - - - -
                                  Table 2 Request parameter

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Mandatory

                                  +

                                  Mandatory

                                  Description

                                  +

                                  Description

                                  dc_endpoint_group

                                  +

                                  dc_endpoint_group

                                  Dictionary data structure

                                  +

                                  Dictionary

                                  Yes

                                  +

                                  Yes

                                  Specifies the dc_endpoint_group object.

                                  +

                                  Specifies the dc_endpoint_group object.

                                  -
                                  Table 3 Description of field dc_endpoint_group

                                  Parameter

                                  +
                                  - - - - - - - - - - - @@ -87,74 +89,74 @@

                                  Response

                                  Table 4 lists the response parameter.

                                  -
                                  Table 3 Description of field dc_endpoint_group

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Mandatory

                                  +

                                  Mandatory

                                  Description

                                  +

                                  Description

                                  description

                                  +

                                  description

                                  String

                                  +

                                  String

                                  No

                                  +

                                  No

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  +

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  +

                                  Angle brackets (<>) are not allowed.

                                  name

                                  +

                                  name

                                  String

                                  +

                                  String

                                  No

                                  +

                                  No

                                  Specifies the name of the Direct Connect endpoint group.

                                  +

                                  Specifies the name of the Direct Connect endpoint group.

                                  +

                                  Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.

                                  Table 4 Response parameter

                                  Parameter

                                  +
                                  - - - - -
                                  Table 4 Response parameter

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  dc_endpoint_group

                                  +

                                  dc_endpoint_group

                                  Dictionary data structure

                                  +

                                  Dictionary

                                  Specifies the dc_endpoint_group object.

                                  +

                                  Specifies the dc_endpoint_group object.

                                  -
                                  Table 5 Description of field dc_endpoint_group

                                  Parameter

                                  +
                                  - - - - - - - - - - - - - - - - - - - - @@ -181,7 +183,7 @@ } } -

                                  Returned Value

                                  For details, see section Common Returned Values.

                                  +

                                  Status Codes

                                  For details, see Common Status Codes.

                                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025341.html b/docs/dc/api-ref/en-dc_topic_0055025341.html index 0a851d9b..90c9b9b0 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025341.html +++ b/docs/dc/api-ref/en-dc_topic_0055025341.html @@ -4,7 +4,7 @@
                                  Table 5 Description of field dc_endpoint_group

                                  Parameter

                                  Type

                                  +

                                  Type

                                  Description

                                  +

                                  Description

                                  id

                                  +

                                  id

                                  String

                                  +

                                  String

                                  Specifies the ID of the Direct Connect endpoint group.

                                  +

                                  Specifies the ID of the Direct Connect endpoint group.

                                  tenant_id

                                  +

                                  tenant_id

                                  String

                                  +

                                  String

                                  Specifies the project ID.

                                  +

                                  Specifies the project ID.

                                  name

                                  +

                                  name

                                  String

                                  +

                                  String

                                  Specifies the name of the Direct Connect endpoint group.

                                  +

                                  Specifies the name of the Direct Connect endpoint group.

                                  description

                                  +

                                  description

                                  String

                                  +

                                  String

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  +

                                  Provides supplementary information about the Direct Connect endpoint group.

                                  endpoints

                                  +

                                  endpoints

                                  List<String>

                                  +

                                  List<String>

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  +

                                  Specifies the list of the endpoints in a Direct Connect endpoint group.

                                  type

                                  +

                                  type

                                  String

                                  +

                                  String

                                  Specifies the type of the Direct Connect endpoints.

                                  -

                                  The value can only be cidr.

                                  +

                                  Specifies the type of the Direct Connect endpoints. The value can only be cidr.

                                  +

                                  Only IPv4 CIDR blocks are supported.

                                  Normal Response Code

                                  +
                                  - @@ -14,28 +14,28 @@ - - -

                                  Successful Response

                                  Type

                                  +

                                  Message

                                  Description

                                  OK

                                  Specifies the normal response code for the GET and PUT operations.

                                  +

                                  Normal response code for GET and PUT operations

                                  201

                                  Created

                                  Specifies the normal response code for the POST operation.

                                  +

                                  Normal response code for POST operations

                                  204

                                  No Content

                                  Specifies the normal response code for the DELETE operation.

                                  +

                                  Normal response code for DELETE operations

                                  -

                                  Returned Value

                                  +
                                  diff --git a/docs/dc/api-ref/en-dc_topic_0055025343.html b/docs/dc/api-ref/en-dc_topic_0055025343.html index 7b48b78d..eb800adf 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025343.html +++ b/docs/dc/api-ref/en-dc_topic_0055025343.html @@ -2,185 +2,689 @@

                                  Error Codes

                                  -

                                  Error Response

                                  Description

                                  Service

                                  +
                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/dc/api-ref/en-dc_topic_0055025347.html b/docs/dc/api-ref/en-dc_topic_0055025347.html index a5fb86c3..f34348e1 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025347.html +++ b/docs/dc/api-ref/en-dc_topic_0055025347.html @@ -2,13 +2,67 @@

                                  Change History

                                  -

                                  Status Code

                                  Module

                                  +

                                  Error Code

                                  Error Code

                                  +

                                  Description

                                  HTTP Status Code

                                  -

                                  Description

                                  -

                                  Solution

                                  +

                                  Solution

                                  Direct Connect

                                  +

                                  400

                                  Direct Connect

                                  +

                                  DC.0000

                                  VPC.1901

                                  +

                                  The request body is abnormal.

                                  400

                                  -

                                  This connection does not exist.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Correct the parameter settings and send the request again.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1902

                                  +

                                  DC.0001

                                  400

                                  +

                                  Request parameter error.

                                  This virtual gateway does not exist.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Correct the parameter settings and send the request again.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1903

                                  +

                                  DC.0002

                                  400

                                  +

                                  The resource to be operated or queried does not exist.

                                  This virtual interface does not exist.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Correct the parameter settings and send the request again.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1904

                                  +

                                  DC.0003

                                  400

                                  +

                                  System error.

                                  The hosting and hosted direct connections cannot automatically match each other.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Correct the parameter settings and send the request again.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1907

                                  +

                                  DC.0004

                                  400

                                  +

                                  The IP address is invalid.

                                  Some connection parameters are incorrectly configured.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Correct the parameter settings and send the request again.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1908

                                  +

                                  DC.0005

                                  400

                                  +

                                  Failed to call the VPC API.

                                  Some virtual gateway parameters are incorrectly configured.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Correct the parameter settings and send the request again.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1909

                                  +

                                  DC.0007

                                  400

                                  +

                                  The VPC does not exist.

                                  Some virtual interface parameters are incorrectly configured.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Correct the parameter settings and send the request again.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1911

                                  +

                                  DC.0008

                                  400

                                  +

                                  The BGP ASN is out of range.

                                  The virtual gateway type is incorrect.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Correct the parameter settings and send the request again.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1918

                                  +

                                  DC.0009

                                  400

                                  +

                                  Invalid policy.

                                  A virtual interface can be specified to only one hosted direct connection.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Contact technical support.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1924

                                  +

                                  DC.0010

                                  400

                                  +

                                  The VPC_VNI does not exist.

                                  No direct connection resources available

                                  -

                                  Contact technical support.

                                  +

                                  Contact technical support.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1925

                                  +

                                  DC.0011

                                  400

                                  +

                                  The AGENT is abnormal.

                                  No VLANs are available for hosting direct connections.

                                  -

                                  Contact technical support.

                                  +

                                  Correct the parameter settings and send the request again.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1927

                                  +

                                  DC.0012

                                  400

                                  +

                                  Failed to call the CBC API.

                                  The bandwidth of a connection cannot be changed to a smaller value.

                                  -

                                  Correct the parameter settings and send the request again.

                                  +

                                  Contact technical support.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1931

                                  +

                                  DC.0013

                                  400

                                  +

                                  You have no permission to operate the field.

                                  Direct Connect is incorrectly configured.

                                  -

                                  Contact technical support.

                                  +

                                  Contact technical support.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1932

                                  +

                                  DC.1000

                                  400

                                  +

                                  Insufficient connection bandwidth.

                                  Direct Connect is incorrectly configured.

                                  -

                                  Contact technical support.

                                  +

                                  Contact technical support.

                                  Direct Connect

                                  +

                                  400

                                  VPC.1934

                                  +

                                  DC.1001

                                  400

                                  +

                                  A VLAN is specified for a non-hosted connection.

                                  A VPC can be specified to only one virtual gateway.

                                  +

                                  Contact technical support.

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1002

                                  +

                                  Failed to create a hosted connection.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1003

                                  +

                                  A VLAN is not specified for a hosted connection.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1004

                                  +

                                  A non-operations connection is selected for creating a hosted connection.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1005

                                  +

                                  The connection is abnormal.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1006

                                  +

                                  The device and type cannot be modified when the connection is in use.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1007

                                  +

                                  The connection is in use.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1008

                                  +

                                  Hosted connection VLANs conflict.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1010

                                  +

                                  Connection bandwidth is decreased.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1011

                                  +

                                  Connection bandwidth cannot be modified.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1012

                                  +

                                  The connection does not exist.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1015

                                  +

                                  The connection or LAG does not exist.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1019

                                  +

                                  The connection quota has been used up.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1100

                                  +

                                  The local endpoint group ID of the virtual gateway is invalid.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1101

                                  +

                                  The number of local subnets exceeds the limit.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1102

                                  +

                                  The standby device is specified when the active device is not specified.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1103

                                  +

                                  The active and standby devices are the same.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1104

                                  +

                                  The device information cannot be updated for the virtual gateway.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1105

                                  +

                                  The local CIDR block overlap with the remote CIDR block.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1106

                                  +

                                  The virtual gateway is in use.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1107

                                  +

                                  Virtual gateway VLANs are exhausted.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1108

                                  +

                                  Virtual gateway VNIs are exhausted.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1109

                                  +

                                  Virtual gateway VRFs are exhausted.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1110

                                  +

                                  A virtual gateway has been associated with the VPC.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1111

                                  +

                                  This virtual gateway does not exist.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1112

                                  +

                                  The devices used the virtual gateway are not in active/standby mode.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1113

                                  +

                                  The virtual gateway is in the cutover state.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1114

                                  +

                                  traffic_mode cannot be updated for VLANs or virtual gateways with a single VTEP device.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1115

                                  +

                                  The VNI of the virtual gateway does not exist.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1116

                                  +

                                  Failed to update the route gateway.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1117

                                  +

                                  The virtual gateway has been associated with two connections and cannot be associated with more connections.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1118

                                  +

                                  The virtual gateway is being operated (locked).

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1119

                                  +

                                  Failed to create the route gateway device group.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1120

                                  +

                                  The main_az_list configuration item is incorrect.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1200

                                  +

                                  No LAG or connection is specified for the virtual interface.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1201

                                  +

                                  The connection does not match the virtual gateway type.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1202

                                  +

                                  Virtual interfaces of the double ipsec type cannot be created.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1203

                                  +

                                  No ASN is specified for a BGP virtual interface.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1204

                                  +

                                  Creating virtual interfaces is not supported for operations connections.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1205

                                  +

                                  The status of the resource associated with the virtual interface is abnormal.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1206

                                  +

                                  The hosted connection has been associated with a virtual interface.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1207

                                  +

                                  The VLAN of the virtual interface is inconsistent with that of the hosted connection.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1208

                                  +

                                  The bandwidth of the virtual interface associated with a hosted connection cannot be modified.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1209

                                  +

                                  Virtual interface VLANs conflict.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1210

                                  +

                                  The virtual interface status cannot be changed.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1211

                                  +

                                  This virtual interface does not exist.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1212

                                  +

                                  The virtual gateway is in a different group from the connection.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1213

                                  +

                                  The virtual interface does not match the tenant.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1214

                                  +

                                  The virtual interface has been used.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1215

                                  +

                                  The virtual interface type does not match.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1216

                                  +

                                  The local gateway to be associated or disassociated is invalid.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1219

                                  +

                                  A virtual interface with VLAN 0 is created.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1221

                                  +

                                  The selected virtual gateway device does not support access from Direct Connect locations.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1223

                                  +

                                  The local BGP ASN is the same as the remote BGP ASN.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1225

                                  +

                                  The number of virtual interfaces for which traffic statistics collection is enabled exceeds the limit.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1226

                                  +

                                  Traffic statistics collection cannot be enabled on Layer 2 remote interfaces that have no sub-interfaces.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1227

                                  +

                                  Traffic statistics cannot be updated because the VIF is abnormal.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1400

                                  +

                                  The number of endpoint groups exceeds the limit.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1401

                                  +

                                  Duplicate CIDR blocks.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1402

                                  +

                                  The endpoint group is in use.

                                  +

                                  Contact technical support.

                                  +

                                  400

                                  +

                                  DC.1403

                                  +

                                  The endpoint group does not exist.

                                  +

                                  Contact technical support.

                                  Released On

                                  +
                                  - + + + + + + + + + + + + + + + + + + + + + + + + + + +

                                  Released On

                                  What's New

                                  2018-10-30

                                  +

                                  2023-04-17

                                  +

                                  This release incorporates the following changes:

                                  +

                                  Added Introduction, Connections, Virtual Gateways, and Virtual Interfaces in Permissions Policies and Supported Actions.

                                  +

                                  2023-04-12

                                  +

                                  This release incorporates the following changes:

                                  +
                                  • Updated the description of parameter charge_mode in Table 1.
                                  • Updated the description of parameter charge_mode in Table 2.
                                  +

                                  2023-04-04

                                  +

                                  This release incorporates the following changes:

                                  +
                                  • Updated the description of parameter port_type in Table 1.
                                  • Updated the description of parameter port_type in Table 2.
                                  • Added parameter rate_limit in Table 1.
                                  +

                                  2023-03-23

                                  +

                                  This release incorporates the following changes:

                                  + +

                                  2023-02-24

                                  +

                                  This release incorporates the following changes:

                                  + +

                                  2023-02-14

                                  +

                                  This release incorporates the following changes:

                                  + +

                                  2023-01-03

                                  +

                                  This release incorporates the following changes:

                                  + +

                                  2022-12-07

                                  +

                                  This release incorporates the following changes:

                                  + +

                                  2022-10-13

                                  +

                                  This release incorporates the following changes:

                                  + +

                                  2018-10-30

                                  This release incorporates the following changes:

                                  @@ -29,13 +83,13 @@

                                  2018-02-18

                                  This release incorporates the following changes:

                                  - +

                                  2017-11-30

                                  This release incorporates the following changes:

                                  -
                                  • Updated the parameters in the "Connection object" table.
                                  • Added parameters type and ipsec_bandwidth to the "Virtual gateway object" table.
                                  +
                                  • Updated the parameters in the "Connection object" table.
                                  • Added parameters type and ipsec_bandwidth to the "Virtual gateway object" table.

                                  2017-9-30

                                  diff --git a/docs/dc/api-ref/public_sys-resources/delta.gif b/docs/dc/api-ref/public_sys-resources/delta.gif index f1371e584da7804dca33b8aeed70fd6f5cdc087a..0d1b1f6741fd17ee01fb5b5c1a4396dea28b6a93 100644 GIT binary patch literal 836 zcmchWF>01!5QImN;7^FeRDuvlieQm$nqSgH2#ST^0cx)=Dn zcnY!FJo_HPt-fVW+YdiB+UT#;6V;vF(d}+cR@IeV(d8~pF{?8>qtl(5 z-l&f3hz@sXMqTY}N84?I)T&mtqU9C|*g%8DFx{Fx6Im5iuF|X}%dCt_S87;LjI4+X zS7=Dl>numvWx_9&xPzYqFMxz!h@dKJnV+WiNj6zrg25Bat1rHX34YcM&(@mM25EsKp^s$!A zn#VD|u6s{$op5YkSDD^r^tisfo6%**9APOOq(ypevUm*eg627JCCoz;t2Wm=9wHzA zIZpn)d?D?0K6~e%(5n+Y{``IW_383vZ~ype`|Z!iyVvi|9^OBm{|3IMllZ91;fssK6Bmk0OU=nm;DqFF$=FTLeZP~_mLKlWJ HFjxZssyz>} diff --git a/docs/dc/api-ref/public_sys-resources/deltaend.gif b/docs/dc/api-ref/public_sys-resources/deltaend.gif index c79293760198b9a8bb91e127d3113f325e4a0c1f..cc7da0fc80c38fbab9ef85bf8d9e69a8f9cd4870 100644 GIT binary patch literal 834 zcmchWF;1LO41@=1m1T=9Xwnb~QAR>E(}2>Xh(M9J1dY2CIYT07X)PL*D{uoU3SWSe zM5)Z@cZj(9E!*Rn@%yj8UtL_@?zGcisVAyCyQACPnyjiTyQ0fonqpRGc1EW=HN8j060m^=i($GodnU3fs$8X6OO{y~m9EsVpcq*Z6|T^b zqSslDvde-aqopiG$tAYJ8Zb!15?a()3^veUF{}|ZIT4x8)aYX^Swx02G;(1<(UEpq zsD~82sYp46Jp6zr)7XK2NT3kbfI%9Tw8DeMU;_=7#;04Wd;7XW>CRXi!yzvnE_|I|r wZ*w5M>1_7SKcT}DJ@4vn|M>OS_UPly>%-H_{r>p;)5Xs}-+pgDf7s~DJ6{D>Q~&?~ literal 56 zcmZ?wbhEHb|3IMllZ91;fssK6Bmk0OVB+s#PS`bvcj9creZ}ijxy2c* E0fV~^4*&oF diff --git a/docs/dc/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/dc/api-ref/public_sys-resources/icon-arrowdn.gif index 84eec9be2f2ce458e888f8a9b803f9387247726a..379428032932289326e52c2772bd90ba3d88b906 100644 GIT binary patch literal 1887 zcmZ?wbhEHbCgqow z*eU^C3h_d20o>TUVm+{T^pf*)^(zt!^bPe4Kwg3=^!3HBG&dKny0|1L72#g21{a4^ z7NqJ2r55Lx7A2Jm>Ih`8X1|p zSh~8p7&*iAy5uL9=BDPA!1Sgd^t#~G3rY&P1wfl!Qj0RnQd8WD@^clyUbf1_?G{Iz z=0WwQ;C71>PQCg-$LND17Ac}(Lcr7mV#1RxkONQnsd>QEUIa|mjQ{`r{qy_R&mZ5v zef{$J)5j0*-@SeF`qj%9&!0Vg^7zri2lwyYy>t84%^TORUA=Po(!~qs&z(JU`qar2 z$B!L7a`@1}1N-;w-Lrew&K=vgZQZhY)5ZeMTG_VdAT{+S(zE> zX{jm6Nr?&Zaj`McQIQehVWA3>*p!%p5Wn0u7E$th{n6D>ft^YU5&dnB%c=(a~-RV>2EO25SIA CZ-yWM literal 68 zcmZ?wbhEHbzkByxQ$u Mo$o?7J5~m305MV#!~g&Q diff --git a/docs/dc/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/dc/api-ref/public_sys-resources/icon-arrowrt.gif index 39583d168d6db303b366b5b8c1780698a6bb6017..6aaaa11c23e919c4798d7dcd2b1ae98dd35dd316 100644 GIT binary patch literal 1890 zcmZ?wbhEHb7yetOgf{ zR2HP_2c;J0mlh?b0+lO+tSYc_E=o--$uA1Y&(DE{Vn9ZINq%ugeu08>u$h8JcxGNo zetEGbSiP^Wm1kaYNn&1ds;7&s63_&_%*+%k11Cod14Ab>6ALqQLqk^=3j-5FHzP|& zBUd9gQwvj9m|mCsATTyHM;rzL?XHK6w zdE)r7qel)OI(T6JzP)>P@7lRz`?jrHHgDRvVg0(bYgVsXxnlXUrArnsTDV~Tyt#8` z&zd=7`n0K2CQq6;p}()Ur@O1OqrI)QrMaoGp}wxRrn;)KqP(oMq`0WCAU`iRCp#-M zBRwrOB{?ZEAwDiPCORrIB0MZKBseHAz~9f;$J@)(!`;o*#o5Wx!QRf+#@fo#!raW% z#MsEtKwnQ+M_Wr%LtRZ(MOjHvL0(Q)Mp{ZzLR?H#L|8~rfS-?-hntI&gPo0)g_((w zfkE*n3y@@B&;b#k`jUY|nSq%>!ec`MLnAA%oR7zc2TpB#@>)|YCO&lN;uMU!b7Eqm H1A{dHTIz>f literal 70 zcmZ?wbhEHbEMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 580 zcmV-K0=xZ3Nk%w1VIu$?0Hp~4{QBgqmQ+MG9K51r{QB&)np^||1PlfQ%(86!{`~yv zv{XhUWKt}AZaiE{EOcHp{O-j3`t;<+eEiycJT4p@77X;(jQsMfB$R?oG%6hQ z+MMLZbQBH@)Vg&1^3?qHb(5!%>3r0+`eq=&V&E}0Dypi0000000000 z00000A^8LW000R9EC2ui03!e$000L5z=Uu}ED8YtqjJd<+B}(9bIOb$3-31_h|V>=0A{ z1Hh0#H30>fNT})^fRU_83uewx9oRr{f{Sx1Ml`t)EQ zGkHZ67&~y{W5Jpq4H_WfuLxp*3<7O}GEl;1ESe36fLNs=B0&LQM1Buf(R)qg(BRd`t1OPjI1m_q4 diff --git a/docs/dc/api-ref/public_sys-resources/icon-danger.gif b/docs/dc/api-ref/public_sys-resources/icon-danger.gif index 6e90d7cfc2193e39e10bb58c38d01a23f045d571..079c79b263f4b48089f3b3256154c73e7699593f 100644 GIT binary patch literal 1086 zcmW+#YfRQ<6hA3LZMyP?V}KhnEtF{Q4vGxS52AozEVM85nq$#%tv8gRF!3GhgM?_) zd5Luv3SKrXFTGCpn$y>EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 580 zcmV-K0=xZ3Nk%w1VIu$?0Hp~4{QBgqmQ+MG9K51r{QB&)np^||1PlfQ%(86!{`~yv zv{XhUWKt}AZaiE{EOcHp{O-j3`t;<+eEiycJT4p@77X;(jQsMfB$R?oG%6hQ z+MMLZbQBH@)Vg&1^3?qHb(5!%>3r0+`eq=&V&E}0Dypi0000000000 z00000A^8LW000R9EC2ui03!e$000L5z=Uu}ED8YtqjJd<+B}(9bIOb$3-31_h|V>=0A{ z1Hh0#H30>fNT})^fRU_83uewx9oRr{f{Sx1Ml`t)EQ zGkHZ67&~y{W5Jpq4H_WfuLxp*3<7O}GEl;1ESe36fLNs=B0&LQM1Buf(R)qg(BRd`t1OPjI1m_q4 diff --git a/docs/dc/api-ref/public_sys-resources/icon-note.gif b/docs/dc/api-ref/public_sys-resources/icon-note.gif index 6314297e45c1de184204098efd4814d6dc8b1cda..31be2b0398ac991e5cff547ef0b10019f1bf267e 100644 GIT binary patch literal 983 zcmcIj&r8&C5S{3kA#~VvcMn;RNQia_r>GEOJ7jGVWt0R$WZ8s=je-u*DOe&kq9}!i z4KyN^y7WUtlMt&*F%bljtRbDEJamX6>@vOi{twMwE+=kqtJr%yLc-a1j}Z>-)`f9GBO%WDhy=L0>5=eLzUZCI?G``P_| zXl3c^-NL}=_M!Zh=FG7pU)shB58htr9~}O0uVbq2_rt-Fxv_(zmmdB7)lfOReyZ>D zrqum6#Z#+~moGM-oS4Ziby(A(@4L&ZrWcR4wV&_mTide#$G4kXKF-|cGp}2pJe$2t GE&l)<3Z_>8 literal 394 zcmZ?wbhEHblx7fPSjxcg=ii?@_wH=jwxy=7CMGH-B`L+l$wfv=#>UF#$gv|VY%C^b zCQFtrnKN(Bo_%|sJbO}7RAORe!otL&qo<>yq_Sq+8Xqqo5h0P3w3Lvb5E(g{p01vl zxR@)KuDH0l^z`+-dH3eaw=XqSH7aTIx{kzVBN;X&hha0dQSgWuiw0NWUvMRmkD|> diff --git a/docs/dc/api-ref/public_sys-resources/icon-notice.gif b/docs/dc/api-ref/public_sys-resources/icon-notice.gif index 3f4e40cec18575b5ed04ee804732d34a476ff360..409070650a49518feb1624c624d814c3bfa63d2e 100644 GIT binary patch literal 962 zcmb7D&r8&C5S<{wSd_qn6)U)w5LOaRh!N}_*49lD)S!dZp@M<3gPIX|@UR9-fz+X3 zAaT9)OY{xZtO-;RC85Vab;JEUNIMS5f^r$7-e%-XK`j{0+N$CsgpRd6B1wp z8dw-cH^rU^H4`&7qgabf)l^K`l!66{q9$U(CKRO5%W5pfY)s&YQ6n`HBR0ZTum%`N zgC%I8hQ+`JG_WvCAt-W$sIn@BKCDG1qQWW^a=`*c7G+i@s0S(ZDv1&+K_2`7O-#cM z=m!ZX1Z#kSG+3e)Jg^wpfCd(Yb5TZ)U=a!DwsG z)Z`|1ejMK4ap%CHj;%+>T6=D++5I=uBbQ$fZ48cf{hV1}9&Njl-I}i7e0#6Hdug@s zsr-57_=gLr&9Ros$k}}M>tJ77=hEJ}iPaZ%8|P+gUbS|Oj}5I{|5nZZc)C1$e*Rj` d`09hYXJ4M@PhCx)dHK8WZo1*|*q+^V@*ncduk8Q; literal 1069 zcmZ?wbhEHblwpu!_|5#>V#c_6iCL zii(PAYHE6VdYYP=;o;#yK|vlK9=^W5j*gDO!NGxnfgvFwo}Qi=85wD5X$1uZ_4W0g zot-mh&TMaQpFVwhQ&UrOb8};3*-O!NFz@UN(;t9~Q7P z$VqvLa4dLqq)m{ahC$$=l9LRB&<_s=hIaR6E(VS>j1C7qn+zE;J}@3S&ca+m71$P8l8F>;am>k-h6c`q0++aM= z*%HV(X+w@d@xgXYo<4>JhZ49t*coLUb}&6;+{SGD$>PK#$KGZe3!yiR49thRI0TXy zE+i|k++dAn*w851bU>QHXorU5UaL}Z{e+0^@06Guq&>8`yX5`%*;KMwNwTppSOWkW Cxwm}) diff --git a/docs/dc/api-ref/public_sys-resources/icon-tip.gif b/docs/dc/api-ref/public_sys-resources/icon-tip.gif index 93aa72053b510e456b149f36a0972703ea9999b7..c47bae05c9fd17c02a851d96cfac67bf194498d8 100644 GIT binary patch literal 879 zcmchWKWmj?48@OdDOZPr)a61!OE4yGD)salg#|^Ix$qIEF#uk)V>D{95e^!2r`i+9t# zTMu5YtUcd+@#gp0tDE;9ug>oLIzL$6dOx4-t#2PKExu1KulwoYeD?Os#mVO%AMWih HO|pR%nKN&Wj+V}pX;WC3SdJV!a_8Qi zE7z`U*|Y^H0^}EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 580 zcmV-K0=xZ3Nk%w1VIu$?0Hp~4{QBgqmQ+MG9K51r{QB&)np^||1PlfQ%(86!{`~yv zv{XhUWKt}AZaiE{EOcHp{O-j3`t;<+eEiycJT4p@77X;(jQsMfB$R?oG%6hQ z+MMLZbQBH@)Vg&1^3?qHb(5!%>3r0+`eq=&V&E}0Dypi0000000000 z00000A^8LW000R9EC2ui03!e$000L5z=Uu}ED8YtqjJd<+B}(9bIOb$3-31_h|V>=0A{ z1Hh0#H30>fNT})^fRU_83uewx9oRr{f{Sx1Ml`t)EQ zGkHZ67&~y{W5Jpq4H_WfuLxp*3<7O}GEl;1ESe36fLNs=B0&LQM1Buf(R)qg(BRd`t1OPjI1m_q4