diff --git a/docs/dc/api-ref/ALL_META.TXT.json b/docs/dc/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..3f779e93 --- /dev/null +++ b/docs/dc/api-ref/ALL_META.TXT.json @@ -0,0 +1,392 @@ +[ + { + "uri":"en-dc_topic_0055025300.html", + "product_code":"dc", + "code":"1", + "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025301.html", + "product_code":"dc", + "code":"2", + "des":"Direct Connect APIs allow you to use all Direct Connect functions.", + "doc_type":"api", + "kw":"API Overview,API Reference", + "title":"API Overview", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025308.html", + "product_code":"dc", + "code":"3", + "des":"Direct Connect has independent endpoints. When API calls are made to Direct Connect, the Direct Connect APIs are used. Therefore, you need pay special attention to the se", + "doc_type":"api", + "kw":"API Usage,API Reference", + "title":"API Usage", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025309.html", + "product_code":"dc", + "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", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025310.html", + "product_code":"dc", + "code":"5", + "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":"Obtaining the API Version Information", + "title":"Obtaining the API Version Information", + "githuburl":"" + }, + { + "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\": [", + "doc_type":"api", + "kw":"Querying All API Versions,Obtaining the API Version Information,API Reference", + "title":"Querying All API Versions", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025312.html", + "product_code":"dc", + "code":"7", + "des":"This API is used to query a specified API version supported by Direct Connect.GET /{api_version}NoneTable 1 lists the response parameters.Example requestGET /v2.0Example ", + "doc_type":"api", + "kw":"Querying a Specified API Version,Obtaining the API Version Information,API Reference", + "title":"Querying a Specified API Version", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025313.html", + "product_code":"dc", + "code":"8", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Connection", + "title":"Connection", + "githuburl":"" + }, + { + "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", + "doc_type":"api", + "kw":"Overview,Connection,API Reference", + "title":"Overview", + "githuburl":"" + }, + { + "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 ", + "doc_type":"api", + "kw":"Creating a Connection,Connection,API Reference", + "title":"Creating a Connection", + "githuburl":"" + }, + { + "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", + "doc_type":"api", + "kw":"Querying the Connection List,Connection,API Reference", + "title":"Querying the Connection List", + "githuburl":"" + }, + { + "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.", + "doc_type":"api", + "kw":"Deleting a Connection,Connection,API Reference", + "title":"Deleting a Connection", + "githuburl":"" + }, + { + "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", + "doc_type":"api", + "kw":"Querying a Connection,Connection,API Reference", + "title":"Querying a Connection", + "githuburl":"" + }, + { + "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-", + "doc_type":"api", + "kw":"Updating a Connection,Connection,API Reference", + "title":"Updating a Connection", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025320.html", + "product_code":"dc", + "code":"15", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Virtual Gateway", + "title":"Virtual Gateway", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025321.html", + "product_code":"dc", + "code":"16", + "des":"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 AP", + "doc_type":"api", + "kw":"Overview,Virtual Gateway,API Reference", + "title":"Overview", + "githuburl":"" + }, + { + "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", + "doc_type":"api", + "kw":"Creating a Virtual Gateway,Virtual Gateway,API Reference", + "title":"Creating a Virtual Gateway", + "githuburl":"" + }, + { + "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", + "doc_type":"api", + "kw":"Querying the Virtual Gateway List,Virtual Gateway,API Reference", + "title":"Querying the Virtual Gateway List", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025324.html", + "product_code":"dc", + "code":"19", + "des":"This API is used to delete a virtual gateway.DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}Table 2 lists the request parameter.NoneExample requestResponse examp", + "doc_type":"api", + "kw":"Deleting a Virtual Gateway,Virtual Gateway,API Reference", + "title":"Deleting a Virtual Gateway", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025325.html", + "product_code":"dc", + "code":"20", + "des":"This API is used to query a virtual gateway.GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}Table 2 lists the request parameter.Table 3 lists the response parameter.", + "doc_type":"api", + "kw":"Querying a Virtual Gateway,Virtual Gateway,API Reference", + "title":"Querying a Virtual Gateway", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025326.html", + "product_code":"dc", + "code":"21", + "des":"This API is used to update a virtual gateway.PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}Table 2 lists the request parameter.Table 3 lists the response parameter", + "doc_type":"api", + "kw":"Updating a Virtual Gateway,Virtual Gateway,API Reference", + "title":"Updating a Virtual Gateway", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025327.html", + "product_code":"dc", + "code":"22", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Virtual Interface", + "title":"Virtual Interface", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025328.html", + "product_code":"dc", + "code":"23", + "des":"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 t", + "doc_type":"api", + "kw":"Overview,Virtual Interface,API Reference", + "title":"Overview", + "githuburl":"" + }, + { + "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", + "doc_type":"api", + "kw":"Creating a Virtual Interface,Virtual Interface,API Reference", + "title":"Creating a Virtual Interface", + "githuburl":"" + }, + { + "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", + "doc_type":"api", + "kw":"Querying the Virtual Interface List,Virtual Interface,API Reference", + "title":"Querying the Virtual Interface List", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025331.html", + "product_code":"dc", + "code":"26", + "des":"This API is used to delete a virtual interface.DELETE /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}Table 2 lists the request parameter.NoneExample requestResponse", + "doc_type":"api", + "kw":"Deleting a Virtual Interface,Virtual Interface,API Reference", + "title":"Deleting a Virtual Interface", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025332.html", + "product_code":"dc", + "code":"27", + "des":"This API is used to query a virtual interface.GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}Table 2 lists the request parameter.Table 3 lists the response para", + "doc_type":"api", + "kw":"Querying a Virtual Interface,Virtual Interface,API Reference", + "title":"Querying a Virtual Interface", + "githuburl":"" + }, + { + "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", + "doc_type":"api", + "kw":"Updating a Virtual Interface,Virtual Interface,API Reference", + "title":"Updating a Virtual Interface", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025334.html", + "product_code":"dc", + "code":"29", + "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":"Direct Connect Endpoint Group", + "title":"Direct Connect Endpoint Group", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025335.html", + "product_code":"dc", + "code":"30", + "des":"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 e", + "doc_type":"api", + "kw":"Overview,Direct Connect Endpoint Group,API Reference", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025336.html", + "product_code":"dc", + "code":"31", + "des":"This API is used to create a Direct Connect endpoint group.POST /v2.0/dcaas/dc-endpoint-groupsTable 1 lists the request parameter.Table 3 lists the response parameter.Exa", + "doc_type":"api", + "kw":"Creating an Endpoint Group,Direct Connect Endpoint Group,API Reference", + "title":"Creating an Endpoint Group", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025337.html", + "product_code":"dc", + "code":"32", + "des":"This API is used to query the Direct Connect endpoint group list.GET /v2.0/dcaas/dc-endpoint-groupsTable 1 lists the request parameter.Table 2 lists the response paramete", + "doc_type":"api", + "kw":"Querying the Direct Connect Endpoint Group List,Direct Connect Endpoint Group,API Reference", + "title":"Querying the Direct Connect Endpoint Group List", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025338.html", + "product_code":"dc", + "code":"33", + "des":"This API is used to delete a Direct Connect endpoint group.DELETE /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}Table 2 lists the request parameter.NoneExample reques", + "doc_type":"api", + "kw":"Deleting an Endpoint Group,Direct Connect Endpoint Group,API Reference", + "title":"Deleting an Endpoint Group", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025339.html", + "product_code":"dc", + "code":"34", + "des":"This API is used to query a Direct Connect endpoint group.GET /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}Table 2 lists the request parameter.Table 3 lists the resp", + "doc_type":"api", + "kw":"Querying a Direct Connect Endpoint Group,Direct Connect Endpoint Group,API Reference", + "title":"Querying a Direct Connect Endpoint Group", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025340.html", + "product_code":"dc", + "code":"35", + "des":"This API is used to update a Direct Connect endpoint group.PUT /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}Table 2 lists the request parameter.Table 4 lists the res", + "doc_type":"api", + "kw":"Updating a Direct Connect Endpoint Group,Direct Connect Endpoint Group,API Reference", + "title":"Updating a Direct Connect Endpoint Group", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025341.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":"Public Parameters", + "title":"Public Parameters", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025342.html", + "product_code":"dc", + "code":"37", + "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", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025343.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":"Error Codes,Public Parameters,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"en-dc_topic_0055025347.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":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/dc/api-ref/CLASS.TXT.json b/docs/dc/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..d68cc966 --- /dev/null +++ b/docs/dc/api-ref/CLASS.TXT.json @@ -0,0 +1,353 @@ +[ + { + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "product_code":"dc", + "title":"API Usage Guidelines", + "uri":"en-dc_topic_0055025300.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"Direct Connect APIs allow you to use all Direct Connect functions.", + "product_code":"dc", + "title":"API Overview", + "uri":"en-dc_topic_0055025301.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "desc":"Direct Connect has independent endpoints. When API calls are made to Direct Connect, the Direct Connect APIs are used. Therefore, you need pay special attention to the se", + "product_code":"dc", + "title":"API Usage", + "uri":"en-dc_topic_0055025308.html", + "doc_type":"api", + "p_code":"", + "code":"3" + }, + { + "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", + "uri":"en-dc_topic_0055025309.html", + "doc_type":"api", + "p_code":"", + "code":"4" + }, + { + "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":"Obtaining the API Version Information", + "uri":"en-dc_topic_0055025310.html", + "doc_type":"api", + "p_code":"4", + "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\": [", + "product_code":"dc", + "title":"Querying All API Versions", + "uri":"en-dc_topic_0055025311.html", + "doc_type":"api", + "p_code":"5", + "code":"6" + }, + { + "desc":"This API is used to query a specified API version supported by Direct Connect.GET /{api_version}NoneTable 1 lists the response parameters.Example requestGET /v2.0Example ", + "product_code":"dc", + "title":"Querying a Specified API Version", + "uri":"en-dc_topic_0055025312.html", + "doc_type":"api", + "p_code":"5", + "code":"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":"Connection", + "uri":"en-dc_topic_0055025313.html", + "doc_type":"api", + "p_code":"4", + "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", + "product_code":"dc", + "title":"Overview", + "uri":"en-dc_topic_0055025314.html", + "doc_type":"api", + "p_code":"8", + "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 ", + "product_code":"dc", + "title":"Creating a Connection", + "uri":"en-dc_topic_0055025315.html", + "doc_type":"api", + "p_code":"8", + "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", + "product_code":"dc", + "title":"Querying the Connection List", + "uri":"en-dc_topic_0055025316.html", + "doc_type":"api", + "p_code":"8", + "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.", + "product_code":"dc", + "title":"Deleting a Connection", + "uri":"en-dc_topic_0055025317.html", + "doc_type":"api", + "p_code":"8", + "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", + "product_code":"dc", + "title":"Querying a Connection", + "uri":"en-dc_topic_0055025318.html", + "doc_type":"api", + "p_code":"8", + "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-", + "product_code":"dc", + "title":"Updating a Connection", + "uri":"en-dc_topic_0055025319.html", + "doc_type":"api", + "p_code":"8", + "code":"14" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dc", + "title":"Virtual Gateway", + "uri":"en-dc_topic_0055025320.html", + "doc_type":"api", + "p_code":"4", + "code":"15" + }, + { + "desc":"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 AP", + "product_code":"dc", + "title":"Overview", + "uri":"en-dc_topic_0055025321.html", + "doc_type":"api", + "p_code":"15", + "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", + "product_code":"dc", + "title":"Creating a Virtual Gateway", + "uri":"en-dc_topic_0055025322.html", + "doc_type":"api", + "p_code":"15", + "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", + "product_code":"dc", + "title":"Querying the Virtual Gateway List", + "uri":"en-dc_topic_0055025323.html", + "doc_type":"api", + "p_code":"15", + "code":"18" + }, + { + "desc":"This API is used to delete a virtual gateway.DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}Table 2 lists the request parameter.NoneExample requestResponse examp", + "product_code":"dc", + "title":"Deleting a Virtual Gateway", + "uri":"en-dc_topic_0055025324.html", + "doc_type":"api", + "p_code":"15", + "code":"19" + }, + { + "desc":"This API is used to query a virtual gateway.GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}Table 2 lists the request parameter.Table 3 lists the response parameter.", + "product_code":"dc", + "title":"Querying a Virtual Gateway", + "uri":"en-dc_topic_0055025325.html", + "doc_type":"api", + "p_code":"15", + "code":"20" + }, + { + "desc":"This API is used to update a virtual gateway.PUT /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}Table 2 lists the request parameter.Table 3 lists the response parameter", + "product_code":"dc", + "title":"Updating a Virtual Gateway", + "uri":"en-dc_topic_0055025326.html", + "doc_type":"api", + "p_code":"15", + "code":"21" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dc", + "title":"Virtual Interface", + "uri":"en-dc_topic_0055025327.html", + "doc_type":"api", + "p_code":"4", + "code":"22" + }, + { + "desc":"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 t", + "product_code":"dc", + "title":"Overview", + "uri":"en-dc_topic_0055025328.html", + "doc_type":"api", + "p_code":"22", + "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", + "product_code":"dc", + "title":"Creating a Virtual Interface", + "uri":"en-dc_topic_0055025329.html", + "doc_type":"api", + "p_code":"22", + "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", + "product_code":"dc", + "title":"Querying the Virtual Interface List", + "uri":"en-dc_topic_0055025330.html", + "doc_type":"api", + "p_code":"22", + "code":"25" + }, + { + "desc":"This API is used to delete a virtual interface.DELETE /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}Table 2 lists the request parameter.NoneExample requestResponse", + "product_code":"dc", + "title":"Deleting a Virtual Interface", + "uri":"en-dc_topic_0055025331.html", + "doc_type":"api", + "p_code":"22", + "code":"26" + }, + { + "desc":"This API is used to query a virtual interface.GET /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}Table 2 lists the request parameter.Table 3 lists the response para", + "product_code":"dc", + "title":"Querying a Virtual Interface", + "uri":"en-dc_topic_0055025332.html", + "doc_type":"api", + "p_code":"22", + "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", + "product_code":"dc", + "title":"Updating a Virtual Interface", + "uri":"en-dc_topic_0055025333.html", + "doc_type":"api", + "p_code":"22", + "code":"28" + }, + { + "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":"Direct Connect Endpoint Group", + "uri":"en-dc_topic_0055025334.html", + "doc_type":"api", + "p_code":"4", + "code":"29" + }, + { + "desc":"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 e", + "product_code":"dc", + "title":"Overview", + "uri":"en-dc_topic_0055025335.html", + "doc_type":"api", + "p_code":"29", + "code":"30" + }, + { + "desc":"This API is used to create a Direct Connect endpoint group.POST /v2.0/dcaas/dc-endpoint-groupsTable 1 lists the request parameter.Table 3 lists the response parameter.Exa", + "product_code":"dc", + "title":"Creating an Endpoint Group", + "uri":"en-dc_topic_0055025336.html", + "doc_type":"api", + "p_code":"29", + "code":"31" + }, + { + "desc":"This API is used to query the Direct Connect endpoint group list.GET /v2.0/dcaas/dc-endpoint-groupsTable 1 lists the request parameter.Table 2 lists the response paramete", + "product_code":"dc", + "title":"Querying the Direct Connect Endpoint Group List", + "uri":"en-dc_topic_0055025337.html", + "doc_type":"api", + "p_code":"29", + "code":"32" + }, + { + "desc":"This API is used to delete a Direct Connect endpoint group.DELETE /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}Table 2 lists the request parameter.NoneExample reques", + "product_code":"dc", + "title":"Deleting an Endpoint Group", + "uri":"en-dc_topic_0055025338.html", + "doc_type":"api", + "p_code":"29", + "code":"33" + }, + { + "desc":"This API is used to query a Direct Connect endpoint group.GET /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}Table 2 lists the request parameter.Table 3 lists the resp", + "product_code":"dc", + "title":"Querying a Direct Connect Endpoint Group", + "uri":"en-dc_topic_0055025339.html", + "doc_type":"api", + "p_code":"29", + "code":"34" + }, + { + "desc":"This API is used to update a Direct Connect endpoint group.PUT /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}Table 2 lists the request parameter.Table 4 lists the res", + "product_code":"dc", + "title":"Updating a Direct Connect Endpoint Group", + "uri":"en-dc_topic_0055025340.html", + "doc_type":"api", + "p_code":"29", + "code":"35" + }, + { + "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":"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.", + "product_code":"dc", + "title":"Common Returned Values", + "uri":"en-dc_topic_0055025342.html", + "doc_type":"api", + "p_code":"36", + "code":"37" + }, + { + "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":"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":"Change History", + "uri":"en-dc_topic_0055025347.html", + "doc_type":"api", + "p_code":"", + "code":"39" + } +] \ No newline at end of file diff --git a/docs/dc/api-ref/PARAMETERS.txt b/docs/dc/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/dc/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/dc/api-ref/en-dc_topic_0055025300.html b/docs/dc/api-ref/en-dc_topic_0055025300.html new file mode 100644 index 00000000..af2826b6 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025300.html @@ -0,0 +1,8 @@ + + +

