diff --git a/docs/natgw/api-ref/.placeholder b/docs/natgw/api-ref/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/natgw/api-ref/ALL_META.TXT.json b/docs/natgw/api-ref/ALL_META.TXT.json index a55d1ad5..9a863d31 100644 --- a/docs/natgw/api-ref/ALL_META.TXT.json +++ b/docs/natgw/api-ref/ALL_META.TXT.json @@ -1,301 +1,764 @@ [ + { + "dockw":"API Reference" + }, { "uri":"nat_api_0047.html", + "node_id":"nat_api_0047.xml", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"API Usage Guidelines", "githuburl":"" }, { - "uri":"nat_api_0000.html", + "uri":"nat_api_0052.html", + "node_id":"nat_api_0052.xml", "product_code":"nat", "code":"2", + "des":"NAT Gateway APIs allow you to use all NAT Gateway functions.", + "doc_type":"api", + "kw":"API Overview,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"API Overview", + "githuburl":"" + }, + { + "uri":"nat_api_0000.html", + "node_id":"nat_api_0000.xml", + "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":"API v2.0", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"API v2.0", "githuburl":"" }, { "uri":"nat_api_0001.html", + "node_id":"nat_api_0001.xml", "product_code":"nat", - "code":"3", + "code":"4", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"NAT Gateway Service", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"NAT Gateway Service", "githuburl":"" }, { "uri":"nat_api_0061.html", + "node_id":"nat_api_0061.xml", "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", + "code":"5", + "des":"This API is used to create a NAT gateway.POST /v2.0/nat_gatewaysTable 1 describes the request parameter.Table 3 lists response parameters.Example requestPOST https://{End", "doc_type":"api", "kw":"Creating a NAT Gateway,NAT Gateway Service,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Creating a NAT Gateway", "githuburl":"" }, { "uri":"nat_api_0002.html", + "node_id":"nat_api_0002.xml", "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 (&", + "code":"6", + "des":"This API is used to query NAT gateways. Unless otherwise specified, exact match is applied.GET /v2.0/nat_gatewaysYou can type the question mark (?) and ampersand (&) at t", "doc_type":"api", "kw":"Querying NAT Gateways,NAT Gateway Service,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Querying NAT Gateways", "githuburl":"" }, { "uri":"nat_api_0062.html", + "node_id":"nat_api_0062.xml", "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", + "code":"7", + "des":"This API is used to query details of a NAT gateway.GET /v2.0/nat_gateways/{nat_gateway_id}NoneTable 2 lists response parameter.Example requestGET https://{Endpoint}/v2.0/", "doc_type":"api", - "kw":"Querying Details About a Specified NAT Gateway,NAT Gateway Service,API Reference", - "title":"Querying Details About a Specified NAT Gateway", + "kw":"Querying Details of a NAT Gateway,NAT Gateway Service,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Querying Details of a NAT Gateway", "githuburl":"" }, { "uri":"nat_api_0003.html", + "node_id":"nat_api_0003.xml", "product_code":"nat", - "code":"7", + "code":"8", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Updating a NAT Gateway", "githuburl":"" }, { "uri":"nat_api_0004.html", + "node_id":"nat_api_0004.xml", "product_code":"nat", - "code":"8", + "code":"9", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Deleting a NAT Gateway", "githuburl":"" }, { "uri":"nat_api_0005.html", + "node_id":"nat_api_0005.xml", "product_code":"nat", - "code":"9", + "code":"10", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"SNAT Rules", "githuburl":"" }, { "uri":"nat_api_0006.html", + "node_id":"nat_api_0006.xml", "product_code":"nat", - "code":"10", + "code":"11", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Creating an SNAT Rule", "githuburl":"" }, { "uri":"nat_api_0007.html", + "node_id":"nat_api_0007.xml", "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", + "code":"12", + "des":"This API is used to query SNAT rules.GET /v2.0/snat_rulesYou can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. Al", "doc_type":"api", "kw":"Querying SNAT Rules,SNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Querying SNAT Rules", "githuburl":"" }, { "uri":"nat_api_0008.html", + "node_id":"nat_api_0008.xml", "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", + "code":"13", + "des":"This API is used to query details of an SNAT rule.GET /v2.0/snat_rules/{snat_rule_id}NoneTable 2 lists response parameter.Example requestGET https://{Endpoint}/v2.0/snat_", "doc_type":"api", - "kw":"Querying Details About a Specified SNAT Rule,SNAT Rules,API Reference", - "title":"Querying Details About a Specified SNAT Rule", + "kw":"Querying Details of an SNAT Rule,SNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Querying Details of an SNAT Rule", "githuburl":"" }, { "uri":"nat_api_0009.html", + "node_id":"nat_api_0009.xml", "product_code":"nat", - "code":"13", + "code":"14", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Deleting an SNAT Rule", "githuburl":"" }, { "uri":"nat_api_0010.html", + "node_id":"nat_api_0010.xml", "product_code":"nat", - "code":"14", + "code":"15", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"DNAT Rules", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"DNAT Rules", "githuburl":"" }, { "uri":"nat_api_0011.html", + "node_id":"nat_api_0011.xml", "product_code":"nat", - "code":"15", + "code":"16", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Creating a DNAT Rule", "githuburl":"" }, { "uri":"nat_api_0012.html", + "node_id":"nat_api_0012.xml", "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", + "code":"17", + "des":"This API is used to query DNAT rules.GET /v2.0/dnat_rulesYou can type a question mark (?) and an ampersand (&) at the end of the URI to define different search criteria. ", "doc_type":"api", "kw":"Querying DNAT Rules,DNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Querying DNAT Rules", "githuburl":"" }, { "uri":"nat_api_0013.html", + "node_id":"nat_api_0013.xml", "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", + "code":"18", + "des":"This API is used to query details of a DNAT rule.GET /v2.0/dnat_rules/{dnat_rule_id}NoneTable 2 lists response parameter.Example requestGET https://{Endpoint}/v2.0/dnat_r", "doc_type":"api", - "kw":"Querying Details About a Specified DNAT Rule,DNAT Rules,API Reference", - "title":"Querying Details About a Specified DNAT Rule", + "kw":"Querying Details of a DNAT Rule,DNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Querying Details of a DNAT Rule", "githuburl":"" }, { "uri":"nat_api_0014.html", + "node_id":"nat_api_0014.xml", "product_code":"nat", - "code":"18", + "code":"19", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Deleting a DNAT Rule", "githuburl":"" }, { - "uri":"nat_api_0024.html", + "uri":"nat_api_0015.html", + "node_id":"nat_api_0015.xml", "product_code":"nat", - "code":"19", + "code":"20", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Tags", + "githuburl":"" + }, + { + "uri":"nat_api_0016.html", + "node_id":"nat_api_0016.xml", + "product_code":"nat", + "code":"21", + "des":"This API is used to filter NAT gateways by tag.TMS uses this API to filter and list NAT gateways by tag.By default, NAT gateways and tags are sorted in descending order o", + "doc_type":"api", + "kw":"Querying NAT Gateways by Tag,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Querying NAT Gateways by Tag", + "githuburl":"" + }, + { + "uri":"nat_api_0017.html", + "node_id":"nat_api_0017.xml", + "product_code":"nat", + "code":"22", + "des":"This API is used to add or delete tags of a specific NAT gateway in batches.TMS uses this API to manage service resource tags.You can add a maximum of 20 tags to a NAT ga", + "doc_type":"api", + "kw":"Adding or Deleting NAT Gateway Tags in Batches,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Adding or Deleting NAT Gateway Tags in Batches", + "githuburl":"" + }, + { + "uri":"nat_api_0018.html", + "node_id":"nat_api_0018.xml", + "product_code":"nat", + "code":"23", + "des":"This API is used to add tags to a NAT gateway. You can add a maximum of 20 tags to a NAT gateway.This API is idempotent.If a to-be-created tag has the same key as an exis", + "doc_type":"api", + "kw":"Adding a NAT Gateway Tag,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Adding a NAT Gateway Tag", + "githuburl":"" + }, + { + "uri":"nat_api_0019.html", + "node_id":"nat_api_0019.xml", + "product_code":"nat", + "code":"24", + "des":"This API is idempotent.When a tag is deleted, it is not verified. The tag key cannot be left blank or be an empty string. If the key of the tag to be deleted does not exi", + "doc_type":"api", + "kw":"Deleting a NAT Gateway Tag,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Deleting a NAT Gateway Tag", + "githuburl":"" + }, + { + "uri":"nat_api_0020.html", + "node_id":"nat_api_0020.xml", + "product_code":"nat", + "code":"25", + "des":"This API is used to query tags of a specified NAT gateway.TMS uses this API to query all tags of a specified NAT gateway.GET /v2.0/{project_id}/nat_gateways/{nat_gateway_", + "doc_type":"api", + "kw":"Querying NAT Gateway Tags,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Querying NAT Gateway Tags", + "githuburl":"" + }, + { + "uri":"nat_api_0021.html", + "node_id":"nat_api_0021.xml", + "product_code":"nat", + "code":"26", + "des":"This API is used to query all tags of a resource type in a specified region.TMS uses this API to list tags created by a tenant to facilitate tag creation and resource fil", + "doc_type":"api", + "kw":"Querying Tags in a Project,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Querying Tags in a Project", + "githuburl":"" + }, + { + "uri":"nat_api_0024.html", + "node_id":"nat_api_0024.xml", + "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":"API Version", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"API Version", "githuburl":"" }, { "uri":"nat_api_0025.html", + "node_id":"nat_api_0025.xml", "product_code":"nat", - "code":"20", + "code":"28", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Querying All API Versions", "githuburl":"" }, { "uri":"nat_api_0026.html", + "node_id":"nat_api_0026.xml", "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.", + "code":"29", + "des":"This API is used to query an 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", + "kw":"Querying an API Version,API Version,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Querying an API Version", "githuburl":"" }, { "uri":"nat_api_0027.html", + "node_id":"nat_api_0027.xml", "product_code":"nat", - "code":"22", + "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":"Permissions Policies and Supported Actions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Permissions Policies and Supported Actions", "githuburl":"" }, { - "uri":"nat_api_0032.html", + "uri":"nat_api_0063.html", + "node_id":"nat_api_0063.xml", "product_code":"nat", - "code":"23", + "code":"31", + "des":"This section describes fine-grained permissions management for your NAT gateways. If your account does not need individual IAM users, then you may skip this section.By de", + "doc_type":"api", + "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"nat_api_0032.html", + "node_id":"nat_api_0032.xml", + "product_code":"nat", + "code":"32", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"NAT Gateway v2.0", "githuburl":"" }, { "uri":"nat_api_0033.html", + "node_id":"nat_api_0033.xml", "product_code":"nat", - "code":"24", + "code":"33", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"SNAT Rule v2.0", "githuburl":"" }, { "uri":"nat_api_0034.html", + "node_id":"nat_api_0034.xml", "product_code":"nat", - "code":"25", + "code":"34", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"DNAT Rule v2.0", "githuburl":"" }, { - "uri":"nat_api_0036.html", + "uri":"nat_api_0035.html", + "node_id":"nat_api_0035.xml", "product_code":"nat", - "code":"26", + "code":"35", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"NAT Gateway Tag v2.0,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], + "title":"NAT Gateway Tag v2.0", + "githuburl":"" + }, + { + "uri":"nat_api_0036.html", + "node_id":"nat_api_0036.xml", + "product_code":"nat", + "code":"36", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Common Parameters", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Common Parameters", "githuburl":"" }, { "uri":"nat_api_0038.html", + "node_id":"nat_api_0038.xml", "product_code":"nat", - "code":"27", + "code":"37", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Status Codes,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Status Codes", "githuburl":"" }, { "uri":"nat_api_0040.html", + "node_id":"nat_api_0040.xml", "product_code":"nat", - "code":"28", + "code":"38", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Error Code Description v2.0", "githuburl":"" }, { "uri":"nat_api_0042.html", + "node_id":"nat_api_0042.xml", "product_code":"nat", - "code":"29", + "code":"39", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Resource Status Description,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Resource Status Description", "githuburl":"" }, { "uri":"nat_api_0046.html", + "node_id":"nat_api_0046.xml", "product_code":"nat", - "code":"30", + "code":"40", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"false" + } + ], "title":"Change History", "githuburl":"" } diff --git a/docs/natgw/api-ref/CLASS.TXT.json b/docs/natgw/api-ref/CLASS.TXT.json index ad8d46b1..1b17efb5 100644 --- a/docs/natgw/api-ref/CLASS.TXT.json +++ b/docs/natgw/api-ref/CLASS.TXT.json @@ -9,10 +9,10 @@ "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.", + "desc":"NAT Gateway APIs allow you to use all NAT Gateway functions.", "product_code":"nat", - "title":"API v2.0", - "uri":"nat_api_0000.html", + "title":"API Overview", + "uri":"nat_api_0052.html", "doc_type":"api", "p_code":"", "code":"2" @@ -20,38 +20,47 @@ { "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", + "title":"API v2.0", + "uri":"nat_api_0000.html", "doc_type":"api", - "p_code":"2", + "p_code":"", "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", + "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":"Creating a NAT Gateway", - "uri":"nat_api_0061.html", + "title":"NAT Gateway Service", + "uri":"nat_api_0001.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 (&", + "desc":"This API is used to create a NAT gateway.POST /v2.0/nat_gatewaysTable 1 describes the request parameter.Table 3 lists response parameters.Example requestPOST https://{End", + "product_code":"nat", + "title":"Creating a NAT Gateway", + "uri":"nat_api_0061.html", + "doc_type":"api", + "p_code":"4", + "code":"5" + }, + { + "desc":"This API is used to query NAT gateways. Unless otherwise specified, exact match is applied.GET /v2.0/nat_gatewaysYou can type the question mark (?) and ampersand (&) at t", "product_code":"nat", "title":"Querying NAT Gateways", "uri":"nat_api_0002.html", "doc_type":"api", - "p_code":"3", - "code":"5" + "p_code":"4", + "code":"6" }, { - "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", + "desc":"This API is used to query details of a NAT gateway.GET /v2.0/nat_gateways/{nat_gateway_id}NoneTable 2 lists response parameter.Example requestGET https://{Endpoint}/v2.0/", "product_code":"nat", - "title":"Querying Details About a Specified NAT Gateway", + "title":"Querying Details of a NAT Gateway", "uri":"nat_api_0062.html", "doc_type":"api", - "p_code":"3", - "code":"6" + "p_code":"4", + "code":"7" }, { "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", @@ -59,8 +68,8 @@ "title":"Updating a NAT Gateway", "uri":"nat_api_0003.html", "doc_type":"api", - "p_code":"3", - "code":"7" + "p_code":"4", + "code":"8" }, { "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", @@ -68,8 +77,8 @@ "title":"Deleting a NAT Gateway", "uri":"nat_api_0004.html", "doc_type":"api", - "p_code":"3", - "code":"8" + "p_code":"4", + "code":"9" }, { "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.", @@ -77,8 +86,8 @@ "title":"SNAT Rules", "uri":"nat_api_0005.html", "doc_type":"api", - "p_code":"2", - "code":"9" + "p_code":"3", + "code":"10" }, { "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", @@ -86,26 +95,26 @@ "title":"Creating an SNAT Rule", "uri":"nat_api_0006.html", "doc_type":"api", - "p_code":"9", - "code":"10" + "p_code":"10", + "code":"11" }, { - "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", + "desc":"This API is used to query SNAT rules.GET /v2.0/snat_rulesYou can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. Al", "product_code":"nat", "title":"Querying SNAT Rules", "uri":"nat_api_0007.html", "doc_type":"api", - "p_code":"9", - "code":"11" + "p_code":"10", + "code":"12" }, { - "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", + "desc":"This API is used to query details of an SNAT rule.GET /v2.0/snat_rules/{snat_rule_id}NoneTable 2 lists response parameter.Example requestGET https://{Endpoint}/v2.0/snat_", "product_code":"nat", - "title":"Querying Details About a Specified SNAT Rule", + "title":"Querying Details of an SNAT Rule", "uri":"nat_api_0008.html", "doc_type":"api", - "p_code":"9", - "code":"12" + "p_code":"10", + "code":"13" }, { "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", @@ -113,8 +122,8 @@ "title":"Deleting an SNAT Rule", "uri":"nat_api_0009.html", "doc_type":"api", - "p_code":"9", - "code":"13" + "p_code":"10", + "code":"14" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -122,8 +131,8 @@ "title":"DNAT Rules", "uri":"nat_api_0010.html", "doc_type":"api", - "p_code":"2", - "code":"14" + "p_code":"3", + "code":"15" }, { "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", @@ -131,26 +140,26 @@ "title":"Creating a DNAT Rule", "uri":"nat_api_0011.html", "doc_type":"api", - "p_code":"14", - "code":"15" + "p_code":"15", + "code":"16" }, { - "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", + "desc":"This API is used to query DNAT rules.GET /v2.0/dnat_rulesYou can type a question mark (?) and an ampersand (&) at the end of the URI to define different search criteria. ", "product_code":"nat", "title":"Querying DNAT Rules", "uri":"nat_api_0012.html", "doc_type":"api", - "p_code":"14", - "code":"16" + "p_code":"15", + "code":"17" }, { - "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", + "desc":"This API is used to query details of a DNAT rule.GET /v2.0/dnat_rules/{dnat_rule_id}NoneTable 2 lists response parameter.Example requestGET https://{Endpoint}/v2.0/dnat_r", "product_code":"nat", - "title":"Querying Details About a Specified DNAT Rule", + "title":"Querying Details of a DNAT Rule", "uri":"nat_api_0013.html", "doc_type":"api", - "p_code":"14", - "code":"17" + "p_code":"15", + "code":"18" }, { "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", @@ -158,8 +167,71 @@ "title":"Deleting a DNAT Rule", "uri":"nat_api_0014.html", "doc_type":"api", - "p_code":"14", - "code":"18" + "p_code":"15", + "code":"19" + }, + { + "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":"Tags", + "uri":"nat_api_0015.html", + "doc_type":"api", + "p_code":"3", + "code":"20" + }, + { + "desc":"This API is used to filter NAT gateways by tag.TMS uses this API to filter and list NAT gateways by tag.By default, NAT gateways and tags are sorted in descending order o", + "product_code":"nat", + "title":"Querying NAT Gateways by Tag", + "uri":"nat_api_0016.html", + "doc_type":"api", + "p_code":"20", + "code":"21" + }, + { + "desc":"This API is used to add or delete tags of a specific NAT gateway in batches.TMS uses this API to manage service resource tags.You can add a maximum of 20 tags to a NAT ga", + "product_code":"nat", + "title":"Adding or Deleting NAT Gateway Tags in Batches", + "uri":"nat_api_0017.html", + "doc_type":"api", + "p_code":"20", + "code":"22" + }, + { + "desc":"This API is used to add tags to a NAT gateway. You can add a maximum of 20 tags to a NAT gateway.This API is idempotent.If a to-be-created tag has the same key as an exis", + "product_code":"nat", + "title":"Adding a NAT Gateway Tag", + "uri":"nat_api_0018.html", + "doc_type":"api", + "p_code":"20", + "code":"23" + }, + { + "desc":"This API is idempotent.When a tag is deleted, it is not verified. The tag key cannot be left blank or be an empty string. If the key of the tag to be deleted does not exi", + "product_code":"nat", + "title":"Deleting a NAT Gateway Tag", + "uri":"nat_api_0019.html", + "doc_type":"api", + "p_code":"20", + "code":"24" + }, + { + "desc":"This API is used to query tags of a specified NAT gateway.TMS uses this API to query all tags of a specified NAT gateway.GET /v2.0/{project_id}/nat_gateways/{nat_gateway_", + "product_code":"nat", + "title":"Querying NAT Gateway Tags", + "uri":"nat_api_0020.html", + "doc_type":"api", + "p_code":"20", + "code":"25" + }, + { + "desc":"This API is used to query all tags of a resource type in a specified region.TMS uses this API to list tags created by a tenant to facilitate tag creation and resource fil", + "product_code":"nat", + "title":"Querying Tags in a Project", + "uri":"nat_api_0021.html", + "doc_type":"api", + "p_code":"20", + "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.", @@ -167,8 +239,8 @@ "title":"API Version", "uri":"nat_api_0024.html", "doc_type":"api", - "p_code":"2", - "code":"19" + "p_code":"3", + "code":"27" }, { "desc":"This API is used to query all API versions of NAT Gateway.GET/NoneTable 1 lists response parameters.Example responseSee Status Codes.", @@ -176,17 +248,17 @@ "title":"Querying All API Versions", "uri":"nat_api_0025.html", "doc_type":"api", - "p_code":"19", - "code":"20" + "p_code":"27", + "code":"28" }, { - "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.", + "desc":"This API is used to query an 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", + "title":"Querying an API Version", "uri":"nat_api_0026.html", "doc_type":"api", - "p_code":"19", - "code":"21" + "p_code":"27", + "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.", @@ -195,7 +267,16 @@ "uri":"nat_api_0027.html", "doc_type":"api", "p_code":"", - "code":"22" + "code":"30" + }, + { + "desc":"This section describes fine-grained permissions management for your NAT gateways. If your account does not need individual IAM users, then you may skip this section.By de", + "product_code":"nat", + "title":"Introduction", + "uri":"nat_api_0063.html", + "doc_type":"api", + "p_code":"30", + "code":"31" }, { "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.", @@ -203,8 +284,8 @@ "title":"NAT Gateway v2.0", "uri":"nat_api_0032.html", "doc_type":"api", - "p_code":"22", - "code":"23" + "p_code":"30", + "code":"32" }, { "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.", @@ -212,8 +293,8 @@ "title":"SNAT Rule v2.0", "uri":"nat_api_0033.html", "doc_type":"api", - "p_code":"22", - "code":"24" + "p_code":"30", + "code":"33" }, { "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.", @@ -221,8 +302,17 @@ "title":"DNAT Rule v2.0", "uri":"nat_api_0034.html", "doc_type":"api", - "p_code":"22", - "code":"25" + "p_code":"30", + "code":"34" + }, + { + "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 Tag v2.0", + "uri":"nat_api_0035.html", + "doc_type":"api", + "p_code":"30", + "code":"35" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -231,7 +321,7 @@ "uri":"nat_api_0036.html", "doc_type":"api", "p_code":"", - "code":"26" + "code":"36" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -239,8 +329,8 @@ "title":"Status Codes", "uri":"nat_api_0038.html", "doc_type":"api", - "p_code":"26", - "code":"27" + "p_code":"36", + "code":"37" }, { "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", @@ -248,8 +338,8 @@ "title":"Error Code Description v2.0", "uri":"nat_api_0040.html", "doc_type":"api", - "p_code":"26", - "code":"28" + "p_code":"36", + "code":"38" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -257,8 +347,8 @@ "title":"Resource Status Description", "uri":"nat_api_0042.html", "doc_type":"api", - "p_code":"26", - "code":"29" + "p_code":"36", + "code":"39" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -267,6 +357,6 @@ "uri":"nat_api_0046.html", "doc_type":"api", "p_code":"", - "code":"30" + "code":"40" } ] \ 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 index f2ee3d74..e6875da1 100644 --- a/docs/natgw/api-ref/nat_api_0000.html +++ b/docs/natgw/api-ref/nat_api_0000.html @@ -10,6 +10,8 @@ + diff --git a/docs/natgw/api-ref/nat_api_0001.html b/docs/natgw/api-ref/nat_api_0001.html index 4e2e87a6..094477a9 100644 --- a/docs/natgw/api-ref/nat_api_0001.html +++ b/docs/natgw/api-ref/nat_api_0001.html @@ -8,7 +8,7 @@ - diff --git a/docs/natgw/api-ref/nat_api_0002.html b/docs/natgw/api-ref/nat_api_0002.html index fcf17750..917c4ef7 100644 --- a/docs/natgw/api-ref/nat_api_0002.html +++ b/docs/natgw/api-ref/nat_api_0002.html @@ -1,7 +1,7 @@

Querying NAT Gateways

-

Function

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

+

Function

This API is used to query NAT gateways. 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.

@@ -70,8 +70,9 @@

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

The type 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

@@ -107,7 +108,7 @@

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.
    +
    • Specifies whether the NAT gateway is up or down.
    • The state can be:
      • true: The NAT gateway is up.
      • false: The NAT gateway is down.
    @@ -147,7 +148,7 @@
-
Table 3 Description of the nat_gateway field

Parameter

+
@@ -189,9 +190,9 @@ - @@ -230,6 +231,41 @@ + + + + + + + + + + + + + + + + + + + +
Table 3 Description of the nat_gateway field

Parameter

Type

String

Specifies the NAT gateway type.

-

The value can be:

+

The type 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.
+
  • 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

@@ -219,7 +220,7 @@

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.
    +
  • Specifies whether the NAT gateway is up or down.
  • The state can be:
    • true: The NAT gateway is up.
    • false: The NAT gateway is down.

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.

billinginfo

+

String

+

Specifies the order information. This parameter is left blank by default.

+

freeze_info

+

String

+

Specifies information about the frozen NAT gateway.

+

sys_tags

+

List<String>

+

Specifies the ID of the enterprise project associated with the NAT gateway when the NAT gateway is created.

+

snat_rule_public_ip_limit

+

Integer

+

Specifies the maximum number of EIPs in an SNAT rule on a NAT gateway. The default value is 20.

+

dnat_rules_limit

+

Long

+

Specifies the maximum number of DNAT rules on a NAT gateway. The default value is 200.

+
@@ -249,6 +285,13 @@ "spec": "2", "internal_network_id": "5930796a-6026-4d8b-8790-6c6bfc9f87e8", "id": "a253be25-ae7c-4013-978b-3c0785eccd63", + "billinginfo": "", + "dnat_rules_limit": 200, + "snat_rule_public_ip_limit": 20, + "freeze_info": null, + "sys_tags": [ + "_sys_enterprise_project_id=0" + ], "name": "wj3" }, { @@ -261,12 +304,19 @@ "spec": "2", "internal_network_id": "fc09463b-4ef8-4c7a-93c8-92d9ca6daf9d", "id": "e824f1b4-4290-4ebc-8322-cfff370dbd1e", + "billinginfo": "", + "dnat_rules_limit": 200, + "snat_rule_public_ip_limit": 20, + "freeze_info": null, + "sys_tags": [ + "_sys_enterprise_project_id=0" + ], "name": "lyl001" } ] } -

