diff --git a/docs/natgw/api-ref/ALL_META.TXT.json b/docs/natgw/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..a55d1ad5 --- /dev/null +++ b/docs/natgw/api-ref/ALL_META.TXT.json @@ -0,0 +1,302 @@ +[ + { + "uri":"nat_api_0047.html", + "product_code":"nat", + "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":"nat_api_0000.html", + "product_code":"nat", + "code":"2", + "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 v2.0", + "title":"API v2.0", + "githuburl":"" + }, + { + "uri":"nat_api_0001.html", + "product_code":"nat", + "code":"3", + "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":"NAT Gateway Service", + "title":"NAT Gateway Service", + "githuburl":"" + }, + { + "uri":"nat_api_0061.html", + "product_code":"nat", + "code":"4", + "des":"This API is used to create a NAT gateway.POST /v2.0/nat_gatewaysTable 1 describes the request parameters.Table 3 lists response parameters.Example requestPOST https://{En", + "doc_type":"api", + "kw":"Creating a NAT Gateway,NAT Gateway Service,API Reference", + "title":"Creating a NAT Gateway", + "githuburl":"" + }, + { + "uri":"nat_api_0002.html", + "product_code":"nat", + "code":"5", + "des":"This API is used to query a NAT gateway list. Unless otherwise specified, exact match is applied.GET /v2.0/nat_gatewaysYou can type the question mark (?) and ampersand (&", + "doc_type":"api", + "kw":"Querying NAT Gateways,NAT Gateway Service,API Reference", + "title":"Querying NAT Gateways", + "githuburl":"" + }, + { + "uri":"nat_api_0062.html", + "product_code":"nat", + "code":"6", + "des":"This API is used to query details about a specified NAT gateway.GET /v2.0/nat_gateways/{nat_gateway_id}NoneTable 2 lists response parameters.Example requestGET https://{E", + "doc_type":"api", + "kw":"Querying Details About a Specified NAT Gateway,NAT Gateway Service,API Reference", + "title":"Querying Details About a Specified NAT Gateway", + "githuburl":"" + }, + { + "uri":"nat_api_0003.html", + "product_code":"nat", + "code":"7", + "des":"This API is used to update a NAT gateway.admin_state_up = True & status = \"ACTIVE\" can be updated. The name, description, and type of a NAT gateway can be updated.PUT /v2", + "doc_type":"api", + "kw":"Updating a NAT Gateway,NAT Gateway Service,API Reference", + "title":"Updating a NAT Gateway", + "githuburl":"" + }, + { + "uri":"nat_api_0004.html", + "product_code":"nat", + "code":"8", + "des":"This API is used to delete a NAT gateway.DELETE /v2.0/nat_gateways/{nat_gateway_id}NoneNoneExample requestDELETE https://{Endpoint}/v2.0/nat_gateways/a78fb3eb-1654-4710-8", + "doc_type":"api", + "kw":"Deleting a NAT Gateway,NAT Gateway Service,API Reference", + "title":"Deleting a NAT Gateway", + "githuburl":"" + }, + { + "uri":"nat_api_0005.html", + "product_code":"nat", + "code":"9", + "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":"SNAT Rules", + "title":"SNAT Rules", + "githuburl":"" + }, + { + "uri":"nat_api_0006.html", + "product_code":"nat", + "code":"10", + "des":"This API is used to create an SNAT rule.You can create an SNAT rule only when status of the NAT gateway is set to ACTIVE and admin_state_up of the NAT gateway administrat", + "doc_type":"api", + "kw":"Creating an SNAT Rule,SNAT Rules,API Reference", + "title":"Creating an SNAT Rule", + "githuburl":"" + }, + { + "uri":"nat_api_0007.html", + "product_code":"nat", + "code":"11", + "des":"This API is used to query an SNAT rule list.GET /v2.0/snat_rulesYou can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search crite", + "doc_type":"api", + "kw":"Querying SNAT Rules,SNAT Rules,API Reference", + "title":"Querying SNAT Rules", + "githuburl":"" + }, + { + "uri":"nat_api_0008.html", + "product_code":"nat", + "code":"12", + "des":"This API is used to query details about a specified SNAT rule.GET /v2.0/snat_rules/{snat_rule_id}NoneTable 2 lists response parameters.Example requestGET https://{Endpoin", + "doc_type":"api", + "kw":"Querying Details About a Specified SNAT Rule,SNAT Rules,API Reference", + "title":"Querying Details About a Specified SNAT Rule", + "githuburl":"" + }, + { + "uri":"nat_api_0009.html", + "product_code":"nat", + "code":"13", + "des":"This API is used to delete an SNAT rule.DELETE /v2.0/snat_rules/{snat_rule_id}NoneNoneExample requestDELETE https://{Endpoint}/v2.0/snat_rules/a78fb3eb-1654-4710-8742-3fc", + "doc_type":"api", + "kw":"Deleting an SNAT Rule,SNAT Rules,API Reference", + "title":"Deleting an SNAT Rule", + "githuburl":"" + }, + { + "uri":"nat_api_0010.html", + "product_code":"nat", + "code":"14", + "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":"DNAT Rules", + "title":"DNAT Rules", + "githuburl":"" + }, + { + "uri":"nat_api_0011.html", + "product_code":"nat", + "code":"15", + "des":"This API is used to create a DNAT rule.You can create a DNAT rule only when status of the NAT gateway is set to ACTIVE and admin_state_up of the NAT gateway administrator", + "doc_type":"api", + "kw":"Creating a DNAT Rule,DNAT Rules,API Reference", + "title":"Creating a DNAT Rule", + "githuburl":"" + }, + { + "uri":"nat_api_0012.html", + "product_code":"nat", + "code":"16", + "des":"This API is used to query a DNAT rule list.GET /v2.0/dnat_rulesYou can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criter", + "doc_type":"api", + "kw":"Querying DNAT Rules,DNAT Rules,API Reference", + "title":"Querying DNAT Rules", + "githuburl":"" + }, + { + "uri":"nat_api_0013.html", + "product_code":"nat", + "code":"17", + "des":"This API is used to query details about a specified DNAT rule.GET /v2.0/dnat_rules/{dnat_rule_id}NoneTable 2 lists response parameters.Example requestGET https://{Endpoin", + "doc_type":"api", + "kw":"Querying Details About a Specified DNAT Rule,DNAT Rules,API Reference", + "title":"Querying Details About a Specified DNAT Rule", + "githuburl":"" + }, + { + "uri":"nat_api_0014.html", + "product_code":"nat", + "code":"18", + "des":"This API is used to delete a DNAT rule.DELETE /v2.0/dnat_rules/{dnat_rule_id}NoneNoneExample requestDELETE https://{Endpoint}/v2.0/dnat_rules/a78fb3eb-1654-4710-8742-3fc4", + "doc_type":"api", + "kw":"Deleting a DNAT Rule,DNAT Rules,API Reference", + "title":"Deleting a DNAT Rule", + "githuburl":"" + }, + { + "uri":"nat_api_0024.html", + "product_code":"nat", + "code":"19", + "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 Version", + "title":"API Version", + "githuburl":"" + }, + { + "uri":"nat_api_0025.html", + "product_code":"nat", + "code":"20", + "des":"This API is used to query all API versions of NAT Gateway.GET/NoneTable 1 lists response parameters.Example responseSee Status Codes.", + "doc_type":"api", + "kw":"Querying All API Versions,API Version,API Reference", + "title":"Querying All API Versions", + "githuburl":"" + }, + { + "uri":"nat_api_0026.html", + "product_code":"nat", + "code":"21", + "des":"This API is used to query a specified API version of NAT Gateway.GET/{api_version}NoneTable 2 lists response parameters.Example responseSee Status Codes.", + "doc_type":"api", + "kw":"Querying a Specified API Version,API Version,API Reference", + "title":"Querying a Specified API Version", + "githuburl":"" + }, + { + "uri":"nat_api_0027.html", + "product_code":"nat", + "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":"Permissions Policies and Supported Actions", + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"nat_api_0032.html", + "product_code":"nat", + "code":"23", + "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":"NAT Gateway v2.0,Permissions Policies and Supported Actions,API Reference", + "title":"NAT Gateway v2.0", + "githuburl":"" + }, + { + "uri":"nat_api_0033.html", + "product_code":"nat", + "code":"24", + "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":"SNAT Rule v2.0,Permissions Policies and Supported Actions,API Reference", + "title":"SNAT Rule v2.0", + "githuburl":"" + }, + { + "uri":"nat_api_0034.html", + "product_code":"nat", + "code":"25", + "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":"DNAT Rule v2.0,Permissions Policies and Supported Actions,API Reference", + "title":"DNAT Rule v2.0", + "githuburl":"" + }, + { + "uri":"nat_api_0036.html", + "product_code":"nat", + "code":"26", + "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 Parameters", + "title":"Common Parameters", + "githuburl":"" + }, + { + "uri":"nat_api_0038.html", + "product_code":"nat", + "code":"27", + "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":"Status Codes,Common Parameters,API Reference", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"nat_api_0040.html", + "product_code":"nat", + "code":"28", + "des":"An error code returned by an API does not correspond to one error message. The following table lists only common error messages.Most NAT Gateway APIs are asynchronous. So", + "doc_type":"api", + "kw":"Error Code Description v2.0,Common Parameters,API Reference", + "title":"Error Code Description v2.0", + "githuburl":"" + }, + { + "uri":"nat_api_0042.html", + "product_code":"nat", + "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":"Resource Status Description,Common Parameters,API Reference", + "title":"Resource Status Description", + "githuburl":"" + }, + { + "uri":"nat_api_0046.html", + "product_code":"nat", + "code":"30", + "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/natgw/api-ref/CLASS.TXT.json b/docs/natgw/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..ad8d46b1 --- /dev/null +++ b/docs/natgw/api-ref/CLASS.TXT.json @@ -0,0 +1,272 @@ +[ + { + "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":"nat", + "title":"API Usage Guidelines", + "uri":"nat_api_0047.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "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":"nat", + "title":"API v2.0", + "uri":"nat_api_0000.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "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":"nat", + "title":"NAT Gateway Service", + "uri":"nat_api_0001.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"This API is used to create a NAT gateway.POST /v2.0/nat_gatewaysTable 1 describes the request parameters.Table 3 lists response parameters.Example requestPOST https://{En", + "product_code":"nat", + "title":"Creating a NAT Gateway", + "uri":"nat_api_0061.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This API is used to query a NAT gateway list. Unless otherwise specified, exact match is applied.GET /v2.0/nat_gatewaysYou can type the question mark (?) and ampersand (&", + "product_code":"nat", + "title":"Querying NAT Gateways", + "uri":"nat_api_0002.html", + "doc_type":"api", + "p_code":"3", + "code":"5" + }, + { + "desc":"This API is used to query details about a specified NAT gateway.GET /v2.0/nat_gateways/{nat_gateway_id}NoneTable 2 lists response parameters.Example requestGET https://{E", + "product_code":"nat", + "title":"Querying Details About a Specified NAT Gateway", + "uri":"nat_api_0062.html", + "doc_type":"api", + "p_code":"3", + "code":"6" + }, + { + "desc":"This API is used to update a NAT gateway.admin_state_up = True & status = \"ACTIVE\" can be updated. The name, description, and type of a NAT gateway can be updated.PUT /v2", + "product_code":"nat", + "title":"Updating a NAT Gateway", + "uri":"nat_api_0003.html", + "doc_type":"api", + "p_code":"3", + "code":"7" + }, + { + "desc":"This API is used to delete a NAT gateway.DELETE /v2.0/nat_gateways/{nat_gateway_id}NoneNoneExample requestDELETE https://{Endpoint}/v2.0/nat_gateways/a78fb3eb-1654-4710-8", + "product_code":"nat", + "title":"Deleting a NAT Gateway", + "uri":"nat_api_0004.html", + "doc_type":"api", + "p_code":"3", + "code":"8" + }, + { + "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":"nat", + "title":"SNAT Rules", + "uri":"nat_api_0005.html", + "doc_type":"api", + "p_code":"2", + "code":"9" + }, + { + "desc":"This API is used to create an SNAT rule.You can create an SNAT rule only when status of the NAT gateway is set to ACTIVE and admin_state_up of the NAT gateway administrat", + "product_code":"nat", + "title":"Creating an SNAT Rule", + "uri":"nat_api_0006.html", + "doc_type":"api", + "p_code":"9", + "code":"10" + }, + { + "desc":"This API is used to query an SNAT rule list.GET /v2.0/snat_rulesYou can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search crite", + "product_code":"nat", + "title":"Querying SNAT Rules", + "uri":"nat_api_0007.html", + "doc_type":"api", + "p_code":"9", + "code":"11" + }, + { + "desc":"This API is used to query details about a specified SNAT rule.GET /v2.0/snat_rules/{snat_rule_id}NoneTable 2 lists response parameters.Example requestGET https://{Endpoin", + "product_code":"nat", + "title":"Querying Details About a Specified SNAT Rule", + "uri":"nat_api_0008.html", + "doc_type":"api", + "p_code":"9", + "code":"12" + }, + { + "desc":"This API is used to delete an SNAT rule.DELETE /v2.0/snat_rules/{snat_rule_id}NoneNoneExample requestDELETE https://{Endpoint}/v2.0/snat_rules/a78fb3eb-1654-4710-8742-3fc", + "product_code":"nat", + "title":"Deleting an SNAT Rule", + "uri":"nat_api_0009.html", + "doc_type":"api", + "p_code":"9", + "code":"13" + }, + { + "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":"nat", + "title":"DNAT Rules", + "uri":"nat_api_0010.html", + "doc_type":"api", + "p_code":"2", + "code":"14" + }, + { + "desc":"This API is used to create a DNAT rule.You can create a DNAT rule only when status of the NAT gateway is set to ACTIVE and admin_state_up of the NAT gateway administrator", + "product_code":"nat", + "title":"Creating a DNAT Rule", + "uri":"nat_api_0011.html", + "doc_type":"api", + "p_code":"14", + "code":"15" + }, + { + "desc":"This API is used to query a DNAT rule list.GET /v2.0/dnat_rulesYou can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criter", + "product_code":"nat", + "title":"Querying DNAT Rules", + "uri":"nat_api_0012.html", + "doc_type":"api", + "p_code":"14", + "code":"16" + }, + { + "desc":"This API is used to query details about a specified DNAT rule.GET /v2.0/dnat_rules/{dnat_rule_id}NoneTable 2 lists response parameters.Example requestGET https://{Endpoin", + "product_code":"nat", + "title":"Querying Details About a Specified DNAT Rule", + "uri":"nat_api_0013.html", + "doc_type":"api", + "p_code":"14", + "code":"17" + }, + { + "desc":"This API is used to delete a DNAT rule.DELETE /v2.0/dnat_rules/{dnat_rule_id}NoneNoneExample requestDELETE https://{Endpoint}/v2.0/dnat_rules/a78fb3eb-1654-4710-8742-3fc4", + "product_code":"nat", + "title":"Deleting a DNAT Rule", + "uri":"nat_api_0014.html", + "doc_type":"api", + "p_code":"14", + "code":"18" + }, + { + "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":"nat", + "title":"API Version", + "uri":"nat_api_0024.html", + "doc_type":"api", + "p_code":"2", + "code":"19" + }, + { + "desc":"This API is used to query all API versions of NAT Gateway.GET/NoneTable 1 lists response parameters.Example responseSee Status Codes.", + "product_code":"nat", + "title":"Querying All API Versions", + "uri":"nat_api_0025.html", + "doc_type":"api", + "p_code":"19", + "code":"20" + }, + { + "desc":"This API is used to query a specified API version of NAT Gateway.GET/{api_version}NoneTable 2 lists response parameters.Example responseSee Status Codes.", + "product_code":"nat", + "title":"Querying a Specified API Version", + "uri":"nat_api_0026.html", + "doc_type":"api", + "p_code":"19", + "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":"nat", + "title":"Permissions Policies and Supported Actions", + "uri":"nat_api_0027.html", + "doc_type":"api", + "p_code":"", + "code":"22" + }, + { + "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":"nat", + "title":"NAT Gateway v2.0", + "uri":"nat_api_0032.html", + "doc_type":"api", + "p_code":"22", + "code":"23" + }, + { + "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":"nat", + "title":"SNAT Rule v2.0", + "uri":"nat_api_0033.html", + "doc_type":"api", + "p_code":"22", + "code":"24" + }, + { + "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":"nat", + "title":"DNAT Rule v2.0", + "uri":"nat_api_0034.html", + "doc_type":"api", + "p_code":"22", + "code":"25" + }, + { + "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":"nat", + "title":"Common Parameters", + "uri":"nat_api_0036.html", + "doc_type":"api", + "p_code":"", + "code":"26" + }, + { + "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":"nat", + "title":"Status Codes", + "uri":"nat_api_0038.html", + "doc_type":"api", + "p_code":"26", + "code":"27" + }, + { + "desc":"An error code returned by an API does not correspond to one error message. The following table lists only common error messages.Most NAT Gateway APIs are asynchronous. So", + "product_code":"nat", + "title":"Error Code Description v2.0", + "uri":"nat_api_0040.html", + "doc_type":"api", + "p_code":"26", + "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":"nat", + "title":"Resource Status Description", + "uri":"nat_api_0042.html", + "doc_type":"api", + "p_code":"26", + "code":"29" + }, + { + "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":"nat", + "title":"Change History", + "uri":"nat_api_0046.html", + "doc_type":"api", + "p_code":"", + "code":"30" + } +] \ No newline at end of file diff --git a/docs/natgw/api-ref/PARAMETERS.txt b/docs/natgw/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/natgw/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/natgw/api-ref/nat_api_0000.html b/docs/natgw/api-ref/nat_api_0000.html new file mode 100644 index 00000000..f2ee3d74 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0000.html @@ -0,0 +1,17 @@ + + +