API Usage Guidelines

+

Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025301.html b/docs/dc/api-ref/en-dc_topic_0055025301.html new file mode 100644 index 00000000..da39afa7 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025301.html @@ -0,0 +1,41 @@ + + +

API Overview

+

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

+ +
+ + + + + + + + + + + + + + + + + + +
Table 1 Direct Connect APIs

Category

+

Sub-Category

+

Description

+

Direct Connect API

+

Connection

+

Used to create, query, and update connections.

+

Virtual gateway

+

Used to manage virtual gateways, including the APIs used to create, delete, query, and update a virtual gateway, and the API to query the virtual gateway list.

+

Virtual interface

+

Used to manage virtual interfaces, including the APIs used to create, delete, query, and update a virtual interface, and the API to query the virtual interface list.

+

Direct Connect endpoint group

+

Used to manage Direct Connect endpoint groups, including the APIs used to create, delete, query, and update a Direct Connect endpoint group, and the API to query the Direct Connect endpoint group list.

+
+
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025308.html b/docs/dc/api-ref/en-dc_topic_0055025308.html new file mode 100644 index 00000000..0962c38c --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025308.html @@ -0,0 +1,6 @@ + + +

API Usage

+

Direct Connect has independent endpoints. When API calls are made to Direct Connect, the Direct Connect APIs are used. Therefore, you need pay special attention to the service endpoints used when you make calls to the Direct Connect APIs.