Status Code

See Status Codes.

+

Status Codes

See Status Codes.

diff --git a/docs/natgw/api-ref/nat_api_0003.html b/docs/natgw/api-ref/nat_api_0003.html index e64ade92..553004fe 100644 --- a/docs/natgw/api-ref/nat_api_0003.html +++ b/docs/natgw/api-ref/nat_api_0003.html @@ -30,7 +30,7 @@
-

Request

Table 2 describes the request parameters.

+

Request

Table 2 describes the request parameter.

@@ -56,7 +56,7 @@
Table 2 Request parameters

Parameter

-
Table 3 Description of the nat_gateway field

Parameter

+
@@ -92,9 +92,9 @@ @@ -103,7 +103,7 @@

Response

Table 4 lists response parameters.

-
Table 3 Description of the nat_gateway field

Parameter

Mandatory

String

Specifies the NAT gateway type.

-

The value can be:

+

The type 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.
+
  • 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.
Table 4 Response parameters

Parameter

+
@@ -122,7 +122,7 @@
Table 4 Response parameter

Parameter

Type

-
Table 5 Description of the nat_gateway field

Parameter

+
@@ -164,9 +164,9 @@ - - @@ -205,6 +205,41 @@ + + + + + + + + + + + + + + + + + + + +
Table 5 Description of the nat_gateway field