API v2.0

+
+
+ +
+ diff --git a/docs/natgw/api-ref/nat_api_0001.html b/docs/natgw/api-ref/nat_api_0001.html new file mode 100644 index 00000000..4e2e87a6 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0001.html @@ -0,0 +1,23 @@ + + +

NAT Gateway Service

+
+
+ + +
+
Parent topic: API v2.0
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0002.html b/docs/natgw/api-ref/nat_api_0002.html new file mode 100644 index 00000000..fcf17750 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0002.html @@ -0,0 +1,277 @@ + + +

Querying NAT Gateways

+

Function

This API is used to query a NAT gateway list. Unless otherwise specified, exact match is applied.

+
+

URI

GET /v2.0/nat_gateways

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. All optional parameters can be filtered. For details, see the example request.

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

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Specifies the NAT gateway ID.

+

limit

+

No

+

Integer

+

Specifies the number of records on each page.

+

tenant_id

+

No

+

String

+

Specifies the project ID.

+

name

+

No

+

String(64)

+

Specifies the NAT gateway name.

+

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

+

description

+

No

+

String(255)

+

Provides supplementary information about the NAT gateway.

+

spec

+

No

+

String

+

Specifies the NAT gateway type.

+

The value can be:

+
  • 1: small type, which supports up to 10,000 SNAT connections.
  • 2: medium type, which supports up to 50,000 SNAT connections.
  • 3: large type, which supports up to 200,000 SNAT connections.
  • 4: extra-large type, which supports up to 1,000,000 SNAT connections.