+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025309.html b/docs/dc/api-ref/en-dc_topic_0055025309.html new file mode 100644 index 00000000..45a9f681 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025309.html @@ -0,0 +1,19 @@ + + +

API

+
+
+ +
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025310.html b/docs/dc/api-ref/en-dc_topic_0055025310.html new file mode 100644 index 00000000..bcefcf0b --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025310.html @@ -0,0 +1,17 @@ + + +

Obtaining the API Version Information

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025311.html b/docs/dc/api-ref/en-dc_topic_0055025311.html new file mode 100644 index 00000000..668e115f --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025311.html @@ -0,0 +1,89 @@ + + +

Querying All API Versions

+

Function

This API is used to query all API versions supported by Direct Connect.

+
+

URI

GET /

+
+

Request

None

+
+

Response

Table 1 lists the response parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Response parameters

Parameter

+

Type

+

Description

+

versions

+

List

+

Specifies all API versions.

+

id

+

String

+

Specifies the version number, for example, v2.0

+

links

+

Array

+

Specifies the API URL.

+

href

+

String

+

Specifies the reference address of the current API version.

+

rel

+

String

+

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

+

status

+

String

+

Specifies the version status. Value options are as follows:

+
  • CURRENT: indicates a primary version.
  • SUPPORTED: indicates an old version that is still supported.
  • DEPRECATED: indicates a deprecated version that may be deleted later.
+
+
+
+

Examples

+
+
+
+
+
Parent topic: Obtaining the API Version Information
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025312.html b/docs/dc/api-ref/en-dc_topic_0055025312.html new file mode 100644 index 00000000..fe67fa04 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025312.html @@ -0,0 +1,105 @@ + + +

Querying a Specified API Version

+

Function

This API is used to query a specified API version supported by Direct Connect.

+
+

URI

GET /{api_version}

+
+

Request

None

+
+

Response

Table 1 lists the response parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Response parameters

Parameter

+

Type

+

Description

+

id

+

String

+

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

+

links

+

Array

+

Specifies the API URL.

+

href

+

String

+

Specifies the reference address of the current API version.

+

rel

+

String

+

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

+

Specifies the version status. Value options are as follows:

+
  • 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. Specifies the time when v1 APIs are released, for example, 2014-06-28T12:20:21Z.

+

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.

+
+
+
+

Examples

+
+
+
+
+
Parent topic: Obtaining the API Version Information
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025313.html b/docs/dc/api-ref/en-dc_topic_0055025313.html new file mode 100644 index 00000000..cfd28dd2 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025313.html @@ -0,0 +1,25 @@ + + +

Connection

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025314.html b/docs/dc/api-ref/en-dc_topic_0055025314.html new file mode 100644 index 00000000..d71b77b6 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025314.html @@ -0,0 +1,345 @@ + + +

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 Model

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