Parameter

Type

String

Specifies the NAT gateway type.

-

The value can be:

+

The type 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.
+
  • 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

@@ -187,14 +187,14 @@

String

  • Specifies the status of the NAT gateway.
  • For details about all its values, see Table 1.
+
  • 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.
    +
  • Specifies whether the NAT gateway is up or down.
  • The state can be:
    • true: The NAT gateway is up.
    • false: The NAT gateway is down.

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.

billinginfo

+

String

+

Specifies the order information. This parameter is left blank by default.

+

freeze_info

+

String

+

Specifies information about the frozen NAT gateway.

+

sys_tags

+

List<String>

+

Specifies the ID of the enterprise project associated with the NAT gateway when the NAT gateway is created.

+

snat_rule_public_ip_limit

+

Integer

+

Specifies the maximum number of EIPs in an SNAT rule on a NAT gateway. The default value is 20.

+

dnat_rules_limit

+

Long

+

Specifies the maximum number of DNAT rules on a NAT gateway. The default value is 200.

+
@@ -229,12 +264,19 @@ "created_at": "2017-11-18 07:34:32.203044", "spec": "1", "internal_network_id": "89d66639-aacb-4929-969d-07080b0f9fd9", - "id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", + "id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", + "billinginfo": "", + "dnat_rules_limit": 200, + "snat_rule_public_ip_limit": 20, + "freeze_info": null, + "sys_tags": [ + "_sys_enterprise_project_id=0" + ], "name": "new_name" } } -

Status Code

See Status Codes.

+

Status Codes

See Status Codes.

diff --git a/docs/natgw/api-ref/nat_api_0005.html b/docs/natgw/api-ref/nat_api_0005.html index 5232dd67..a985f04d 100644 --- a/docs/natgw/api-ref/nat_api_0005.html +++ b/docs/natgw/api-ref/nat_api_0005.html @@ -8,7 +8,7 @@ - diff --git a/docs/natgw/api-ref/nat_api_0006.html b/docs/natgw/api-ref/nat_api_0006.html index e64b7fd0..4e84c3aa 100644 --- a/docs/natgw/api-ref/nat_api_0006.html +++ b/docs/natgw/api-ref/nat_api_0006.html @@ -7,7 +7,7 @@

URI

POST /v2.0/snat_rules

-

Request

Table 1 describes the request parameters.

+

Request

Table 1 describes the request parameter.

@@ -32,7 +32,7 @@
Table 1 Request parameter

Parameter

-
Table 2 Description of the snat_rule field

Parameter

+
@@ -57,7 +57,7 @@ - - + + + + + @@ -118,7 +127,7 @@
Table 2 Description of the snat_rule field

Parameter

Mandatory

String

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

+

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

cidr

@@ -67,8 +67,8 @@

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.

+

If source_type is set to 0, cidr must be a subset of the VPC subnet.

+

If source_type is set to 1, cidr must be a CIDR block of your on-premises network connected to the VPC through Direct Connect or Cloud Connect.

source_type

@@ -88,9 +88,18 @@

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.

+

Specifies the EIP ID. Use commas (,) to separate multiple IDs.

+

The maximum length of the ID is 4,096 bytes.

+

Constraints: The number of EIP IDs cannot exceed 20.

+

description

+

No

+

String

+

Provides supplementary information about the SNAT rule.

-
Table 4 Description of the snat_rule field

Parameter

+
@@ -165,23 +174,37 @@ - - - + + + + + + + + - @@ -214,25 +237,28 @@ { "snat_rule": { "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", + "description": "description", "network_id": "eaad9cd6-2372-4be1-9535-9bd37210ae7b", "source_type":0, "floating_ip_id": "bdc10a4c-d81a-41ec-adf7-de857f7c812a" } } -
  1. Configure parameter cider in a VPC.
    POST https://{Endpoint}/v2.0/snat_rules
    +
  1. Configure parameter cidr in a VPC.
    POST https://{Endpoint}/v2.0/snat_rules
     {      
        "snat_rule": {
              "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
              "cidr": "192.168.1.10/32",
    +         "description": "description",
              "source_type":0,
              "floating_ip_id": "bdc10a4c-d81a-41ec-adf7-de857f7c812a"
           }
       }
    -
  1. Configure parameter cider over a Direct Connect connection.
    POST https://{Endpoint}/v2.0/snat_rules 
    +
  1. Configure parameter cidr over a Direct Connect connection.
    POST https://{Endpoint}/v2.0/snat_rules 
      {
           "snat_rule": { 
              "nat_gateway_id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
              "cidr": "172.30.0.0/24",
    +         "description": "description",
              "source_type":1,
              "floating_ip_id": "bdc10a4c-d81a-41ec-adf7-de857f7c812a"
           }
    @@ -251,7 +277,9 @@
              "tenant_id": "27e25061336f4af590faeabeb7fcd9a3", 
              "created_at": "2017-11-18 07:54:21.665430", 
              "id": "5b95c675-69c2-4656-ba06-58ff72e1d338", 
    -         "floating_ip_address": "5.21.11.226"
    +         "floating_ip_address": "5.21.11.226",
    +         "freezed_ip_address": "",
    +         "description": "description"
          } 
      }
  2. Response to the request for specifying the CIDR block in a VPC
    { 
    @@ -265,7 +293,9 @@
              "tenant_id": "27e25061336f4af590faeabeb7fcd9a3", 
              "created_at": "2017-11-18 07:54:21.665430", 
              "id": "5b95c675-69c2-4656-ba06-58ff72e1d338", 
    -         "floating_ip_address": "5.21.11.226"
    +         "floating_ip_address": "5.21.11.226",
    +         "freezed_ip_address": "",
    +         "description": "description"
          } 
      }
  3. Response to the request for specifying the CIDR block in a VPC
    { 
    @@ -279,13 +309,15 @@
              "tenant_id": "27e25061336f4af590faeabeb7fcd9a3", 
              "created_at": "2017-11-18 07:54:21.665430", 
              "id": "5b95c675-69c2-4656-ba06-58ff72e1d338", 
    -         "floating_ip_address": "5.21.11.226"
    +         "floating_ip_address": "5.21.11.226",
    +         "freezed_ip_address": "",
    +         "description": "description"
          } 
      }
-

Status Code

See Status Codes.

+

Status Codes

See Status Codes.

diff --git a/docs/natgw/api-ref/nat_api_0007.html b/docs/natgw/api-ref/nat_api_0007.html index ae44c390..a506c8c3 100644 --- a/docs/natgw/api-ref/nat_api_0007.html +++ b/docs/natgw/api-ref/nat_api_0007.html @@ -1,7 +1,7 @@

Querying SNAT Rules

-

Function

This API is used to query an SNAT rule list.

+

Function

This API is used to query SNAT rules.

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.

@@ -88,7 +88,7 @@
- - + + + + + - @@ -137,7 +146,7 @@

Response

Table 2 lists response parameters.

-
Table 4 Description of the snat_rule field

Parameter

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.

+

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.
+
  • Specifies the EIP ID. Use commas (,) to separate multiple IDs.
  • The maximum length of the ID is 4,096 bytes.

floating_ip_address

String(1024)

  • Specifies the EIP. Multiple EIPs are separated using commas (,).
  • The maximum length is 1024 bytes.
+
  • Specifies the EIP. Use commas (,) to separate multiple EIPs.
  • The maximum length is 1,024 bytes.
+

freezed_ip_address

+

String(1024)

+
  • Specifies the frozen EIP. Use commas (,) to separate frozen EIPs.
  • The maximum length is 1,024 bytes.
+

description

+

String

+

Provides supplementary information about the SNAT rule.

status

@@ -195,7 +218,7 @@

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.
    +
  • Specifies the unfrozen or frozen state.
  • Specifies whether the SNAT rule is enabled or disabled.
  • The state can be:
    • true: The SNAT rule is enabled.
    • false: The SNAT rule is disabled.

String(4096)

Specifies the EIP ID.

+

Specifies the EIP ID.

floating_ip_address

@@ -97,7 +97,16 @@

String(1024)

Specifies the EIP.

+

Specifies the EIP.

+

description

+

No

+

String

+

Provides supplementary information about the SNAT rule.

status

@@ -115,7 +124,7 @@

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.
    +
  • Specifies whether the SNAT rule is enabled or disabled.
  • The state can be:
    • true: The SNAT rule is enabled.
    • false: The SNAT rule is disabled.
Table 2 Response parameters

Parameter

+
@@ -156,7 +165,7 @@
Table 2 Response parameter

Parameter

Type

-
Table 3 Description of the snat_rule field

Parameter

+
@@ -203,23 +212,37 @@ - - - + + + + + + + + - @@ -264,7 +287,9 @@ "tenant_id": "abc", "created_at": "2017-11-15 15:44:42.595173", "id": "79195d50-0271-41f1-bded-4c089b2502ff", - "floating_ip_address": "5.21.11.242" + "floating_ip_address": "5.21.11.242", + "freezed_ip_address": "", + "description": "description" }, { "floating_ip_id": "6e496fba-abe9-4f5e-9406-2ad8c809ac8c", @@ -277,12 +302,14 @@ "tenant_id": "abc", "created_at": "2017-11-17 07:43:44.830845", "id": "4a1a10d7-0d9f-4846-8cda-24cffeffef5c", - "floating_ip_address": "5.21.11.142" + "floating_ip_address": "5.21.11.142", + "freezed_ip_address": "", + "description": "description" } ] } -

Status Code

See Status Codes.

+

Status Codes

See Status Codes.

diff --git a/docs/natgw/api-ref/nat_api_0008.html b/docs/natgw/api-ref/nat_api_0008.html index bdbb38a0..e5faf53a 100644 --- a/docs/natgw/api-ref/nat_api_0008.html +++ b/docs/natgw/api-ref/nat_api_0008.html @@ -1,7 +1,7 @@ -

Querying Details About a Specified SNAT Rule

-

Function

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

+

Querying Details of an SNAT Rule

+

Function

This API is used to query details of an SNAT rule.

URI

GET /v2.0/snat_rules/{snat_rule_id}

@@ -30,9 +30,9 @@

Request

None

-

Response

Table 2 lists response parameters.

+

Response

Table 2 lists response parameter.

-
Table 3 Description of the snat_rule field

Parameter

Type

Integer

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

+

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.

+

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.
+
  • Specifies the EIP ID. Use commas (,) to separate multiple IDs.
  • The maximum length of the ID is 4,096 bytes.
  • Constraints: 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.
+
  • Specifies the EIP. Use commas (,) to separate multiple EIPs.
  • The maximum length is 1,024 bytes.
+

freezed_ip_address

+

String(1024)

+
  • Specifies the frozen EIP. Use commas (,) to separate frozen EIPs.
  • The maximum length is 1,024 bytes.
+

description

+

String(255)

+

Provides supplementary information about the SNAT rule.

status

@@ -233,7 +256,7 @@

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.
    +
  • Specifies whether the SNAT rule is enabled or disabled.
  • The state can be:
    • true: The SNAT rule is enabled.
    • false: The SNAT rule is disabled.
Table 2 Response parameters

Parameter

+
@@ -51,7 +51,7 @@
Table 2 Response parameter

Parameter

Type

-
Table 3 Description of the snat_rule field

Parameter

+
@@ -91,7 +91,7 @@ - - - + + + + + + + + - @@ -158,11 +172,13 @@ "tenant_id": "27e25061336f4af590faeabeb7fcd9a3", "created_at": "2017-11-18 07:54:21.665430", "id": "5b95c675-69c2-4656-ba06-58ff72e1d338", - "floating_ip_address": "5.21.11.226" + "floating_ip_address": "5.21.11.226", + "freezed_ip_address": "", + "description": "description" } } -