+

router_id

+

No

+

String

+

Specifies the router ID.

+

internal_network_id

+

No

+

String

+

Specifies the network ID of the downstream interface (the next hop of the DVR) of the NAT gateway.

+

status

+

No

+

String

+
  • Specifies the NAT gateway status.
  • For details about all its values, see Table 1.
+

admin_state_up

+

No

+

Boolean

+
  • Specifies whether the NAT gateway is up or down.
  • The value can be:
    • true: The NAT gateway is up.
    • false: The NAT gateway is down.
    +
+

created_at

+

No

+

String

+

Specifies when the NAT gateway is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Request

None

+
+

Response

Table 2 lists response parameters.

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

Parameter

+

Type

+

Description

+

nat_gateways

+

List (NAT gateways)

+

Specifies the NAT gateway objects. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Description of the nat_gateway field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the NAT gateway ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

name

+

String(64)

+

Specifies the NAT gateway name.

+

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

+

description

+

String(255)

+

Provides supplementary information about the NAT gateway.

+

spec

+

String

+

Specifies the NAT gateway type.

+

The value can be:

+
  • 0: micro type, which supports up to 1,000 SNAT connections.
+
  • 1: small type, which supports up to 10,000 SNAT connections.
  • 2: medium type, which supports up to 50,000 SNAT connections.
  • 3: large type, which supports up to 200,000 SNAT connections.
  • 4: extra-large type, which supports up to 1,000,000 SNAT connections.
+

router_id

+

String

+

Specifies the router ID.

+

internal_network_id

+

String

+

Specifies the network ID of the downstream interface (the next hop of the DVR) of the NAT gateway.

+

status

+

String

+
  • Specifies the NAT gateway status.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the NAT gateway is up or down.
  • The value can be:
    • true: The NAT gateway is up.
    • false: The NAT gateway is down.
    +
+

created_at

+

String

+

Specifies when the NAT gateway is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: NAT Gateway Service
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0003.html b/docs/natgw/api-ref/nat_api_0003.html new file mode 100644 index 00000000..e64ade92 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0003.html @@ -0,0 +1,245 @@ + + +

Updating a NAT Gateway

+

Function

This API is used to update a NAT gateway.

+

admin_state_up = True & status = "ACTIVE" can be updated. The name, description, and type of a NAT gateway can be updated.

+
+
+

URI

PUT /v2.0/nat_gateways/{nat_gateway_id}

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

Parameter

+

Type

+

Mandatory

+

Description

+

nat_gateway_id

+

String

+

Yes

+

Specifies the NAT gateway ID.

+
+
+
+

Request

Table 2 describes the request parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

nat_gateway

+

Yes

+

Object

+

Specifies the NAT gateway object. For details, see Table 3.

+

Mandatory field: None. Only the name, description, and spec fields can be updated. At least one attribute must be specified for the NAT gateway to be updated.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Description of the nat_gateway field

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String(64)

+

Specifies the NAT gateway name.

+

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

+

description

+

No

+

String(255)

+

Provides supplementary information about the NAT gateway.

+

spec

+

No

+

String

+

Specifies the NAT gateway type.

+

The value can be:

+
  • 0: micro type, which supports up to 1,000 SNAT connections.
+
  • 1: small type, which supports up to 10,000 SNAT connections.
  • 2: medium type, which supports up to 50,000 SNAT connections.
  • 3: large type, which supports up to 200,000 SNAT connections.
  • 4: extra-large type, which supports up to 1,000,000 SNAT connections.
+
+
+
+

Response

Table 4 lists response parameters.

+ +
+ + + + + + + + + +
Table 4 Response parameters

Parameter

+

Type

+

Description

+

nat_gateway

+

Object

+

Specifies the NAT gateway object. For details, see Table 5.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Description of the nat_gateway field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the NAT gateway ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

name

+

String(64)

+

Specifies the NAT gateway name.

+

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

+

description

+

String(255)

+

Provides supplementary information about the NAT gateway.

+

spec

+

String

+

Specifies the NAT gateway type.

+

The value can be:

+
  • 0: micro type, which supports up to 1,000 SNAT connections.
+
  • 1: small type, which supports up to 10,000 SNAT connections.
  • 2: medium type, which supports up to 50,000 SNAT connections.
  • 3: large type, which supports up to 200,000 SNAT connections.
  • 4: extra-large type, which supports up to 1,000,000 SNAT connections.
+

router_id

+

String

+

Specifies the router ID.

+

internal_network_id

+

String

+

Specifies the network ID of the downstream interface (the next hop of the DVR) of the NAT gateway.

+

status

+

String

+
  • Specifies the status of the NAT gateway.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the NAT gateway is up or down.
  • The value can be:
    • true: The NAT gateway is up.
    • false: The NAT gateway is down.
    +
+

created_at

+

String

+

Specifies when the NAT gateway is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: NAT Gateway Service
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0004.html b/docs/natgw/api-ref/nat_api_0004.html new file mode 100644 index 00000000..43917bbd --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0004.html @@ -0,0 +1,48 @@ + + +

Deleting a NAT Gateway

+

Function

This API is used to delete a NAT gateway.

+
+

URI