Attribute

+

Type

+

CRUD

+

Default Value

+

Constraint

+

Description

+

id

+

String

+

R

+

Automatically generated

+

uuid

+

Specifies the connection ID.

+

tenant_id

+

String

+

CR

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the tenant ID.

+

name

+

String

+

CRU

+

None

+

The value can contain 0 to 64 characters.

+

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

+

Specifies the connection name.

+

description

+

String

+

CRU

+

None

+

The value can contain 0 to 128 characters.

+

Provides supplementary information about the connection.

+

port_type

+

String

+

CR

+

None

+

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.

+

bandwidth

+

Integer

+

CRU

+

N/A

+

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

+

Specifies the bandwidth of the connection in Mbit/s.

+

location

+

String

+

CR

+

None

+

The value can contain 0 to 255 characters.

+

Specifies the connection access location.

+

peer_location

+

String

+

CR

+

None

+

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.

+

device_id

+

String

+

CR

+

None

+

The value can contain 0 to 255 characters.

+

Specifies the gateway device ID of the connection.

+

interface_name

+

String

+

CR

+

None

+

The value can contain 0 to 255 characters.

+

Specifies the name of the interface accessed by the connection.

+

redundant_id

+

String

+

CR

+

None

+

uuid

+

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

+

provider

+

String

+

CR

+

None

+

The value can contain 0 to 255 characters.

+

Specifies the carrier who provides the leased line.

+

provider_status

+

String

+

CRU

+

DOWN

+

N/A

+

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

+

type

+

String

+

CR

+

standard

+

The value can contain 0 to 255 characters.

+

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

+

hosting_id

+

String

+

CR

+

None

+

uuid

+

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

+

vlan

+

Integer

+

CR

+

N/A

+

<1, 4063>

+

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

+

charge_mode

+

String

+

CR

+

prepayment

+

The value can contain 0 to 255 characters.

+

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

+

apply_time

+

String

+

R

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the time when the connection is requested.

+

create_time

+

String

+

R

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the time when the connection is created.

+

delete_time

+

String

+

R

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the time when the connection is deleted.

+

order_id

+

String

+

CRU

+

None

+

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.

+

product_id

+

String

+

CRU

+

None

+

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.

+

status

+

String

+

CR

+

DOWN

+

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.

+

admin_state_up

+

Boolean

+

CR

+

true

+

The value can only be true.

+

Specifies the administrative status of the connection.

+

The value can be true or false.

+
+
+
+
+
+
+
Parent topic: Connection
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025315.html b/docs/dc/api-ref/en-dc_topic_0055025315.html new file mode 100644 index 00000000..497d98c2 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025315.html @@ -0,0 +1,483 @@ + + +

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.
+
+
+

URI

POST /v2.0/dcaas/direct-connects

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

Parameter

+

Type

+

Mandatory

+

Description

+

direct_connect

+

Dictionary data structure

+

Yes

+

Specifies the direct_connect object.

+
+
+
+

Request

Table 2 lists the direct_connect request parameters.

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

Parameter

+

Type

+

Mandatory

+

Description

+

tenant_id

+

String

+

No

+

Specifies the project ID.

+

name

+

String

+

No

+

Specifies the connection name.

+

description

+

String

+

No

+

Provides supplementary information about the connection.

+

port_type

+

String

+

Yes

+

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

+

bandwidth

+

Integer

+

Yes

+

Specifies the connection bandwidth in Mbit/s.

+

location

+

String

+

Yes

+

Specifies the connection access location.

+

peer_location

+

String

+

No

+

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

+

device_id

+

String

+

No

+

Specifies the gateway device ID of the connection.

+

interface_name

+

String

+

No

+

Specifies the name of the interface accessed by the connection.

+

redundant_id

+

String

+

No

+

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

+

provider

+

String

+

Yes

+

Specifies the carrier who provides the leased line.

+

provider_status

+

String

+

No

+

Specifies the status of the carrier's leased line.

+

The value can be ACTIVE or DOWN.

+

type

+

String

+

No

+

Specifies the connection type. The value can be hosted.

+

hosting_id

+

String

+

No

+

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

+

vlan

+

Integer

+

No

+

Specifies the VLAN pre-allocated to the hosted connection.

+

charge_mode

+

String

+

No

+

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

+

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.

+

status

+

String

+

No

+

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

+

No

+

Specifies the administrative status of the connection.

+

The value can be true or false.

+
+
+
+

Response

Table 3 lists the response parameter.

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

Parameter

+

Type

+

Description

+

direct_connect

+

Dictionary data structure

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Connection
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025316.html b/docs/dc/api-ref/en-dc_topic_0055025316.html new file mode 100644 index 00000000..283534f5 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025316.html @@ -0,0 +1,288 @@ + + +

Querying the Connection List

+

Function

This API is used to query the connection list.

+
+

URI

GET /v2.0/dcaas/direct-connects

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

Parameter

+

Type

+

Mandatory

+

Description

+

direct_connects

+

List data structure

+

Yes

+

Specifies the connection list.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

fields

+

String

+

No

+

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.

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

Parameter

+

Type

+

Description

+

direct_connects

+

List data structure

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Connection
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025317.html b/docs/dc/api-ref/en-dc_topic_0055025317.html new file mode 100644 index 00000000..afeeed8f --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025317.html @@ -0,0 +1,46 @@ + + +

Deleting a Connection

+

Function

This API is used to delete a connection.

+
+

URI

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

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

Parameter

+

Type

+

Mandatory

+

Description

+

direct_connect_id

+

String

+

Yes

+

Indicates the connection ID.

+
+
+
+

Request

None

+
+

Response

None

+
+

Examples

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

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Connection
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025318.html b/docs/dc/api-ref/en-dc_topic_0055025318.html new file mode 100644 index 00000000..42791494 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025318.html @@ -0,0 +1,274 @@ + + +

Querying a Connection

+

Function

This API is used to query a connection.

+
+

URI

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

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

Parameter

+

Type

+

Mandatory

+

Description

+

direct_connect_id

+

String

+

Yes

+

Specifies the connection ID.

+
+
+
+

Request

None

+
+

Response

Table 2 lists the response parameter.

+ +
+ + + + + + + + + +
Table 2 Response parameter

Parameter

+

Type

+

Description

+

direct_connect

+

Dictionary data structure

+

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.

+
+
+
+

Examples

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

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Connection
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025319.html b/docs/dc/api-ref/en-dc_topic_0055025319.html new file mode 100644 index 00000000..a04ad2b3 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025319.html @@ -0,0 +1,360 @@ + + +

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.
+
+
+

URI

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

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

Parameter

+

Type

+

Mandatory

+

Description

+

direct_connect_id

+

String

+

No

+

Specifies the connection ID.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

direct_connect

+

Dictionary data structure

+

No

+

Specifies the direct_connect object.

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

Parameter

+

Type

+

Mandatory

+

Description

+

description

+

String

+

No

+

Provides supplementary information about the connection.

+

name

+

String

+

No

+

Specifies the connection name.

+

bandwidth

+

Integer

+

No

+