Status Code

See Status Codes.

+

Status Codes

See Status Codes.

diff --git a/docs/natgw/api-ref/nat_api_0010.html b/docs/natgw/api-ref/nat_api_0010.html index 76ef6f17..3aba2960 100644 --- a/docs/natgw/api-ref/nat_api_0010.html +++ b/docs/natgw/api-ref/nat_api_0010.html @@ -8,7 +8,7 @@ - diff --git a/docs/natgw/api-ref/nat_api_0011.html b/docs/natgw/api-ref/nat_api_0011.html index ff8c49fe..241a81d0 100644 --- a/docs/natgw/api-ref/nat_api_0011.html +++ b/docs/natgw/api-ref/nat_api_0011.html @@ -2,12 +2,12 @@

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.

+

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. Specify either port_id or private_ip at a time. If you are going to create a DNAT rule that allows traffic to and from all ports of a server and an EIP, 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.

+

Request

Table 1 lists the request parameter.

Table 3 Description of the snat_rule field

Parameter

Type

String

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

+

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

source_type

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

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.
+
  • Specifies the EIP ID. Use commas (,) to separate IDs.
  • The maximum length of the ID is 4,096 bytes.
  • Constraints: 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.
+
  • Specifies the EIP. Use commas (,) to separate EIPs.
  • The maximum length is 1,024 bytes.
+

freezed_ip_address

+

String(1024)

+
  • Specifies the frozen EIP. Use commas (,) to separate frozen EIPs.
  • The maximum length is 1,024 bytes.
+

description

+

String(255)

+

Provides supplementary information about the SNAT rule.

status

@@ -136,7 +150,7 @@

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.

+

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

@@ -32,7 +32,7 @@
Table 1 Request parameter

Parameter

-
Table 2 Description of the dnat_rule field

Parameter

+
@@ -57,7 +57,7 @@ - @@ -68,7 +68,7 @@ - @@ -78,8 +78,8 @@ - - - - + + + + +
Table 2 Description of the dnat_rule field

Parameter

Mandatory

String

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

+

Specifies the port ID of the cloud server (ECS or BMS). Either this parameter or private_ip must be specified.

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

String

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

+

Specifies the private IP address, for example, the IP address of an on-premises network connected by 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.

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.

+

Specifies the port number used by the cloud server (ECS or BMS) to provide services for external systems. In VPC DNAT scenarios, this parameter indicates the protocol port number of the NIC of the cloud server (ECS or BMS) in the DNAT rule. In Direct Connect DNAT scenarios, this parameter indicates the protocol port number of your private IP address in the DNAT rule.

+

The value ranges from 0 to 65535.

floating_ip_id

@@ -88,7 +88,7 @@

String

Specifies the EIP ID.

+

Specifies the EIP ID.

external_service_port

@@ -97,8 +97,8 @@

Integer

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

-

The value ranges from 0 to 65535.

+

Specifies the port for providing services for external systems.

+

The value ranges from 0 to 65535.

protocol

@@ -107,17 +107,26 @@

String

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

+

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

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

description

+

No

+

String

+

Provides supplementary information about the DNAT rule.

+

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.

+

Response

Table 3 lists response parameter.

@@ -138,7 +147,7 @@
Table 3 Response parameter

Parameter

-
Table 4 Description of the dnat_rule field

Parameter

+
@@ -171,14 +180,14 @@ - - @@ -186,38 +195,45 @@ - - - - - + + + + - @@ -237,30 +253,32 @@ -
Table 4 Description of the dnat_rule field

Parameter

Type

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.

+

Specifies the port ID of the cloud server (ECS or BMS). This parameter is used in the VPC scenario, where this parameter or private_ip must be specified.

private_ip

String

Specifies the IP address of a Direct Connect connection.

+

Specifies the IP address of an on-premises network connected by a Direct Connect connection.

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

Integer

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

+

Specifies the port number used by the cloud server (ECS or BMS) to provide services for external systems.

floating_ip_id

String

Specifies the EIP ID.

+

Specifies the EIP ID.

floating_ip_address

String

Specifies the EIP.

+

Specifies the EIP address.

external_service_port

Integer

Specifies the port for providing external services.

+

Specifies the port for providing services for external systems.

protocol

String

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

+

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

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

description

+

String

+

Provides supplementary information about the DNAT rule.

+

status

String

@@ -229,7 +245,7 @@

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.
    +
  • Specifies whether the NAT gateway is up or down.
  • The value can be:
    • true: The DNAT rule is enabled.
    • false: The DNAT rule is disabled.

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.

+

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

-