DELETE /v2.0/nat_gateways/{nat_gateway_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

nat_gateway_id

+

Yes

+

String

+

Specifies the NAT gateway ID.

+
+
+
+

Request

None

+
+

Response

None

+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: NAT Gateway Service
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0005.html b/docs/natgw/api-ref/nat_api_0005.html new file mode 100644 index 00000000..5232dd67 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0005.html @@ -0,0 +1,21 @@ + + +

SNAT Rules

+
+
+ + +
+
Parent topic: API v2.0
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0006.html b/docs/natgw/api-ref/nat_api_0006.html new file mode 100644 index 00000000..e64b7fd0 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0006.html @@ -0,0 +1,296 @@ + + +

Creating an SNAT Rule

+

Function

This API is used to create an SNAT rule.

+

You can create an SNAT rule only when status of the NAT gateway is set to ACTIVE and admin_state_up of the NAT gateway administrator to True.

+
+
+

URI

POST /v2.0/snat_rules

+
+

Request

Table 1 describes the request parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

snat_rule

+

Yes

+

Object

+

Specifies the SNAT rule object. For details, see Table 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Description of the snat_rule field

Parameter

+

Mandatory

+

Type

+

Description

+

nat_gateway_id

+

Yes

+

String

+

Specifies the NAT gateway ID.

+

network_id

+

No

+

String

+

Specifies the network ID used by the SNAT rule. This parameter and cidr are alternative.

+

cidr

+

No

+

String

+

Specifies CIDR, which can be in the format of a network segment or a host IP address. This parameter and network_id are alternative.

+

If the value of Source_type is 0, the CIDR block must be a subset of the VPC subnet CIDR block.

+

If the value of Source_type is 1, cidr must be a CIDR block of Direct Connect connection.

+

source_type

+

No

+

Integer

+

0: Either network_id or cidr can be specified in a VPC.

+

1: Only cidr can be specified over a Direct Connect connection.

+

If no value is entered, the default value 0 (VPC) is used.

+

floating_ip_id

+

Yes

+

String

+

Specifies the EIP ID. Multiple EIPs are separated using commas (,).

+

The maximum length of the ID is 4096 bytes.

+

The number of EIP IDs cannot exceed 20.

+
+
+
+

Response

Table 3 lists response parameters.

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

Parameter

+

Type

+

Description

+

snat_rule

+

Object

+

Specifies the SNAT rule object. For details, see Table 4.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Description of the snat_rule field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the SNAT rule ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

nat_gateway_id

+

String

+

Specifies the NAT gateway ID.

+

network_id

+

String

+

Specifies the network ID used by the SNAT rule.

+

cidr

+

String

+

Specifies a subset of the VPC subnet CIDR block or a CIDR block of Direct Connect connection.

+

source_type

+

Integer

+

0: Either network_id or cidr can be specified in a VPC.

+

1: Only cidr can be specified over a Direct Connect connection.

+

If no value is entered, the default value 0 (VPC) is used.

+

floating_ip_id

+

String(4096)

+
  • Specifies the EIP ID. Multiple EIPs are separated using commas (,).
  • The maximum length of the ID is 4096 bytes.
+

floating_ip_address

+

String(1024)

+
  • Specifies the EIP. Multiple EIPs are separated using commas (,).
  • The maximum length is 1024 bytes.
+

status

+

String

+
  • Specifies the status of the SNAT rule.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the SNAT rule is enabled or disabled.
  • The value can be:
    • true: The SNAT rule is enabled.
    • false: The SNAT rule is disabled.
    +
+

created_at

+

String

+

Specifies when the SNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+ +
+

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: SNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0007.html b/docs/natgw/api-ref/nat_api_0007.html new file mode 100644 index 00000000..ae44c390 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0007.html @@ -0,0 +1,293 @@ + + +

Querying SNAT Rules

+

Function

This API is used to query an SNAT rule list.

+
+

URI

GET /v2.0/snat_rules

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. All optional parameters can be filtered. For details, see the example request.

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

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Specifies the SNAT rule ID.

+

limit

+

No

+

Integer

+

Specifies the number of records on each page.

+

tenant_id

+

No

+

String

+

Specifies the project ID.

+

nat_gateway_id

+

No

+

String

+

Specifies the NAT gateway ID.

+

network_id

+

No

+

String

+

Specifies the network ID used by the SNAT rule.

+

cidr

+

No

+

String

+

Specifies a subset of the VPC subnet CIDR block or a CIDR block of Direct Connect connection.

+

source_type

+

No

+

Integer

+

0: Either network_id or cidr can be specified in a VPC.

+

1: Only cidr can be specified over a Direct Connect connection.

+

If no value is entered, the default value 0 (VPC) is used.

+

floating_ip_id

+

No

+

String(4096)

+

Specifies the EIP ID.

+

floating_ip_address

+

No

+

String(1024)

+

Specifies the EIP.

+

status

+

No

+

String

+
  • Specifies the status of the SNAT rule.
  • For details about all its values, see Table 1.
+

admin_state_up

+

No

+

Boolean

+
  • Specifies whether the SNAT rule is enabled or disabled.
  • The value can be:
    • true: The SNAT rule is enabled.
    • false: The SNAT rule is disabled.
    +
+

created_at

+

No

+

String

+

Specifies when the SNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+

+
+

Request

None

+
+

Response

Table 2 lists response parameters.

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

Parameter

+

Type

+

Description

+

snat_rules

+

List (SNAT rules)

+

Specifies the SNAT rule objects. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Description of the snat_rule field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the SNAT rule ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

nat_gateway_id

+

String

+

Specifies the NAT gateway ID.

+

network_id

+

String

+

Specifies the network ID used by the SNAT rule.

+

cidr

+

String

+

Specifies a subset of the VPC subnet CIDR block or a CIDR block of Direct Connect connection.

+

source_type

+

Integer

+

0: Either network_id or cidr can be specified in a VPC.

+

1: Only cidr can be specified over a Direct Connect connection.

+

If no value is entered, the default value 0 (VPC) is used.

+

floating_ip_id

+

String(4096)

+
  • Specifies the EIP ID. Multiple EIPs are separated using commas (,).
  • The maximum length of the ID is 4096 bytes.
  • The number of EIP IDs cannot exceed 20.
+

floating_ip_address

+

String(1024)

+
  • Specifies the EIP. Multiple EIPs are separated using commas (,).
  • The maximum length is 1024 bytes.
+

status

+

String

+
  • Specifies the status of the SNAT rule.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the SNAT rule is enabled or disabled.
  • The value can be:
    • true: The SNAT rule is enabled.
    • false: The SNAT rule is disabled.
    +
+

created_at

+

String

+

Specifies when the SNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: SNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0008.html b/docs/natgw/api-ref/nat_api_0008.html new file mode 100644 index 00000000..bdbb38a0 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0008.html @@ -0,0 +1,173 @@ + + +

Querying Details About a Specified SNAT Rule

+

Function

This API is used to query details about a specified SNAT rule.

+
+

URI

GET /v2.0/snat_rules/{snat_rule_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

snat_rule_id

+

Yes

+

String

+

Specifies the SNAT rule ID.

+
+
+
+

Request

None

+
+

Response

Table 2 lists response parameters.

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

Parameter

+

Type

+

Description

+

snat_rule

+

Object

+

Specifies the SNAT rule object. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Description of the snat_rule field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the SNAT rule ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

nat_gateway_id

+

String

+

Specifies the NAT gateway ID.

+

network_id

+

String

+

Specifies the network ID used by the SNAT rule.

+

cidr

+

String

+

Specifies a subset of the VPC subnet CIDR block or a CIDR block of Direct Connect connection.

+

source_type

+

Integer

+

0: Either network_id or cidr can be specified in a VPC.

+

1: Only cidr can be specified over a Direct Connect connection.

+

If no value is entered, the default value 0 (VPC) is used.

+

floating_ip_id

+

String(4096)

+
  • Specifies the EIP ID. Multiple EIPs are separated using commas (,).
  • The maximum length of the ID is 4096 bytes.
  • The number of EIP IDs cannot exceed 20.
+

floating_ip_address

+

String(1024)

+
  • Specifies the EIP. Multiple EIPs are separated using commas (,).
  • The maximum length is 1024 bytes.
+

status

+

String

+
  • Specifies the status of the SNAT rule.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the SNAT rule is enabled or disabled.
  • The value can be:
    • true: The SNAT rule is enabled.
    • false: The SNAT rule is disabled.
    +
+

created_at

+

String

+

Specifies when the SNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: SNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0009.html b/docs/natgw/api-ref/nat_api_0009.html new file mode 100644 index 00000000..2e3c2296 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0009.html @@ -0,0 +1,48 @@ + + +

Deleting an SNAT Rule

+

Function

This API is used to delete an SNAT rule.

+
+

URI

DELETE /v2.0/snat_rules/{snat_rule_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

snat_rule_id

+

Yes

+

String

+

Specifies the SNAT rule ID.

+
+
+
+

Request

None

+
+

Response

None

+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: SNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0010.html b/docs/natgw/api-ref/nat_api_0010.html new file mode 100644 index 00000000..76ef6f17 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0010.html @@ -0,0 +1,21 @@ + + +

DNAT Rules

+
+
+ + +
+
Parent topic: API v2.0
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0011.html b/docs/natgw/api-ref/nat_api_0011.html new file mode 100644 index 00000000..ff8c49fe --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0011.html @@ -0,0 +1,315 @@ + + +

Creating a DNAT Rule

+

Function

This API is used to create a DNAT rule.

+

You can create a DNAT rule only when status of the NAT gateway is set to ACTIVE and admin_state_up of the NAT gateway administrator to True. Either port_id or private_ip is used each time. If you create a rule that applies to all port types, set internal_service_port to 0, external_service_port to 0, and protocol to ANY.

+
+
+

URI

POST /v2.0/dnat_rules

+
+

Request

Table 1 lists the request parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

dnat_rule

+

Yes

+

Object

+

Specifies the DNAT rule object. For details, see Table 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Description of the dnat_rule field

Parameter

+

Mandatory

+

Type

+

Description

+

nat_gateway_id

+

Yes

+

String

+

Specifies the NAT gateway ID.

+

port_id

+

No

+

String

+

Specifies the port ID of an ECS or a BMS. This parameter and private_ip are alternative.

+

When the DNAT rule is used in the VPC scenario, use this parameter.

+

+

private_ip

+

No

+

String

+

Specifies the private IP address, for example, the IP address of a Direct Connect connection. This parameter and port_id are alternative.

+

When the DNAT rule is used in the Direct Connect scenario, use this parameter.

+

internal_service_port

+

Yes

+

Integer

+

Specifies the port used by ECSs or BMSs to provide services that are accessible from external systems. In the VPC scenario, this parameter indicates the NIC port of the ECS or BMS associated with the DNAT rule. In the Direct Connect scenario, this parameter indicates the port of the private IP address of the DNAT rule.

+

The value ranges from 0 to 65535.

+

floating_ip_id

+

Yes

+

String

+

Specifies the EIP ID.

+

external_service_port

+

Yes

+

Integer

+

Specifies the port for providing services that are accessible from external systems..

+

The value ranges from 0 to 65535.

+

protocol

+

Yes

+

String

+

Specifies the protocol type. Currently, TCP, UDP, and ANY are supported.

+

The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

+
+
+

To map all ports, set internal_service_port and external_service_port to 0 and protocol to ANY or 0.

+
+
+

Response

Table 3 lists response parameters.

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

Parameter

+

Type

+

Description

+

dnat_rule

+

Object

+

Specifies the DNAT rule object. For details, see Table 4.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Description of the dnat_rule field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the DNAT rule ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

nat_gateway_id

+

String

+

Specifies the NAT gateway ID.

+

port_id

+

String

+

Specifies the port ID of an ECS or a BMS. This parameter is used in the VPC scenario. This parameter and private_ip are alternative.

+

private_ip

+

String

+

Specifies the IP address of a Direct Connect connection.

+

This parameter is used in the Direct Connect scenario. This parameter and port_id are alternative.

+

internal_service_port

+

Integer

+

Specifies the port used by ECSs or BMSs to provide services for external systems.

+

floating_ip_id

+

String

+

Specifies the EIP ID.

+

floating_ip_address

+

String

+

Specifies the EIP.

+

external_service_port

+

Integer

+

Specifies the port for providing external services.

+

protocol

+

String

+

Specifies the protocol type. Currently, TCP, UDP, and ANY are supported.

+

The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

+

status

+

String

+
  • Specifies the status of the DNAT rule.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the DNAT rule is enabled or disabled.
  • The value can be:
    • true: The DNAT rule is enabled.
    • false: The DNAT rule is disabled.
    +
+

created_at

+

String

+

Specifies when the DNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: DNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0012.html b/docs/natgw/api-ref/nat_api_0012.html new file mode 100644 index 00000000..83a1ae52 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0012.html @@ -0,0 +1,296 @@ + + +

Querying DNAT Rules

+

Function

This API is used to query a DNAT rule list.

+
+

URI

GET /v2.0/dnat_rules

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. All optional parameters can be filtered. For details, see the example request.

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

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the DNAT rule ID.

+

limit

+

Integer

+

Specifies the number of records on each page.

+

tenant_id

+

String

+

Specifies the project ID.

+

nat_gateway_id

+

String

+

Specifies the NAT gateway ID.

+

port_id

+

String

+

Specifies the port ID of an ECS or a BMS.

+

private_ip

+

String

+

Specifies the private IP address, for example, the IP address of a Direct Connect connection.

+

internal_service_port

+

Integer

+

Specifies the port used by ECSs or BMSs to provide services for external systems.

+

floating_ip_id

+

String

+

Specifies the EIP ID.

+

floating_ip_address

+

String

+

Specifies the EIP.

+

external_service_port

+

Integer

+

Specifies the port for providing external services.

+

protocol

+

String

+

Specifies the protocol type. Currently, TCP, UDP, and ANY are supported.

+

The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

+

status

+

String

+		 +

admin_state_up

+

Boolean

+
  • Specifies whether the DNAT rule is enabled or disabled.
  • The value can be:
    • true: The DNAT rule is enabled.
    • false: The DNAT rule is disabled.
    +
+

created_at

+

String

+

Specifies when the DNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Request

None

+
+

Response

Table 2 lists response parameters.

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

Parameter

+

Type

+

Description

+

dnat_rules

+

Array(Object)

+

Specifies the DNAT rule objects. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Description of the dnat_rule field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the DNAT rule ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

nat_gateway_id

+

String

+

Specifies the NAT gateway ID.

+

port_id

+

String

+

Specifies the port ID of an ECS or a BMS.

+

private_ip

+

String

+

Specifies the private IP address, for example, the IP address of a Direct Connect connection.

+

internal_service_port

+

Integer

+

Specifies the port used by ECSs or BMSs to provide services for external systems.

+

floating_ip_id

+

String

+

Specifies the EIP ID.

+

floating_ip_address

+

String

+

Specifies the EIP.

+

external_service_port

+

Integer

+

Specifies the port for providing external services.

+

protocol

+

String

+

Specifies the protocol type. Currently, TCP, UDP, and ANY are supported.

+

The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

+

status

+

String

+
  • Specifies the status of the DNAT rule.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the DNAT rule is enabled or disabled.
  • The value can be:
    • true: The DNAT rule is enabled.
    • false: The DNAT rule is disabled.
    +
+

created_at

+

String

+

Specifies when the DNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: DNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0013.html b/docs/natgw/api-ref/nat_api_0013.html new file mode 100644 index 00000000..23e87d04 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0013.html @@ -0,0 +1,188 @@ + + +

Querying Details About a Specified DNAT Rule

+

Function

This API is used to query details about a specified DNAT rule.

+
+

URI

GET /v2.0/dnat_rules/{dnat_rule_id}

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

Parameter

+

Type

+

Mandatory

+

Description

+

dnat_rule_id

+

String

+

Yes

+

Specifies the DNAT rule ID.

+
+
+
+

Request

None

+
+

Response

Table 2 lists response parameters.

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

Parameter

+

Type

+

Description

+

dnat_rule

+

Object

+

Specifies the DNAT rule object. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Description of the dnat_rule field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the DNAT rule ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

nat_gateway_id

+

String

+

Specifies the NAT gateway ID.

+

port_id

+

String

+

Specifies the port ID of an ECS or a BMS.

+

private_ip

+

String

+

Specifies the private IP address, for example, the IP address of a Direct Connect connection.

+

internal_service_port

+

Integer

+

Specifies the port used by ECSs or BMSs to provide services for external systems.

+

floating_ip_id

+

String

+

Specifies the EIP ID.

+

floating_ip_address

+

String

+

Specifies the EIP.

+

external_service_port

+

Integer

+

Specifies the port for providing external services.

+

protocol

+

String

+

Specifies the protocol type. Currently, TCP, UDP, and ANY are supported.

+

The protocol number of TCP, UDP, and ANY are 6, 17, and 0, respectively.

+

status

+

String

+
  • Specifies the status of the DNAT rule.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the DNAT rule is enabled or disabled.
  • The value can be:
    • true: The DNAT rule is enabled.
    • false: The DNAT rule is disabled.
    +
+

created_at

+

String

+

Specifies when the DNAT rule is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: DNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0014.html b/docs/natgw/api-ref/nat_api_0014.html new file mode 100644 index 00000000..bec37c7b --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0014.html @@ -0,0 +1,48 @@ + + +

Deleting a DNAT Rule

+

Function

This API is used to delete a DNAT rule.

+
+

URI

DELETE /v2.0/dnat_rules/{dnat_rule_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

dnat_rule_id

+

Yes

+

String

+

Specifies the ID of the DNAT rule.

+
+
+
+

Request

None

+
+

Response

None

+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: DNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0024.html b/docs/natgw/api-ref/nat_api_0024.html new file mode 100644 index 00000000..05ffec68 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0024.html @@ -0,0 +1,17 @@ + + +

API Version

+
+
+ + +
+
Parent topic: API v2.0
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0025.html b/docs/natgw/api-ref/nat_api_0025.html new file mode 100644 index 00000000..2fd9a483 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0025.html @@ -0,0 +1,137 @@ + + +

Querying All API Versions

+

Function

This API is used to query all API versions of NAT Gateway.

+
+

API Format

GET/

+
+

Request

None

+
+

Response

Table 1 lists response parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

versions

+

Yes

+

Array

+

Specifies the list of all versions.

+

id

+

Yes

+

String

+

Specifies the version ID, for example, v1.

+

links

+

Yes

+

Array

+

Specifies the API URL.

+

href

+

Yes

+

String

+

Specifies the reference address of the current API version.

+

rel

+

Yes

+

String

+

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

+

version

+

Yes

+

String

+

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

+

status

+

Yes

+

String

+

Specifies the version status.

+

The value can be:

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

updated

+

Yes

+

String

+

Specifies the time when the API version was released.

+

The value must be UTC time. For example, the release time of v1 is 2014-06-28T12:20:21Z.

+

min_version

+

No

+

String

+

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

+
+
+
+

Examples

+
{
+  "versions": [
+    {
+      "id": "v2.0",
+      "links": [
+        {
+          "href": "https://x.x.x.x/v2.0/",
+          "rel": "self"
+        }
+      ],
+      "min_version": "",
+      "status": "CURRENT",
+      "updated": "2018-09-30T00:00:00Z",
+      "version": ""
+    }
+  ]
+}
+
+

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: API Version
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0026.html b/docs/natgw/api-ref/nat_api_0026.html new file mode 100644 index 00000000..c3d47f1f --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0026.html @@ -0,0 +1,152 @@ + + +

Querying a Specified API Version

+

Function

This API is used to query a specified API version of NAT Gateway.

+
+

URI

GET/{api_version}

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

Parameter

+

Mandatory

+

Description

+

api_version

+

Yes

+

Specifies the API version.

+
+
+
+

Request

None

+
+

Response

Table 2 lists response parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

version

+

Yes

+

String

+

Specifies the API version.

+

id

+

Yes

+

String

+

Specifies the version ID, for example, v1.

+

links

+

Yes

+

Array

+

Specifies the API URL.

+

href

+

Yes

+

String

+

Specifies the reference address of the current API version.

+

rel

+

Yes

+

String

+

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

+

version

+

Yes

+

String

+

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

+

status

+

Yes

+

String

+

Specifies the version status. Possible values are as follows:

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

updated

+

Yes

+

String

+

Specifies the version release time, which must be the UTC time. For example, the release time of v1 is 2014-06-28T12:20:21Z.

+

min_version

+

No

+

String

+

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

+
+
+
+

Examples

+
{ 
+  "version": { 
+      "id": "v2.0", 
+      "links": [ 
+        { 
+          "href": "https://x.x.x.x/v2.0/", 
+          "rel": "self" 
+        } 
+      ], 
+      "min_version": "", 
+      "status": "CURRENT", 
+      "updated": "2018-09-30T00:00:00Z", 
+      "version": "" 
+    } 
+}
+
+

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: API Version
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0027.html b/docs/natgw/api-ref/nat_api_0027.html new file mode 100644 index 00000000..52580915 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0027.html @@ -0,0 +1,16 @@ + + +

Permissions Policies and Supported Actions

+

+
+
+ +
+ diff --git a/docs/natgw/api-ref/nat_api_0032.html b/docs/natgw/api-ref/nat_api_0032.html new file mode 100644 index 00000000..19c26165 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0032.html @@ -0,0 +1,57 @@ + + +

NAT Gateway v2.0

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

Permission

+

API

+

Action

+

Creating NAT Gateways

+

POST /v2.0/nat_gateways

+

nat:natGateways:create

+

Querying NAT Gateways

+

GET /v2.0/nat_gateways

+

nat:natGateways:list

+

Querying NAT Gateway Details

+

GET /v2.0/nat_gateways/{nat_gateway_id}

+

nat:natGateways:get

+

Updating NAT Gateways

+

PUT /v2.0/nat_gateways/{nat_gateway_id}

+

nat:natGateways:update

+

Deleting NAT Gateways

+

DELETE /v2.0/nat_gateways/{nat_gateway_id}

+

nat:natGateways:delete

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0033.html b/docs/natgw/api-ref/nat_api_0033.html new file mode 100644 index 00000000..1902ebe2 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0033.html @@ -0,0 +1,50 @@ + + +

SNAT Rule v2.0

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

Permission

+

API

+

Action

+

Creating SNAT Rules

+

POST /v2.0/snat_rules

+

nat:snatRules:create

+

Querying SNAT Rules

+

GET /v2.0/snat_rules

+

nat:snatRules:list

+

Querying SNAT Rule Details

+

GET /v2.0/snat_rules/{snat_rule_id }

+

nat:snatRules:get

+

Deleting SNAT Rules

+

DELETE /v2.0/snat_rules/{snat_rule_id}

+

nat:snatRules:delete

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0034.html b/docs/natgw/api-ref/nat_api_0034.html new file mode 100644 index 00000000..9ad338fd --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0034.html @@ -0,0 +1,50 @@ + + +

DNAT Rule v2.0

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

Permission

+

API

+

Action

+

Creating DNAT Rules

+

POST /v2.0/dnat_rules

+

nat:dnatRules:create

+

Querying DNAT Rules

+

GET /v2.0/dnat_rules

+

nat:dnatRules:list

+

Querying DNAT Rule Details

+

GET /v2.0/dnat_rules/{dnat_rule_id }

+

nat:dnatRules:get

+

Deleting DNAT Rules

+

DELETE /v2.0/dnat_rules/{dnat_rule_id}

+

nat:dnat_rules:delete

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0036.html b/docs/natgw/api-ref/nat_api_0036.html new file mode 100644 index 00000000..90d320ff --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0036.html @@ -0,0 +1,15 @@ + + +

Common Parameters

+
+
+ +
+ diff --git a/docs/natgw/api-ref/nat_api_0038.html b/docs/natgw/api-ref/nat_api_0038.html new file mode 100644 index 00000000..5f8669ee --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0038.html @@ -0,0 +1,123 @@ + + +

Status Codes

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

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 for the DELETE operation.

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

Error Response Code

+

Description

+

400 Bad Request

+

The server failed to process the request.

+

401 Unauthorized

+

You must enter a 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 cannot be accepted 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 cannot be processed due to a conflict.

+

500 Internal Server Error

+

Failed to complete the request because of an internal service error.

+

501 Not Implemented

+

Failed to complete the request because the server does not support the requested function.

+

502 Bad Gateway

+

Failed to complete the request because the server has received an invalid response.

+

503 Service Unavailable

+

Failed to complete the request because the system is currently unavailable.

+

504 Gateway Timeout

+

A gateway timeout error occurred.

+
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0040.html b/docs/natgw/api-ref/nat_api_0040.html new file mode 100644 index 00000000..7cea77f9 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0040.html @@ -0,0 +1,1017 @@ + + +

Error Code Description v2.0

+

Background Information

+
+

Error Codes

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

Module

+

HTTP Status Code

+

Error Code

+

Description

+

Error Message

+

Handling Measure

+

Public

+

400

+

VPC.0002

+

The AZ is left blank.

+

Available zone Name is null.

+

Verify whether the availability_zone field in the request body for creating a subnet is empty.

+

404

+

VPC.0003

+

The VPC does not exist.

+

VPC does not exit.

+

Check whether the VPC ID is correct or whether the VPC exists under the tenant.

+

400

+

VPC.0004

+

The status of the VPC is abnormal.

+

VPC is not active, please try later.

+

Try again later or contact technical support.

+

400

+

VPC.0007

+

Inconsistent tenant IDs.

+

urlTenantId is not equal tokenTenantId

+

The tenant ID in the URL is different from that parsed in the token.

+

401

+

VPC.0008

+

Invalid token.

+

Invalid token in the header.

+

Check whether the token in the request header is valid.

+

401

+

VPC.0009

+

Real-name authentication fails.

+

real-name authentication fail.

+

Contact technical support.

+

403

+

VPC.2701

+

You do not have permission to perform this operation, or your account balance is insufficient.

+

Token not allowed to do this action.

+

Check whether the account balance is insufficient or whether your account has been frozen.

+

403

+

VPC.0010

+

Insufficient permissions to make calls to the underlying system.

+

Rules on xx by ** disallowed by policy

+

Obtain the required permissions.

+

403

+

VPC.2201

+

Insufficient fine-grained permissions.

+

Policy doesn't allow <x:x:x> to be performed

+

Obtain the required permissions.

+

400

+

VPC.0014

+

The enterprise project is unavailable.

+

This enterpriseProject status is disable.

+

Use the ID of another available enterprise project.

+

400

+

VPC.0011

+

Invalid enterprise project ID.

+

EnterpriseProjectId is invalid

+

Enter a valid enterprise project ID.

+

400

+

VPC.2048

+

+

Invalid timestamp.

+

+

Invalid value for created_at %(timestamp)s.

+

Enter the time in the correct format.

+

+

400

+

VPC.2002

+

Invalid request parameters.

+

Invalid parameters.

+

Enter the correct parameter.

+

400

+

VPC.2010

+

+

The default route already exists.

+

+

The router %(router_id)s has default route.

+

The router has a default route. Delete the default route and then create a NAT gateway.

+

+

400

+

VPC.2011

+

+

The router does not exist.

+

+

The router %(router_id)s does not exist.

+

Check whether the entered router ID is correct.

+

+

400

+

VPC.2009

+

+

The network does not exist.

+

+

Network %(network_id)s does not exist.

+

Enter a valid network ID.

+

+

400

+

VPC.2016

+

The rule has not been deleted.

+

Rule has not been deleted.

+

Contact technical support.

+

+

400

+

VPC.2049

+

The database is abnormal.

+

DB Error

+

+

Contact technical support.

+

+

400

+

VPC.2013

+

+

The subnet is not connected to the virtual router.

+

Router %(router)s has no port for subnet %(subnet)s.

+

Add the subnet to the router port.

+

+

400

+

VPC.2019

+

+

The resource is in use.

+

+

Resource %(res_type)s %(res)s is used by %(user_type)s %(user)s

+

Contact technical support.

+

+

400

+

VPC.2008

+

+

The network does not have any subnet.

+

Network %(network)s does not contain any IPv4 subnet

+

Contact technical support.

+

+

400

+

VPC.2012

+

The VPC already has a NAT gateway.

+

The router %(router_id)s already has nat gateway.

+

Select another VPC.

+

NAT Gateway

+

400

+

VPC.2000

+

NAT gateway request error.

+

Lack of user authority.

+

//request is null.

+

//endpoint is empty.

+

// resource type is invalid. //create natgateway requset is null. //update natgateway request is null

+

Contact technical support.

+

400

+

VPC.2030

+

The system is busy. Please try again later.

+

The system is busy. Please try again later.

+

Try again later.

+

400

+

VPC.2001

+

Incorrect NAT gateway parameter.

+

Request is invalid. //NatGateway id unvalid.

+

// the enterprise project id is unsupported.

+

// the enterprise project id in request is invalid. //parameter is null.

+

// tags is invalid.

+

// get natgateways error limit is invalid.

+

//get natgateways error marker is invalid.

+

//Only admin user can do this action. //Parameters are invalid, check them and try.

+

Enter the correct parameter or contact technical support.

+

400

+

VPC.2004

+

+

The NAT gateway is not activated.

+

NatGateway %(nat_gateway_id)s is not ACTIVE.

+

Check the gateway status. If the gateway is not in the running state for a long time, contact technical support.

+

400

+

VPC.2005

+

+

The NAT gateway is not in the UP state.

+

NatGateway %(nat_gateway_id)s is not UP.

+

The gateway may be frozen due to arrears.

+

+

400

+

VPC.2006

+

+

The NAT gateway is frozen.

+

+

NatGateway %(nat_gateway_id)s is frozen.can not update

+

The gateway may be frozen due to arrears and cannot be updated.

+

+

400

+

VPC.2007

+

+

The NAT gateway does not exist.

+

+

NatGateway %(nat_gateway_id)s does not exist.

+

The NAT gateway does not exist.

+

+

400

+

VPC.2050

+

+

Concurrent operation conflicts.

+

Concurrent conflict requests found

+

Contact technical support.

+

+

400

+

VPC.2051

+

+

Failed to create the internal port of the NAT gateway.

+

Create NG Port failed.

+

+

Internal error. Contact technical support.

+

+

400

+

VPC.2052

+

+

Failed to bind the internal port to the NAT gateway.

+

NG Port %(port)s is unbound.

+

+

Internal error. Contact technical support.

+

+

400

+

VPC.2053

+

+

The NAT gateway does not support IPv6.

+

NatGateway does not support IPv6.

+

+

The NAT gateway cannot be bound to an IPv6 EIP.

+

400

+

VPC.2045

+

An error occurred when selecting the gateway node.

+

Get Nat gateway host failed

+

Contact technical support.

+

400

+

VPC.2046

+

+

Failed to obtain the IP address of the gateway node.

+

Get Nat gateway agent local_ip failed

+

Contact technical support.

+

+

400

+

VPC.2047

+

+

Failed to obtain the VPC route table.

+

Get RouteTable %(router_id)s failed.

+

Contact technical support.

+

+

400

+

VPC.2012

+

The router already has a NAT gateway.

+

The router %(router_id)s already has nat gateway.

+

Select a router that has not been bound to a NAT gateway.

+

+

SNAT Rule

+

+

400

+

VPC.2014

+

Incorrect SNAT rule parameter.

+

Endpoint is null or empty. //Endpoint is Invalid.

+

//Request is null. //natGatewayId is invalid. //SnatRule id unvalid. //NatGatewayId is unvalid.

+

//Invalid value for public ip id.

+

//Endpoint is null.

+

//request is null.

+

//Query SnatRules list error marker is invalid.

+

Enter the correct parameter or contact technical support.

+

400

+

+

VPC.2031

+

+

The CIDR of the SNAT rule conflicts with the network.

+

+

Either network_id or cidr must be specified.Both can not be specified at the same time

+

Do not specify the Cidr and Network_id fields at the same time when configuring an SNAT rule.

+

+

400

+

VPC.2032

+

+

Invalid CIDR block.

+

cidr is invalid, make sure it's format is correct.

+

Enter a valid CIDR block, for example, 192.168.0.0/24.

+

+

400

+

VPC.2033

+

Invalid rule type.

+

+

source_type and network_id is incompatible.

+

+

If an SNAT rule is configured for a VPC, the parameter Source_Type is optional or set its value to 0.

+

If an SNAT rule is configured for a Direct Connect connection, Source_type must be set to 1.

+

400

+

VPC.2034

+

+

The CIDR block must be a subset of the VPC subnet CIDR block.

+

cidr must be a subset of subnet's cidr.

+

+

If an SNAT rule is configured for a VPC, the CIDR block must be the VPC subnet CIDR block. For example, if the subnet is 192.168.0.0/24, the CIDR block can be 192.168.0.0/25.

+

+

400

+

VPC.2035

+

+

The CIDR block conflicts with the subnet CIDR block.

+

cidr conflicts with subnet's cidr.

+

If an SNAT rule is configured for a Direct Connect connection, the CIDR block cannot conflict with the VPC subnet CIDR block.

+

400

+

VPC.2036

+

+

The CIDR block conflicts with the existing one.

+

+

cidr in the request conflicts with cidrs of existing rules.

+

Enter a CIDR block that does not conflict with existing ones.

+

+

400

+

VPC.2018

+

+

The rule already exists.

+

+

Snat rule for network %(network)s exists.

+

+

Select a subnet that is not configured with an SNAT rule.

+

+

400

+

VPC.2042

+

+

The EIP has been used by the SNAT rule.

+

+

There is a duplicate EIP %(fips)s in SNAT rule.

+

Select another EIP.

+

+

400

+

VPC.2044

+

+

The public IP address UUID of the SNAT rule is invalid.

+

Invalid input for floating_ip_id. Reason: \'%(fip)s\' is not a valid UUID.

+

Enter a valid UUID.

+

+

400

+

VPC.2040

+

+

The public IP address ID of an SNAT rule cannot be a null string.

+

Invalid value for public ip id.

+

+

Enter a valid ID.

+

+

400

+

VPC.2039

+

+

The number of EIPs associated with the SNAT rule exceeds the upper limit.

+

%(limit)s EIP has been associated to this SNAT rules's EIP pool, no more is allowed.

+

The number of EIPs associated with the SNAT rule exceeds the upper limit. For details, see the NAT Gateway API Reference.

+

+

DNAT Rule

+

+

400

+

VPC.2020

+

Incorrect DNAT rule parameter.

+

get dnatRules error limit is invalid.

+

//get dnatrules error marker is invalid.

+

//endpoint is empty.

+

//DnatRule id unvalid.

+

//VPC ID is invalid.

+

//Request is null.

+

//DnatRule id invalid.

+

//DnatRule natGatewayId id invalid.

+

Enter the correct parameter or contact technical support.

+

400

+

VPC.2054

+

+

Invalid DNAT rule protocol.

+

+

Dnat rule protocol %(protocol)s not supported.Only protocol values %(values)s and integer representations [6, 17, 0] are supported.

+

Configure a valid protocol. The value range can be 6, 17, or 0, corresponding to protocols TCP, UDP, and ANY, respectively.

+

+

400

+

VPC.2069

+

+

Invalid DNAT rule port.

+

Invalid value for port %(port)s

+

Configure a valid internal port and external port. The value ranges from 0 to 65535.

+

400

+

VPC.2023

+

+

The internal network information of the DNAT rule conflicts with the existing one.

+

+

The port_id, private_ip, internal port and protocol specified have been occupied.

+

Enter the VM port ID, private IP address, or internal port that does not conflict with the existing one.

+

+

400

+

VPC.2024

+

+

The external network information of the DNAT rule conflicts with the existing one.

+

+

The floating ip, external port and protocol specified have been occupied.

+

+

Enter the floating IP address ID, external port, or protocol that does not conflict with the existing one.

+

+

400

+

VPC.2070

+

+

The request information of the DNAT rule is incorrect when Port Type is set to All ports.

+

+

The external port equals 0 and internal port equls 0 and protocol equals any must satisfied at the same time.

+

Set both the internal port and the external port to 0 and the protocol is ANY.

+

+

400

+

VPC.2027

+

+

The port ID of the DNAT rule conflicts with that of an existing DNAT rule.

+

+

The port_id already existing dnat allport rules or dnat_rules, can no longer create dnat rules or dnat allport rules.

+

Change the VM port ID to create or modify the DNAT rule.

+

400

+

VPC.2028

+

+

The private IP address of the DNAT rule conflicts with that of an existing DNAT rule.

+

+

The private_ip already existing dnat allport rules or dnat rules, can no longer create dnat rules or dnat allport rules.

+

The private IP address conflicts with the existing DNAT rule. Change the private IP address or modify the DNAT rule.

+

400

+

VPC.2029

+

The DNAT rule has been frozen and cannot be modified.

+

+

DNAT rule is frozen, can no longer update.

+

+

Check whether the floating IP address bound to the DNAT rule is in arrears or whether the user account is in arrears.

+

400

+

VPC.2038

+

The maximum number of DNAT rules allowed to be associated has been reached.

+

%(limit)s DNAT rules has been associated to this NAT Gateway, no more is allowed

+

The maximum number of DNAT rules allowed to be associated with the NAT gateway has been reached.

+

400

+

VPC.2055

+

+

The DNAT rule contains mutually exclusive parameters.

+

+

The port_id and private_ip exist at the same time and value is not empty, but at least one value is empty.

+

The VM port ID and private IP address cannot be configured at the same time.

+

+

400

+

VPC.2056

+

+

The DNAT rule does not have some required parameters.

+

+

The port_id and private_ip values are both empty, at least one value is not empty.

+

Configure the VM port ID and private IP address.

+

+

400

+

VPC.2071

+

+

Invalid private IP address of the DNAT rule.

+

The private ip address is not legal.

+

Configure a valid private IP address.

+

+

400

+

VPC.2037

+

+

This virtual IP address is not supported.

+

+

The virtual IP address is not supported.

+

Configure a valid private IP address.

+

400

+

VPC.2026

+

+

The maximum number of DNAT rules allowed to be associated has been reached.

+

+

%(limit)s DNAT rules has been associated to this Floating IP, no more is allowed

+

The maximum number of DNAT rules allowed to be associated with a floating IP address has been reached.

+

+

400

+

VPC.2057

+

+

The maximum number of DNAT rules allowed to be created in batches exceeds the upper limit.

+

batch create dnat rules max limit: %(limit)s

+

+

The maximum number of DNAT rules allowed to be created in batches exceeds the upper limit.

+

+

400

+

VPC.2022

+

+

Invalid VM port ID of the DNAT rule.

+

Port %(port)s is not a valid port.

+

+

Configure a valid VM port ID.

+

+

400

+

VPC.2058

+

The value of VtepIp must be specified.

+

Vtep_ip is Null.

+

Contact technical support.

+

400

+

VPC.2075

+

The description contains more than 255 characters.

+

Enter a maximum of 255 characters.

+

Enter a maximum of 255 characters.

+

EIP

+

400

+

VPC.2059

+

+

The EIP is frozen.

+

+

Floating Ip %(fip)s is freezed.

+

Select an EIP that has not been frozen.

+

+

400

+

VPC.2060

+

+

The EIP has been associated with a port.

+

Floating Ip %(fip)s has associated with port %(port)s.

+

+

Select an EIP that has not been bound to any other object. For example, if an EIP has been bound to an ECS, it cannot be bound to a NAT gateway.

+

400

+

VPC.2061

+

+

The EIP has been associated with a NAT gateway.

+

Floating Ip %(fip)s has used by nat gateway %(nat_gateway)s.

+

+

The EIP has been bound to a NAT gateway. Select another one.

+

+

400

+

VPC.2062

+

+

The EIP is in use.

+

+

Floating Ip %(fip)s has been occupied.

+

The EIP has been bound to a NAT gateway. Select another one.

+

400

+

VPC.2074

+

+

An EIP cannot be associated with an SNAT rule and a DNAT rule with Port Type set to All ports at the same time.

+

Floating Ip %(fip)s can not be associated with both SNAT rule and DNAT all port rule.

+

Do not associate an EIP with an SNAT rule and a DNAT rule with Port Type set to All ports at the same time.

+

400

+

VPC.2073

+

An EIP cannot be associated with a DNAT rule and a DNAT rule with Port Type set to All ports at the same time.

+

Floating Ip %(fip)s can not be associated with both DNAT rule and DNAT all port rule.

+

Do not associate an EIP with a DNAT rule and a DNAT rule with Port Type set to All ports at the same time.

+

400

+

VPC.2043

+

+

The EIP has been associated with a rule.

+

Floating Ip %(fip)s is used by other rules

+

Select an EIP that is not in use.

+

+
+
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0042.html b/docs/natgw/api-ref/nat_api_0042.html new file mode 100644 index 00000000..f0b0f8b4 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0042.html @@ -0,0 +1,50 @@ + + +

Resource Status Description

+
+
+ + + + + + + + + + + + + + + + + + + + + + +
Table 1 Resource status description

Status

+

Description

+

ACTIVE

+

The resource status is normal.

+

PENDING_CREATE

+

The resource is being created.

+

PENDING_UPDATE

+

The resource is being updated.

+

PENDING_DELETE

+

The resource is being deleted.

+

EIP_FREEZED

+

The EIP of the resource is frozen.

+

INACTIVE

+

The resource status is abnormal.

+
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0046.html b/docs/natgw/api-ref/nat_api_0046.html new file mode 100644 index 00000000..00520e87 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0046.html @@ -0,0 +1,56 @@ + + +

Change History

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

Released On

+

What's New

+

2019-09-18

+

This release incorporates the following changes:

+ +

2019-01-10

+

This release incorporates the following change:

+

Added parameters cidr and source_type in SNAT Rules.

+

2019-01-04

+

This release incorporates the following change:

+

Added API Version.

+

2018-02-24

+

This release incorporates the following change:

+

Rectified the example request in Deleting an SNAT Rule.

+

2018-02-13

+

This release incorporates the following change:

+ +

2018-01-30

+

This release incorporates the following changes:

+
  • Updated the document structure.
  • Adjusted the sub-chapter sequence of chapters NAT Gateway Service and SNAT Rules.
  • Put response codes in a separate chapter.
+

2018-01-15

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0047.html b/docs/natgw/api-ref/nat_api_0047.html new file mode 100644 index 00000000..63061b9f --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0047.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/natgw/api-ref/nat_api_0061.html b/docs/natgw/api-ref/nat_api_0061.html new file mode 100644 index 00000000..8cce699b --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0061.html @@ -0,0 +1,246 @@ + + +

Creating a NAT Gateway

+

Function

This API is used to create a NAT gateway.

+
+

URI

POST /v2.0/nat_gateways

+
+

Request

Table 1 describes the request parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

nat_gateway

+

Yes

+

Object

+

Specifies the NAT gateway object. For details, see Table 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Description of the nat_gateway field

Parameter

+

Mandatory

+

Type

+

Description

+

tenant_id

+

No

+

String

+

Specifies the project ID.

+

name

+

Yes

+

String(64)

+

Specifies the NAT gateway name.

+

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

+

description

+

No

+

String(255)

+

Provides supplementary information about the NAT gateway.

+

spec

+

Yes

+

String

+

Specifies the NAT gateway type.

+

The value can be:

+
  • 1: small type, which supports up to 10,000 SNAT connections.
  • 2: medium type, which supports up to 50,000 SNAT connections.
  • 3: large type, which supports up to 200,000 SNAT connections.
  • 4: extra-large type, which supports up to 1,000,000 SNAT connections.
+

router_id

+

Yes

+

String

+

Specifies the VPC ID.

+

internal_network_id

+

Yes

+

String

+

Specifies the network ID of the downstream interface (the next hop of the DVR) of the NAT gateway.

+
+
+
+

Response

Table 3 lists response parameters.

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

Parameter

+

Type

+

Description

+

nat_gateway

+

Object

+

Specifies the NAT gateway object. For details, see Table 4.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Description of the nat_gateway field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the NAT gateway ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

name

+

String(64)

+

Specifies the NAT gateway name.

+

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

+

description

+

String(255)

+

Provides supplementary information about the NAT gateway.

+

spec

+

String

+

Specifies the NAT gateway type.

+

The value can be:

+
  • 1: small type, which supports up to 10,000 SNAT connections.
  • 2: medium type, which supports up to 50,000 SNAT connections.
  • 3: large type, which supports up to 200,000 SNAT connections.
  • 4: extra-large type, which supports up to 1,000,000 SNAT connections.
+

router_id

+

String

+

Specifies the router ID.

+

internal_network_id

+

String

+

Specifies the network ID of the downstream interface (the next hop of the DVR) of the NAT gateway.

+

status

+

String

+
  • Specifies the NAT gateway status.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the NAT gateway is up or down.
  • The value can be:
    • true: The NAT gateway is up.
    • false: The NAT gateway is down.
    +
+

created_at

+

String

+

Specifies when the NAT gateway is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+ +
+

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: NAT Gateway Service
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0062.html b/docs/natgw/api-ref/nat_api_0062.html new file mode 100644 index 00000000..f9786290 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0062.html @@ -0,0 +1,167 @@ + + +

Querying Details About a Specified NAT Gateway

+

Function

This API is used to query details about a specified NAT gateway.

+
+

URI

GET /v2.0/nat_gateways/{nat_gateway_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

nat_gateway_id

+

Yes

+

String

+

Specifies the NAT gateway ID.

+
+
+
+

Request

None

+
+

Response

Table 2 lists response parameters.

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

Parameter

+

Type

+

Description

+

nat_gateway

+

Object

+

Specifies the NAT gateway object. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Description of the nat_gateway field

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the NAT gateway ID.

+

tenant_id

+

String

+

Specifies the project ID.

+

name

+

String(64)

+

Specifies the NAT gateway name.

+

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

+

description

+

String(255)

+

Provides supplementary information about the NAT gateway.

+

spec

+

String

+

Specifies the NAT gateway type.

+

The value can be:

+
  • 0: micro type, which supports up to 1,000 SNAT connections.
+
  • 1: small type, which supports up to 10,000 SNAT connections.
  • 2: medium type, which supports up to 50,000 SNAT connections.
  • 3: large type, which supports up to 200,000 SNAT connections.
  • 4: extra-large type, which supports up to 1,000,000 SNAT connections.
+

router_id

+

String

+

Specifies the router ID.

+

internal_network_id

+

String

+

Specifies the network ID of the downstream interface (the next hop of the DVR) of the NAT gateway.

+

status

+

String

+
  • Specifies the NAT gateway status.
  • For details about all its values, see Table 1.
+

admin_state_up

+

Boolean

+
  • Specifies whether the NAT gateway is up or down.
  • The value can be:
    • true: The NAT gateway is up.
    • false: The NAT gateway is down.
    +
+

created_at

+

String

+

Specifies when the NAT gateway is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

+
+
+
+

Examples

+
+ +

Status Code

See Status Codes.

+
+
+
+
+
Parent topic: NAT Gateway Service
+
+
+ diff --git a/docs/natgw/api-ref/public_sys-resources/ExpandCollapse.js b/docs/natgw/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 00000000..3f1b7db0 --- /dev/null +++ b/docs/natgw/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/natgw/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/natgw/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/natgw/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/natgw/api-ref/public_sys-resources/commonltr.css b/docs/natgw/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 00000000..c5480b0a --- /dev/null +++ b/docs/natgw/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/natgw/api-ref/public_sys-resources/commonltr_print.css b/docs/natgw/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 00000000..a5982314 --- /dev/null +++ b/docs/natgw/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/natgw/api-ref/public_sys-resources/commonrtl.css b/docs/natgw/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 00000000..947a9a03 --- /dev/null +++ b/docs/natgw/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding: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/natgw/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/natgw/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/natgw/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/natgw/api-ref/public_sys-resources/delta.gif b/docs/natgw/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/deltaend.gif b/docs/natgw/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/natgw/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..84eec9be Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/natgw/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..39583d16 Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/icon-caution.gif b/docs/natgw/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/icon-danger.gif b/docs/natgw/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/icon-huawei.gif b/docs/natgw/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/icon-note.gif b/docs/natgw/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/icon-notice.gif b/docs/natgw/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/icon-tip.gif b/docs/natgw/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/icon-warning.gif b/docs/natgw/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/natgw/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/natgw/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/natgw/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/natgw/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/natgw/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/natgw/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/natgw/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/natgw/api-ref/public_sys-resources/popup.js b/docs/natgw/api-ref/public_sys-resources/popup.js new file mode 100644 index 00000000..5305962b --- /dev/null +++ b/docs/natgw/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/natgw/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/natgw/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/natgw/api-ref/public_sys-resources/warning_3.0-en-us.png differ