Specifies the bandwidth of the connection in Mbit/s.

+

provider_status

+

String

+

No

+

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.

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

Parameter

+

Type

+

Description

+

direct_connect

+

Dictionary data structure

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Connection
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025320.html b/docs/dc/api-ref/en-dc_topic_0055025320.html new file mode 100644 index 00000000..83533925 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025320.html @@ -0,0 +1,26 @@ + + +

Virtual Gateway

+

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025321.html b/docs/dc/api-ref/en-dc_topic_0055025321.html new file mode 100644 index 00000000..e641602f --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025321.html @@ -0,0 +1,190 @@ + + +

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 Model

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

Attribute

+

Type

+

CRUD

+

Default Value

+

Constraint

+

Description

+

id

+

String

+

R

+

Automatically generated

+

uuid

+

Specifies the virtual gateway ID.

+

tenant_id

+

String

+

CR

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the tenant ID.

+

name

+

String

+

CRU

+

None

+

The value can contain 0 to 64 characters.

+

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

+

Specifies the virtual gateway name.

+

description

+

String

+

CRU

+

None

+

The value can contain 0 to 128 characters.

+

Provides supplementary information about the virtual gateway.

+

vpc_id

+

String

+

CR

+

N/A

+

uuid

+

Specifies the ID of the VPC to be accessed.

+

local_ep_group_id

+

String

+

CRU

+

N/A

+

uuid

+

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

+

device_id

+

String

+

CR

+

None

+

The value can contain 0 to 255 characters.

+

Specifies the ID of the physical device.

+

redundant_device_id

+

String

+

CR

+

None

+

The value can contain 0 to 255 characters.

+

Specifies the ID of the redundant device.

+

type

+

String

+

CR

+

default

+

The value can contain 0 to 255 characters.

+

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

+

ipsec_bandwidth

+

Integer

+

CR

+

N/A

+

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.

+

status

+

String

+

R

+

NA

+

N/A

+

Specifies the virtual gateway status.

+

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

+

admin_state_up

+

Boolean

+

CR

+

true

+

The value can only be true.

+

Specifies the administrative status of the virtual gateway.

+

The value can be true or false.

+
+
+
+
+
+
+
Parent topic: Virtual Gateway
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025322.html b/docs/dc/api-ref/en-dc_topic_0055025322.html new file mode 100644 index 00000000..762764c7 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025322.html @@ -0,0 +1,309 @@ + + +

Creating a Virtual Gateway

+

Function

This API is used to create a virtual gateway.

+
+

URI

POST /v2.0/dcaas/virtual-gateways

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_gateway

+

Dictionary data structure

+

Yes

+

Specifies the virtual_gateway object.

+
+
+
+

Request

Table 2 lists the virtual_gateway parameters.

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

Parameter

+

Type

+

Mandatory

+

Description

+

tenant_id

+

String

+

No

+

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.

+

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

+

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.

+

admin_state_up

+

Boolean

+

No

+

Specifies the administrative status of the virtual gateway.

+

The value can be true or false.

+
+
+
+

Response

Table 3 lists the response parameter.

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

Parameter

+

Type

+

Description

+

virtual_gateway

+

Dictionary data structure

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Gateway
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025323.html b/docs/dc/api-ref/en-dc_topic_0055025323.html new file mode 100644 index 00000000..19f06505 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025323.html @@ -0,0 +1,186 @@ + + +

Querying the Virtual Gateway List

+

Function

This API is used to query the virtual gateway list.

+
+

URI

GET /v2.0/dcaas/virtual-gateways

+
+

Request

Table 1 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

fields

+

String

+

No

+

Specifies the parameters expected to be returned.

+

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

+
+
+
+

Response

Table 2 lists the response parameter.

+ +
+ + + + + + + + + +
Table 2 Response parameter

Parameter

+

Type

+

Description

+

virtual_gateways

+

List data structure

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Gateway
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025324.html b/docs/dc/api-ref/en-dc_topic_0055025324.html new file mode 100644 index 00000000..fadb6e94 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025324.html @@ -0,0 +1,71 @@ + + +

Deleting a Virtual Gateway

+

Function

This API is used to delete a virtual gateway.

+
+

URI

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

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_gateway_id

+

String

+

Yes

+

Indicates the virtual gateway ID.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_gateway_id

+

String

+

Yes

+

Indicates the virtual gateway ID.

+
+
+
+

Response

None

+
+

Examples

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

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Gateway
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025325.html b/docs/dc/api-ref/en-dc_topic_0055025325.html new file mode 100644 index 00000000..bd88332d --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025325.html @@ -0,0 +1,237 @@ + + +

Querying a Virtual Gateway

+

Function

This API is used to query a virtual gateway.

+
+

URI

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

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_gateway_id

+

String

+

Yes

+

Specifies the virtual gateway ID.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_gateway_id

+

String

+

Yes

+

Specifies the virtual gateway ID.

+
+
+
+

Response

Table 3 lists the response parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_gateway

+

Dictionary data structure

+

Yes

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Gateway
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025326.html b/docs/dc/api-ref/en-dc_topic_0055025326.html new file mode 100644 index 00000000..eb0463ef --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025326.html @@ -0,0 +1,254 @@ + + +

Updating a Virtual Gateway

+

Function

This API is used to update a virtual gateway.

+
+

URI

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

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_gateway_id

+

String

+

Yes

+

Specifies the virtual gateway ID.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_gateway

+

Dictionary data structure

+

Yes

+

Specifies the virtual_gateway object.

+
+
+

+ +
+ + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Type

+

Mandatory

+

Description

+

description

+

String

+

No

+

Provides supplementary information about the virtual gateway.

+

name

+

String

+

No

+

Specifies the virtual gateway name.

+

local_ep_group_id

+

String

+

No

+

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

+
+
+
+

Response

Table 3 lists the response parameter.

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

Parameter

+

Type

+

Description

+

virtual_gateway

+

Dictionary data structure

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Gateway
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025327.html b/docs/dc/api-ref/en-dc_topic_0055025327.html new file mode 100644 index 00000000..e7211c8c --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025327.html @@ -0,0 +1,26 @@ + + +

Virtual Interface

+

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025328.html b/docs/dc/api-ref/en-dc_topic_0055025328.html new file mode 100644 index 00000000..38715c2c --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025328.html @@ -0,0 +1,307 @@ + + +

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 Model

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

Attribute

+

Type

+

CRUD

+

Default Value

+

Constraint

+

Description

+

id

+

String

+

R

+

Automatically generated

+

uuid

+

Specifies the virtual interface ID.

+

tenant_id

+

String

+

CR

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the tenant ID.

+

name

+

String

+

CRU

+

None

+

The value can contain 0 to 64 characters.

+

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

+

Specifies the virtual interface name.

+

description

+

String

+

CRU

+

None

+

The value can contain 0 to 128 characters.

+

Provides supplementary information about the virtual interface.

+

direct_connect_id

+

String

+

CR

+

N/A

+

uuid

+

Specifies the connection ID.

+

vgw_ id

+

String

+

CR

+

N/A

+

N/A

+

Specifies the virtual gateway ID.

+

type

+

String

+

CR

+

None

+