Examples

  • Example request
    1. Create a rule for a specified port.
      POST https://{Endpoint}/v2.0/dnat_rules
      +

      Examples

      • Example requests
        1. Creating a DNAT rule with specified internal_service_port and external_service_port
          POST https://{Endpoint}/v2.0/dnat_rules
           {
               "dnat_rule": {
                   "floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
                   "nat_gateway_id": "cda3a125-2406-456c-a11f-598e10578541",
                   "port_id": "9a469561-daac-4c94-88f5-39366e5ea193",
          +        "description": "description",
                   "internal_service_port": 993,
                   "protocol": "tcp",
                   "external_service_port": 242
               }
           }
          -
        1. Create a rule for all ports.
          POST https://{Endpoint}/v2.0/dnat_rules
          +
        1. Creating a DNAT rule with both internal_service_port and external_service_port set to 0
          POST https://{Endpoint}/v2.0/dnat_rules
           {
               "dnat_rule": {
                   "floating_ip_id": "Cf99c679-9f41-4dac-8513-9c9228e713e1",
                   "nat_gateway_id": "Dda3a125-2406-456c-a11f-598e10578541",
                   "private_ip": "192.168.1.100",
          +        "description": "description",
                   "internal_service_port": 0,
                   "protocol": "any",
                   "external_service_port": 0
          @@ -269,10 +287,11 @@
           
      -
      • Example response
        1. Create a response for a specified port.
          {
          +
          • Example responses
            1. Response to the request for creating a DNAT rule with specified internal_service_port and external_service_port
              {
                   "dnat_rule": {
                       "floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
                       "status": "ACTIVE",
              +        "description": "description",
                       "nat_gateway_id": "cda3a125-2406-456c-a11f-598e10578541",
                       "admin_state_up": true,
                       "port_id": "9a469561-daac-4c94-88f5-39366e5ea193",
              @@ -286,10 +305,11 @@
                       "private_ip": ""
                   }
               }
              -
            2. Create a response for all ports.
              {
              +
            3. Response to the request for creating a DNAT rule with both internal_service_port and external_service_port set to 0
              {
                   "dnat_rule": {
                       "floating_ip_id": "cf99c679-9f41-4dac-8513-9c9228e713e1",
                       "status": "ACTIVE",
              +        "description": "description",
                       "nat_gateway_id": "dda3a125-2406-456c-a11f-598e10578541",
                       "admin_state_up": true,
                       "private_ip": "192.168.1.100",
              @@ -304,7 +324,7 @@
               }
          -

          Status Code

          See Status Codes.

          +

          Status Codes

          See Status Codes.

          diff --git a/docs/natgw/api-ref/nat_api_0012.html b/docs/natgw/api-ref/nat_api_0012.html index 83a1ae52..3fbe73e8 100644 --- a/docs/natgw/api-ref/nat_api_0012.html +++ b/docs/natgw/api-ref/nat_api_0012.html @@ -1,10 +1,10 @@

          Querying DNAT Rules

          -

          Function

          This API is used to query a DNAT rule list.

          +

          Function

          This API is used to query DNAT rules.

          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.

          +

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

          - - - - - - - + + + + - @@ -121,9 +128,9 @@

          Request

          None

          -

          Response

          Table 2 lists response parameters.

          +

          Response

          Table 2 lists response parameter.

          -
          Table 1 Parameter description

          Parameter

          @@ -26,7 +26,7 @@

          Integer

          Specifies the number of records on each page.

          +

          Specifies the number of records returned on each page.

          tenant_id

          @@ -47,21 +47,21 @@

          String

          Specifies the port ID of an ECS or a BMS.

          +

          Specifies the port ID of the cloud server (ECS or BMS).

          private_ip

          String

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

          +

          Specifies the private IP address, for example, the IP address of an on-premises network connected by a Direct Connect connection.

          internal_service_port

          Integer

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

          +

          Specifies the port number used by the cloud server (ECS or BMS) to provide services for external systems.

          floating_ip_id

          @@ -75,24 +75,31 @@

          String

          Specifies the EIP.

          +

          Specifies the EIP address.

          external_service_port

          Integer

          Specifies the port for providing external services.

          +

          Specifies the port for providing services for external systems.

          protocol

          String

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

          +

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

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

          description

          +

          String

          +

          Provides supplementary information about the DNAT rule.

          +

          status

          String

          @@ -112,7 +119,7 @@

          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.

          +

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

          Table 2 Response parameters

          Parameter

          +
          @@ -142,7 +149,7 @@
          Table 2 Response parameter

          Parameter

          Type

          -
          Table 3 Description of the dnat_rule field

          Parameter

          +
          @@ -175,21 +182,21 @@ - - - - - - + + + + - @@ -255,6 +269,7 @@ { "floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1", "status": "ACTIVE", + "description": "description", "nat_gateway_id": "cda3a125-2406-456c-a11f-598e10578541", "admin_state_up": true, "port_id": "9a469561-daac-4c94-88f5-39366e5ea193", @@ -270,8 +285,9 @@ { "floating_ip_id": "cf99c679-9f41-4dac-8513-9c9228e713e1", "status": "ACTIVE", + "description": "description", "nat_gateway_id": "dda3a125-2406-456c-a11f-598e10578541", - "admin_state_up": true,  + "admin_state_up": true, "port_id": "", "private_ip": "192.168.1.100", "internal_service_port": 0, @@ -280,12 +296,12 @@ "created_at": "2017-11-16 15:44:42.595173", "id": "89195d50-0271-41f1-bded-4c089b2502ff", "floating_ip_address": "5.21.11.227", -      "external_service_port": 0 + "external_service_port": 0 } ] } -

          Status Code

          See Status Codes.

          +

          Status Codes

          See Status Codes.

          diff --git a/docs/natgw/api-ref/nat_api_0013.html b/docs/natgw/api-ref/nat_api_0013.html index 23e87d04..ecfa5a1a 100644 --- a/docs/natgw/api-ref/nat_api_0013.html +++ b/docs/natgw/api-ref/nat_api_0013.html @@ -1,7 +1,7 @@ -

          Querying Details About a Specified DNAT Rule

          -

          Function

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

          +

          Querying Details of a DNAT Rule

          +

          Function

          This API is used to query details of a DNAT rule.

          URI

          GET /v2.0/dnat_rules/{dnat_rule_id}

          @@ -30,9 +30,9 @@

          Request

          None

          -

          Response

          Table 2 lists response parameters.

          +

          Response

          Table 2 lists response parameter.

          -
          Table 3 Description of the dnat_rule field

          Parameter

          Type

          String

          Specifies the port ID of an ECS or a BMS.

          +

          Specifies the port ID of the cloud server (ECS or BMS).

          private_ip

          String

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

          +

          Specifies the private IP address, for example, the IP address of an on-premises network connected by a Direct Connect connection.

          internal_service_port

          Integer

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

          +

          Specifies the port number used by the cloud server (ECS or BMS) to provide services for external systems.

          floating_ip_id

          @@ -203,24 +210,31 @@

          String

          Specifies the EIP.

          +

          Specifies the EIP address.

          external_service_port

          Integer

          Specifies the port for providing external services.

          +

          Specifies the port for providing services for external systems.

          protocol

          String

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

          +

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

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

          description

          +

          String

          +

          Provides supplementary information about the DNAT rule.

          +

          status

          String

          @@ -240,7 +254,7 @@

          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.

          +

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

          Table 2 Response parameters

          Parameter

          +
          @@ -51,7 +51,7 @@
          Table 2 Response parameter

          Parameter

          Type

          -
          Table 3 Description of the dnat_rule field

          Parameter

          +
          @@ -84,21 +84,21 @@ - - - - - - + + + + - @@ -160,24 +167,25 @@
          • Example response
            {              
            -  "dnat_rule": {
            -      "floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
            -      "status": "ACTIVE",
            -      "nat_gateway_id": "cda3a125-2406-456c-a11f-598e10578541",
            -      "admin_state_up": true,
            -      "port_id": "9a469561-daac-4c94-88f5-39366e5ea193",
            -      "internal_service_port": 993,
            -      "protocol": "TCP",
            -      "tenant_id": "abc",
            -      "created_at": "2017-11-15 15:44:42.595173",
            -      "id": "79195d50-0271-41f1-bded-4c089b2502ff",
            -      "floating_ip_address": "5.21.11.226",
            -      "external_service_port": 242
            -      "private_ip": ""  
            +  "dnat_rule": {
            +        "floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
            +        "status": "ACTIVE",
            +        "nat_gateway_id": "cda3a125-2406-456c-a11f-598e10578541",
            +        "admin_state_up": true,
            +        "description": "description",
            +        "port_id": "9a469561-daac-4c94-88f5-39366e5ea193",
            +        "internal_service_port": 993,
            +        "protocol": "TCP",
            +        "tenant_id": "abc",
            +        "created_at": "2017-11-15 15:44:42.595173",
            +        "id": "79195d50-0271-41f1-bded-4c089b2502ff",
            +        "floating_ip_address": "5.21.11.226",
            +        "external_service_port": 242
            +        "private_ip": ""  
                }
             }
          -

          Status Code

          See Status Codes.

          +

          Status Codes

          See Status Codes.

          diff --git a/docs/natgw/api-ref/nat_api_0015.html b/docs/natgw/api-ref/nat_api_0015.html new file mode 100644 index 00000000..c648efab --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0015.html @@ -0,0 +1,25 @@ + + +

          Tags

          +
          + + diff --git a/docs/natgw/api-ref/nat_api_0016.html b/docs/natgw/api-ref/nat_api_0016.html new file mode 100644 index 00000000..efabe685 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0016.html @@ -0,0 +1,417 @@ + + +

          Querying NAT Gateways by Tag

          +

          Function

          This API is used to filter NAT gateways by tag.

          +

          TMS uses this API to filter and list NAT gateways by tag.

          +

          By default, NAT gateways and tags are sorted in descending order of creation time.

          +
          +

          URI

          • URI format
          +

          POST /v2.0/{project_id}/nat_gateways/resource_instances/action

          +
          • Parameter description
          + +
          Table 3 Description of the dnat_rule field

          Parameter

          Type

          String

          Specifies the port ID of an ECS or a BMS.

          +

          Specifies the port ID of the cloud server (ECS or BMS).

          private_ip

          String

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

          +

          Specifies the private IP address, for example, the IP address of an on-premises network connected by a Direct Connect connection.

          internal_service_port

          Integer

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

          +

          Specifies the port number used by the cloud server (ECS or BMS) to provide services for external systems.

          floating_ip_id

          @@ -112,24 +112,31 @@

          String

          Specifies the EIP.

          +

          Specifies the EIP address.

          external_service_port

          Integer

          Specifies the port for providing external services.

          +

          Specifies the port for providing services for external systems.

          protocol

          String

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

          +

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

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

          description

          +

          String

          +

          Provides supplementary information about the DNAT rule.

          +

          status

          String

          @@ -149,7 +156,7 @@

          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.

          +

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

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          project_id

          +

          Yes

          +

          String

          +

          Specifies the project ID.

          +
          +
          + +

          Request

          Table 2 describes the request parameters.

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          tags

          +

          No

          +

          Array<Object>

          +

          Specifies the included tags. Each tag contains a maximum of 20 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique. Resources identified by different keys are in AND relationship, and values in one tag are in OR relationship. If no tag filtering criteria is specified, full data is returned.

          +

          tags_any

          +

          No

          +

          Array<Object>

          +

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

          +

          not_tags

          +

          No

          +

          Array<Object>

          +

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

          +

          not_tags_any

          +

          No

          +

          Array<Object>

          +

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

          +

          limit

          +

          No

          +

          String

          +

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

          +

          offset

          +

          No

          +

          String

          +

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

          +

          action

          +

          Yes

          +

          String

          +

          Specifies the operation to perform. The value can only be filter (filtering) or count (querying the total number).

          +

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

          +

          matches

          +

          No

          +

          Array<match>

          +

          Specifies the search criteria. The tag key is the field to match, for example, resource_name. The tag value indicates the matched value. This field is a fixed dictionary value.

          +

          Determine whether fuzzy match is required based on different fields. For example, if key is resource_name, fuzzy search (case insensitive) is used by default. If value is an empty string, exact match is used. If key is resource_id, exact match is used.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 3 Description of field tag

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          key

          +

          Yes

          +

          String

          +

          Specifies the tag key. A key contains a maximum of 127 Unicode characters and cannot be blank. (The system does not check the parameter when searching a tag.) The key cannot be empty or an empty string, and cannot contain spaces. Before verification, delete spaces before and after the value.

          +

          values

          +

          Yes

          +

          Array<String>

          +

          Specifies the tag values. Each value contains a maximum of 255 Unicode characters and cannot contain spaces. Before verification, delete spaces before and after the value.

          +

          The asterisk (*) is a reserved character. The value can be empty but cannot be left blank.

          +

          If the value starts with an asterisk (*), the string following the asterisk is fuzzy matched.

          +

          If the values are null, it indicates any_value (querying any value). The values are in OR relationship.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 4 Description of field match

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          key

          +

          Yes

          +

          String

          +

          Specifies the tag key. The value is fixed at resource_name.

          +

          value

          +

          Yes

          +

          String

          +

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

          +
          +
          +
          +

          Response

          Table 5 lists response parameters.

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

          Parameter

          +

          Type

          +

          Description

          +

          resources

          +

          Array<resource>

          +

          Specifies the resource object list. For details, see Table 6.

          +

          total_count

          +

          Integer

          +

          Specifies the total number of resources.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + +
          Table 6 Data structure description of field resource

          Parameter

          +

          Type

          +

          Description

          +

          resource_id

          +

          String

          +

          Specifies the resource ID.

          +

          resouce_detail

          +

          Object

          +

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

          +

          tags

          +

          Array<resource_tag>

          +

          Specifies the list of queried tags. If no tag is matched, an empty array is returned. For details, see Table 7.

          +

          resource_name

          +

          String

          +

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

          +
          +
          + +
          + + + + + + + + + + + + + +
          Table 7 Parameter description of field resource_tag

          Parameter

          +

          Type

          +

          Description

          +

          key

          +

          String

          +

          Specifies the tag key. It contains a maximum of 36 Unicode characters. It cannot be left empty or contain ASCII characters (0–31) and the following special characters: *<>\=

          +

          value

          +

          String

          +

          Specifies the key value. The value can contain a maximum of 43 Unicode characters and can be an empty string. It cannot contain ASCII characters (0–31) and the following characters: *<>\=

          +
          +
          +
          +

          Examples

          • Example request
            1. Request body when action is set to filter
            +
            POST  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/resource_instances/action 
            +{
            +    "offset": "100", 
            +    "limit": "100", 
            +    "action": "filter", 
            +    "matches": [
            +        {
            +            "key": "resource_name", 
            +            "value": "nat_gateways"
            +        }
            +    ], 
            +    "not_tags": [
            +        {
            +            "key": "key1", 
            +            "values": [
            +                "*value1", 
            +                "value2"
            +            ]
            +        }
            +    ], 
            +    "tags": [
            +        {
            +            "key": "key2", 
            +            "values": [
            +                "*value3", 
            +                "value4"
            +            ]
            +        }
            +    ], 
            +    "tags_any": [
            +        {
            +            "key": "key3", 
            +            "values": [
            +                "*value5", 
            +                "value6"
            +            ]
            +        }
            +    ],
            +    "not_tags_any": [
            +        {
            +            "key": "key4", 
            +            "values": [
            +                "*value7", 
            +                "value8"
            +            ]
            +        }
            +    ]
            +}
            +
            1. Request body when action is set to count
            +
            POST  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/resource_instances/action        {
            +    "action": "count", 
            +    "matches": [
            +        {
            +            "key": "resource_name", 
            +            "value": "nat_gateways"
            +        }
            +    ], 
            +    "not_tags": [
            +        {
            +            "key": "key1", 
            +            "values": [
            +                "*value1", 
            +                "value2"
            +            ]
            +        }
            +    ], 
            +    "tags": [
            +        {
            +            "key": "key2", 
            +            "values": [
            +                "*value3", 
            +                "value4"
            +            ]
            +        }
            +    ], 
            +    "tags_any": [
            +        {
            +            "key": "key3", 
            +            "values": [
            +                "*value5", 
            +                "value6"
            +            ]
            +        }
            +    ],
            +    "not_tags_any": [
            +        {
            +            "key": "key4", 
            +            "values": [
            +                "*value7", 
            +                "value8"
            +            ]
            +        }
            +    ]
            +}
            +
          +
          +
          • Example response
            1. Response body when action is set to filter
            +
            { 
            +    "resources": [
            +        {
            +            "resource_detail": null, 
            +            "resource_id": "e5ad289f-9c56-4daf-b08b-2e53a983473a", 
            +            "resource_name": "nat_gateways", 
            +            "tags": [
            +                {
            +                   "key": "key2",
            +                   "value": "value4"
            +                },
            +                {
            +                   "key": "key2",
            +                   "value": "value3"
            +                }
            +            ]
            +        }
            +    ], 
            +    "total_count": 1000
            +}
            +
            1. Response body when action is set to count
            +
            { 
            +    "total_count": 1000
            +}
            +
          +

          Status Code

          See Status Codes.

          +
          + +
          + +
          + diff --git a/docs/natgw/api-ref/nat_api_0017.html b/docs/natgw/api-ref/nat_api_0017.html new file mode 100644 index 00000000..47219685 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0017.html @@ -0,0 +1,155 @@ + + +

          Adding or Deleting NAT Gateway Tags in Batches

          +

          Function

          This API is used to add or delete tags of a specific NAT gateway in batches.

          +

          TMS uses this API to manage service resource tags.

          +

          You can add a maximum of 20 tags to a NAT gateway.

          +

          This API is idempotent.

          +

          If there are duplicate keys in the request body when you add tags, an error is reported.

          +

          If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.

          +

          When tags are being deleted and some tags do not exist, the operation is considered successful by default. The character set of the tags will not be checked. A key and a value can respectively contain up to 127 and 255 Unicode characters. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.

          +
          +

          URI

          • URI format
          +

          POST /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags/action

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          project_id

          +

          Yes

          +

          String

          +

          Specifies the project ID.

          +

          nat_gateway_id

          +

          Yes

          +

          String

          +

          Specifies the NAT gateway ID.

          +
          +
          +
          +

          Request

          Table 2 describes the request parameters.

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          tags

          +

          Yes

          +

          Array

          +

          Specifies tags. For details, see Table 3.

          +

          action

          +

          Yes

          +

          String

          +

          Specifies the operation to be performed. The value can be set to create or delete only.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 3 Parameter description of field tags

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          key

          +

          Yes

          +

          String

          +

          Specifies the tag key. It contains a maximum of 36 Unicode characters. This parameter cannot be left blank or contain ASCII (0-31) or the following characters: =*<>\,|/

          +

          value

          +

          Yes

          +

          String

          +

          Specifies the key value. Each value contains a maximum of 43 Unicode characters. If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key. The value can be an empty character string. It cannot contain ASCII (0-31) or the following characters: =*<>\,|/

          +
          +
          +
          +

          Response

          None

          +
          +

          Examples

          • Example request
            POST  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags/action
            +{
            +    "action": "create",
            +    "tags": [
            +        {
            +            "key": "key1",
            +            "value": "value1"
            +        },
            +        {
            +            "key": "key2",
            +            "value": "value2"
            +        }
            +    ]
            +}
            +Or
            +{
            +    "action": "delete",
            +    "tags": [
            +        {
            +            "key": "key1",
            +            "value": "value1             
            +         },
            +        {
            +            "key": "key2",
            +            "value": "value2"
            +        }
            +    ]
            +}
            +
          +
          +

          Example response

          None

          +
          +

          Status Code

          See Status Codes.

          +
          +
          +
          + +
          + diff --git a/docs/natgw/api-ref/nat_api_0018.html b/docs/natgw/api-ref/nat_api_0018.html new file mode 100644 index 00000000..e286a7bd --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0018.html @@ -0,0 +1,121 @@ + + +

          Adding a NAT Gateway Tag

          +

          Function

          This API is used to add tags to a NAT gateway. You can add a maximum of 20 tags to a NAT gateway.

          +

          This API is idempotent.

          +

          If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.

          +

          Ensure that the NAT gateway which you add the tag to exists.

          +
          +
          +

          URI

          POST /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          project_id

          +

          Yes

          +

          String

          +

          Specifies the project ID.

          +

          nat_gateway_id

          +

          Yes

          +

          String

          +

          Specifies the NAT gateway ID.

          +
          +
          +
          +

          Request

          Table 2 describes the request parameters.

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          tag

          +

          Yes

          +

          Array

          +

          Specifies the list of tags.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 3 Description of field tag

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          key

          +

          Yes

          +

          String

          +

          Specifies the tag key. It contains a maximum of 36 Unicode characters. This parameter cannot be left blank or contain ASCII (0-31) or the following characters: =*<>\,|/

          +

          value

          +

          Yes

          +

          String

          +

          Specifies the key value. The value can contain a maximum of 43 Unicode characters and can be an empty string. It cannot contain ASCII (0-31) or the following characters: =*<>\,|/

          +
          +
          +
          +

          Response

          None

          +
          +

          Examples

          • Example request
            POST  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags
            +{
            +     "tag":
            +    {
            +        "key":"key1",
            +        "value":"value1"
            +    }
            +}
            +
          +
          +

          Status Code

          See Status Codes.

          +
          +
          +
          + +
          + diff --git a/docs/natgw/api-ref/nat_api_0019.html b/docs/natgw/api-ref/nat_api_0019.html new file mode 100644 index 00000000..cee55275 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0019.html @@ -0,0 +1,67 @@ + + +

          Deleting a NAT Gateway Tag

          +

          Function

          This API is idempotent.

          +

          When a tag is deleted, it is not verified. The tag key cannot be left blank or be an empty string. If the key of the tag to be deleted does not exist, 404 will be returned.

          +
          +

          URI

          DELETE /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags/{key}

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          project_id

          +

          Yes

          +

          String

          +

          Specifies the project ID.

          +

          nat_gateway_id

          +

          Yes

          +

          String

          +

          Specifies the NAT gateway ID.

          +

          key

          +

          Yes

          +

          String

          +

          Specifies the tag key.

          +
          +
          +
          +

          Request

          None

          +
          +

          Response

          None

          +
          +

          Examples

          • Example request
            DELETE https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags/key1
            +
          +
          +
          • Example response
            None (STATUS CODE 204)
            +
          +

          Status Code

          See Status Codes.

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

          Querying NAT Gateway Tags

          +

          Function

          This API is used to query tags of a specified NAT gateway.

          +

          TMS uses this API to query all tags of a specified NAT gateway.

          +
          +

          URI

          GET /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          project_id

          +

          Yes

          +

          String

          +

          Specifies the project ID.

          +

          nat_gateway_id

          +

          Yes

          +

          String

          +

          Specifies the NAT gateway ID.

          +
          +
          +
          +

          Request

          None

          +
          +

          Response

          Table 2 lists response parameters.

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          tags

          +

          Yes

          +

          Array

          +

          Specifies tags.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 3 Parameter description of field tags

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          key

          +

          Yes

          +

          String

          +

          Specifies the tag key. It contains a maximum of 36 Unicode characters. It cannot be left empty or contain ASCII characters (0-31) and the following special characters: *<>\=

          +

          value

          +

          Yes

          +

          String

          +

          Specifies the key value. The value can contain a maximum of 43 Unicode characters and can be an empty string. It cannot contain non-printable ASCII characters (0–31) or the following special characters: *<>\=

          +
          +
          +
          +

          Examples

          • Example request
            GET https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags
            +
          +
          +
          • Example response
            {
            +    "tags": [
            +        {
            +            "key": "key1",
            +            "value": "value1"
            +        },
            +        {
            +            "key": "key2",
            +            "value": "value2"
            +        }
            +    ]
            +}
            +
          +

          Status Code

          See Status Codes.

          +
          +
          +
          + +
          + diff --git a/docs/natgw/api-ref/nat_api_0021.html b/docs/natgw/api-ref/nat_api_0021.html new file mode 100644 index 00000000..b6651224 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0021.html @@ -0,0 +1,121 @@ + + +

          Querying Tags in a Project

          +

          Function

          This API is used to query all tags of a resource type in a specified region.

          +

          TMS uses this API to list tags created by a tenant to facilitate tag creation and resource filtering on the console.

          +
          +

          URI

          GET /v2.0/{project_id}/nat_gateways/tags

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          project_id

          +

          Yes

          +

          String

          +

          Specifies the project ID.

          +
          +
          +
          +

          Request

          None

          +
          +

          Response

          Table 2 lists response parameters.

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

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          tags

          +

          Yes

          +

          Array

          +

          Specifies tags.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 3 Parameter description of field tags

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          key

          +

          Yes

          +

          String

          +

          Specifies the tag key. It contains a maximum of 36 Unicode characters. It cannot be left empty or contain ASCII characters (0–31) and the following special characters: *<>\=

          +

          values

          +

          Yes

          +

          Array<String>

          +

          Specifies the tag values. The value can contain a maximum of 43 Unicode characters and can be an empty string. It cannot contain non-printable ASCII characters (0–31) or the following special characters: *<>\=

          +
          +
          +
          +

          Examples

          • Example request
            GET  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/tags
            +
          +
          +
          • Example response
            {
            +    "tags": [
            +        {
            +            "key": "key1",
            +            "values": [
            +                "value1",
            +                "value2"
            +            ]
            +        },
            +        {
            +            "key": "key2",
            +            "values": [
            +                "value3",
            +                "value4"
            +            ]
            +        }
            +    ]
            +}
            +
          +

          Status Code

          See Status Codes.

          +
          +
          +
          + +
          + diff --git a/docs/natgw/api-ref/nat_api_0024.html b/docs/natgw/api-ref/nat_api_0024.html index 05ffec68..059dfb37 100644 --- a/docs/natgw/api-ref/nat_api_0024.html +++ b/docs/natgw/api-ref/nat_api_0024.html @@ -6,7 +6,7 @@ diff --git a/docs/natgw/api-ref/nat_api_0025.html b/docs/natgw/api-ref/nat_api_0025.html index 2fd9a483..566ffeff 100644 --- a/docs/natgw/api-ref/nat_api_0025.html +++ b/docs/natgw/api-ref/nat_api_0025.html @@ -126,7 +126,7 @@ ] } -

          Status Code

          See Status Codes.

          +

          Status Codes

          See Status Codes.

          diff --git a/docs/natgw/api-ref/nat_api_0026.html b/docs/natgw/api-ref/nat_api_0026.html index c3d47f1f..6a1f2bb7 100644 --- a/docs/natgw/api-ref/nat_api_0026.html +++ b/docs/natgw/api-ref/nat_api_0026.html @@ -1,7 +1,7 @@ -

          Querying a Specified API Version

          -

          Function

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

          +

          Querying an API Version

          +

          Function

          This API is used to query an API version of NAT Gateway.

          URI

          GET/{api_version}

          @@ -141,7 +141,7 @@ } }
          -

          Status Code

          See Status Codes.

          +

          Status Codes

          See Status Codes.

          diff --git a/docs/natgw/api-ref/nat_api_0027.html b/docs/natgw/api-ref/nat_api_0027.html index 52580915..9a346278 100644 --- a/docs/natgw/api-ref/nat_api_0027.html +++ b/docs/natgw/api-ref/nat_api_0027.html @@ -5,12 +5,16 @@
          diff --git a/docs/natgw/api-ref/nat_api_0035.html b/docs/natgw/api-ref/nat_api_0035.html new file mode 100644 index 00000000..d82dc369 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0035.html @@ -0,0 +1,65 @@ + + +

          NAT Gateway Tag v2.0

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

          Permission

          +

          API

          +

          Action

          +

          Adding NAT Gateway Resource Tags

          +

          POST /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags

          +

          nat:natGatewayTags:create

          +

          Querying NAT Gateway Resource Tags

          +

          GET /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags

          +

          nat:natGatewayTags:get

          +

          Deleting NAT Gateway Resource Tags

          +

          DELETE /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/{key}

          +

          nat:natGatewayTags:delete

          +

          Creating or Deleting NAT Gateway Resource Tags in Batches

          +

          POST /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags/action

          +

          nat:natGatewayTags:create

          +

          nat:natGatewayTags:delete

          +

          Querying NAT Gateway Resources by Tag

          +

          POST /v2.0/{project_id}/nat_gateways/resource_instances/action

          +

          nat:natGatewayTags:get

          +

          Querying NAT Gateway Tags in a Project

          +

          GET /v2.0/{project_id}/nat_gateways/tags

          +

          nat:natGatewayTags:get

          +
          +
          +
          + + diff --git a/docs/natgw/api-ref/nat_api_0040.html b/docs/natgw/api-ref/nat_api_0040.html index 7cea77f9..f27640c5 100644 --- a/docs/natgw/api-ref/nat_api_0040.html +++ b/docs/natgw/api-ref/nat_api_0040.html @@ -4,1004 +4,1004 @@

          Background Information

          • 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. Some error codes are displayed in the returned messages for task viewing requests. HTTP status codes may not be accurate.
          • The NAT Gateway service is strongly dependent on other services, such as network and storage. When error messages are provided for the NAT Gateway-depended services, contact technical support for troubleshooting.

          Error Codes

          -

          Module

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/natgw/api-ref/nat_api_0046.html b/docs/natgw/api-ref/nat_api_0046.html index 00520e87..44f19c8a 100644 --- a/docs/natgw/api-ref/nat_api_0046.html +++ b/docs/natgw/api-ref/nat_api_0046.html @@ -8,7 +8,31 @@ - + + + + + + + + + + + +

          Module

          HTTP Status Code

          +

          HTTP Status Code

          Error Code

          +

          Error Code

          Description

          +

          Description

          Error Message

          +

          Error Message

          Handling Measure

          +

          Handling Measure

          Public

          +

          Public

          400

          +

          400

          VPC.0002

          +

          VPC.0002

          The AZ is left blank.

          +

          The AZ is left blank.

          Available zone Name is null.

          +

          Available zone Name is null.

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

          +

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

          404

          +

          404

          VPC.0003

          +

          VPC.0003

          The VPC does not exist.

          +

          The VPC does not exist.

          VPC does not exit.

          +

          VPC does not exit.

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

          +

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

          400

          +

          400

          VPC.0004

          +

          VPC.0004

          The status of the VPC is abnormal.

          +

          The status of the VPC is abnormal.

          VPC is not active, please try later.

          +

          VPC is not active, please try later.

          Try again later or contact technical support.

          +

          Try again later or contact technical support.

          400

          +

          400

          VPC.0007

          +

          VPC.0007

          Inconsistent tenant IDs.

          +

          Inconsistent tenant IDs.

          urlTenantId is not equal tokenTenantId

          +

          urlTenantId is not equal tokenTenantId

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

          +

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

          401

          +

          401

          VPC.0008

          +

          VPC.0008

          Invalid token.

          +

          Invalid token.

          Invalid token in the header.

          +

          Invalid token in the header.

          Check whether the token in the request header is valid.

          +

          Check whether the token in the request header is valid.

          401

          +

          401

          VPC.0009

          +

          VPC.0009

          Real-name authentication fails.

          +

          Real-name authentication fails.

          real-name authentication fail.

          +

          real-name authentication fail.

          Contact technical support.

          +

          Contact technical support.

          403

          +

          403

          VPC.2701

          +

          VPC.2701

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

          +

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

          Token not allowed to do this action.

          +

          Token not allowed to do this action.

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

          +

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

          403

          +

          403

          VPC.0010

          +

          VPC.0010

          Insufficient permissions to make calls to the underlying system.

          +

          Insufficient permissions to make calls to the underlying system.

          Rules on xx by ** disallowed by policy

          +

          Rules on xx by ** disallowed by policy

          Obtain the required permissions.

          +

          Obtain the required permissions.

          403

          +

          403

          VPC.2201

          +

          VPC.2201

          Insufficient fine-grained permissions.

          +

          Insufficient fine-grained permissions.

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

          +

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

          Obtain the required permissions.

          +

          Obtain the required permissions.

          400

          +

          400

          VPC.0014

          +

          VPC.0014

          The enterprise project is unavailable.

          +

          The enterprise project is unavailable.

          This enterpriseProject status is disable.

          +

          This enterpriseProject status is disable.

          Use the ID of another available enterprise project.

          +

          Use the ID of another available enterprise project.

          400

          +

          400

          VPC.0011

          +

          VPC.0011

          Invalid enterprise project ID.

          +

          Invalid enterprise project ID.

          EnterpriseProjectId is invalid

          +

          EnterpriseProjectId is invalid

          Enter a valid enterprise project ID.

          +

          Enter a valid enterprise project ID.

          400

          +

          400

          VPC.2048

          -

          +

          VPC.2048

          +

          Invalid timestamp.

          -

          +

          Invalid timestamp.

          +

          Invalid value for created_at %(timestamp)s.

          +

          Invalid value for created_at %(timestamp)s.

          Enter the time in the correct format.

          -

          +

          Enter the time in the correct format.

          +

          400

          +

          400

          VPC.2002

          +

          VPC.2002

          Invalid request parameters.

          +

          Invalid request parameters.

          Invalid parameters.

          +

          Invalid parameters.

          Enter the correct parameter.

          +

          Enter the correct parameter.

          400

          +

          400

          VPC.2010

          -

          +

          VPC.2010

          +

          The default route already exists.

          -

          +

          The default route already exists.

          +

          The router %(router_id)s has default route.

          +

          The router %(router_id)s has default route.

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

          -

          +

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

          +

          400

          +

          400

          VPC.2011

          -

          +

          VPC.2011

          +

          The router does not exist.

          -

          +

          The router does not exist.

          +

          The router %(router_id)s does not exist.

          +

          The router %(router_id)s does not exist.

          Check whether the entered router ID is correct.

          -

          +

          Check whether the entered router ID is correct.

          +

          400

          +

          400

          VPC.2009

          -

          +

          VPC.2009

          +

          The network does not exist.

          -

          +

          The network does not exist.

          +

          Network %(network_id)s does not exist.

          +

          Network %(network_id)s does not exist.

          Enter a valid network ID.

          -

          +

          Enter a valid network ID.

          +

          400

          +

          400

          VPC.2016

          +

          VPC.2016

          The rule has not been deleted.

          +

          The rule has not been deleted.

          Rule has not been deleted.

          +

          Rule has not been deleted.

          Contact technical support.

          -

          +

          Contact technical support.

          +

          400

          +

          400

          VPC.2049

          +

          VPC.2049

          The database is abnormal.

          +

          The database is abnormal.

          DB Error

          -

          +

          DB Error

          +

          Contact technical support.

          -

          +

          Contact technical support.

          +

          400

          +

          400

          VPC.2013

          -

          +

          VPC.2013

          +

          The subnet is not connected to the virtual router.

          +

          The subnet is not connected to the virtual router.

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

          +

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

          Add the subnet to the router port.

          -

          +

          Add the subnet to the router port.

          +

          400

          +

          400

          VPC.2019

          -

          +

          VPC.2019

          +

          The resource is in use.

          -

          +

          The resource is in use.

          +

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

          +

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

          Contact technical support.

          -

          +

          Contact technical support.

          +

          400

          +

          400

          VPC.2008

          -

          +

          VPC.2008

          +

          The network does not have any subnet.

          +

          The network does not have any subnet.

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

          +

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

          Contact technical support.

          -

          +

          Contact technical support.

          +

          400

          +

          400

          VPC.2012

          +

          VPC.2012

          The VPC already has a NAT gateway.

          +

          The VPC already has a NAT gateway.

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

          +

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

          Select another VPC.

          +

          Select another VPC.

          NAT Gateway

          +

          NAT Gateway

          400

          +

          400

          VPC.2000

          +

          VPC.2000

          NAT gateway request error.

          +

          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

          +

          Lack of user authority.

          +

          //request is null.

          +

          //endpoint is empty.

          +

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

          Contact technical support.

          +

          Contact technical support.

          400

          +

          400

          VPC.2030

          +

          VPC.2030

          The system is busy. Please try again later.

          +

          The system is busy. Please try again later.

          The system is busy. Please try again later.

          +

          The system is busy. Please try again later.

          Try again later.

          +

          Try again later.

          400

          +

          400

          VPC.2001

          +

          VPC.2001

          Incorrect NAT gateway parameter.

          +

          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.

          +

          Request is invalid. //NatGateway id invalid.

          +

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

          +

          Enter the correct parameter or contact technical support.

          400

          +

          400

          VPC.2004

          -

          +

          VPC.2004

          +

          The NAT gateway is not activated.

          +

          The NAT gateway is not activated.

          NatGateway %(nat_gateway_id)s is not ACTIVE.

          +

          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.

          +

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

          400

          +

          400

          VPC.2005

          -

          +

          VPC.2005

          +

          The NAT gateway is not in the UP state.

          +

          The NAT gateway is not in the UP state.

          NatGateway %(nat_gateway_id)s is not UP.

          +

          NatGateway %(nat_gateway_id)s is not UP.

          The gateway may be frozen due to arrears.

          -

          +

          The gateway may be frozen due to arrears.

          +

          400

          +

          400

          VPC.2006

          -

          +

          VPC.2006

          +

          The NAT gateway is frozen.

          -

          +

          The NAT gateway is frozen.

          +

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

          +

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

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

          -

          +

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

          +

          400

          +

          400

          VPC.2007

          -

          +

          VPC.2007

          +

          The NAT gateway does not exist.

          -

          +

          The NAT gateway does not exist.

          +

          NatGateway %(nat_gateway_id)s does not exist.

          +

          NatGateway %(nat_gateway_id)s does not exist.

          The NAT gateway does not exist.

          -

          +

          The NAT gateway does not exist.

          +

          400

          +

          400

          VPC.2050

          -

          +

          VPC.2050

          +

          Concurrent operation conflicts.

          +

          Concurrent operation conflicts.

          Concurrent conflict requests found

          +

          Concurrent conflict requests found

          Contact technical support.

          -

          +

          Contact technical support.

          +

          400

          +

          400

          VPC.2051

          -

          +

          VPC.2051

          +

          Failed to create the internal port of the NAT gateway.

          +

          Failed to create the internal port of the NAT gateway.

          Create NG Port failed.

          -

          +

          Create NG Port failed.

          +

          Internal error. Contact technical support.

          -

          +

          Internal error. Contact technical support.

          +

          400

          +

          400

          VPC.2052

          -

          +

          VPC.2052

          +

          Failed to bind the internal port to the NAT gateway.

          +

          Failed to bind the internal port to the NAT gateway.

          NG Port %(port)s is unbound.

          -

          +

          NG Port %(port)s is unbound.

          +

          Internal error. Contact technical support.

          -

          +

          Internal error. Contact technical support.

          +

          400

          +

          400

          VPC.2053

          -

          +

          VPC.2053

          +

          The NAT gateway does not support IPv6.

          +

          The NAT gateway does not support IPv6.

          NatGateway does not support IPv6.

          -

          +

          NatGateway does not support IPv6.

          +

          The NAT gateway cannot be bound to an IPv6 EIP.

          +

          The NAT gateway cannot be bound to an IPv6 EIP.

          400

          +

          400

          VPC.2045

          +

          VPC.2045

          An error occurred when selecting the gateway node.

          +

          An error occurred when selecting the gateway node.

          Get Nat gateway host failed

          +

          Get Nat gateway host failed

          Contact technical support.

          +

          Contact technical support.

          400

          +

          400

          VPC.2046

          -

          +

          VPC.2046

          +

          Failed to obtain the IP address of the gateway node.

          +

          Failed to obtain the IP address of the gateway node.

          Get Nat gateway agent local_ip failed

          +

          Get Nat gateway agent local_ip failed

          Contact technical support.

          -

          +

          Contact technical support.

          +

          400

          +

          400

          VPC.2047

          -

          +

          VPC.2047

          +

          Failed to obtain the VPC route table.

          +

          Failed to obtain the VPC route table.

          Get RouteTable %(router_id)s failed.

          +

          Get RouteTable %(router_id)s failed.

          Contact technical support.

          -

          +

          Contact technical support.

          +

          400

          +

          400

          VPC.2012

          +

          VPC.2012

          The router already has a NAT gateway.

          +

          The router already has a NAT gateway.

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

          +

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

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

          -

          +

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

          +

          SNAT Rule

          -

          +

          SNAT Rule

          +

          400

          +

          400

          VPC.2014

          +

          VPC.2014

          Incorrect SNAT rule parameter.

          +

          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.

          +

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

          +

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

          +

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

          +

          Enter the correct parameter or contact technical support.

          400

          -

          +

          400

          +

          VPC.2031

          -

          +

          VPC.2031

          +

          The CIDR of the SNAT rule conflicts with the network.

          -

          +

          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

          +

          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.

          -

          +

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

          +

          400

          +

          400

          VPC.2032

          -

          +

          VPC.2032

          +

          Invalid CIDR block.

          +

          Invalid CIDR block.

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

          +

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

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

          -

          +

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

          +

          400

          +

          400

          VPC.2033

          +

          VPC.2033

          Invalid rule type.

          -

          +

          Invalid rule type.

          +

          source_type and network_id is incompatible.

          -

          +

          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.

          +

          If the SNAT rule is configured for servers in a VPC, source_type is optional or must be set to 0.

          +

          If an SNAT rule is configured for an on-premises network connects to the VPC through Direct Connect or CC, source_type must be set to 1.

          400

          +

          400

          VPC.2034

          -

          +

          VPC.2034

          +

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

          +

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

          cidr must be a subset of subnet's cidr.

          -

          +

          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.

          -

          +

          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

          +

          400

          VPC.2035

          -

          +

          VPC.2035

          +

          The CIDR block conflicts with the subnet CIDR block.

          +

          The CIDR block conflicts with the subnet CIDR block.

          cidr conflicts with subnet's cidr.

          +

          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.

          +

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

          400

          +

          400

          VPC.2036

          -

          +

          VPC.2036

          +

          The CIDR block conflicts with the existing one.

          -

          +

          The CIDR block conflicts with the existing one.

          +

          cidr in the request conflicts with cidrs of existing rules.

          +

          cidr in the request conflicts with cidrs of existing rules.

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

          -

          +

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

          +

          400

          +

          400

          VPC.2018

          -

          +

          VPC.2018

          +

          The rule already exists.

          -

          +

          The rule already exists.

          +

          Snat rule for network %(network)s exists.

          -

          +

          Snat rule for network %(network)s exists.

          +

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

          -

          +

          Select a subnet that has no SNAT rules configured.

          +

          400

          +

          400

          VPC.2042

          -

          +

          VPC.2042

          +

          The EIP has been used by the SNAT rule.

          -

          +

          The EIP has been used by the SNAT rule.

          +

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

          +

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

          Select another EIP.

          -

          +

          Select another EIP.

          +

          400

          +

          400

          VPC.2044

          -

          +

          VPC.2044

          +

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

          +

          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.

          +

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

          Enter a valid UUID.

          -

          +

          Enter a valid UUID.

          +

          400

          +

          400

          VPC.2040

          -

          +

          VPC.2040

          +

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

          +

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

          Invalid value for public ip id.

          -

          +

          Invalid value for public ip id.

          +

          Enter a valid ID.

          -

          +

          Enter a valid UUID.

          +

          400

          +

          400

          VPC.2039

          -

          +

          VPC.2039

          +

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

          +

          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.

          +

          %(limit)s EIP has been associated to this SNAT rules' 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.

          -

          +

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

          +

          DNAT Rule

          -

          +

          DNAT Rule

          +

          400

          +

          400

          VPC.2020

          +

          VPC.2020

          Incorrect DNAT rule parameter.

          +

          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.

          +

          get dnatRules error limit is invalid.

          +

          //get dnatrules error marker is invalid.

          +

          //endpoint is empty.

          +

          //DnatRule id invalid.

          +

          //VPC ID is invalid.

          +

          //Request is null.

          +

          //DnatRule id invalid.

          +

          //DnatRule natGatewayId id invalid.

          Enter the correct parameter or contact technical support.

          +

          Enter the correct parameter or contact technical support.

          400

          +

          400

          VPC.2054

          -

          +

          VPC.2054

          +

          Invalid DNAT rule protocol.

          -

          +

          Invalid DNAT rule protocol.

          +

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

          +

          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.

          -

          +

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

          +

          400

          +

          400

          VPC.2069

          -

          +

          VPC.2069

          +

          Invalid DNAT rule port.

          +

          Invalid DNAT rule port.

          Invalid value for port %(port)s

          +

          Invalid value for port %(port)s

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

          +

          Configure a valid internal port and external port. Supported range: 0 to 65535

          400

          +

          400

          VPC.2023

          -

          +

          VPC.2023

          +

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

          -

          +

          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.

          +

          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.

          -

          +

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

          +

          400

          +

          400

          VPC.2024

          -

          +

          VPC.2024

          +

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

          -

          +

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

          +

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

          -

          +

          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.

          -

          +

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

          +

          400

          +

          400

          VPC.2070

          -

          +

          VPC.2070

          +

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

          -

          +

          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.

          +

          The external port equals 0 and internal port equals 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.

          -

          +

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

          +

          400

          +

          400

          VPC.2027

          -

          +

          VPC.2027

          +

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

          -

          +

          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.

          +

          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.

          +

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

          400

          +

          400

          VPC.2028

          -

          +

          VPC.2028

          +

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

          -

          +

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

          +

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

          400

          +

          400

          VPC.2029

          +

          VPC.2029

          The DNAT rule has been frozen and cannot be modified.

          -

          +

          The DNAT rule has been frozen and cannot be modified.

          +

          DNAT rule is frozen, can no longer update.

          -

          +

          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.

          +

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

          400

          +

          400

          VPC.2038

          +

          VPC.2038

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

          +

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

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

          +

          %(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.

          +

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

          400

          +

          400

          VPC.2055

          -

          +

          VPC.2055

          +

          The DNAT rule contains mutually exclusive parameters.

          -

          +

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

          -

          +

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

          +

          400

          +

          400

          VPC.2056

          -

          +

          VPC.2056

          +

          The DNAT rule does not have some required parameters.

          -

          +

          The parameters required by the DNAT rule are missing.

          +

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

          +

          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.

          -

          +

          Configure the VM port ID and private IP address.

          +

          400

          +

          400

          VPC.2071

          -

          +

          VPC.2071

          +

          Invalid private IP address of the DNAT rule.

          +

          Invalid private IP address of the DNAT rule.

          The private ip address is not legal.

          +

          The private ip address is not legal.

          Configure a valid private IP address.

          -

          +

          Configure a valid private IP address.

          +

          400

          +

          400

          VPC.2037

          -

          +

          VPC.2037

          +

          This virtual IP address is not supported.

          -

          +

          This virtual IP address is not supported.

          +

          The virtual IP address is not supported.

          +

          The virtual IP address is not supported.

          Configure a valid private IP address.

          +

          Configure a valid private IP address.

          400

          +

          400

          VPC.2026

          -

          +

          VPC.2026

          +

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

          -

          +

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

          +

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

          +

          %(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.

          -

          +

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

          +

          400

          +

          400

          VPC.2057

          -

          +

          VPC.2057

          +

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

          +

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

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

          -

          +

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

          +

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

          -

          +

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

          +

          400

          +

          400

          VPC.2022

          -

          +

          VPC.2022

          +

          Invalid VM port ID of the DNAT rule.

          +

          Invalid VM port ID of the DNAT rule.

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

          -

          +

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

          +

          Configure a valid VM port ID.

          -

          +

          Configure a valid VM port ID.

          +

          400

          +

          400

          VPC.2058

          +

          VPC.2058

          The value of VtepIp must be specified.

          +

          VtepIp must be specified.

          Vtep_ip is Null.

          +

          Vtep_ip is Null.

          Contact technical support.

          +

          Contact technical support.

          400

          +

          400

          VPC.2075

          +

          VPC.2075

          The description contains more than 255 characters.

          +

          The description contains more than 255 characters.

          Enter a maximum of 255 characters.

          +

          Enter a maximum of 255 characters.

          Enter a maximum of 255 characters.

          +

          Enter a maximum of 255 characters.

          EIP

          +

          EIP

          400

          +

          400

          VPC.2059

          -

          +

          VPC.2059

          +

          The EIP is frozen.

          -

          +

          The EIP is frozen.

          +

          Floating Ip %(fip)s is freezed.

          +

          Floating Ip %(fip)s is frozen.

          Select an EIP that has not been frozen.

          -

          +

          Select an EIP that has not been frozen.

          +

          400

          +

          400

          VPC.2060

          -

          +

          VPC.2060

          +

          The EIP has been associated with a port.

          +

          The EIP has been associated with a port.

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

          -

          +

          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.

          +

          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

          +

          400

          VPC.2061

          -

          +

          VPC.2061

          +

          The EIP has been associated with a NAT gateway.

          +

          The EIP has been associated with a NAT gateway.

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

          -

          +

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

          +

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

          -

          +

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

          +

          400

          +

          400

          VPC.2062

          -

          +

          VPC.2062

          +

          The EIP is in use.

          -

          +

          The EIP is in use.

          +

          Floating Ip %(fip)s has been occupied.

          +

          Floating Ip %(fip)s has been occupied.

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

          +

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

          400

          +

          400

          VPC.2074

          -

          +

          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.

          +

          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.

          +

          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.

          +

          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

          +

          400

          VPC.2073

          +

          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.

          +

          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.

          +

          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.

          +

          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

          +

          400

          VPC.2043

          -

          +

          VPC.2043

          +

          The EIP has been associated with a rule.

          +

          The EIP has been associated with a rule.

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

          +

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

          Select an EIP that is not in use.

          -

          +

          Select an EIP that is not in use.

          +

          2019-09-18

          +

          2024-01-15

          +

          This issue incorporates the following changes:

          + +

          2023-06-30

          +

          This issue incorporates the following change:

          +

          Added Permissions Policies and Supported Actions.

          +

          2022-10-31

          +

          This release incorporates the following change:

          +

          Added Tags.

          +

          2022-10-30

          +

          This release incorporates the following change:

          + +

          2019-09-18

          This release incorporates the following changes:

          @@ -35,7 +59,7 @@

          2018-02-13

          This release incorporates the following change:

          - +

          Added the description of request parameter router_id in Creating a NAT Gateway.

          2018-01-30

          diff --git a/docs/natgw/api-ref/nat_api_0047.html b/docs/natgw/api-ref/nat_api_0047.html index 63061b9f..a9d40a19 100644 --- a/docs/natgw/api-ref/nat_api_0047.html +++ b/docs/natgw/api-ref/nat_api_0047.html @@ -1,7 +1,7 @@

          API Usage Guidelines

          -

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

          +

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

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

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

          diff --git a/docs/natgw/api-ref/nat_api_0052.html b/docs/natgw/api-ref/nat_api_0052.html new file mode 100644 index 00000000..17dbe239 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0052.html @@ -0,0 +1,170 @@ + + +

          API Overview

          +

          NAT Gateway APIs allow you to use all NAT Gateway functions.

          +

          API v2.0

          +
          + + + + + + + + + + + + + + + + + + + +
          Table 1 NAT gateway API v2.0

          Type

          +

          Description

          +

          NAT Gateway Service

          +

          Create, query, update, and delete NAT gateways, including creating a NAT gateway, querying NAT gateways, querying details of a NAT gateway, updating a NAT gateway, and deleting a NAT gateway.

          +

          SNAT Rules

          +

          Create, query, and delete SNAT rules, including creating an SNAT rule, querying SNAT rules, querying details of an SNAT rule, and deleting an SNAT rule.

          +

          DNAT Rules

          +

          Create, query, and delete DNAT rules, including creating a DNAT rule, querying DNAT rules, querying details of a DNAT rule, and deleting a DNAT rule.

          +

          Tags

          +

          Tag NAT gateways. Tags help you manage the NAT gateways. You can query, add, and delete tags of NAT gateways.

          +

          API Version

          +

          Query all API versions or an API version.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 2 NAT gateway API (v2.0) description

          Type

          +

          API

          +

          Description

          +

          NAT Gateway Service

          +

          Creating a NAT Gateway

          +

          This API is used to create a NAT gateway.

          +

          Querying NAT Gateways

          +

          This API is used to query NAT gateways.

          +

          Querying Details of a NAT Gateway

          +

          This API is used to query details of a NAT gateway.

          +

          Updating a NAT Gateway

          +

          This API is used to update a NAT gateway.

          +

          Deleting a NAT Gateway

          +

          This API is used to delete a NAT gateway.

          +

          SNAT Rules

          +

          Creating an SNAT Rule

          +

          This API is used to create an SNAT rule.

          +

          Querying SNAT Rules

          +

          This API is used to query SNAT rules.

          +

          Querying Details of an SNAT Rule

          +

          This API is used to query details of an SNAT rule.

          +

          Deleting an SNAT Rule

          +

          This API is used to delete an SNAT rule.

          +

          DNAT Rules

          +

          Creating a DNAT Rule

          +

          This API is used to create a DNAT rule.

          +

          Querying DNAT Rules

          +

          This API is used to query DNAT rules.

          +

          Querying Details of a DNAT Rule

          +

          This API is used to query details of a DNAT rule.

          +

          Deleting a DNAT Rule

          +

          This API is used to delete a DNAT rule.

          +

          Tags

          +

          Querying NAT Gateways by Tag

          +

          This API is used to filter NAT gateways by tag.

          +

          Adding or Deleting NAT Gateway Tags in Batches

          +

          This API is used to add or remove tags to or from a NAT gateway.

          +

          Adding a NAT Gateway Tag

          +

          This API is used to add tags to a NAT gateway.

          +

          Deleting a NAT Gateway Tag

          +

          This API is used to delete NAT gateway tags.

          +

          Querying NAT Gateway Tags

          +

          This API is used to query tags of a NAT gateway.

          +

          Querying Tags in a Project

          +

          This API is used to query all tags of a resource type in a region.

          +

          API Version

          +

          Querying All API Versions

          +

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

          +

          Querying an API Version

          +

          This API is used to query an API version of NAT Gateway.

          +
          +
          +
          +
          +
          + diff --git a/docs/natgw/api-ref/nat_api_0061.html b/docs/natgw/api-ref/nat_api_0061.html index 8cce699b..8820b038 100644 --- a/docs/natgw/api-ref/nat_api_0061.html +++ b/docs/natgw/api-ref/nat_api_0061.html @@ -5,7 +5,7 @@

          URI

          POST /v2.0/nat_gateways

          -

          Request

          Table 1 describes the request parameters.

          +

          Request

          Table 1 describes the request parameter.

          @@ -75,8 +75,8 @@ @@ -193,7 +194,7 @@ - @@ -201,7 +202,42 @@ - + + + + + + + + + + + + + + + + + + + + @@ -230,12 +266,19 @@ "spec": "1", "internal_network_id": "89d66639-aacb-4929-969d-07080b0f9fd9", "id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", + "billinginfo": "", + "dnat_rules_limit": 200, + "snat_rule_public_ip_limit": 20, + "freeze_info": null, + "sys_tags": [ + "_sys_enterprise_project_id=0" + ], "name": "nat_001" } } -

          Status Code

          See Status Codes.

          +

          Status Codes

          See Status Codes.

          diff --git a/docs/natgw/api-ref/nat_api_0062.html b/docs/natgw/api-ref/nat_api_0062.html index f9786290..c0b750f2 100644 --- a/docs/natgw/api-ref/nat_api_0062.html +++ b/docs/natgw/api-ref/nat_api_0062.html @@ -1,7 +1,7 @@ -

          Querying Details About a Specified NAT Gateway

          -

          Function

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

          +

          Querying Details of a NAT Gateway

          +

          Function

          This API is used to query details of a NAT gateway.

          URI

          GET /v2.0/nat_gateways/{nat_gateway_id}

          @@ -30,7 +30,7 @@

          Request

          None

          -

          Response

          Table 2 lists response parameters.

          +

          Response

          Table 2 lists response parameter.

          Table 1 Request parameter

          Parameter

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

          The type 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

          @@ -164,7 +164,8 @@

          String

          Specifies the NAT gateway type.

          -

          The value can be:

          +

          The type 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.

          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.
            +
          • Specifies whether the NAT gateway is up or down.
          • The state can be:
            • true: The NAT gateway is up.
            • false: The NAT gateway is down.

          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.

          +

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

          +

          billinginfo

          +

          String

          +

          Specifies the order information. This parameter is left blank by default.

          +

          freeze_info

          +

          String

          +

          Specifies information about the frozen NAT gateway.

          +

          sys_tags

          +

          List<String>

          +

          Specifies the ID of the enterprise project associated with the NAT gateway when the NAT gateway is created.

          +

          snat_rule_public_ip_limit

          +

          Integer

          +

          Specifies the maximum number of EIPs in an SNAT rule on a NAT gateway. The default value is 20.

          +

          dnat_rules_limit

          +

          Long

          +

          Specifies the maximum number of DNAT rules on a NAT gateway. The default value is 200.

          @@ -51,7 +51,7 @@
          Table 2 Response parameter

          Parameter

          -
          Table 3 Description of the nat_gateway field

          Parameter

          +
          @@ -92,10 +92,10 @@ - - + + + + + + + + + + + + + + + + + + + + @@ -152,11 +187,18 @@ "spec": "1", "internal_network_id": "89d66639-aacb-4929-969d-07080b0f9fd9", "id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8", + "billinginfo": "", + "dnat_rules_limit": 200, + "snat_rule_public_ip_limit": 20, + "freeze_info": null, + "sys_tags": [ + "_sys_enterprise_project_id=0" + ], "name": "nat_001" } } -

          Status Code

          See Status Codes.

          +

          Status Codes

          See Status Codes.

          diff --git a/docs/natgw/api-ref/nat_api_0063.html b/docs/natgw/api-ref/nat_api_0063.html new file mode 100644 index 00000000..9050aa89 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0063.html @@ -0,0 +1,20 @@ + + +

          Introduction

          +

          This section describes fine-grained permissions management for your NAT gateways. If your account does not need individual IAM users, then you may skip this section.

          +

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

          +

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

          +
          +

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

          +

          Supported Actions

          NAT Gateway provides system-defined policies, which can be directly used in IAM. The account administrator can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:

          +
          • Permissions: Statements in a policy that allow or deny certain operations.
          • APIs: REST APIs that can be called by a user who has been granted specific permissions.
          • Actions: Specific operations that are allowed or denied.
          • IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. The account administrator can check whether an action supports IAM projects or enterprise projects in the action list. The check mark (√) indicates that the action supports the project and the cross symbol (×) indicates that the action does not support the project.
          +

          NAT Gateway supports the following actions that can be defined in custom policies:

          +
          • NAT Gateway v2.0, including actions supported by all APIs of NAT Gateway, such as creating, updating, and deleting a NAT gateway.
          • SNAT Rule v2.0, including actions supported by all APIs of the SNAT rule, such as creating an SNAT rule and querying SNAT rules.
          • DNAT Rule v2.0, including actions supported by all APIs of the DNAT rule, such as creating a DNAT rule and querying DNAT rules.
          • NAT Gateway Tag v2.0, including actions supported by NAT Gateway tags, such as adding a tag to a NAT gateway and querying NAT gateway tags.
          +
          +
          + + diff --git a/docs/natgw/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/natgw/api-ref/public_sys-resources/icon-arrowdn.gif index 84eec9be..37942803 100644 Binary files a/docs/natgw/api-ref/public_sys-resources/icon-arrowdn.gif 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 index 39583d16..6aaaa11c 100644 Binary files a/docs/natgw/api-ref/public_sys-resources/icon-arrowrt.gif and b/docs/natgw/api-ref/public_sys-resources/icon-arrowrt.gif differ
          Table 3 Description of the nat_gateway field

          Parameter

          Type

          String

          Specifies the NAT gateway type.

          +

          Specifies the NAT gateway specifications.

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

          @@ -131,7 +131,42 @@

          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.

          +

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

          +

          billinginfo

          +

          String

          +

          Specifies the order information. This parameter is left blank by default.

          +

          freeze_info

          +

          String

          +

          Specifies information about the frozen NAT gateway.

          +

          sys_tags

          +

          List<String>

          +

          Specifies the ID of the enterprise project associated with the NAT gateway when the NAT gateway is created.

          +

          snat_rule_public_ip_limit

          +

          Integer

          +

          Specifies the maximum number of EIPs in an SNAT rule on a NAT gateway. The default value is 20.

          +

          dnat_rules_limit

          +

          Long

          +

          Specifies the maximum number of DNAT rules on a NAT gateway. The default value is 200.