The value can contain 0 to 255 characters.

+

Specifies the interface type: public or private.

+

service_type

+

String

+

CR

+

None

+

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.

+

vlan

+

Integer

+

CR

+

N/A

+

VLAN: 1 to 4063

+

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

+

bandwidth

+

Integer

+

CRU

+

N/A

+

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

+

Specifies the virtual interface bandwidth.

+

local_gateway_v4_ip

+

String

+

CR

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the IPv4 address of the local gateway.

+

remote_gateway_v4_ip

+

String

+

CR

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the IPv4 address of the remote gateway.

+

route_mode

+

String

+

CR

+

static

+

The value can contain 0 to 255 characters.

+

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

+

bgp_asn

+

Integer

+

CR

+

N/A

+

ASN: 1 to 4294967295

+

Specifies the AS number of the BGP peer.

+

bgp_md5

+

String

+

CR

+

N/A

+

The value can contain 0 to 255 characters.

+

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

+

remote_ep_group_id

+

String

+

CRU

+

N/A

+

uuid

+

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

+

service_ep_group_id

+

String

+

CRU

+

N/A

+

uuid

+

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

+

create_time

+

String

+

R

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the time when the virtual interface is created.

+

delete_time

+

String

+

R

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the time when the virtual interface is deleted.

+

status

+

String

+

R

+

N/A

+

N/A

+

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.

+

The value can be true or false.

+
+
+
+
+
+
+
Parent topic: Virtual Interface
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025329.html b/docs/dc/api-ref/en-dc_topic_0055025329.html new file mode 100644 index 00000000..c8a94452 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025329.html @@ -0,0 +1,504 @@ + + +

Creating a Virtual Interface

+

Function

This API is used to create a virtual interface.

+
+

URI

POST /v2.0/dcaas/virtual-interfaces

+
+

Request

Table 1 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_interface

+

Dictionary data structure

+

Yes

+

Specifies the virtual_interface object.

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

Parameter

+

Type

+

Mandatory

+

Description

+

tenant_id

+

String

+

No

+

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 CIDR blocks used by the on-premises network.

+

service_ep_group_id

+

String

+

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.

+

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.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_interface

+

Dictionary data structure

+

Yes

+

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.

+
+
+
+

Examples

+
+ +

Response code

For details, see Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Interface
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025330.html b/docs/dc/api-ref/en-dc_topic_0055025330.html new file mode 100644 index 00000000..6f351285 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025330.html @@ -0,0 +1,256 @@ + + +

Querying the Virtual Interface List

+

Function

This API is used to query the virtual interface list.

+
+

URI

GET /v2.0/dcaas/virtual-interfaces

+
+

Request

Table 1 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

fields

+

String

+

No

+

Specifies the parameters expected to be returned.

+

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

+
+
+
+

Response

Table 2 lists the response parameter.

+ +
+ + + + + + + + + +
Table 2 Response parameter

Parameter

+

Type

+

Description

+

virtual_interfaces

+

List data structure

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Interface
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025331.html b/docs/dc/api-ref/en-dc_topic_0055025331.html new file mode 100644 index 00000000..809c895d --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025331.html @@ -0,0 +1,71 @@ + + +

Deleting a Virtual Interface

+

Function

This API is used to delete a virtual interface.

+
+

URI

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

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_interface_id

+

String

+

Yes

+

Indicates the virtual interface ID.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_interface_id

+

String

+

Yes

+

Indicates the virtual interface ID.

+
+
+
+

Response

None

+
+

Examples

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

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Interface
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025332.html b/docs/dc/api-ref/en-dc_topic_0055025332.html new file mode 100644 index 00000000..6003244b --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025332.html @@ -0,0 +1,275 @@ + + +

Querying a Virtual Interface

+

Function

This API is used to query a virtual interface.

+
+

URI

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

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_interface_id

+

String

+

Yes

+

Specifies the virtual interface ID.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_interface_id

+

String

+

Yes

+

Specifies the virtual interface ID.

+
+
+
+

Response

Table 3 lists the response parameter.

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

Parameter

+

Type

+

Description

+

virtual_interface

+

Dictionary data structure

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Interface
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025333.html b/docs/dc/api-ref/en-dc_topic_0055025333.html new file mode 100644 index 00000000..15ffd69f --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025333.html @@ -0,0 +1,360 @@ + + +

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.
+
+
+

URI

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

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_interface_id

+

String

+

Yes

+

Specifies the virtual interface ID.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_interface

+

Dictionary data structure

+

Yes

+

Specifies the virtual_interface object.

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

Parameter

+

Type

+

Mandatory

+

Description

+

virtual_interface_id

+

String

+

Yes

+

Specifies the virtual interface ID.

+

description

+

String

+

No

+

Provides supplementary information about the virtual interface.

+

name

+

String

+

No

+

Specifies the virtual interface name.

+

bandwidth

+

Integer

+

No

+

Specifies the virtual interface bandwidth.

+

remote_ep_group_id

+

String

+

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.

+
+
+
+

Response

Table 4 lists the response parameter.

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

Parameter

+

Type

+

Description

+

virtual_interface

+

Dictionary data structure

+

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.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Virtual Interface
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025334.html b/docs/dc/api-ref/en-dc_topic_0055025334.html new file mode 100644 index 00000000..9fbd31fd --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025334.html @@ -0,0 +1,26 @@ + + +

Direct Connect Endpoint Group

+

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025335.html b/docs/dc/api-ref/en-dc_topic_0055025335.html new file mode 100644 index 00000000..7c6d634d --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025335.html @@ -0,0 +1,110 @@ + + +

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 Model

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Direct Connect endpoint group objects

Attribute

+

Type

+

CRUD

+

Default Value

+

Constraint

+

Description

+

id

+

String

+

R

+

Automatically generated

+

uuid

+

Specifies the ID of the Direct Connect endpoint group.

+

tenant_id

+

String

+

CR

+

N/A

+

The value can contain 0 to 255 characters.

+

Specifies the project ID.

+

name

+

String

+

CRU

+

No

+

The value can contain 0 to 64 characters.

+

Specifies the name of the Direct Connect endpoint group.

+

description

+

String

+

CRU

+

No

+

The value can contain 0 to 128 characters.

+

Provides supplementary information about the Direct Connect endpoint group.

+

endpoints

+

List<String>

+

CR

+

N/A

+

N/A

+

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

+

type

+

String

+

CR

+

N/A

+

Only cidr is supported.

+

Specifies the type of the Direct Connect endpoints.

+

The value can only be cidr.

+
+
+
+
+
+
+
Parent topic: Direct Connect Endpoint Group
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025336.html b/docs/dc/api-ref/en-dc_topic_0055025336.html new file mode 100644 index 00000000..124e0684 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025336.html @@ -0,0 +1,198 @@ + + +

Creating an Endpoint Group

+

Function

This API is used to create a Direct Connect endpoint group.

+
+

URI

POST /v2.0/dcaas/dc-endpoint-groups

+
+

Request

Table 1 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

dc_endpoint_group

+

Dictionary data structure

+

Yes

+

Specifies the dc_endpoint_group object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Description of field dc_endpoint_group

Parameter

+

Type

+

Mandatory

+

Description

+

tenant_id

+

String

+

Yes

+

Specifies the project ID.

+

name

+

String

+

No

+

Specifies the name of the Direct Connect endpoint group.

+

description

+

String

+

No

+

Provides supplementary information about the Direct Connect endpoint group.

+

endpoints

+

List<String>

+

Yes

+

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

+

type

+

String

+

Yes

+

Specifies the type of the Direct Connect endpoints.

+

The value can only be cidr.

+
+
+
+

Response

Table 3 lists the response parameter.

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

Parameter

+

Type

+

Description

+

dc_endpoint_group

+

Dictionary data structure

+

Specifies the dc_endpoint_group object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Description of field dc_endpoint_group

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the ID of the Direct Connect endpoint group.

+

tenant_id

+

String

+

Specifies the project ID.

+

name

+

String

+

Specifies the name of the Direct Connect endpoint group.

+

description

+

String

+

Provides supplementary information about the Direct Connect endpoint group.

+

endpoints

+

List<String>

+

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

+

type

+

String

+

Specifies the type of the Direct Connect endpoints.

+

The value can only be cidr.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Direct Connect Endpoint Group
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025337.html b/docs/dc/api-ref/en-dc_topic_0055025337.html new file mode 100644 index 00000000..5da609b2 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025337.html @@ -0,0 +1,135 @@ + + +

Querying the Direct Connect Endpoint Group List

+

Function

This API is used to query the Direct Connect endpoint group list.

+
+

URI

GET /v2.0/dcaas/dc-endpoint-groups

+
+

Request

Table 1 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

fields

+

String

+

No

+

Specifies the parameters expected to be returned.

+

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

+
+
+
+

Response

Table 2 lists the response parameter.

+ +
+ + + + + + + + + +
Table 2 Response parameter

Parameter

+

Type

+

Description

+

dc_endpoint_groups

+

List data structure

+

Specifies the Direct Connect endpoint group list.

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

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the ID of the Direct Connect endpoint group.

+

tenant_id

+

String

+

Specifies the project ID.

+

name

+

String

+

Specifies the name of the Direct Connect endpoint group.

+

description

+

String

+

Provides supplementary information about the Direct Connect endpoint group.

+

endpoints

+

List<String>

+

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

+

type

+

String

+

Specifies the type of the Direct Connect endpoints.

+

The value can only be cidr.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Direct Connect Endpoint Group
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025338.html b/docs/dc/api-ref/en-dc_topic_0055025338.html new file mode 100644 index 00000000..c8bb7411 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025338.html @@ -0,0 +1,71 @@ + + +

Deleting an Endpoint Group

+

Function

This API is used to delete a Direct Connect endpoint group.

+
+

URI

DELETE /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}

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

Parameter

+

Type

+

Mandatory

+

Description

+

endpoint_group_id

+

String

+

Yes

+

Indicates the ID of the Direct Connect endpoint group.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

endpoint_group_id

+

String

+

Yes

+

Indicates the ID of the Direct Connect endpoint group.

+
+
+
+

Response

None

+
+

Examples

+
DELETE /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}
+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Direct Connect Endpoint Group
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025339.html b/docs/dc/api-ref/en-dc_topic_0055025339.html new file mode 100644 index 00000000..83c2f32d --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025339.html @@ -0,0 +1,154 @@ + + +

Querying a Direct Connect Endpoint Group

+

Function

This API is used to query a Direct Connect endpoint group.

+
+

URI

GET /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}

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

Parameter

+

Type

+

Mandatory

+

Description

+

endpoint_group_id

+

String

+

Yes

+

Specifies the ID of the Direct Connect endpoint group.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

endpoint_group_id

+

String

+

Yes

+

Specifies the ID of the Direct Connect endpoint group.

+
+
+
+

Response

Table 3 lists the response parameter.

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

Parameter

+

Type

+

Description

+

dc_endpoint_group

+

Dictionary data structure

+

Specifies the dc_endpoint_group object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Description of field dc_endpoint_group

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the ID of the Direct Connect endpoint group.

+

tenant_id

+

String

+

Specifies the project ID.

+

name

+

String

+

Specifies the name of the Direct Connect endpoint group.

+

description

+

String

+

Provides supplementary information about the Direct Connect endpoint group.

+

endpoints

+

List<String>

+

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

+

type

+

String

+

Specifies the type of the Direct Connect endpoints.

+

The value can only be cidr.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Direct Connect Endpoint Group
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025340.html b/docs/dc/api-ref/en-dc_topic_0055025340.html new file mode 100644 index 00000000..ebbd146f --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025340.html @@ -0,0 +1,192 @@ + + +

Updating a Direct Connect Endpoint Group

+

Function

This API is used to update a Direct Connect endpoint group.

+
+

URI

PUT /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}

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

Parameter

+

Type

+

Mandatory

+

Description

+

endpoint_group_id

+

String

+

Yes

+

Specifies the ID of the Direct Connect endpoint group.

+
+
+
+

Request

Table 2 lists the request parameter.

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

Parameter

+

Type

+

Mandatory

+

Description

+

dc_endpoint_group

+

Dictionary data structure

+

Yes

+

Specifies the dc_endpoint_group object.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Description of field dc_endpoint_group

Parameter

+

Type

+

Mandatory

+

Description

+

description

+

String

+

No

+

Provides supplementary information about the Direct Connect endpoint group.

+

name

+

String

+

No

+

Specifies the name of the Direct Connect endpoint group.

+
+
+
+

Response

Table 4 lists the response parameter.

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

Parameter

+

Type

+

Description

+

dc_endpoint_group

+

Dictionary data structure

+

Specifies the dc_endpoint_group object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Description of field dc_endpoint_group

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the ID of the Direct Connect endpoint group.

+

tenant_id

+

String

+

Specifies the project ID.

+

name

+

String

+

Specifies the name of the Direct Connect endpoint group.

+

description

+

String

+

Provides supplementary information about the Direct Connect endpoint group.

+

endpoints

+

List<String>

+

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

+

type

+

String

+

Specifies the type of the Direct Connect endpoints.

+

The value can only be cidr.

+
+
+
+

Examples

+
+ +

Returned Value

For details, see section Common Returned Values.

+
+
+
+
+
Parent topic: Direct Connect Endpoint Group
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025341.html b/docs/dc/api-ref/en-dc_topic_0055025341.html new file mode 100644 index 00000000..0a851d9b --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025341.html @@ -0,0 +1,13 @@ + + +

Public Parameters

+
+
+ +
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025342.html b/docs/dc/api-ref/en-dc_topic_0055025342.html new file mode 100644 index 00000000..9a509607 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025342.html @@ -0,0 +1,123 @@ + + +

Common Returned Values

+
+
+ + + + + + + + + + + + + + + + + +

Normal Response Code

+

Type

+

Description

+

200

+

OK

+

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

+

201

+

Created

+

Specifies the normal response code for the POST operation.

+

204

+

No Content

+

Specifies the normal response code for the DELETE operation.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Returned Value

+

Description

+

400 Bad Request

+

The server failed to process the request.

+

401 Unauthorized

+

You must enter the username and password to access the requested page.

+

403 Forbidden

+

You are forbidden to access the requested page.

+

404 Not Found

+

The server could not find the requested page.

+

405 Method Not Allowed

+

You are not allowed to use the method specified in the request.

+

406 Not Acceptable

+

The response generated by the server could not be received by the client.

+

407 Proxy Authentication Required

+

You must use the proxy server for authentication so that the request can be processed.

+

408 Request Timeout

+

The request timed out.

+

409 Conflict

+

The request could not be processed due to a conflict.

+

500 Internal Server Error

+

The request is not completed because the service is abnormal.

+

501 Not Implemented

+

The request is not completed because the server does not support the requested function.

+

502 Bad Gateway

+

The request is not completed because the server receives an invalid response from an upstream server.

+

503 Service Unavailable

+

The request is not completed because the system is out of service temporarily.

+

504 Gateway Timeout

+

A gateway timed out.

+
+
+
+
+
+
Parent topic: Public Parameters
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025343.html b/docs/dc/api-ref/en-dc_topic_0055025343.html new file mode 100644 index 00000000..7b48b78d --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025343.html @@ -0,0 +1,195 @@ + + +

Error Codes

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Service

+

Module

+

Error Code

+

HTTP Status Code

+

Description

+

Solution

+

Direct Connect

+

Direct Connect

+

VPC.1901

+

400

+

This connection does not exist.

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1902

+

400

+

This virtual gateway does not exist.

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1903

+

400

+

This virtual interface does not exist.

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1904

+

400

+

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

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1907

+

400

+

Some connection parameters are incorrectly configured.

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1908

+

400

+

Some virtual gateway parameters are incorrectly configured.

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1909

+

400

+

Some virtual interface parameters are incorrectly configured.

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1911

+

400

+

The virtual gateway type is incorrect.

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1918

+

400

+

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

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1924

+

400

+

No direct connection resources available

+

Contact technical support.

+

Direct Connect

+

VPC.1925

+

400

+

No VLANs are available for hosting direct connections.

+

Contact technical support.

+

Direct Connect

+

VPC.1927

+

400

+

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

+

Correct the parameter settings and send the request again.

+

Direct Connect

+

VPC.1931

+

400

+

Direct Connect is incorrectly configured.

+

Contact technical support.

+

Direct Connect

+

VPC.1932

+

400

+

Direct Connect is incorrectly configured.

+

Contact technical support.

+

Direct Connect

+

VPC.1934

+

400

+

A VPC can be specified to only one virtual gateway.

+

Contact technical support.

+
+
+
+
+
+
Parent topic: Public Parameters
+
+
+ diff --git a/docs/dc/api-ref/en-dc_topic_0055025347.html b/docs/dc/api-ref/en-dc_topic_0055025347.html new file mode 100644 index 00000000..a5fb86c3 --- /dev/null +++ b/docs/dc/api-ref/en-dc_topic_0055025347.html @@ -0,0 +1,50 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + + + + +

Released On

+

What's New

+

2018-10-30

+

This release incorporates the following changes:

+ +

2018-04-30

+

This release incorporates the following changes:

+
  • Added the description about how to use the Direct Connect APIs.
  • Added API constraints for creating a connection.
+

2018-03-30

+

This release incorporates the following changes:

+

Modified the API usage.

+

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.
+

2017-9-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/dc/api-ref/public_sys-resources/ExpandCollapse.js b/docs/dc/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 00000000..3f1b7db0 --- /dev/null +++ b/docs/dc/api-ref/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";var href="";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(href.substring(href.lastIndexOf("#")+1))}}catch(a){}}; \ No newline at end of file diff --git a/docs/dc/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/dc/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/dc/api-ref/public_sys-resources/commonltr.css b/docs/dc/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 00000000..c5480b0a --- /dev/null +++ b/docs/dc/api-ref/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/dc/api-ref/public_sys-resources/commonltr_print.css b/docs/dc/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 00000000..a5982314 --- /dev/null +++ b/docs/dc/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/dc/api-ref/public_sys-resources/commonrtl.css b/docs/dc/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 00000000..06c75caa --- /dev/null +++ b/docs/dc/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1 @@ +.msgph{font-family:Courier New}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}.figcap{font-style:italic}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em}.linklist{margin-top:1em;margin-bottom:1em}.linklistwithchild{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.relconcepts{margin-top:1em;margin-bottom:1em}.reltasks{margin-top:1em;margin-bottom:1em}.relref{margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}.topictitle1{margin-top:0;margin-bottom:.1em;font-size:1.34em}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:black;font-size:1.17em;font-weight:bold}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.note{margin-top:1em;margin-bottom:1em}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em}.cautiontitle{font-weight:bold}.caution{font-weight:bold;margin-bottom:1em}ul.simple{list-style-type:none}.firstcol{font-weight:bold}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.uicontrol{font-weight:bold}.parmname{font-weight:bold}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:solid 1px;border-bottom:solid 1px}.row-nocellborder{border-left:none;border-right:0;border-top:0;border-left:hidden;border-bottom:solid 1px}.cell-norowborder{border-top:0;border-bottom:0;border-right:0;border-bottom:hidden;border-left:solid 1px}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.screen{padding:5px 5px 5px 5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre}pre.codeblock{padding:5px 5px 5px 5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/dc/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/dc/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/dc/api-ref/public_sys-resources/delta.gif b/docs/dc/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..f1371e58 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/deltaend.gif b/docs/dc/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..c7929376 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/dc/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..84eec9be Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/dc/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..39583d16 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/icon-caution.gif b/docs/dc/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..6e90d7cf Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/icon-danger.gif b/docs/dc/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..6e90d7cf Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/icon-huawei.gif b/docs/dc/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/icon-note.gif b/docs/dc/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..6314297e Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/icon-notice.gif b/docs/dc/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..3f4e40ce Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/icon-tip.gif b/docs/dc/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..93aa7205 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/icon-warning.gif b/docs/dc/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..6e90d7cf Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/dc/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/dc/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 00000000..57a0e1f5 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/dc/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/dc/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 00000000..fa4b6499 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/dc/api-ref/public_sys-resources/popup.js b/docs/dc/api-ref/public_sys-resources/popup.js new file mode 100644 index 00000000..5305962b --- /dev/null +++ b/docs/dc/api-ref/public_sys-resources/popup.js @@ -0,0 +1 @@ +var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!=null){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(tooltipTxt){if(document.body==null){return}if(i==0){return}clickFlag=true;var text=eval("jsonData."+tooltipTxt);var bodyWidth=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var st=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){st=0}var leftPos=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=text;dhtmlgoodies_tooltip.style.left=leftPos+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+st+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=leftPos+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+st+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var tooltipWidth=dhtmlgoodies_tooltip.offsetWidth;if(tooltipWidthbodyWidth){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((leftPos+tooltipWidth)-bodyWidth))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((leftPos+tooltipWidth)-bodyWidth)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if(dhtmlgoodies_tooltip!=null&&dhtmlgoodies_tooltip.style!=null){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!=null&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!=null&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/dc/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/dc/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 00000000..def5c356 Binary files /dev/null and b/docs/dc/api-ref/public_sys-resources/warning_3.0-en-us.png differ