From f463d397b5065586bab7891284414e69fd8f5ed0 Mon Sep 17 00:00:00 2001 From: zhoumeng35 Date: Mon, 5 May 2025 12:02:05 +0000 Subject: [PATCH] NAT api 0920 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reviewed-by: Hajba, László Antal Co-authored-by: zhoumeng35 Co-committed-by: zhoumeng35 --- docs/natgw/api-ref/ALL_META.TXT.json | 928 ++++++- .../BatchCreateDeletePrivateNatTags.html | 206 ++ .../BatchCreateDeleteTransitIpTags.html | 206 ++ docs/natgw/api-ref/CLASS.TXT.json | 449 +++- docs/natgw/api-ref/CreatePrivateDnat.html | 417 ++++ docs/natgw/api-ref/CreatePrivateNat.html | 517 ++++ docs/natgw/api-ref/CreatePrivateNatTag.html | 165 ++ docs/natgw/api-ref/CreatePrivateSnat.html | 357 +++ docs/natgw/api-ref/CreateTransitIp.html | 377 +++ docs/natgw/api-ref/CreateTransitIpTag.html | 165 ++ docs/natgw/api-ref/DeletePrivateDnat.html | 98 + docs/natgw/api-ref/DeletePrivateNat.html | 98 + docs/natgw/api-ref/DeletePrivateNatTag.html | 110 + docs/natgw/api-ref/DeletePrivateSnat.html | 98 + docs/natgw/api-ref/DeleteTransitIp.html | 98 + docs/natgw/api-ref/DeleteTransitIpTag.html | 110 + docs/natgw/api-ref/ErrorCode.html | 2191 +++++++++++++++++ docs/natgw/api-ref/ListPrivateDnats.html | 538 ++++ docs/natgw/api-ref/ListPrivateNatTags.html | 160 ++ docs/natgw/api-ref/ListPrivateNats.html | 547 ++++ docs/natgw/api-ref/ListPrivateNatsByTags.html | 403 +++ docs/natgw/api-ref/ListPrivateSnats.html | 450 ++++ docs/natgw/api-ref/ListTransitIpTags.html | 160 ++ docs/natgw/api-ref/ListTransitIps.html | 446 ++++ docs/natgw/api-ref/ListTransitIpsByTags.html | 403 +++ docs/natgw/api-ref/PrivateNat.html | 24 + docs/natgw/api-ref/PrivateNatDnat.html | 24 + docs/natgw/api-ref/PrivateNatSnat.html | 24 + docs/natgw/api-ref/PrivateNatTags.html | 26 + docs/natgw/api-ref/PrivateNatTransitIp.html | 22 + .../api-ref/PrivateNatTransitIpTags.html | 26 + docs/natgw/api-ref/ShowPrivateDnat.html | 290 +++ docs/natgw/api-ref/ShowPrivateNat.html | 336 +++ docs/natgw/api-ref/ShowPrivateNatTags.html | 164 ++ docs/natgw/api-ref/ShowPrivateSnat.html | 269 ++ docs/natgw/api-ref/ShowTransitIp.html | 266 ++ docs/natgw/api-ref/ShowTransitIpTags.html | 164 ++ docs/natgw/api-ref/UpdatePrivateDnat.html | 412 ++++ docs/natgw/api-ref/UpdatePrivateNat.html | 422 ++++ docs/natgw/api-ref/UpdatePrivateSnat.html | 332 +++ docs/natgw/api-ref/nat_api_0000.html | 2 +- docs/natgw/api-ref/nat_api_0001.html | 2 +- docs/natgw/api-ref/nat_api_0002.html | 10 +- docs/natgw/api-ref/nat_api_0003.html | 12 +- docs/natgw/api-ref/nat_api_0005.html | 2 +- docs/natgw/api-ref/nat_api_0006.html | 16 +- docs/natgw/api-ref/nat_api_0007.html | 14 +- docs/natgw/api-ref/nat_api_0008.html | 4 +- docs/natgw/api-ref/nat_api_0010.html | 2 +- docs/natgw/api-ref/nat_api_0011.html | 16 +- docs/natgw/api-ref/nat_api_0012.html | 6 +- docs/natgw/api-ref/nat_api_0013.html | 4 +- docs/natgw/api-ref/nat_api_0015.html | 2 +- docs/natgw/api-ref/nat_api_0016.html | 10 +- docs/natgw/api-ref/nat_api_0024.html | 2 +- docs/natgw/api-ref/nat_api_0027.html | 12 + docs/natgw/api-ref/nat_api_0032.html | 10 +- docs/natgw/api-ref/nat_api_0033.html | 8 +- docs/natgw/api-ref/nat_api_0034.html | 8 +- docs/natgw/api-ref/nat_api_0036.html | 2 + docs/natgw/api-ref/nat_api_0040.html | 2 +- docs/natgw/api-ref/nat_api_0046.html | 20 +- docs/natgw/api-ref/nat_api_0047.html | 6 +- docs/natgw/api-ref/nat_api_0052.html | 294 ++- docs/natgw/api-ref/nat_api_0061.html | 3 +- docs/natgw/api-ref/nat_api_0062.html | 10 +- docs/natgw/api-ref/nat_api_0063.html | 6 +- docs/natgw/api-ref/nat_api_0070.html | 69 + docs/natgw/api-ref/nat_api_0071.html | 60 + docs/natgw/api-ref/nat_api_0072.html | 69 + docs/natgw/api-ref/nat_api_0073.html | 69 + docs/natgw/api-ref/nat_api_0074.html | 82 + docs/natgw/api-ref/nat_api_0075.html | 84 + docs/natgw/api-ref/nat_private_0000.html | 22 + 74 files changed, 13207 insertions(+), 231 deletions(-) create mode 100644 docs/natgw/api-ref/BatchCreateDeletePrivateNatTags.html create mode 100644 docs/natgw/api-ref/BatchCreateDeleteTransitIpTags.html create mode 100644 docs/natgw/api-ref/CreatePrivateDnat.html create mode 100644 docs/natgw/api-ref/CreatePrivateNat.html create mode 100644 docs/natgw/api-ref/CreatePrivateNatTag.html create mode 100644 docs/natgw/api-ref/CreatePrivateSnat.html create mode 100644 docs/natgw/api-ref/CreateTransitIp.html create mode 100644 docs/natgw/api-ref/CreateTransitIpTag.html create mode 100644 docs/natgw/api-ref/DeletePrivateDnat.html create mode 100644 docs/natgw/api-ref/DeletePrivateNat.html create mode 100644 docs/natgw/api-ref/DeletePrivateNatTag.html create mode 100644 docs/natgw/api-ref/DeletePrivateSnat.html create mode 100644 docs/natgw/api-ref/DeleteTransitIp.html create mode 100644 docs/natgw/api-ref/DeleteTransitIpTag.html create mode 100644 docs/natgw/api-ref/ErrorCode.html create mode 100644 docs/natgw/api-ref/ListPrivateDnats.html create mode 100644 docs/natgw/api-ref/ListPrivateNatTags.html create mode 100644 docs/natgw/api-ref/ListPrivateNats.html create mode 100644 docs/natgw/api-ref/ListPrivateNatsByTags.html create mode 100644 docs/natgw/api-ref/ListPrivateSnats.html create mode 100644 docs/natgw/api-ref/ListTransitIpTags.html create mode 100644 docs/natgw/api-ref/ListTransitIps.html create mode 100644 docs/natgw/api-ref/ListTransitIpsByTags.html create mode 100644 docs/natgw/api-ref/PrivateNat.html create mode 100644 docs/natgw/api-ref/PrivateNatDnat.html create mode 100644 docs/natgw/api-ref/PrivateNatSnat.html create mode 100644 docs/natgw/api-ref/PrivateNatTags.html create mode 100644 docs/natgw/api-ref/PrivateNatTransitIp.html create mode 100644 docs/natgw/api-ref/PrivateNatTransitIpTags.html create mode 100644 docs/natgw/api-ref/ShowPrivateDnat.html create mode 100644 docs/natgw/api-ref/ShowPrivateNat.html create mode 100644 docs/natgw/api-ref/ShowPrivateNatTags.html create mode 100644 docs/natgw/api-ref/ShowPrivateSnat.html create mode 100644 docs/natgw/api-ref/ShowTransitIp.html create mode 100644 docs/natgw/api-ref/ShowTransitIpTags.html create mode 100644 docs/natgw/api-ref/UpdatePrivateDnat.html create mode 100644 docs/natgw/api-ref/UpdatePrivateNat.html create mode 100644 docs/natgw/api-ref/UpdatePrivateSnat.html create mode 100644 docs/natgw/api-ref/nat_api_0070.html create mode 100644 docs/natgw/api-ref/nat_api_0071.html create mode 100644 docs/natgw/api-ref/nat_api_0072.html create mode 100644 docs/natgw/api-ref/nat_api_0073.html create mode 100644 docs/natgw/api-ref/nat_api_0074.html create mode 100644 docs/natgw/api-ref/nat_api_0075.html create mode 100644 docs/natgw/api-ref/nat_private_0000.html diff --git a/docs/natgw/api-ref/ALL_META.TXT.json b/docs/natgw/api-ref/ALL_META.TXT.json index 9a863d31d..e15849c9d 100644 --- a/docs/natgw/api-ref/ALL_META.TXT.json +++ b/docs/natgw/api-ref/ALL_META.TXT.json @@ -7,7 +7,7 @@ "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 ", + "des":"Public cloud Application Programming Interfaces (APIs) comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource ", "doc_type":"api", "kw":"API Usage Guidelines,API Reference", "search_title":"", @@ -15,7 +15,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"API Usage Guidelines", @@ -26,7 +26,7 @@ "node_id":"nat_api_0052.xml", "product_code":"nat", "code":"2", - "des":"NAT Gateway APIs allow you to use all NAT Gateway functions.", + "des":"NAT Gateway APIs allow you to use all NAT Gateway functions.If null will be returned for a request parameter, this parameter will not be returned in the response body.", "doc_type":"api", "kw":"API Overview,API Reference", "search_title":"", @@ -34,7 +34,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"API Overview", @@ -47,16 +47,16 @@ "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", + "kw":"APIs for Public NAT Gateways (v2.0)", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], - "title":"API v2.0", + "title":"APIs for Public NAT Gateways (v2.0)", "githuburl":"" }, { @@ -72,7 +72,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"NAT Gateway Service", @@ -91,7 +91,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Creating a NAT Gateway", @@ -110,7 +110,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying NAT Gateways", @@ -129,7 +129,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying Details of a NAT Gateway", @@ -148,7 +148,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Updating a NAT Gateway", @@ -167,7 +167,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Deleting a NAT Gateway", @@ -186,7 +186,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"SNAT Rules", @@ -205,7 +205,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Creating an SNAT Rule", @@ -224,7 +224,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying SNAT Rules", @@ -243,7 +243,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying Details of an SNAT Rule", @@ -262,7 +262,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Deleting an SNAT Rule", @@ -281,7 +281,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"DNAT Rules", @@ -300,7 +300,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Creating a DNAT Rule", @@ -319,7 +319,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying DNAT Rules", @@ -338,7 +338,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying Details of a DNAT Rule", @@ -357,7 +357,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Deleting a DNAT Rule", @@ -376,7 +376,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Tags", @@ -395,7 +395,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying NAT Gateways by Tag", @@ -414,7 +414,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Adding or Deleting NAT Gateway Tags in Batches", @@ -433,7 +433,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Adding a NAT Gateway Tag", @@ -452,7 +452,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Deleting a NAT Gateway Tag", @@ -471,7 +471,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying NAT Gateway Tags", @@ -490,7 +490,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying Tags in a Project", @@ -509,7 +509,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"API Version", @@ -528,7 +528,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying All API Versions", @@ -547,17 +547,702 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Querying an API Version", "githuburl":"" }, + { + "uri":"nat_private_0000.html", + "node_id":"nat_private_0000.xml", + "product_code":"nat", + "code":"30", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"APIs for Private NAT Gateways (v3.0)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"true;false" + } + ], + "title":"APIs for Private NAT Gateways (v3.0)", + "githuburl":"" + }, + { + "uri":"PrivateNat.html", + "node_id":"privatenat.xml", + "product_code":"NAT", + "code":"31", + "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":"Private NAT Gateways", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Private NAT Gateways", + "githuburl":"" + }, + { + "uri":"ListPrivateNats.html", + "node_id":"listprivatenats.xml", + "product_code":"NAT", + "code":"32", + "des":"This API is used to query private NAT gateways.You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria.All optional ", + "doc_type":"api", + "kw":"Querying Private NAT Gateways,Private NAT Gateways,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Private NAT Gateways", + "githuburl":"" + }, + { + "uri":"UpdatePrivateNat.html", + "node_id":"updateprivatenat.xml", + "product_code":"NAT", + "code":"33", + "des":"This API is used to update a private NAT gateway.PUT /v3/{project_id}/private-nat/gateways/{gateway_id}Status code: 200Updating a private NAT gateway. (Setting name to pr", + "doc_type":"api", + "kw":"Updating a Private NAT Gateway,Private NAT Gateways,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Updating a Private NAT Gateway", + "githuburl":"" + }, + { + "uri":"DeletePrivateNat.html", + "node_id":"deleteprivatenat.xml", + "product_code":"NAT", + "code":"34", + "des":"This API is used to delete a private NAT gateway.DELETE /v3/{project_id}/private-nat/gateways/{gateway_id}Status code: 204Private NAT gateway deleted.NoneNoneSee Error Co", + "doc_type":"api", + "kw":"Deleting a Private NAT Gateway,Private NAT Gateways,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Deleting a Private NAT Gateway", + "githuburl":"" + }, + { + "uri":"CreatePrivateNat.html", + "node_id":"createprivatenat.xml", + "product_code":"NAT", + "code":"35", + "des":"This API is used to create a private NAT gateway.POST /v3/{project_id}/private-nat/gatewaysStatus code: 201Creating a private NAT gateway (Setting name to private-nat-gat", + "doc_type":"api", + "kw":"Creating a Private NAT Gateway,Private NAT Gateways,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Creating a Private NAT Gateway", + "githuburl":"" + }, + { + "uri":"ShowPrivateNat.html", + "node_id":"showprivatenat.xml", + "product_code":"NAT", + "code":"36", + "des":"This API is used to query details about a specified private NAT gateway.GET /v3/{project_id}/private-nat/gateways/{gateway_id}Status code: 200Status code: 200Details abou", + "doc_type":"api", + "kw":"Querying Details About a Specified Private NAT Gateway,Private NAT Gateways,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Details About a Specified Private NAT Gateway", + "githuburl":"" + }, + { + "uri":"PrivateNatDnat.html", + "node_id":"privatenatdnat.xml", + "product_code":"NAT", + "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":"DNAT Rules", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"DNAT Rules", + "githuburl":"" + }, + { + "uri":"ListPrivateDnats.html", + "node_id":"listprivatednats.xml", + "product_code":"NAT", + "code":"38", + "des":"This API is used to query DNAT rules.You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria.All optional parameters", + "doc_type":"api", + "kw":"Querying DNAT Rules,DNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying DNAT Rules", + "githuburl":"" + }, + { + "uri":"UpdatePrivateDnat.html", + "node_id":"updateprivatednat.xml", + "product_code":"NAT", + "code":"39", + "des":"This API is used to update a specified DNAT rule.PUT /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}Status code: 200Updating a DNAT rule (Updating description to m", + "doc_type":"api", + "kw":"Updating a DNAT Rule,DNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Updating a DNAT Rule", + "githuburl":"" + }, + { + "uri":"CreatePrivateDnat.html", + "node_id":"createprivatednat.xml", + "product_code":"NAT", + "code":"40", + "des":"This API is used to create a DNAT rule.When you are creating a DNAT rule, status of the NAT gateway must be set to ACTIVE.POST /v3/{project_id}/private-nat/dnat-rulesStat", + "doc_type":"api", + "kw":"Creating a DNAT Rule,DNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Creating a DNAT Rule", + "githuburl":"" + }, + { + "uri":"DeletePrivateDnat.html", + "node_id":"deleteprivatednat.xml", + "product_code":"NAT", + "code":"41", + "des":"This API is used to delete a specified DNAT rule.DELETE /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}Status code: 204DNAT rule deleted.NoneNoneSee Error Codes.", + "doc_type":"api", + "kw":"Deleting a DNAT Rule,DNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Deleting a DNAT Rule", + "githuburl":"" + }, + { + "uri":"ShowPrivateDnat.html", + "node_id":"showprivatednat.xml", + "product_code":"NAT", + "code":"42", + "des":"This API is used to query details about a specified DNAT rule.GET /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}Status code: 200Status code: 200DNAT rule details ", + "doc_type":"api", + "kw":"Querying Details About a Specified DNAT Rule,DNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Details About a Specified DNAT Rule", + "githuburl":"" + }, + { + "uri":"PrivateNatSnat.html", + "node_id":"privatenatsnat.xml", + "product_code":"NAT", + "code":"43", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"SNAT Rules", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"SNAT Rules", + "githuburl":"" + }, + { + "uri":"ListPrivateSnats.html", + "node_id":"listprivatesnats.xml", + "product_code":"NAT", + "code":"44", + "des":"This API is used to query SNAT rules.GET /v3/{project_id}/private-nat/snat-rulesStatus code: 200Status code: 200SNAT rules queried.See Error Codes.", + "doc_type":"api", + "kw":"Querying SNAT Rules,SNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying SNAT Rules", + "githuburl":"" + }, + { + "uri":"ShowPrivateSnat.html", + "node_id":"showprivatesnat.xml", + "product_code":"NAT", + "code":"45", + "des":"This API is used to query details about a specified SNAT rule.GET /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}Status code: 200Status code: 200SNAT rule details ", + "doc_type":"api", + "kw":"Querying Details About a Specified SNAT Rule,SNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Details About a Specified SNAT Rule", + "githuburl":"" + }, + { + "uri":"UpdatePrivateSnat.html", + "node_id":"updateprivatesnat.xml", + "product_code":"NAT", + "code":"46", + "des":"This API is used to update a specified SNAT rule.PUT /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}Status code: 200Updating an SNAT rule (Setting transit_ip_ids t", + "doc_type":"api", + "kw":"Updating an SNAT Rule,SNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Updating an SNAT Rule", + "githuburl":"" + }, + { + "uri":"CreatePrivateSnat.html", + "node_id":"createprivatesnat.xml", + "product_code":"NAT", + "code":"47", + "des":"This API is used to create an SNAT rule.When you are creating an SNAT rule, status of the NAT gateway must be set to ACTIVE.POST /v3/{project_id}/private-nat/snat-rulesSt", + "doc_type":"api", + "kw":"Creating an SNAT Rule,SNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Creating an SNAT Rule", + "githuburl":"" + }, + { + "uri":"DeletePrivateSnat.html", + "node_id":"deleteprivatesnat.xml", + "product_code":"NAT", + "code":"48", + "des":"This API is used to delete a specified SNAT rule.DELETE /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}Status code: 204SNAT rule deleted.NoneNoneSee Error Codes.", + "doc_type":"api", + "kw":"Deleting an SNAT Rule,SNAT Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Deleting an SNAT Rule", + "githuburl":"" + }, + { + "uri":"PrivateNatTransitIp.html", + "node_id":"privatenattransitip.xml", + "product_code":"NAT", + "code":"49", + "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":"Transit IP Addresses", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Transit IP Addresses", + "githuburl":"" + }, + { + "uri":"ListTransitIps.html", + "node_id":"listtransitips.xml", + "product_code":"NAT", + "code":"50", + "des":"This API is to query transit IP addresses.You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria.All optional param", + "doc_type":"api", + "kw":"Querying Transit IP Addresses,Transit IP Addresses,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Transit IP Addresses", + "githuburl":"" + }, + { + "uri":"DeleteTransitIp.html", + "node_id":"deletetransitip.xml", + "product_code":"NAT", + "code":"51", + "des":"This API is used to release a transit IP address.DELETE /v3/{project_id}/private-nat/transit-ips/{transit_ip_id}Status code: 204Transit IP address released.NoneNoneSee Er", + "doc_type":"api", + "kw":"Releasing a Transit IP Address,Transit IP Addresses,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Releasing a Transit IP Address", + "githuburl":"" + }, + { + "uri":"CreateTransitIp.html", + "node_id":"createtransitip.xml", + "product_code":"NAT", + "code":"52", + "des":"This API is used to assign a transit IP address.POST /v3/{project_id}/private-nat/transit-ipsStatus code: 201Assigning a transit IP address (Setting virsubnet_id to 2759d", + "doc_type":"api", + "kw":"Assigning a Transit IP Address,Transit IP Addresses,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Assigning a Transit IP Address", + "githuburl":"" + }, + { + "uri":"ShowTransitIp.html", + "node_id":"showtransitip.xml", + "product_code":"NAT", + "code":"53", + "des":"This API is used to query details about a specified transit IP address.GET /v3/{project_id}/private-nat/transit-ips/{transit_ip_id}Status code: 200Status code: 200Details", + "doc_type":"api", + "kw":"Querying Details About a Specified Transit IP Address,Transit IP Addresses,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Details About a Specified Transit IP Address", + "githuburl":"" + }, + { + "uri":"PrivateNatTags.html", + "node_id":"privatenattags.xml", + "product_code":"NAT", + "code":"54", + "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":"Private NAT Gateway Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Private NAT Gateway Tags", + "githuburl":"" + }, + { + "uri":"ListPrivateNatsByTags.html", + "node_id":"listprivatenatsbytags.xml", + "product_code":"NAT", + "code":"55", + "des":"This API is used to query private NAT gateways by tag.This API is used to query private NAT gateways by tag.Tag Management Service (TMS) uses this API to filter and list ", + "doc_type":"api", + "kw":"Querying Private NAT Gateways,Private NAT Gateway Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Private NAT Gateways", + "githuburl":"" + }, + { + "uri":"ListPrivateNatTags.html", + "node_id":"listprivatenattags.xml", + "product_code":"NAT", + "code":"56", + "des":"This API is used to query tags of all private NAT gateways owned by a tenant in a project.This API is used to query tags of all private NAT gateways owned by a tenant in ", + "doc_type":"api", + "kw":"Querying Tags of All Private NAT Gateways in a Project,Private NAT Gateway Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Tags of All Private NAT Gateways in a Project", + "githuburl":"" + }, + { + "uri":"ShowPrivateNatTags.html", + "node_id":"showprivatenattags.xml", + "product_code":"NAT", + "code":"57", + "des":"This API is used to query tags of a private NAT gateway.This API is used to query tags of a private NAT gateway.TMS uses this API to query all tags of a private NAT gatew", + "doc_type":"api", + "kw":"Querying Tags of a Private NAT Gateway,Private NAT Gateway Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Tags of a Private NAT Gateway", + "githuburl":"" + }, + { + "uri":"CreatePrivateNatTag.html", + "node_id":"createprivatenattag.xml", + "product_code":"NAT", + "code":"58", + "des":"This API is used to add tags to a private NAT gateway.This API is used to add tags to a private NAT gateway.A private NAT gateway can have up to 20 tags.A private NAT gat", + "doc_type":"api", + "kw":"Adding a Tag to a Private NAT Gateway,Private NAT Gateway Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Adding a Tag to a Private NAT Gateway", + "githuburl":"" + }, + { + "uri":"BatchCreateDeletePrivateNatTags.html", + "node_id":"batchcreatedeleteprivatenattags.xml", + "product_code":"NAT", + "code":"59", + "des":"This API is used to batch add or delete tags to or from a private NAT gateway.This API is used to batch add or delete tags to or from a private NAT gateway.TMS uses this ", + "doc_type":"api", + "kw":"Batch Adding or Deleting Tags to or from a Private NAT Gateway,Private NAT Gateway Tags,API Referenc", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Batch Adding or Deleting Tags to or from a Private NAT Gateway", + "githuburl":"" + }, + { + "uri":"DeletePrivateNatTag.html", + "node_id":"deleteprivatenattag.xml", + "product_code":"NAT", + "code":"60", + "des":"This API is idempotent.This API is idempotent.When a tag is deleted, the tag character set is not verified. Before calling this API, perform the encodeURI operation. The ", + "doc_type":"api", + "kw":"Deleting a Tag from a Private NAT Gateway,Private NAT Gateway Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Deleting a Tag from a Private NAT Gateway", + "githuburl":"" + }, + { + "uri":"PrivateNatTransitIpTags.html", + "node_id":"privatenattransitiptags.xml", + "product_code":"NAT", + "code":"61", + "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":"Transit IP Address Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Transit IP Address Tags", + "githuburl":"" + }, + { + "uri":"ListTransitIpsByTags.html", + "node_id":"listtransitipsbytags.xml", + "product_code":"NAT", + "code":"62", + "des":"This API is used to query transit IP addresses by tag.This API is used to query transit IP addresses by tag.TMS uses this API to filter and list transit IP addresses by t", + "doc_type":"api", + "kw":"Querying Transit IP Addresses by Tag,Transit IP Address Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Transit IP Addresses by Tag", + "githuburl":"" + }, + { + "uri":"ListTransitIpTags.html", + "node_id":"listtransitiptags.xml", + "product_code":"NAT", + "code":"63", + "des":"This API is used to query tags of all transit IP addresses owned by a tenant in a project.This API is used to query tags of all transit IP addresses owned by a tenant in ", + "doc_type":"api", + "kw":"Querying Tags of All Transit IP Addresses in a Specified Project,Transit IP Address Tags,API Referen", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Tags of All Transit IP Addresses in a Specified Project", + "githuburl":"" + }, + { + "uri":"ShowTransitIpTags.html", + "node_id":"showtransitiptags.xml", + "product_code":"NAT", + "code":"64", + "des":"This API is used to query tags of a specified transit IP address.This API is used to query tags of a specified transit IP address.TMS uses this API to query all tags of a", + "doc_type":"api", + "kw":"Querying Tags of a Transit IP Address,Transit IP Address Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Querying Tags of a Transit IP Address", + "githuburl":"" + }, + { + "uri":"CreateTransitIpTag.html", + "node_id":"createtransitiptag.xml", + "product_code":"NAT", + "code":"65", + "des":"This API is used to add a tag to a transit IP address.This API is used to add a tag to a transit IP address.A transit IP address can have up to 20 tags.A transit IP addre", + "doc_type":"api", + "kw":"Adding a Tag to a Transit IP Address,Transit IP Address Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Adding a Tag to a Transit IP Address", + "githuburl":"" + }, + { + "uri":"BatchCreateDeleteTransitIpTags.html", + "node_id":"batchcreatedeletetransitiptags.xml", + "product_code":"NAT", + "code":"66", + "des":"This API is used to batch add or delete tags to or from a transit IP address.This API is used to batch add or delete tags to or from a transit IP address.TMS needs to use", + "doc_type":"api", + "kw":"Batch Adding or Deleting Tags to or from a Transit IP Address,Transit IP Address Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Batch Adding or Deleting Tags to or from a Transit IP Address", + "githuburl":"" + }, + { + "uri":"DeleteTransitIpTag.html", + "node_id":"deletetransitiptag.xml", + "product_code":"NAT", + "code":"67", + "des":"This API is idempotent.This API is idempotent.When a tag is deleted, the tag character set is not verified. Before calling this API, perform the encodeURI operation. The ", + "doc_type":"api", + "kw":"Deleting a Tag from a Transit IP Address,Transit IP Address Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"NAT" + } + ], + "title":"Deleting a Tag from a Transit IP Address", + "githuburl":"" + }, { "uri":"nat_api_0027.html", "node_id":"nat_api_0027.xml", "product_code":"nat", - "code":"30", + "code":"68", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Permissions Policies and Supported Actions", @@ -566,7 +1251,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Permissions Policies and Supported Actions", @@ -576,7 +1261,7 @@ "uri":"nat_api_0063.html", "node_id":"nat_api_0063.xml", "product_code":"nat", - "code":"31", + "code":"69", "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", @@ -585,7 +1270,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Introduction", @@ -595,7 +1280,7 @@ "uri":"nat_api_0032.html", "node_id":"nat_api_0032.xml", "product_code":"nat", - "code":"32", + "code":"70", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"NAT Gateway v2.0,Permissions Policies and Supported Actions,API Reference", @@ -604,7 +1289,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"NAT Gateway v2.0", @@ -614,7 +1299,7 @@ "uri":"nat_api_0033.html", "node_id":"nat_api_0033.xml", "product_code":"nat", - "code":"33", + "code":"71", "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", @@ -623,7 +1308,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"SNAT Rule v2.0", @@ -633,7 +1318,7 @@ "uri":"nat_api_0034.html", "node_id":"nat_api_0034.xml", "product_code":"nat", - "code":"34", + "code":"72", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"DNAT Rule v2.0,Permissions Policies and Supported Actions,API Reference", @@ -642,7 +1327,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"DNAT Rule v2.0", @@ -652,7 +1337,7 @@ "uri":"nat_api_0035.html", "node_id":"nat_api_0035.xml", "product_code":"nat", - "code":"35", + "code":"73", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"NAT Gateway Tag v2.0,Permissions Policies and Supported Actions,API Reference", @@ -661,17 +1346,131 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"NAT Gateway Tag v2.0", "githuburl":"" }, + { + "uri":"nat_api_0070.html", + "node_id":"nat_api_0070.xml", + "product_code":"nat", + "code":"74", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Private NAT Gateways,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"true;false" + } + ], + "title":"Private NAT Gateways", + "githuburl":"" + }, + { + "uri":"nat_api_0071.html", + "node_id":"nat_api_0071.xml", + "product_code":"nat", + "code":"75", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Private NAT Gateway - Transit IP Address,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"true;false" + } + ], + "title":"Private NAT Gateway - Transit IP Address", + "githuburl":"" + }, + { + "uri":"nat_api_0072.html", + "node_id":"nat_api_0072.xml", + "product_code":"nat", + "code":"76", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"SNAT Rules of Private NAT Gateways,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"true;false" + } + ], + "title":"SNAT Rules of Private NAT Gateways", + "githuburl":"" + }, + { + "uri":"nat_api_0073.html", + "node_id":"nat_api_0073.xml", + "product_code":"nat", + "code":"77", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"DNAT Rules of Private NAT Gateways,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"true;false" + } + ], + "title":"DNAT Rules of Private NAT Gateways", + "githuburl":"" + }, + { + "uri":"nat_api_0074.html", + "node_id":"nat_api_0074.xml", + "product_code":"nat", + "code":"78", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Private NAT Gateway - Tag,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"true;false" + } + ], + "title":"Private NAT Gateway - Tag", + "githuburl":"" + }, + { + "uri":"nat_api_0075.html", + "node_id":"nat_api_0075.xml", + "product_code":"nat", + "code":"79", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Private NAT Gateway - Transit IP Address Tag,Permissions Policies and Supported Actions,API Referenc", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"true;false" + } + ], + "title":"Private NAT Gateway - Transit IP Address Tag", + "githuburl":"" + }, { "uri":"nat_api_0036.html", "node_id":"nat_api_0036.xml", "product_code":"nat", - "code":"36", + "code":"80", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Common Parameters", @@ -680,7 +1479,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Common Parameters", @@ -690,7 +1489,7 @@ "uri":"nat_api_0038.html", "node_id":"nat_api_0038.xml", "product_code":"nat", - "code":"37", + "code":"81", "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", @@ -699,7 +1498,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Status Codes", @@ -709,7 +1508,7 @@ "uri":"nat_api_0040.html", "node_id":"nat_api_0040.xml", "product_code":"nat", - "code":"38", + "code":"82", "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", @@ -718,17 +1517,36 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Error Code Description v2.0", "githuburl":"" }, + { + "uri":"ErrorCode.html", + "node_id":"errorcode_1.xml", + "product_code":"nat", + "code":"83", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Error Codes,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"nat", + "opensource":"true;false" + } + ], + "title":"Error Codes", + "githuburl":"" + }, { "uri":"nat_api_0042.html", "node_id":"nat_api_0042.xml", "product_code":"nat", - "code":"39", + "code":"84", "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", @@ -737,7 +1555,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Resource Status Description", @@ -747,7 +1565,7 @@ "uri":"nat_api_0046.html", "node_id":"nat_api_0046.xml", "product_code":"nat", - "code":"40", + "code":"85", "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", @@ -756,7 +1574,7 @@ { "documenttype":"api", "prodname":"nat", - "opensource":"false" + "opensource":"true;false" } ], "title":"Change History", diff --git a/docs/natgw/api-ref/BatchCreateDeletePrivateNatTags.html b/docs/natgw/api-ref/BatchCreateDeletePrivateNatTags.html new file mode 100644 index 000000000..61f7cbb81 --- /dev/null +++ b/docs/natgw/api-ref/BatchCreateDeletePrivateNatTags.html @@ -0,0 +1,206 @@ + + +

Batch Adding or Deleting Tags to or from a Private NAT Gateway

+

Function

  • This API is used to batch add or delete tags to or from a private NAT gateway.

    +

  • TMS uses this API to batch manage tags of a private NAT gateway.

    +

  • A private NAT gateway can have up to 20 tags.

    +
+
+

Constraints

This API is idempotent.

+

  • If the request body contains duplicate keys, an error is reported.

    +

  • During tag creation, duplicate keys are not allowed. If a key already exists in the database, its value will be overwritten by the new duplicate key.

    +

  • During tag deletion, if some tags to be deleted do not exist, the operation is considered to be successful by default. The character set of the tags will not be verified.

    +

  • The tags structure cannot be missing during deletion. The key cannot be left blank or be an empty string.

    +
+
+

URI

POST /v3/{project_id}/private-nat-gateways/{resource_id}/tags/action

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_id

+

Yes

+

String

+

Specifies the private NAT gateway ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

Yes

+

String

+

Specifies the operation.

+

The value can be one of the following:

+

  • create

    +

  • delete

    +
+

Enumeration values:

+

  • create

    +

  • delete

    +
+

tags

+

Yes

+

Array of Tag objects

+

Specifies the tag list.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Tag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

Yes

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Response Parameters

Status code: 204

+

Tags added or deleted.

+

None

+
+

Example Requests

  • Adding tags to a private NAT gateway (Setting action to create and adding the following two tags: key1, value1 and key2, value2)

    +
    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action
+
+{
+  "action" : "create",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
    +

  • Deleting tags from a private NAT gateway (Setting action to delete and deleting the following two tags: key1, value1 and key2, value2)

    +
    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action
+
+{
+  "action" : "delete",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
    +
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Tags added or deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateway Tags
+
+
+ diff --git a/docs/natgw/api-ref/BatchCreateDeleteTransitIpTags.html b/docs/natgw/api-ref/BatchCreateDeleteTransitIpTags.html new file mode 100644 index 000000000..9b5e6f078 --- /dev/null +++ b/docs/natgw/api-ref/BatchCreateDeleteTransitIpTags.html @@ -0,0 +1,206 @@ + + +

Batch Adding or Deleting Tags to or from a Transit IP Address

+

Function

  • This API is used to batch add or delete tags to or from a transit IP address.

    +

  • TMS needs to use this API to batch manage tags of a specified transit IP address.

    +

  • A transit IP address can have up to 20 tags.

    +
+
+

Constraints

This API is idempotent.

+

  • If the request body contains duplicate keys, an error is reported.

    +

  • During tag creation, duplicate keys are not allowed. If a key already exists in the database, its value will be overwritten by the new duplicate key.

    +

  • During tag deletion, if some tags to be deleted do not exist, the operation is considered to be successful by default. The character set of the tags will not be verified.

    +

  • The tags structure cannot be missing during deletion. The key cannot be left blank or be an empty string.

    +
+
+

URI

POST /v3/{project_id}/transit-ips/{resource_id}/tags/action

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_id

+

Yes

+

String

+

Specifies the ID of the transit IP address.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

Yes

+

String

+

Specifies the operation.

+

The value can be one of the following:

+

  • create

    +

  • delete

    +
+

Enumeration values:

+

  • create

    +

  • delete

    +
+

tags

+

Yes

+

Array of Tag objects

+

Specifies the tag list.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Tag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

Yes

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Response Parameters

Status code: 204

+

Tags added or deleted.

+

None

+
+

Example Requests

  • Adding tags to a transit IP address (Setting action to create and adding the following two tags: key1, value1 and key2, value2)

    +
    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action
+
+{
+  "action" : "create",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
    +

  • Deleting tags of a transit IP address (Setting action to delete and deleting the following two tags: key1, value1 and key2, value2)

    +
    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action
+
+{
+  "action" : "delete",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
    +
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Tags added or deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Address Tags
+
+
+ diff --git a/docs/natgw/api-ref/CLASS.TXT.json b/docs/natgw/api-ref/CLASS.TXT.json index 1b17efb50..df9d6f347 100644 --- a/docs/natgw/api-ref/CLASS.TXT.json +++ b/docs/natgw/api-ref/CLASS.TXT.json @@ -1,6 +1,6 @@ [ { - "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", + "desc":"Public cloud Application Programming Interfaces (APIs) comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource ", "product_code":"nat", "title":"API Usage Guidelines", "uri":"nat_api_0047.html", @@ -9,7 +9,7 @@ "code":"1" }, { - "desc":"NAT Gateway APIs allow you to use all NAT Gateway functions.", + "desc":"NAT Gateway APIs allow you to use all NAT Gateway functions.If null will be returned for a request parameter, this parameter will not be returned in the response body.", "product_code":"nat", "title":"API Overview", "uri":"nat_api_0052.html", @@ -20,7 +20,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"nat", - "title":"API v2.0", + "title":"APIs for Public NAT Gateways (v2.0)", "uri":"nat_api_0000.html", "doc_type":"api", "p_code":"", @@ -260,6 +260,348 @@ "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.", + "product_code":"nat", + "title":"APIs for Private NAT Gateways (v3.0)", + "uri":"nat_private_0000.html", + "doc_type":"api", + "p_code":"", + "code":"30" + }, + { + "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":"Private NAT Gateways", + "uri":"PrivateNat.html", + "doc_type":"api", + "p_code":"30", + "code":"31" + }, + { + "desc":"This API is used to query private NAT gateways.You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria.All optional ", + "product_code":"NAT", + "title":"Querying Private NAT Gateways", + "uri":"ListPrivateNats.html", + "doc_type":"api", + "p_code":"31", + "code":"32" + }, + { + "desc":"This API is used to update a private NAT gateway.PUT /v3/{project_id}/private-nat/gateways/{gateway_id}Status code: 200Updating a private NAT gateway. (Setting name to pr", + "product_code":"NAT", + "title":"Updating a Private NAT Gateway", + "uri":"UpdatePrivateNat.html", + "doc_type":"api", + "p_code":"31", + "code":"33" + }, + { + "desc":"This API is used to delete a private NAT gateway.DELETE /v3/{project_id}/private-nat/gateways/{gateway_id}Status code: 204Private NAT gateway deleted.NoneNoneSee Error Co", + "product_code":"NAT", + "title":"Deleting a Private NAT Gateway", + "uri":"DeletePrivateNat.html", + "doc_type":"api", + "p_code":"31", + "code":"34" + }, + { + "desc":"This API is used to create a private NAT gateway.POST /v3/{project_id}/private-nat/gatewaysStatus code: 201Creating a private NAT gateway (Setting name to private-nat-gat", + "product_code":"NAT", + "title":"Creating a Private NAT Gateway", + "uri":"CreatePrivateNat.html", + "doc_type":"api", + "p_code":"31", + "code":"35" + }, + { + "desc":"This API is used to query details about a specified private NAT gateway.GET /v3/{project_id}/private-nat/gateways/{gateway_id}Status code: 200Status code: 200Details abou", + "product_code":"NAT", + "title":"Querying Details About a Specified Private NAT Gateway", + "uri":"ShowPrivateNat.html", + "doc_type":"api", + "p_code":"31", + "code":"36" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"NAT", + "title":"DNAT Rules", + "uri":"PrivateNatDnat.html", + "doc_type":"api", + "p_code":"30", + "code":"37" + }, + { + "desc":"This API is used to query DNAT rules.You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria.All optional parameters", + "product_code":"NAT", + "title":"Querying DNAT Rules", + "uri":"ListPrivateDnats.html", + "doc_type":"api", + "p_code":"37", + "code":"38" + }, + { + "desc":"This API is used to update a specified DNAT rule.PUT /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}Status code: 200Updating a DNAT rule (Updating description to m", + "product_code":"NAT", + "title":"Updating a DNAT Rule", + "uri":"UpdatePrivateDnat.html", + "doc_type":"api", + "p_code":"37", + "code":"39" + }, + { + "desc":"This API is used to create a DNAT rule.When you are creating a DNAT rule, status of the NAT gateway must be set to ACTIVE.POST /v3/{project_id}/private-nat/dnat-rulesStat", + "product_code":"NAT", + "title":"Creating a DNAT Rule", + "uri":"CreatePrivateDnat.html", + "doc_type":"api", + "p_code":"37", + "code":"40" + }, + { + "desc":"This API is used to delete a specified DNAT rule.DELETE /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}Status code: 204DNAT rule deleted.NoneNoneSee Error Codes.", + "product_code":"NAT", + "title":"Deleting a DNAT Rule", + "uri":"DeletePrivateDnat.html", + "doc_type":"api", + "p_code":"37", + "code":"41" + }, + { + "desc":"This API is used to query details about a specified DNAT rule.GET /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}Status code: 200Status code: 200DNAT rule details ", + "product_code":"NAT", + "title":"Querying Details About a Specified DNAT Rule", + "uri":"ShowPrivateDnat.html", + "doc_type":"api", + "p_code":"37", + "code":"42" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"NAT", + "title":"SNAT Rules", + "uri":"PrivateNatSnat.html", + "doc_type":"api", + "p_code":"30", + "code":"43" + }, + { + "desc":"This API is used to query SNAT rules.GET /v3/{project_id}/private-nat/snat-rulesStatus code: 200Status code: 200SNAT rules queried.See Error Codes.", + "product_code":"NAT", + "title":"Querying SNAT Rules", + "uri":"ListPrivateSnats.html", + "doc_type":"api", + "p_code":"43", + "code":"44" + }, + { + "desc":"This API is used to query details about a specified SNAT rule.GET /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}Status code: 200Status code: 200SNAT rule details ", + "product_code":"NAT", + "title":"Querying Details About a Specified SNAT Rule", + "uri":"ShowPrivateSnat.html", + "doc_type":"api", + "p_code":"43", + "code":"45" + }, + { + "desc":"This API is used to update a specified SNAT rule.PUT /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}Status code: 200Updating an SNAT rule (Setting transit_ip_ids t", + "product_code":"NAT", + "title":"Updating an SNAT Rule", + "uri":"UpdatePrivateSnat.html", + "doc_type":"api", + "p_code":"43", + "code":"46" + }, + { + "desc":"This API is used to create an SNAT rule.When you are creating an SNAT rule, status of the NAT gateway must be set to ACTIVE.POST /v3/{project_id}/private-nat/snat-rulesSt", + "product_code":"NAT", + "title":"Creating an SNAT Rule", + "uri":"CreatePrivateSnat.html", + "doc_type":"api", + "p_code":"43", + "code":"47" + }, + { + "desc":"This API is used to delete a specified SNAT rule.DELETE /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}Status code: 204SNAT rule deleted.NoneNoneSee Error Codes.", + "product_code":"NAT", + "title":"Deleting an SNAT Rule", + "uri":"DeletePrivateSnat.html", + "doc_type":"api", + "p_code":"43", + "code":"48" + }, + { + "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":"Transit IP Addresses", + "uri":"PrivateNatTransitIp.html", + "doc_type":"api", + "p_code":"30", + "code":"49" + }, + { + "desc":"This API is to query transit IP addresses.You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria.All optional param", + "product_code":"NAT", + "title":"Querying Transit IP Addresses", + "uri":"ListTransitIps.html", + "doc_type":"api", + "p_code":"49", + "code":"50" + }, + { + "desc":"This API is used to release a transit IP address.DELETE /v3/{project_id}/private-nat/transit-ips/{transit_ip_id}Status code: 204Transit IP address released.NoneNoneSee Er", + "product_code":"NAT", + "title":"Releasing a Transit IP Address", + "uri":"DeleteTransitIp.html", + "doc_type":"api", + "p_code":"49", + "code":"51" + }, + { + "desc":"This API is used to assign a transit IP address.POST /v3/{project_id}/private-nat/transit-ipsStatus code: 201Assigning a transit IP address (Setting virsubnet_id to 2759d", + "product_code":"NAT", + "title":"Assigning a Transit IP Address", + "uri":"CreateTransitIp.html", + "doc_type":"api", + "p_code":"49", + "code":"52" + }, + { + "desc":"This API is used to query details about a specified transit IP address.GET /v3/{project_id}/private-nat/transit-ips/{transit_ip_id}Status code: 200Status code: 200Details", + "product_code":"NAT", + "title":"Querying Details About a Specified Transit IP Address", + "uri":"ShowTransitIp.html", + "doc_type":"api", + "p_code":"49", + "code":"53" + }, + { + "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":"Private NAT Gateway Tags", + "uri":"PrivateNatTags.html", + "doc_type":"api", + "p_code":"30", + "code":"54" + }, + { + "desc":"This API is used to query private NAT gateways by tag.This API is used to query private NAT gateways by tag.Tag Management Service (TMS) uses this API to filter and list ", + "product_code":"NAT", + "title":"Querying Private NAT Gateways", + "uri":"ListPrivateNatsByTags.html", + "doc_type":"api", + "p_code":"54", + "code":"55" + }, + { + "desc":"This API is used to query tags of all private NAT gateways owned by a tenant in a project.This API is used to query tags of all private NAT gateways owned by a tenant in ", + "product_code":"NAT", + "title":"Querying Tags of All Private NAT Gateways in a Project", + "uri":"ListPrivateNatTags.html", + "doc_type":"api", + "p_code":"54", + "code":"56" + }, + { + "desc":"This API is used to query tags of a private NAT gateway.This API is used to query tags of a private NAT gateway.TMS uses this API to query all tags of a private NAT gatew", + "product_code":"NAT", + "title":"Querying Tags of a Private NAT Gateway", + "uri":"ShowPrivateNatTags.html", + "doc_type":"api", + "p_code":"54", + "code":"57" + }, + { + "desc":"This API is used to add tags to a private NAT gateway.This API is used to add tags to a private NAT gateway.A private NAT gateway can have up to 20 tags.A private NAT gat", + "product_code":"NAT", + "title":"Adding a Tag to a Private NAT Gateway", + "uri":"CreatePrivateNatTag.html", + "doc_type":"api", + "p_code":"54", + "code":"58" + }, + { + "desc":"This API is used to batch add or delete tags to or from a private NAT gateway.This API is used to batch add or delete tags to or from a private NAT gateway.TMS uses this ", + "product_code":"NAT", + "title":"Batch Adding or Deleting Tags to or from a Private NAT Gateway", + "uri":"BatchCreateDeletePrivateNatTags.html", + "doc_type":"api", + "p_code":"54", + "code":"59" + }, + { + "desc":"This API is idempotent.This API is idempotent.When a tag is deleted, the tag character set is not verified. Before calling this API, perform the encodeURI operation. The ", + "product_code":"NAT", + "title":"Deleting a Tag from a Private NAT Gateway", + "uri":"DeletePrivateNatTag.html", + "doc_type":"api", + "p_code":"54", + "code":"60" + }, + { + "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":"Transit IP Address Tags", + "uri":"PrivateNatTransitIpTags.html", + "doc_type":"api", + "p_code":"30", + "code":"61" + }, + { + "desc":"This API is used to query transit IP addresses by tag.This API is used to query transit IP addresses by tag.TMS uses this API to filter and list transit IP addresses by t", + "product_code":"NAT", + "title":"Querying Transit IP Addresses by Tag", + "uri":"ListTransitIpsByTags.html", + "doc_type":"api", + "p_code":"61", + "code":"62" + }, + { + "desc":"This API is used to query tags of all transit IP addresses owned by a tenant in a project.This API is used to query tags of all transit IP addresses owned by a tenant in ", + "product_code":"NAT", + "title":"Querying Tags of All Transit IP Addresses in a Specified Project", + "uri":"ListTransitIpTags.html", + "doc_type":"api", + "p_code":"61", + "code":"63" + }, + { + "desc":"This API is used to query tags of a specified transit IP address.This API is used to query tags of a specified transit IP address.TMS uses this API to query all tags of a", + "product_code":"NAT", + "title":"Querying Tags of a Transit IP Address", + "uri":"ShowTransitIpTags.html", + "doc_type":"api", + "p_code":"61", + "code":"64" + }, + { + "desc":"This API is used to add a tag to a transit IP address.This API is used to add a tag to a transit IP address.A transit IP address can have up to 20 tags.A transit IP addre", + "product_code":"NAT", + "title":"Adding a Tag to a Transit IP Address", + "uri":"CreateTransitIpTag.html", + "doc_type":"api", + "p_code":"61", + "code":"65" + }, + { + "desc":"This API is used to batch add or delete tags to or from a transit IP address.This API is used to batch add or delete tags to or from a transit IP address.TMS needs to use", + "product_code":"NAT", + "title":"Batch Adding or Deleting Tags to or from a Transit IP Address", + "uri":"BatchCreateDeleteTransitIpTags.html", + "doc_type":"api", + "p_code":"61", + "code":"66" + }, + { + "desc":"This API is idempotent.This API is idempotent.When a tag is deleted, the tag character set is not verified. Before calling this API, perform the encodeURI operation. The ", + "product_code":"NAT", + "title":"Deleting a Tag from a Transit IP Address", + "uri":"DeleteTransitIpTag.html", + "doc_type":"api", + "p_code":"61", + "code":"67" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"nat", @@ -267,7 +609,7 @@ "uri":"nat_api_0027.html", "doc_type":"api", "p_code":"", - "code":"30" + "code":"68" }, { "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", @@ -275,8 +617,8 @@ "title":"Introduction", "uri":"nat_api_0063.html", "doc_type":"api", - "p_code":"30", - "code":"31" + "p_code":"68", + "code":"69" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -284,8 +626,8 @@ "title":"NAT Gateway v2.0", "uri":"nat_api_0032.html", "doc_type":"api", - "p_code":"30", - "code":"32" + "p_code":"68", + "code":"70" }, { "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.", @@ -293,8 +635,8 @@ "title":"SNAT Rule v2.0", "uri":"nat_api_0033.html", "doc_type":"api", - "p_code":"30", - "code":"33" + "p_code":"68", + "code":"71" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -302,8 +644,8 @@ "title":"DNAT Rule v2.0", "uri":"nat_api_0034.html", "doc_type":"api", - "p_code":"30", - "code":"34" + "p_code":"68", + "code":"72" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -311,8 +653,62 @@ "title":"NAT Gateway Tag v2.0", "uri":"nat_api_0035.html", "doc_type":"api", - "p_code":"30", - "code":"35" + "p_code":"68", + "code":"73" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nat", + "title":"Private NAT Gateways", + "uri":"nat_api_0070.html", + "doc_type":"api", + "p_code":"68", + "code":"74" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nat", + "title":"Private NAT Gateway - Transit IP Address", + "uri":"nat_api_0071.html", + "doc_type":"api", + "p_code":"68", + "code":"75" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nat", + "title":"SNAT Rules of Private NAT Gateways", + "uri":"nat_api_0072.html", + "doc_type":"api", + "p_code":"68", + "code":"76" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nat", + "title":"DNAT Rules of Private NAT Gateways", + "uri":"nat_api_0073.html", + "doc_type":"api", + "p_code":"68", + "code":"77" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nat", + "title":"Private NAT Gateway - Tag", + "uri":"nat_api_0074.html", + "doc_type":"api", + "p_code":"68", + "code":"78" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nat", + "title":"Private NAT Gateway - Transit IP Address Tag", + "uri":"nat_api_0075.html", + "doc_type":"api", + "p_code":"68", + "code":"79" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -321,7 +717,7 @@ "uri":"nat_api_0036.html", "doc_type":"api", "p_code":"", - "code":"36" + "code":"80" }, { "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.", @@ -329,8 +725,8 @@ "title":"Status Codes", "uri":"nat_api_0038.html", "doc_type":"api", - "p_code":"36", - "code":"37" + "p_code":"80", + "code":"81" }, { "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", @@ -338,8 +734,17 @@ "title":"Error Code Description v2.0", "uri":"nat_api_0040.html", "doc_type":"api", - "p_code":"36", - "code":"38" + "p_code":"80", + "code":"82" + }, + { + "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":"Error Codes", + "uri":"ErrorCode.html", + "doc_type":"api", + "p_code":"80", + "code":"83" }, { "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.", @@ -347,8 +752,8 @@ "title":"Resource Status Description", "uri":"nat_api_0042.html", "doc_type":"api", - "p_code":"36", - "code":"39" + "p_code":"80", + "code":"84" }, { "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.", @@ -357,6 +762,6 @@ "uri":"nat_api_0046.html", "doc_type":"api", "p_code":"", - "code":"40" + "code":"85" } ] \ No newline at end of file diff --git a/docs/natgw/api-ref/CreatePrivateDnat.html b/docs/natgw/api-ref/CreatePrivateDnat.html new file mode 100644 index 000000000..540cc4e24 --- /dev/null +++ b/docs/natgw/api-ref/CreatePrivateDnat.html @@ -0,0 +1,417 @@ + + +

Creating a DNAT Rule

+

Function

This API is used to create a DNAT rule.

+
+

Constraints

When you are creating a DNAT rule, status of the NAT gateway must be set to ACTIVE.

+
+

URI

POST /v3/{project_id}/private-nat/dnat-rules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

dnat_rule

+

Yes

+

CreatePrivateDnatOption object

+

Specifies the request body for creating a DNAT rule.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 CreatePrivateDnatOption

Parameter

+

Mandatory

+

Type

+

Description

+

description

+

No

+

String

+

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_id

+

Yes

+

String

+

Specifies the ID of the transit IP address.

+

network_interface_id

+

No

+

String

+

Specifies the port ID of the resource that the NAT gateway is bound to. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address. Note: Either this parameter or private_ip_address must be specified. Otherwise, an error will be reported.

+

gateway_id

+

Yes

+

String

+

Specifies the private NAT gateway ID.

+

protocol

+

No

+

String

+

Specifies the protocol type.

+

TCP, UDP, and ANY are supported.

+

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

+

Enumeration values:

+

  • tcp

    +

  • udp

    +

  • any

    +
+

private_ip_address

+

No

+

String

+

Specifies the port IP address that the NAT gateway uses. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address. Note: Either this parameter or network_interface_id must be specified. Otherwise, an error will be reported.

+

internal_service_port

+

No

+

String

+

Specifies the port number of the resource, which can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

transit_service_port

+

No

+

String

+

Specifies the port number of the transit IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

dnat_rule

+

PrivateDnat object

+

Specifies the response body of the DNAT rule.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 PrivateDnat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the DNAT rule ID.

+

project_id

+

String

+

Specifies the project ID.

+

description

+

String

+

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_id

+

String

+

Specifies the ID of the transit IP address.

+

gateway_id

+

String

+

Specifies the private NAT gateway ID.

+

network_interface_id

+

String

+

Specifies the network interface ID. Network interfaces of a compute instance, load balancer (v2 or v3), or virtual IP address are supported.

+

type

+

String

+

Specifies the backend resource type of the DNAT rule.

+

The type can be:

+

  • COMPUTE: The backend resource is a compute instance.

    +

  • VIP: The backend resource is a virtual IP address.

    +

  • ELB: The backend resource is a v2 load balancer.

    +

  • ELBv3: The backend resource is a v3 load balancer.

    +

  • CUSTOMIZE: The backend resource is a user-defined IP address.

    +
+

protocol

+

String

+

Specifies the protocol type.

+

TCP, UDP, and ANY are supported.

+

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

+

Enumeration values:

+

  • tcp

    +

  • udp

    +

  • any

    +
+

private_ip_address

+

String

+

Specifies the port IP address that the NAT gateway uses. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

internal_service_port

+

String

+

Specifies the port number of the resource, which can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

transit_service_port

+

String

+

Specifies the port number of the transit IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

enterprise_project_id

+

String

+

Specifies the ID of the enterprise project that is associated with the DNAT rule when the DNAT rule is created.

+

created_at

+

String

+

Specifies the time when the DNAT rule was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the DNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

status

+

String

+

Specifies the DNAT rule status of a private NAT gateway.

+

The value can be:

+

  • ACTIVE: The DNAT rule is running properly.

    +

  • FROZEN: The DNAT rule is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+
+
+
+

Example Requests

Creating a DNAT rule with the transit IP address ID set to 3faa719d-6d18-4ccb-a5c7-33e65a09663e, the private NAT gateway ID set to 0adefb29-a6c2-48a5-8637-2be67fa03fec, and network interface ID set to dae9393a-b536-491c-a5a2-72edc1104707

+
POST https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules
+
+{
+  "dnat_rule" : {
+    "description" : "aa",
+    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
+    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
+    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707"
+  }
+}
+
+

Example Responses

Status code: 201

+

DNAT rule created.

+
{
+  "dnat_rule" : {
+    "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83",
+    "project_id" : "da261828016849188f4dcc2ef94d9da9",
+    "description" : "aa",
+    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
+    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707",
+    "type" : "COMPUTE",
+    "protocol" : "any",
+    "internal_service_port" : "0",
+    "transit_service_port" : "0",
+    "private_ip_address" : "192.168.1.72",
+    "created_at" : "2019-04-29T07:10:01",
+    "updated_at" : "2019-04-29T07:10:01",
+    "status" : "ACTIVE"
+  },
+  "request_id" : "70505c941b9b4dfd82fd351932328a2f"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

201

+

DNAT rule created.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: DNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/CreatePrivateNat.html b/docs/natgw/api-ref/CreatePrivateNat.html new file mode 100644 index 000000000..a101ff978 --- /dev/null +++ b/docs/natgw/api-ref/CreatePrivateNat.html @@ -0,0 +1,517 @@ + + +

Creating a Private NAT Gateway

+

Function

This API is used to create a private NAT gateway.

+
+

URI

POST /v3/{project_id}/private-nat/gateways

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

gateway

+

Yes

+

CreatePrivateNatOption object

+

Specifies the request body for creating the private NAT gateway.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 CreatePrivateNatOption

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Specifies the private NAT gateway name.

+

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

+

description

+

No

+

String

+

Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

spec

+

No

+

String

+

Specifies the private NAT gateway specifications.

+

The value can be:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

Default value:

+

Small

+

Enumeration values:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

downlink_vpcs

+

Yes

+

Array of DownlinkVpcOption objects

+

Specifies the VPC where the private NAT gateway works.

+

tags

+

No

+

Array of Tag objects

+

Specifies the tag list.

+

enterprise_project_id

+

No

+

String

+

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

+

For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

+

Default value:

+

0

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 DownlinkVpcOption

Parameter

+

Mandatory

+

Type

+

Description

+

virsubnet_id

+

Yes

+

String

+

Specifies the ID of the subnet where the private NAT gateway works.

+

ngport_ip_address

+

No

+

String

+

Specifies the private IP address of the private NAT gateway.

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

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

Yes

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

gateway

+

PrivateNat object

+

Specifies the response body for the private NAT gateway.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 PrivateNat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the private NAT gateway ID.

+

project_id

+

String

+

Specifies the project ID.

+

name

+

String

+

Specifies the private NAT gateway name.

+

description

+

String

+

Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

spec

+

String

+

Specifies the private NAT gateway specifications.

+

The value can be:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

Default value:

+

Small

+

Enumeration values:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

status

+

String

+

Specifies the private NAT gateway status.

+

The value can be:

+

  • ACTIVE: The private NAT gateway is running properly.

    +

  • FROZEN: The private NAT gateway is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+

created_at

+

String

+

Specifies the time when the private NAT gateway was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the private NAT gateway was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

downlink_vpcs

+

Array of DownlinkVpc objects

+

Specifies the VPC where the private NAT gateway works.

+

tags

+

Array of Tag objects

+

Specifies the list of tags.

+

enterprise_project_id

+

String

+

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

+

rule_max

+

Integer

+

Specifies the maximum number of rules.

+

Value range:

+

0-65535

+

transit_ip_pool_size_max

+

Integer

+

Specifies the maximum number of transit IP addresses in a transit IP address pool.

+

Value range:

+

1-100

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 9 DownlinkVpc

Parameter

+

Type

+

Description

+

vpc_id

+

String

+

Specifies the ID of the VPC where the private NAT gateway works.

+

virsubnet_id

+

String

+

Specifies the ID of the subnet where the private NAT gateway works.

+

ngport_ip_address

+

String

+

Specifies the private IP address of the private NAT gateway.

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 Tag

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Example Requests

Creating a private NAT gateway (Setting name to private-nat-gateway-name, spec to Small, and virsubnet_id to 373979ee-f4f0-46c5-80e3-0fbf72646b70)

+
POST https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways
+
+{
+  "gateway" : {
+    "name" : "private-nat-gateway-name",
+    "spec" : "Small",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "description" : "create private nat",
+    "downlink_vpcs" : [ {
+      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
+    } ],
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ]
+  }
+}
+
+

Example Responses

Status code: 201

+

Private NAT gateway created.

+
{
+  "request_id" : "9882046a9b96f1405472e36d797e33dc",
+  "gateway" : {
+    "id" : "14338426-6afe-4019-996b-3a9525296e11",
+    "name" : "private-nat-gateway-name",
+    "description" : "private-nat-gateway-description",
+    "spec" : "Small",
+    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "status" : "ACTIVE",
+    "created_at" : "2019-04-22T08:47:13",
+    "updated_at" : "2019-04-22T08:47:13",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ],
+    "downlink_vpcs" : [ {
+      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
+      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70",
+      "ngport_ip_address" : "192.168.10.190"
+    } ],
+    "transit_ip_pool_size_max" : 1,
+    "rule_max" : 20
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

201

+

Private NAT gateway created.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateways
+
+
+ diff --git a/docs/natgw/api-ref/CreatePrivateNatTag.html b/docs/natgw/api-ref/CreatePrivateNatTag.html new file mode 100644 index 000000000..3335399e3 --- /dev/null +++ b/docs/natgw/api-ref/CreatePrivateNatTag.html @@ -0,0 +1,165 @@ + + +

Adding a Tag to a Private NAT Gateway

+

Function

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

    +

  • A private NAT gateway can have up to 20 tags.

    +

  • This API is idempotent.

    +

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

    +
+
+

URI

POST /v3/{project_id}/private-nat-gateways/{resource_id}/tags

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_id

+

Yes

+

String

+

Specifies the private NAT gateway ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

tag

+

Yes

+

Tag object

+

Specifies the tag.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Tag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

Yes

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Response Parameters

Status code: 204

+

Tag added.

+

None

+
+

Example Requests

Adding a tag to a private NAT gateway (Setting key to key1 and value to value1)

+
POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags
+
+{
+  "tag" : {
+    "key" : "key1",
+    "value" : "value1"
+  }
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Tag added.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateway Tags
+
+
+ diff --git a/docs/natgw/api-ref/CreatePrivateSnat.html b/docs/natgw/api-ref/CreatePrivateSnat.html new file mode 100644 index 000000000..1d0be7ce7 --- /dev/null +++ b/docs/natgw/api-ref/CreatePrivateSnat.html @@ -0,0 +1,357 @@ + + +

Creating an SNAT Rule

+

Function

This API is used to create an SNAT rule.

+
+

Constraints

When you are creating an SNAT rule, status of the NAT gateway must be set to ACTIVE.

+
+

URI

POST /v3/{project_id}/private-nat/snat-rules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

snat_rule

+

Yes

+

CreatePrivateSnatOption object

+

Specifies the request body for creating an SNAT rule.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 CreatePrivateSnatOption

Parameter

+

Mandatory

+

Type

+

Description

+

gateway_id

+

Yes

+

String

+

Specifies the private NAT gateway ID.

+

cidr

+

No

+

String

+

Specifies the CIDR block that matches the SNAT rule.

+

Constraint: Either this parameter or virsubnet_id must be specified.

+

virsubnet_id

+

No

+

String

+

Specifies the ID of the subnet that matches the SNAT rule.

+

Constraint: Either this parameter or cidr must be specified.

+

description

+

No

+

String

+

Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_ids

+

Yes

+

Array of strings

+

Specifies the IDs of the transit IP addresses.

+

Constraints: A maximum number of 20 IDs is allowed.

+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

snat_rule

+

PrivateSnat object

+

Specifies the response body of the SNAT rule.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 PrivateSnat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the SNAT rule ID.

+

project_id

+

String

+

Specifies the project ID.

+

gateway_id

+

String

+

Specifies the private NAT gateway ID.

+

cidr

+

String

+

Specifies the CIDR block that matches the SNAT rule.

+

Constraints:

+

  • Either this parameter or virsubnet_id must be specified.

    +

  • The CIDR block cannot be the same as that of an existing SNAT rule.

    +
+

virsubnet_id

+

String

+

Specifies the ID of the subnet that matches the SNAT rule.

+

Constraint: Either this parameter or cidr must be specified.

+

description

+

String

+

Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_associations

+

Array of AssociatedTransitIp objects

+

Specifies the list of details of associated transit IP addresses.

+

created_at

+

String

+

Specifies the time when the SNAT rule was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the SNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

enterprise_project_id

+

String

+

Specifies the enterprise project ID.

+

status

+

String

+

Specifies the SNAT rule status of a private NAT gateway.

+

The value can be:

+

  • ACTIVE: The SNAT rule is running properly.

    +

  • FROZEN: The SNAT rule is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 7 AssociatedTransitIp

Parameter

+

Type

+

Description

+

transit_ip_id

+

String

+

Specifies the ID of the transit IP address.

+

transit_ip_address

+

String

+

Specifies the transit IP address.

+
+
+
+

Example Requests

Creating an SNAT rule (Setting description to my_snat_rule01, gateway_id to 80da6f26-94eb-4537-97f0-5a56f4d04cfb, virsubnet_id to 5b9ea497-727d-4ad0-a99e-3984b3f5aaed, and transit_ip_ids to 36a3049a-1682-48b3-b1cf-cb986a3350ef)

+
POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat/snat-rules
+
+{
+  "snat_rule" : {
+    "description" : "my_snat_rule01",
+    "gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
+    "virsubnet_id" : "5b9ea497-727d-4ad0-a99e-3984b3f5aaed",
+    "transit_ip_ids" : [ "36a3049a-1682-48b3-b1cf-cb986a3350ef" ]
+  }
+}
+
+

Example Responses

Status code: 201

+

SNAT rule created.

+
{
+  "snat_rule" : {
+    "id" : "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81",
+    "project_id" : "cfa563efb77d4b6d9960781d82530fd8",
+    "description" : "snat rule description",
+    "gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
+    "cidr" : "",
+    "virsubnet_id" : "5b9ea497-727d-4ad0-a99e-3984b3f5aaed",
+    "transit_ip_associations" : [ {
+      "transit_ip_id" : "36a3049a-1682-48b3-b1cf-cb986a3350ef",
+      "transit_ip_address" : "172.20.1.10"
+    } ],
+    "created_at" : "2019-10-22T03:31:19",
+    "updated_at" : "2019-10-22T03:31:19",
+    "status" : "ACTIVE"
+  },
+  "request_id" : "2937502e-73f9-4ba5-ae75-2293a0b35fb8"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

201

+

SNAT rule created.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: SNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/CreateTransitIp.html b/docs/natgw/api-ref/CreateTransitIp.html new file mode 100644 index 000000000..be2812701 --- /dev/null +++ b/docs/natgw/api-ref/CreateTransitIp.html @@ -0,0 +1,377 @@ + + +

Assigning a Transit IP Address

+

Function

This API is used to assign a transit IP address.

+
+

URI

POST /v3/{project_id}/private-nat/transit-ips

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

transit_ip

+

Yes

+

CreatTransitIpOption object

+

Specifies the request body for assigning a transit IP address.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 CreatTransitIpOption

Parameter

+

Mandatory

+

Type

+

Description

+

virsubnet_id

+

Yes

+

String

+

Specifies the subnet ID of the current project.

+

ip_address

+

No

+

String

+

Specifies the transit IP address.

+

enterprise_project_id

+

No

+

String

+

Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is being assigned.

+

Default value:

+

0

+

tags

+

No

+

Array of Tag objects

+

Specifies the tag of the transit IP address.

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

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

Yes

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

transit_ip

+

TransitIp object

+

Specifies the response body of the transit IP address.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 TransitIp

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the ID of the transit IP address.

+

project_id

+

String

+

Specifies the project ID.

+

network_interface_id

+

String

+

Specifies the network interface ID of the transit IP address.

+

ip_address

+

String

+

Specifies the transit IP address.

+

created_at

+

String

+

Specifies the time when the transit IP address was assigned. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the transit IP address was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

virsubnet_id

+

String

+

Specifies the subnet ID of the current tenant.

+

Constraint: Either this parameter or transit_subnet_id must be specified. The default value is an empty string.

+

tags

+

Array of Tag objects

+

Specifies the list of tags.

+

gateway_id

+

String

+

Specifies the ID of the private NAT gateway associated with the transit IP address.

+

enterprise_project_id

+

String

+

Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is being assigned.

+

status

+

String

+

Specifies the transit IP address status.

+

The value can be:

+

  • ACTIVE: The transit IP address is running properly.

    +

  • FROZEN: The transit IP address is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

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

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Example Requests

Assigning a transit IP address (Setting virsubnet_id to 2759da7b-8015-404c-ae0a-a389007b0e2a, ip_address to 192.168.1.68, and enterprise_project_id to 2759da7b-8015-404c-ae0a-a389007b0e2a)

+
POST https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/transit-ips
+
+{
+  "transit_ip" : {
+    "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "ip_address" : "192.168.1.68",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ]
+  }
+}
+
+

Example Responses

Status code: 201

+

Transit IP address assigned.

+
{
+  "transit_ip" : {
+    "id" : "a2845109-3b2f-4627-b08f-09a726c0a6e7",
+    "project_id" : "da261828016849188f4dcc2ef94d9da9",
+    "network_interface_id" : "adebbdca-8c26-4c14-b34f-3f53cd2c42f2",
+    "ip_address" : "192.168.1.68",
+    "gateway_id" : "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "created_at" : "2019-04-29T02:16:09",
+    "updated_at" : "2019-04-29T02:16:09",
+    "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ],
+    "status" : "ACTIVE"
+  },
+  "request_id" : "747a911c17067a39692f75ac146fb47e"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

201

+

Transit IP address assigned.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Addresses
+
+
+ diff --git a/docs/natgw/api-ref/CreateTransitIpTag.html b/docs/natgw/api-ref/CreateTransitIpTag.html new file mode 100644 index 000000000..c51580b62 --- /dev/null +++ b/docs/natgw/api-ref/CreateTransitIpTag.html @@ -0,0 +1,165 @@ + + +

Adding a Tag to a Transit IP Address

+

Function

  • This API is used to add a tag to a transit IP address.

    +

  • A transit IP address can have up to 20 tags.

    +

  • This API is idempotent.

    +

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

    +
+
+

URI

POST /v3/{project_id}/transit-ips/{resource_id}/tags

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_id

+

Yes

+

String

+

Specifies the ID of the transit IP address.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

tag

+

Yes

+

Tag object

+

Specifies the tag.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Tag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

Yes

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Response Parameters

Status code: 204

+

Tag added.

+

None

+
+

Example Requests

Adding a tag to a transit IP address (Setting key to key1 and value to value1)

+
POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags
+
+{
+  "tag" : {
+    "key" : "key1",
+    "value" : "value1"
+  }
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Tag added.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Address Tags
+
+
+ diff --git a/docs/natgw/api-ref/DeletePrivateDnat.html b/docs/natgw/api-ref/DeletePrivateDnat.html new file mode 100644 index 000000000..295a76d46 --- /dev/null +++ b/docs/natgw/api-ref/DeletePrivateDnat.html @@ -0,0 +1,98 @@ + + +

Deleting a DNAT Rule

+

Function

This API is used to delete a specified DNAT rule.

+
+

URI

DELETE /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

dnat_rule_id

+

Yes

+

String

+

Specifies the DNAT rule ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 204

+

DNAT rule deleted.

+

None

+
+

Example Requests

DELETE  https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules/24dd6bf5-48f2-4915-ad0b-5bb111d39c83
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

DNAT rule deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: DNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/DeletePrivateNat.html b/docs/natgw/api-ref/DeletePrivateNat.html new file mode 100644 index 000000000..309d81ce8 --- /dev/null +++ b/docs/natgw/api-ref/DeletePrivateNat.html @@ -0,0 +1,98 @@ + + +

Deleting a Private NAT Gateway

+

Function

This API is used to delete a private NAT gateway.

+
+

URI

DELETE /v3/{project_id}/private-nat/gateways/{gateway_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

gateway_id

+

Yes

+

String

+

Specifies the private NAT gateway ID.

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 204

+

Private NAT gateway deleted.

+

None

+
+

Example Requests

DELETE https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways/14338426-6afe-4019-996b-3a9525296e11
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Private NAT gateway deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateways
+
+
+ diff --git a/docs/natgw/api-ref/DeletePrivateNatTag.html b/docs/natgw/api-ref/DeletePrivateNatTag.html new file mode 100644 index 000000000..a00d93d83 --- /dev/null +++ b/docs/natgw/api-ref/DeletePrivateNatTag.html @@ -0,0 +1,110 @@ + + +

Deleting a Tag from a Private NAT Gateway

+

Function

  • This API is idempotent.

    +

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

    +
+
+

URI

DELETE /v3/{project_id}/private-nat-gateways/{resource_id}/tags/{key}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key.

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_id

+

Yes

+

String

+

Specifies the private NAT gateway ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 204

+

Tag deleted.

+

None

+
+

Example Requests

This API is used to delete a tag from a private NAT gateway.

+
DELETE  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/key1
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Tag deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateway Tags
+
+
+ diff --git a/docs/natgw/api-ref/DeletePrivateSnat.html b/docs/natgw/api-ref/DeletePrivateSnat.html new file mode 100644 index 000000000..f1a35ee77 --- /dev/null +++ b/docs/natgw/api-ref/DeletePrivateSnat.html @@ -0,0 +1,98 @@ + + +

Deleting an SNAT Rule

+

Function

This API is used to delete a specified SNAT rule.

+
+

URI

DELETE /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

snat_rule_id

+

Yes

+

String

+

Specifies the SNAT rule ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 204

+

SNAT rule deleted.

+

None

+
+

Example Requests

DELETE https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat/snat-rules/8a522ff9-8158-494b-83cd-533b045700e6
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

SNAT rule deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: SNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/DeleteTransitIp.html b/docs/natgw/api-ref/DeleteTransitIp.html new file mode 100644 index 000000000..54af1b22d --- /dev/null +++ b/docs/natgw/api-ref/DeleteTransitIp.html @@ -0,0 +1,98 @@ + + +

Releasing a Transit IP Address

+

Function

This API is used to release a transit IP address.

+
+

URI

DELETE /v3/{project_id}/private-nat/transit-ips/{transit_ip_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

transit_ip_id

+

Yes

+

String

+

Specifies the ID of the transit IP address.

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 204

+

Transit IP address released.

+

None

+
+

Example Requests

DELETE https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/transit-ips/a2845109-3b2f-4627-b08f-09a726c0a6e7
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Transit IP address released.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Addresses
+
+
+ diff --git a/docs/natgw/api-ref/DeleteTransitIpTag.html b/docs/natgw/api-ref/DeleteTransitIpTag.html new file mode 100644 index 000000000..5438d0d8b --- /dev/null +++ b/docs/natgw/api-ref/DeleteTransitIpTag.html @@ -0,0 +1,110 @@ + + +

Deleting a Tag from a Transit IP Address

+

Function

  • This API is idempotent.

    +

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

    +
+
+

URI

DELETE /v3/{project_id}/transit-ips/{resource_id}/tags/{key}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key.

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_id

+

Yes

+

String

+

Specifies the ID of the transit IP address.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 204

+

Tag deleted.

+

None

+
+

Example Requests

Deleting a tag from a transit IP address

+
DELETE  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/key1
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Tag deleted.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Address Tags
+
+
+ diff --git a/docs/natgw/api-ref/ErrorCode.html b/docs/natgw/api-ref/ErrorCode.html new file mode 100644 index 000000000..25dc5f347 --- /dev/null +++ b/docs/natgw/api-ref/ErrorCode.html @@ -0,0 +1,2191 @@ + + +

Error Codes

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

Status Code

+

Error Codes

+

Error Message

+

Description

+

Solution

+

400

+

NAT.0001

+

Invalid value for created_at %(timestamp)s.

+

Invalid timestamp.

+

Make sure that you enter the time in the correct format.

+

400

+

NAT.0002

+

Invalid parameters.

+

Invalid request parameter.

+

Check whether the input parameter is correct.

+

400

+

NAT.0006

+

Rule has not been deleted.

+

NAT gateway deletion failed because its rule has not been deleted.

+

Check whether there are SNAT or DNAT rules using this NAT gateway.

+

400

+

NAT.0007

+

DB Error

+

The database is abnormal.

+

Contact technical support.

+

400

+

NAT.0008

+

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

+

The subnet is not connected to the virtual router.

+

Add the subnet to the router port.

+

400

+

NAT.0009

+

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

+

The resource is in use.

+

Check whether the resource is in use.

+

400

+

NAT.0010

+

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

+

No subnets added in this VPC.

+

Check whether a subnet is added in this VPC. If no, add one.

+

400

+

NAT.0012

+

The network %(network)s already has nat gateway.

+

A NAT gateway has been created for this subnet.

+

Select a subnet for which no NAT gateway has been created.

+

400

+

NAT.0014

+

Invalid input for description.+exceeds maximum length of 255.

+

description contains more than 255 characters.

+

Enter a maximum of 255 characters.

+

400

+

NAT.0015

+

Invalid input for name.+exceeds maximum length of 255.

+

name contains more than 255 characters.

+

Enter a maximum of 255 characters.

+

400

+

NAT.0016

+

Invalid input for spec. Reason: '*' is not in ['1', '2', '3', '4'].

+

The value of spec is not 1, 2, 3, or 4.

+

Set spec to 1, 2, 3, or 4.

+

400

+

NAT.0017

+

Invalid input for router_id. Reason: '********-****-****-****-*************' is not a valid UUID.

+

router_id is an invalid UUID.

+

Enter a valid router_id.

+

400

+

NAT.0018

+

Invalid input for internal_network_id. Reason: '********-****-****-****-*************' is not a valid UUID.

+

internal_network_id is an invalid UUID.

+

Enter a valid internal_network_id.

+

400

+

NAT.0022

+

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

+

The subnet for which the SNAT rule is configured conflicts with the VPC subnet.

+

Specify either network_id or cidr.

+

400

+

NAT.0026

+

Floating IP ********-****-****-****-************* could not be found.

+

The ID of the floating IP address is not found.

+

Check whether the floating IP address ID is correct.

+

400

+

NAT.0101

+

Lack of user authority. +//request is null. +//endpoint is empty. +//resource type is invalid. +//create natgateway requset is null. +//update natgateway request is null +//NatGateway id is invalid. +//the enterprise project id is unsupported. +//the enterprise project id in request is invalid. +//request 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.

+

NAT gateway request error.

+

Troubleshoot the fault as prompted or contact technical support.

+

400

+

NAT.0102

+

The system is busy. Please try again later.

+

The system is busy. Please try again later.

+

Try again later.

+

400

+

NAT.0103

+

NatGateway %(nat_gateway_id)s is not ACTIVE.

+

The NAT gateway is not activated.

+

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

+

400

+

NAT.0104

+

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

+

The NAT gateway is frozen.

+

Check the NAT gateway status. The gateway may be frozen due to arrears and cannot be updated.

+

400

+

NAT.0106

+

Concurrent conflict requests found

+

Concurrent operations on the NAT gateway conflict.

+

Contact technical support.

+

400

+

NAT.0107

+

Create NG Port failed.

+

Failed to create the internal port of the NAT gateway.

+

Contact technical support.

+

400

+

NAT.0108

+

NG Port %(port)s is unbound.

+

Failed to bind the internal port to the NAT gateway.

+

Contact technical support.

+

400

+

NAT.0109

+

NatGateway does not support IPv6.

+

NAT Gateway does not support IPv6 EIPs.

+

Bind an IPv4 EIP.

+

400

+

NAT.0110

+

Get Nat gateway host failed

+

Failed to select the gateway node.

+

Contact technical support.

+

400

+

NAT.0111

+

Get Nat gateway agent local_ip failed

+

Failed to obtain the gateway node IP address.

+

Contact technical support.

+

400

+

NAT.0112

+

Get RouteTable %(router_id)s failed.

+

Failed to obtain the Virtual Private Cloud (VPC) route table.

+

Contact technical support.

+

400

+

NAT.0113

+

%(limit)s NAT gateways has been created to this VPC, no more is allowed

+

The maximum number of NAT gateways has been reached.

+

Create a NAT gateway in another VPC or delete existing NAT gateways in this VPC.

+

400

+

NAT.0201

+

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.

+

Incorrect SNAT rule parameter.

+

Check whether the SNAT rule is correctly configured or contact technical support.

+

400

+

NAT.0202

+

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

+

The subnet for which the SNAT rule is configured conflicts with the VPC subnet.

+

Do not configure both Cidr and Network_id when you are configuring an SNAT rule.

+

400

+

NAT.0203

+

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

+

Invalid CIDR block.

+

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

+

400

+

NAT.0204

+

source_type and network_id is incompatible.

+

Invalid SNAT rule type.

+

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

+

400

+

NAT.0205

+

cidr must be a subset of subnet's cidr.

+

The CIDR block is not a subset of the VPC subnet.

+

Enter a subset of the subnet CIDR block. For example, if the subnet is 192.168.0.0/24, cidr can be 192.168.0.0/25.

+

400

+

NAT.0206

+

cidr conflicts with subnet's cidr.

+

The CIDR block of the SNAT rule conflicts with the subnet CIDR block.

+

If the SNAT rule is configured for subnets connected to a VPC through Direct Connect or Cloud Connect, the CIDR block cannot conflict with the VPC subnet CIDR block.

+

400

+

NAT.0207

+

cidr in the request conflicts with cidrs of existing rules.

+

The CIDR block conflicts with the existing one.

+

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

+

400

+

NAT.0208

+

Snat rule for network %(network)s exists.

+

The rule already exists.

+

Select a subnet that has no SNAT rules configured.

+

400

+

NAT.0210

+

Invalid input for floating_ip_id. Reason: \'%(fip)s\' is not a valid UUID. +//Invalid value for public ip id.

+

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

+

Enter a valid UUID.

+

400

+

NAT.0211

+

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

+

The maximum number of EIPs that can be bound to the SNAT rule has been reached.

+

Ensure that the number of EIPs does not exceed the maximum number allowed.

+

400

+

NAT.0212

+

SNAT Rule %(rule)s Associated or disassociate EIP %(fip)s Failed."

+

Failed to bind the EIP to or unbind the EIP from the SNAT rule.

+

Contact technical support.

+

400

+

NAT.0301

+

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. +//internal_service_port_range' out of range(1-65535). +//internal_service_port_range': invalid format. +//internal_service_port_range': param is null. +//'internal_service_port_range' and 'external_service_port_range' must be equal. +//for non-all port rule,the protocol can not be any. +//param xxx is null in request body.

+

Incorrect DNAT rule parameter.

+

Check whether the DNAT rule is correctly configured or contact technical support.

+

400

+

NAT.0302

+

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

+

Invalid DNAT rule protocol.

+

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

+

400

+

NAT.0303

+

Invalid value for port %(port)s

+

Invalid port in the DNAT rule.

+

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

+

400

+

NAT.0304

+

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

+

The internal network information in this DNAT rule conflicts with that in existing DNAT rules.

+

Enter a VM port ID, or private IP address and internal port, that does not conflict with existing DNAT rules.

+

400

+

NAT.0305

+

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

+

The external network information in this DNAT rule conflicts with that in existing DNAT rules.

+

Enter a floating IP address ID, external port number, and protocol that do not conflict with those in existing DNAT rules.

+

400

+

NAT.0306

+

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

+

Incorrect request for the DNAT rule.

+

Set both the internal port and external port to 0 and protocol to ANY to make the configurations take effect.

+

400

+

NAT.0307

+

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

+

The port ID in this DNAT rule conflicts with that in an existing DNAT rule.

+

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

+

400

+

NAT.0308

+

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 configured in the DNAT rule conflicts with that in an existing DNAT rule.

+

Change the private IP address or modify this DNAT rule.

+

400

+

NAT.0309

+

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

+

The maximum number of DNAT rules has been reached.

+

Ensure that the number of DNAT rules added to the NAT gateway is within the upper limit.

+

400

+

NAT.0310

+

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

+

Some parameters of this DNAT rule are not configured.

+

Check whether port_id and private_ip are configured. If no, configure at least one of them.

+

400

+

NAT.0311

+

The private ip address is not legal.

+

Invalid private IP address in the DNAT rule.

+

Configure a valid private IP address.

+

400

+

NAT.0312

+

The virtual IP address is not supported.

+

Virtual IP addresses are not supported.

+

Configure a valid private IP address.

+

400

+

NAT.0313

+

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

+

The maximum number of DNAT rules has been reached.

+

The maximum number of DNAT rules that are allowed to have the same floating IP address bound has been reached.

+

400

+

NAT.0314

+

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

+

The maximum number of DNAT rules that can be added in batches has been reached.

+

Reduce the number of DNAT rules and then add them in batches.

+

400

+

NAT.0315

+

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

+

Invalid VM port ID in the DNAT rule.

+

Configure a valid VM port ID.

+

400

+

NAT.0316

+

Vtep_ip is Null.

+

VtepIp must be specified.

+

Delete this DNAT rule and create a new one, or contact technical support.

+

400

+

NAT.0317

+

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

+

The DNAT rule contains mutually exclusive parameters.

+

Configure either port_id or private_ip.

+

400

+

NAT.0318

+

DNAT rule is frozen, can no longer update.

+

The DNAT rule has been frozen and cannot be updated.

+

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

+

400

+

NAT.0401

+

Floating Ip %(fip)s is freezed.

+

The EIP is frozen.

+

Select an EIP that is not frozen.

+

400

+

NAT.0402

+

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

+

The EIP has been bound to a port.

+

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

+

400

+

NAT.0403

+

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

+

The EIP has been used by an SNAT rule.

+

Select another EIP.

+

400

+

NAT.0404

+

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

+

The EIP has been bound to a NAT gateway.

+

Select another EIP.

+

400

+

NAT.0405

+

Floating Ip %(fip)s has been occupied.

+

The EIP is in use.

+

Select another EIP.

+

400

+

NAT.0407

+

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

+

The EIP has been bound to a rule.

+

Select an EIP that is not in use.

+

400

+

NAT.0408

+

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

+

A DNAT rule cannot share an EIP with another DNAT rule in which mapping to a specific port is not set.

+

Select another EIP.

+

400

+

NAT.0409

+

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

+

An SNAT rule cannot share an EIP with a DNAT rule in which mapping to a specific port is not set.

+

Select another EIP.

+

400

+

NAT.0410

+

Invalid value of the FloatIP.

+

Invalid floating IP address.

+

Enter a valid floating IP address.

+

400

+

VPC.0002

+

Available zone Name is null.

+

The AZ is left blank.

+

Check whether availability_zone in the request body for creating a subnet is left blank.

+

400

+

VPC.0004

+

VPC does not active, please try later.

+

The VPC status is abnormal.

+

Try again later or contact technical support.

+

400

+

VPC.0007

+

urlTenantId is not equal tokenTenantId

+

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

+

Contact technical support.

+

400

+

VPC.0011

+

EnterpriseProjectId is invalid

+

Invalid enterprise project ID.

+

Enter a valid enterprise project ID.

+

400

+

VPC.0014

+

This enterpriseProject status is disable.

+

Unavailable enterprise project.

+

Use the ID of an available enterprise project.

+

400

+

VPC.2000

+

Lack of user authority. +//request is null. +//endpoint is empty. +//resource type is invalid. +//create natgateway requset is null. +//update natgateway request is null.

+

NAT gateway request error.

+

Contact technical support.

+

400

+

VPC.2001

+

NatGateway id is invalid. +//the enterprise project id in request is invalid. +//request 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.

+

Incorrect NAT gateway parameter.

+

Check whether the NAT gateway is correctly configured or contact technical support.

+

400

+

VPC.2002

+

Invalid parameters.

+

Invalid request parameter.

+

Check whether the input parameter is correct.

+

400

+

VPC.2004

+

NatGateway %(nat_gateway_id)s is not ACTIVE.

+

The NAT gateway is not activated.

+

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

+

400

+

VPC.2005

+

NatGateway %(nat_gateway_id)s is not UP.

+

The NAT gateway is not in the UP state.

+

Check whether the gateway has been frozen due to arrears or other reasons.

+

400

+

VPC.2006

+

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

+

The NAT gateway is frozen.

+

Check whether the gateway is frozen due to arrears. If yes, it cannot be updated.

+

400

+

VPC.2007

+

NatGateway %(nat_gateway_id)s does not exist.

+

The NAT gateway is not found.

+

Check whether the NAT gateway ID is correct.

+

400

+

VPC.2008

+

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

+

No subnets added in this VPC.

+

Contact technical support.

+

400

+

VPC.2009

+

Network %(network_id)s does not exist.

+

The subnet is not found.

+

Enter a valid subnet.

+

400

+

VPC.2010

+

The router %(router_id)s has default route.

+

The default route already exists.

+

Delete the default route and then create a NAT gateway.

+

400

+

VPC.2011

+

The router %(router_id)s does not exist.

+

The router is not found.

+

Check whether the entered router ID is correct.

+

400

+

VPC.2012

+

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

+

The VPC already has a NAT gateway.

+

Select another VPC.

+

400

+

VPC.2013

+

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

+

The subnet is not connected to the virtual router.

+

Add the subnet to the router port.

+

400

+

VPC.2014

+

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.

+

Incorrect SNAT rule parameter.

+

Check whether the SNAT rule is correctly configured or contact technical support.

+

400

+

VPC.2016

+

Rule has not been deleted.

+

NAT gateway deletion failed because its rule has not been deleted.

+

Contact technical support.

+

400

+

VPC.2018

+

Snat rule for network %(network)s exists.

+

The rule already exists.

+

Select a subnet that has no SNAT rules configured.

+

400

+

VPC.2019

+

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

+

The resource is in use.

+

Contact technical support.

+

400

+

VPC.2020

+

get dnatRules error limit is invalid. +//get dnatrules error marker is invalid. +//endpoint is empty. +//DnatRule id invalid. +//Request is null. +//DnatRule id invalid. +//DnatRule natGatewayId id invalid.

+

Incorrect DNAT rule parameter.

+

Check whether the DNAT rule is correctly configured or contact technical support.

+

400

+

VPC.2022

+

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

+

Invalid VM port ID in the DNAT rule.

+

Configure a valid VM port ID.

+

400

+

VPC.2023

+

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

+

The internal network information in this DNAT rule conflicts with that in existing DNAT rules.

+

Enter a VM port ID, or private IP address and internal port, that does not conflict with existing DNAT rules.

+

400

+

VPC.2024

+

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

+

The external network information in this DNAT rule conflicts with that in existing DNAT rules.

+

Enter a floating IP address ID, external port number, and protocol that do not conflict with those in existing DNAT rules.

+

400

+

VPC.2026

+

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

+

The maximum number of DNAT rules that are allowed to have the same floating IP address bound has been reached.

+

Reduce the number of DNAT rules.

+

400

+

VPC.2027

+

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

+

The port ID in this DNAT rule conflicts with that in an existing DNAT rule.

+

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

+

400

+

VPC.2028

+

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 configured in the DNAT rule conflicts with that in an existing DNAT rule.

+

Change the private IP address or modify this DNAT rule.

+

400

+

VPC.2029

+

DNAT rule is frozen, can no longer update.

+

The DNAT rule has been frozen and cannot be updated.

+

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

+

400

+

VPC.2030

+

The system is busy. Please try again later.

+

The system is busy. Please try again later.

+

Try again later.

+

400

+

VPC.2031

+

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

+

The subnet for which the SNAT rule is configured conflicts with the VPC subnet.

+

Do not configure both Cidr and Network_id when you are configuring an SNAT rule.

+

400

+

VPC.2032

+

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

+

Invalid CIDR block.

+

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

+

400

+

VPC.2033

+

source_type and network_id is incompatible.

+

Invalid SNAT rule type.

+

If the SNAT rule is configured for servers in a VPC, Source_Type is optional or must be set to 0. If the SNAT rule is configured for servers in your on-premises data centers that are connected to a VPC through Direct Connect or your servers in another VPC, Source_Type must be set to 1.

+

400

+

VPC.2034

+

cidr must be a subset of subnet's cidr.

+

The CIDR block is not a subset of the VPC subnet.

+

Enter a subset of the subnet CIDR block. For example, if the subnet is 192.168.0.0/24, cidr can be 192.168.0.0/25.

+

400

+

VPC.2035

+

cidr conflicts with subnet's cidr.

+

The CIDR block of the SNAT rule conflicts with the subnet CIDR block.

+

If the SNAT rule is configured for subnets connected to a VPC through Direct Connect or Cloud Connect, the CIDR block cannot conflict with the VPC subnet CIDR block.

+

400

+

VPC.2036

+

cidr in the request conflicts with cidrs of existing rules.

+

The CIDR block conflicts with the existing one.

+

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

+

400

+

VPC.2037

+

The virtual IP address is not supported.

+

Virtual IP addresses are not supported.

+

Configure a valid private IP address.

+

400

+

VPC.2038

+

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

+

The maximum number of DNAT rules has been reached.

+

Delete some DNAT rules.

+

400

+

VPC.2039

+

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

+

The maximum number of EIPs bound to the SNAT rule has been reached.

+

Reduce the number of EIPs.

+

400

+

VPC.2040

+

Invalid value for public ip id.

+

The public IP address ID of an SNAT rule cannot be left blank.

+

Enter a valid UUID.

+

400

+

VPC.2042

+

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

+

The EIP has been used by an SNAT rule.

+

Select another EIP.

+

400

+

VPC.2043

+

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

+

The EIP has been bound to a rule.

+

Select another EIP.

+

400

+

VPC.2044

+

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

+

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

+

Enter a valid UUID.

+

400

+

VPC.2045

+

Get Nat gateway host failed

+

Failed to select the gateway node.

+

Contact technical support.

+

400

+

VPC.2046

+

Get Nat gateway agent local_ip failed

+

Failed to obtain the gateway node IP address.

+

Contact technical support.

+

400

+

VPC.2047

+

Get RouteTable %(router_id)s failed.

+

Failed to obtain the VPC route table.

+

Contact technical support.

+

400

+

VPC.2048

+

Invalid value for created_at %(timestamp)s.

+

Invalid timestamp.

+

Make sure that you enter the time in the correct format.

+

400

+

VPC.2049

+

DB Error

+

The database is abnormal.

+

Contact technical support.

+

400

+

VPC.2050

+

Concurrent conflict requests found

+

Concurrent operations on the NAT gateway conflict.

+

Contact technical support.

+

400

+

VPC.2051

+

Create NG Port failed.

+

Failed to create the internal port of the NAT gateway.

+

Contact technical support.

+

400

+

VPC.2052

+

NG Port %(port)s is unbound.

+

Failed to bind the internal port to the NAT gateway.

+

Contact technical support.

+

400

+

VPC.2053

+

NatGateway does not support IPv6.

+

NAT Gateway does not support IPv6 EIPs.

+

Bind an IPv4 EIP.

+

400

+

VPC.2054

+

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

+

Invalid DNAT rule protocol.

+

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

+

400

+

VPC.2055

+

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

+

The DNAT rule contains mutually exclusive parameters.

+

Configure either port_id or private_ip.

+

400

+

VPC.2056

+

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

+

Some parameters of this DNAT rule are not configured.

+

Check whether port_id and private_ip are configured. If no, configure at least one of them.

+

400

+

VPC.2057

+

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

+

The maximum number of DNAT rules allowed to be added in batches has been exceeded.

+

Reduce the number of DNAT rules for batch addition.

+

400

+

VPC.2058

+

Vtep_ip is Null.

+

VtepIp must be specified.

+

Contact technical support.

+

400

+

VPC.2059

+

Floating Ip %(fip)s is freezed.

+

The EIP is frozen.

+

Select an EIP that is not frozen.

+

400

+

VPC.2060

+

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

+

The EIP has been bound to a port.

+

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

+

400

+

VPC.2061

+

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

+

The EIP has been bound to a NAT gateway.

+

Select another EIP.

+

400

+

VPC.2062

+

Floating Ip %(fip)s has been occupied.

+

The EIP is in use.

+

Select another EIP.

+

400

+

VPC.2069

+

Invalid value for port %(port)s

+

Invalid port in the DNAT rule.

+

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

+

400

+

VPC.2070

+

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

+

Incorrect request for the DNAT rule.

+

Set the private port number and public port number to 0 and Protocol to Any.

+

400

+

VPC.2071

+

The private ip address is not legal.

+

Invalid private IP address in the DNAT rule.

+

Configure a valid private IP address.

+

400

+

VPC.2073

+

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

+

A DNAT rule cannot share an EIP with another DNAT rule in which mapping to a specific port is not set.

+

Select another EIP.

+

400

+

VPC.2074

+

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

+

An SNAT rule cannot share an EIP with another DNAT rule in which mapping to a specific port is not set.

+

Select another EIP.

+

400

+

VPC.2075

+

Enter a maximum of 255 characters.

+

The description contains more than 255 characters.

+

Enter a maximum of 255 characters.

+

400/404

+

NAT.0105

+

NatGateway %(nat_gateway_id)s does not exist.

+

The NAT gateway is not found. (HTTP status code 400 indicates that the gateway to be deleted is not found. HTTP status code 404 indicates that the gateway that you created or queried is not found.)

+

Check whether the NAT gateway ID is available.

+

401

+

NAT.0025

+

Token is expired.

+

Token expired.

+

Check whether the token is within the validity period.

+

401

+

VPC.0008

+

Invalid token in the header.

+

Invalid token.

+

Check whether the token in the request header is valid.

+

401

+

VPC.0009

+

real-name authentication fail.

+

Real-name authentication failed.

+

Contact technical support.

+

403

+

VPC.0010

+

Rules on xx by ** disallowed by policy

+

Insufficient permissions to call the underlying system.

+

Obtain required permissions.

+

403

+

VPC.2201

+

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

+

Insufficient fine-grained permissions.

+

Obtain required permissions.

+

403

+

VPC.2701

+

Token not allowed to do this action.

+

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

+

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

+

404

+

NAT.0004

+

The router %(router_id)s does not exist.

+

The router is not found.

+

Check whether the entered router ID is correct.

+

404

+

NAT.0005

+

Network %(network_id)s does not exist.

+

The subnet is not found.

+

Enter a valid subnet.

+

404

+

NAT.0013

+

Router %(router)s for the specified NAT gateway could not be found.

+

The route for the specified NAT gateway is not found.

+

Create a route for the specified NAT gateway.

+

404

+

NAT.0019

+

Network ********-****-****-****-************* could not be found.

+

The subnet ID is not found.

+

Check whether the subnet ID is available.

+

404

+

NAT.0020

+

Specifying 'tenant_id' other than authenticated tenant in request requires admin privileges

+

tenant_id is left blank or not found.

+

Check whether the tenant ID is available.

+

404

+

NAT.0021

+

Invalid input for nat_gateway_id. Reason: '********-****-****-****-*************'is not a valid UUID.

+

Nat_gateway_id is left blank or not found.

+

Check whether the NAT gateway ID is available.

+

404

+

NAT.0023

+

Port '********-****-****-****-*************' could not be found.

+

The port ID is not found.

+

Check whether the port ID is available.

+

404

+

NAT.0024

+

Invalid input for floating_ip_id. Reason: '********-****-****-****-*************'is not a valid UUID.

+

Floating_ip_id is left blank, not found, or is invalid.

+

Check whether the floating IP address ID is correct.

+

404

+

NAT.0209

+

No Snat Rule exist with id %(id)s

+

The SNAT rule is not found.

+

Check whether the SNAT rule ID is available.

+

404

+

NAT.0319

+

No Dnat Rule exist with id %(id)s

+

The DNAT rule is not found.

+

Contact technical support.

+

404

+

VPC.0003

+

VPC does not exit.

+

The VPC is not found.

+

Check whether the VPC ID is valid or whether the VPC is available.

+

400

+

NAT.1010

+

Request parameter Json parsing failed %s.

+

Parsing JSON request failed.

+

Check whether the request parameters are in the correct format.

+

400

+

NAT.1015

+

Tags parameter is illegal.

+

Invalid tag.

+

Enter a valid tag value.

+

400

+

NAT.1016

+

The number of tags exceeds the limit %s.

+

The maximum number of tags has been reached.

+

Add up to %s tags.

+

400

+

NAT.1022

+

Account is restricted, operation is forbidden.

+

The private NAT gateway cannot be created because your account has been suspended.

+

Check whether your account is suspended and contact technical support.

+

400

+

NAT.1023

+

Account is suspended, operation is forbidden.

+

The private NAT gateway cannot be created because your account has been frozen.

+

Check whether your account is frozen and contact technical support.

+

400

+

NAT.1101

+

Transit subnet can not be create with this network %s. +//External subnet can not be create with this network %s.

+

The subnet where the transit IP address is located is unavailable.

+

Contact technical support.

+

400

+

NAT.1201

+

%s downlink vpc has been associated to this private nat gateway, no more is allowed.

+

Only one downlink_vpc can be entered.

+

Enter only one downlink_vpc.

+

400

+

NAT.1202

+

There are one or more rules still in use on the gateway %s, can not be deleted.

+

The private NAT gateway cannot be deleted because it has rules.

+

Delete a private NAT gateway after deleting all its rules.

+

400

+

NAT.1204

+

This vpc at most have %s private nat gateway.

+

The maximum number of private NAT gateways in the VPC has been reached.

+

Use another VPC or delete other private NAT gateways in this VPC.

+

400

+

NAT.1206

+

Update (%s) spec to (%s) are the same as the original.

+

The private NAT gateway can be updated only to different specifications.

+

Update the private NAT gateway to different specifications.

+

400

+

NAT.1207

+

Gateway %s already has %d rules, the maximum number of rule for spec %s is %d. Downgrade is forbidden. //Add this gateway rule over rule max %d.

+

The maximum number of rules that can be added on the private NAT gateway of the new specifications has been exceeded, so the gateway specifications cannot be updated. The maximum number of NAT gateway rules has been reached. No more rules can be created.

+

Ensure that the number of rules added on the private NAT gateway does not exceed the maximum number of rules after the update. Delete some rules or update the private NAT gateway to more robust specifications.

+

400

+

NAT.1208

+

Gateway %s is frozen, create operation is forbidden. //Gateway %s is frozen, delete operation is forbidden. //Gateway %s is frozen, update operation is forbidden.

+

Operation not allowed. The private NAT gateway has been frozen.

+

Check whether your private NAT gateway is frozen and contact technical support.

+

400

+

NAT.1306

+

dnat Parameters entered are illegal, protocol:any should be entered with internal_service_port:0 and transit_service_port:0 together. +//dnat Parameters entered are illegal, protocol:any should be entered with internal_service_port:0 and external_service_port:0 together.

+

Invalid parameters in the request body of the DNAT rule.

+

Set protocol to any, internal_service_port to 0, and transit_service_port to 0.

+

400

+

NAT.1311

+

The networkInterfaceId(port_id) and private_ip_address(fixed_ip_address) exist at the same time or both are empty, but at least one value is empty.

+

Either network_interface_id or private_ip_address must be specified.

+

Specify network_interface_id or private_ip_address.

+

400

+

NAT.1404

+

No more IP addresses available on subnet %s.

+

There are no available IP addresses in the subnet.

+

Contact technical support.

+

400

+

NAT.1405

+

IP address %s is not a valid IP for the subnet.

+

Invalid IP address in the subnet.

+

Contact technical support.

+

400

+

NAT.1501

+

Either virSubnet(network) or cidr must be specified." + "Both can not be specified at the same time.

+

Either virsubnet_id or cidr must be specified.

+

Specify virsubnet_id or cidr.

+

400

+

NAT.1502

+

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

+

Invalid cidr.

+

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

+

400

+

NAT.1506

+

%s transit ip has been associated to this SNAT rules's transit ip pool, no more is allowed. +//%s external ip has been associated to this SNAT rules's external ip pool, no more is allowed.

+

The maximum number of transit IP addresses that can be selected for the SNAT rule has been exceeded.

+

Enter only one transit IP address.

+

400

+

NAT.1507

+

'transit_ip_id' attribute value should be 'uuid' type! +//'external_ip_id' attribute value should be 'uuid' type!

+

Invalid transit_ip_id.

+

Enter the transit_ip_id value in UUID format.

+

404

+

NAT.1002

+

%s %s could not be found.

+

The resource is not found.

+

Check whether the resource is available or contact technical support.

+

404

+

NAT.1003

+

VirSubnet %s could not be found in vpc for gateway %s.

+

The subnet for which the SNAT rule is configured is not in the VPC of the private NAT gateway.

+

Ensure that the subnet for which the SNAT rule is configured is in the VPC of the private NAT gateway.

+

404

+

NAT.1009

+

Port %s information is missing.

+

Port information is missing.

+

Contact technical support.

+

409

+

NAT.1303

+

Transit ip %s is in this vpc, not support to specified. +//External ip %s is in this vpc, not support to specified.

+

The VPC of the transit IP address must be different from that of the private NAT gateway.

+

Use a transit IP address that is in a different VPC of the private NAT gateway.

+

409

+

NAT.1304

+

Port %s is not in this vpc, not support to specified.

+

The port for which the DNAT rule is configured is not in the VPC of the private NAT gateway.

+

Ensure that the port for which the DNAT rule is configured is in the VPC of the private NAT gateway.

+

409

+

NAT.1305

+

Transit ip %s is used by exist dnat rule. +//External ip %s is used by exist dnat rule.

+

The transit IP address is already used by a DNAT rule.

+

Use a transit IP address that is not used by any DNAT rule.

+

409

+

NAT.1307

+

Internal parameters entered conflict with exist dnat rules. //PrivateIp(FixedIp) %s is used by exist dnat rule.

+

The internal network information in this DNAT rule conflicts with that in existing DNAT rules.

+

Use a port, private IP address, backend port, and protocol that do not conflict with those of existing DNAT rules.

+

409

+

NAT.1308

+

Transit ip %s is used by exist snat rule. +//External ip %s is used by exist snat rule.

+

The transit IP address is already used by an SNAT rule.

+

Use a transit IP address that is not used by any SNAT rule.

+

409

+

NAT.1309

+

Port %s is used by exist dnat rule.

+

The port is being used by a DNAT rule of another protocol type.

+

Use a port that is not used by DNAT rules of another protocol type.

+

409

+

NAT.1310

+

Transit parameters entered conflict with exist dnat rules. +//External parameters entered conflict with exist dnat rules.

+

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

+

Use a transit IP address, port number, and protocol that do not conflict with those in existing DNAT rules.

+

409

+

NAT.1403

+

Unable to complete operation for subnet %s. The IP address %s is in use.

+

This IP address is already in use.

+

Contact technical support.

+

409

+

NAT.1406

+

Transit ip %s has used by private nat gateway %s. +//External ip %s has used by private nat gateway %s.

+

The transit IP address has been used by another private NAT gateway.

+

Use a transit IP address that is not used by other private NAT gateways.

+

409

+

NAT.1409

+

Transit ip %s is used by rules. +//External ip %s is used by rules.

+

The transit IP address is used by a rule.

+

Ensure that the transit IP address is not used by other rules before deleting it.

+

409

+

NAT.1410

+

Transit ip %s is used by dnat rules of other protocols. +//External ip %s is used by dnat rules of other protocols.

+

The transit IP address is being used by a DNAT rule of another protocol type.

+

Use a transit IP address that is not used by DNAT rules of another protocol type.

+

409

+

NAT.1503

+

Snat rule for network %s exists.

+

An SNAT rule has been configured for this subnet.

+

Select a subnet that has no SNAT rules configured.

+

409

+

NAT.1505

+

Snat rule for cidr %s exists.

+

An SNAT rule has been configured for this CIDR block.

+

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

+

500

+

NAT.1001

+

Internal Server Error.

+

Internal service error.

+

Contact technical support.

+

500

+

NAT.1004

+

Create Port Failed with subnet %s.

+

Failed to create the port in the subnet.

+

Contact technical support.

+

500

+

NAT.1005

+

Delete Port %s Failed.

+

Port deletion failed.

+

Contact technical support.

+
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/natgw/api-ref/ListPrivateDnats.html b/docs/natgw/api-ref/ListPrivateDnats.html new file mode 100644 index 000000000..6c1e95344 --- /dev/null +++ b/docs/natgw/api-ref/ListPrivateDnats.html @@ -0,0 +1,538 @@ + + +

Querying DNAT Rules

+

Function

This API is used to query DNAT rules.

+
+

Constraints

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.

+
+

URI

GET /v3/{project_id}/private-nat/dnat-rules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Specifies the number of records displayed on each page.

+

The value ranges from 1 to 2000.

+

Default value: 2000

+

Value range:

+

1-2000

+

Default value:

+

2000

+

marker

+

No

+

String

+

Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

+

The value is obtained from next_marker or previous_marker in PageInfo queried last time.

+

page_reverse

+

No

+

Boolean

+

Specifies whether to query resources on the previous page.

+

id

+

No

+

Array of strings

+

Specifies the DNAT rule ID.

+

project_id

+

No

+

Array of strings

+

Specifies the project ID.

+

enterprise_project_id

+

No

+

Array of strings

+

Specifies the ID of the enterprise project that is associated with the DNAT rule when the DNAT rule is created.

+

description

+

No

+

Array of strings

+

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

gateway_id

+

No

+

Array of strings

+

Specifies the private NAT gateway ID.

+

transit_ip_id

+

No

+

Array of strings

+

Specifies the ID of the transit IP address.

+

external_ip_address

+

No

+

Array of strings

+

Specifies the transit IP address.

+

network_interface_id

+

No

+

Array of strings

+

Specifies the port ID of the resource that the NAT gateway is bound to. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

type

+

No

+

Array of strings

+

Specifies the backend resource type of the DNAT rule.

+

The type can be:

+

  • COMPUTE: The backend resource is a compute instance.

    +

  • VIP: The backend resource is a virtual IP address.

    +

  • ELB: The backend resource is a v2 load balancer.

    +

  • ELBv3: The backend resource is a v3 load balancer.

    +

  • CUSTOMIZE: The backend resource is a user-defined IP address.

    +
+

private_ip_address

+

No

+

Array of strings

+

Specifies the port IP address that the NAT gateway uses. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

protocol

+

No

+

Array of strings

+

Specifies the DNAT rule protocol type.

+

TCP, UDP, and ANY are supported.

+

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

+

internal_service_port

+

No

+

Array of strings

+

Specifies the port number of the resource, which can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

transit_service_port

+

No

+

Array of strings

+

Specifies the port number of the transit IP address.

+

created_at

+

No

+

String

+

Specifies the time when the DNAT rule was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

No

+

String

+

Specifies the time when the DNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

dnat_rules

+

Array of PrivateDnat objects

+

Specifies the response body for querying DNAT rules.

+

request_id

+

String

+

Specifies the request ID.

+

page_info

+

PageInfo object

+

Specifies the pagination information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PrivateDnat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the DNAT rule ID.

+

project_id

+

String

+

Specifies the project ID.

+

description

+

String

+

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_id

+

String

+

Specifies the ID of the transit IP address.

+

gateway_id

+

String

+

Specifies the private NAT gateway ID.

+

network_interface_id

+

String

+

Specifies the network interface ID. Network interfaces of a compute instance, load balancer (v2 or v3), or virtual IP address are supported.

+

type

+

String

+

Specifies the backend resource type of the DNAT rule.

+

The type can be:

+

  • COMPUTE: The backend resource is a compute instance.

    +

  • VIP: The backend resource is a virtual IP address.

    +

  • ELB: The backend resource is a v2 load balancer.

    +

  • ELBv3: The backend resource is a v3 load balancer.

    +

  • CUSTOMIZE: The backend resource is a user-defined IP address.

    +
+

protocol

+

String

+

Specifies the protocol type.

+

TCP, UDP, and ANY are supported.

+

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

+

Enumeration values:

+

  • tcp

    +

  • udp

    +

  • any

    +
+

private_ip_address

+

String

+

Specifies the port IP address that the NAT gateway uses. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

internal_service_port

+

String

+

Specifies the port number of the resource, which can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

transit_service_port

+

String

+

Specifies the port number of the transit IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

enterprise_project_id

+

String

+

Specifies the ID of the enterprise project that is associated with the DNAT rule when the DNAT rule is created.

+

created_at

+

String

+

Specifies the time when the DNAT rule was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the DNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

status

+

String

+

Specifies the DNAT rule status of a private NAT gateway.

+

The value can be:

+

  • ACTIVE: The DNAT rule is running properly.

    +

  • FROZEN: The DNAT rule is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

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

Parameter

+

Type

+

Description

+

next_marker

+

String

+

Specifies the ID of the last record in this query, which can be used in the next query.

+

previous_marker

+

String

+

Specifies the ID of the first record in the pagination query result. When page_reverse is set to true, this parameter is used together to query resources on the previous page.

+

current_count

+

Integer

+

Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page.

+

Value range:

+

1-2000

+
+
+
+

Example Requests

GET https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules
+
+

Example Responses

Status code: 200

+

DNAT rules queried.

+
{
+  "dnat_rules" : [ {
+    "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83",
+    "project_id" : "da261828016849188f4dcc2ef94d9da9",
+    "description" : "aa",
+    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
+    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707",
+    "type" : "COMPUTE",
+    "protocol" : "any",
+    "internal_service_port" : "0",
+    "transit_service_port" : "0",
+    "private_ip_address" : "192.168.1.72",
+    "created_at" : "2019-04-29T07:10:01",
+    "updated_at" : "2019-04-29T07:10:01",
+    "status" : "ACTIVE"
+  }, {
+    "id" : "25dcdb21-97de-43cd-b476-31637a47f05d",
+    "project_id" : "da261828016849188f4dcc2ef94d9da9",
+    "description" : "aa",
+    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
+    "transit_ip_id" : "15abdf29-4a68-474c-9963-79c4e6d495d7",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "network_interface_id" : "9e2f0dbb-68b2-4c4b-9298-fa4f13187976",
+    "type" : "COMPUTE",
+    "protocol" : "any",
+    "internal_service_port" : "0",
+    "transit_service_port" : "0",
+    "private_ip_address" : "192.168.1.99",
+    "created_at" : "2019-04-29T07:15:41",
+    "updated_at" : "2019-04-29T07:15:41",
+    "status" : "ACTIVE"
+  } ],
+  "request_id" : "a7b00469-5a31-4274-bb10-59167243383e",
+  "page_info" : {
+    "previous_marker" : "14338426-6afe-4019-996b-018008113013",
+    "current_count" : 2
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

DNAT rules queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: DNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/ListPrivateNatTags.html b/docs/natgw/api-ref/ListPrivateNatTags.html new file mode 100644 index 000000000..22a29b252 --- /dev/null +++ b/docs/natgw/api-ref/ListPrivateNatTags.html @@ -0,0 +1,160 @@ + + +

Querying Tags of All Private NAT Gateways in a Project

+

Function

  • This API is used to query tags of all private NAT gateways owned by a tenant in a project.

    +

  • TMS uses this API to list tags of all private NAT gateways owned by a tenant, and provides tag association when you tag or filter private NAT gateways.

    +
+
+

URI

GET /v3/{project_id}/private-nat-gateways/tags

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

request_id

+

String

+

Specifies the request ID.

+

tags

+

Array of Tags objects

+

Specifies the tags.

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

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. (The system does not verify key when searching for resources.) key cannot be left blank or be an empty string. key cannot contain spaces. Before using the value of key, delete spaces before and after the value.

+

values

+

Array of strings

+

Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. Before verifying and using values, delete SBC spaces before and after the value.

+

The value can be an empty array but cannot be left blank. If values is not specified, any parameter value can be queried.

+

The values are in the OR relationship. The system verifies the length, but not verifies the character set of values when searching for resources.

+
+
+
+

Example Requests

GET  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/tags
+
+

Example Responses

Status code: 200

+

Query operation succeeded.

+
{
+  "request_id" : "c285190c-b9e9-4f38-a69a-6745f22d8dca",
+  "tags" : [ {
+    "key" : "keys",
+    "values" : [ "value" ]
+  }, {
+    "key" : "key3",
+    "values" : [ "value3" ]
+  }, {
+    "key" : "key1",
+    "values" : [ "value1" ]
+  }, {
+    "key" : "key2",
+    "values" : [ "value2" ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Query operation succeeded.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateway Tags
+
+
+ diff --git a/docs/natgw/api-ref/ListPrivateNats.html b/docs/natgw/api-ref/ListPrivateNats.html new file mode 100644 index 000000000..525854724 --- /dev/null +++ b/docs/natgw/api-ref/ListPrivateNats.html @@ -0,0 +1,547 @@ + + +

Querying Private NAT Gateways

+

Function

This API is used to query private NAT gateways.

+
+

Constraints

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.

+
+

URI

GET /v3/{project_id}/private-nat/gateways

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Specifies the number of records displayed on each page.

+

The value ranges from 1 to 2000.

+

Default value: 2000

+

Value range:

+

1-2000

+

Default value:

+

2000

+

marker

+

No

+

String

+

Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

+

The value is obtained from next_marker or previous_marker in PageInfo queried last time.

+

page_reverse

+

No

+

Boolean

+

Specifies whether to query resources on the previous page.

+

id

+

No

+

Array of strings

+

Specifies the private NAT gateway ID.

+

name

+

No

+

Array of strings

+

Specifies the private NAT gateway name.

+

description

+

No

+

Array of strings

+

Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

spec

+

No

+

Array of strings

+

Specifies the private NAT gateway specifications.

+

The value can be:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

Enumeration values:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

project_id

+

No

+

Array of strings

+

Specifies the project ID.

+

status

+

No

+

Array of strings

+

Specifies the private NAT gateway status.

+

The value can be:

+

  • ACTIVE: The private NAT gateway is running properly.

    +

  • FROZEN: The private NAT gateway is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+

vpc_id

+

No

+

Array of strings

+

Specifies the ID of the VPC where the private NAT gateway works.

+

virsubnet_id

+

No

+

Array of strings

+

Specifies the ID of the subnet where the private NAT gateway works.

+

enterprise_project_id

+

No

+

Array of strings

+

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

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

gateways

+

Array of PrivateNat objects

+

Specifies the response body for querying private NAT gateways.

+

For details, see the PrivateNat description.

+

request_id

+

String

+

Specifies the request ID.

+

page_info

+

PageInfo object

+

Specifies the pagination information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PrivateNat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the private NAT gateway ID.

+

project_id

+

String

+

Specifies the project ID.

+

name

+

String

+

Specifies the private NAT gateway name.

+

description

+

String

+

Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

spec

+

String

+

Specifies the private NAT gateway specifications.

+

The value can be:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

Default value:

+

Small

+

Enumeration values:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

status

+

String

+

Specifies the private NAT gateway status.

+

The value can be:

+

  • ACTIVE: The private NAT gateway is running properly.

    +

  • FROZEN: The private NAT gateway is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+

created_at

+

String

+

Specifies the time when the private NAT gateway was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the private NAT gateway was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

downlink_vpcs

+

Array of DownlinkVpc objects

+

Specifies the VPC where the private NAT gateway works.

+

tags

+

Array of Tag objects

+

Specifies the list of tags.

+

enterprise_project_id

+

String

+

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

+

rule_max

+

Integer

+

Specifies the maximum number of rules.

+

Value range:

+

0-65535

+

transit_ip_pool_size_max

+

Integer

+

Specifies the maximum number of transit IP addresses in a transit IP address pool.

+

Value range:

+

1-100

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 DownlinkVpc

Parameter

+

Type

+

Description

+

vpc_id

+

String

+

Specifies the ID of the VPC where the private NAT gateway works.

+

virsubnet_id

+

String

+

Specifies the ID of the subnet where the private NAT gateway works.

+

ngport_ip_address

+

String

+

Specifies the private IP address of the private NAT gateway.

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

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

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

Parameter

+

Type

+

Description

+

next_marker

+

String

+

Specifies the ID of the last record in this query, which can be used in the next query.

+

previous_marker

+

String

+

Specifies the ID of the first record in the pagination query result. When page_reverse is set to true, this parameter is used together to query resources on the previous page.

+

current_count

+

Integer

+

Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page.

+

Value range:

+

1-2000

+
+
+
+

Example Requests

GET https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways
+
+

Example Responses

Status code: 200

+

Private NAT gateways queried.

+
{
+  "gateways" : [ {
+    "id" : "14338426-6afe-4019-996b-3a9525296e11",
+    "name" : "private-nat-gateway-name1",
+    "description" : "private-nat-gateway-description1",
+    "spec" : "Small",
+    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "status" : "ACTIVE",
+    "created_at" : "2019-04-22T08:47:13",
+    "updated_at" : "2019-04-22T08:47:13",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ],
+    "downlink_vpcs" : [ {
+      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
+      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70",
+      "ngport_ip_address" : "10.0.0.17"
+    } ],
+    "transit_ip_pool_size_max" : 1,
+    "rule_max" : 20
+  }, {
+    "id" : "65995b8e-dcb7-4ab4-9931-bc3c95beec0a",
+    "name" : "private-nat-gateway-name2",
+    "description" : "private-nat-gateway-description2",
+    "spec" : "Small",
+    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "status" : "ACTIVE",
+    "created_at" : "2019-04-22T09:06:54",
+    "updated_at" : "2019-04-22T09:06:54",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ],
+    "downlink_vpcs" : [ {
+      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
+      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70",
+      "ngport_ip_address" : "10.0.0.18"
+    } ],
+    "transit_ip_pool_size_max" : 1,
+    "rule_max" : 20
+  } ],
+  "request_id" : "a7b00469-5a31-4274-bb10-59167243383e",
+  "page_info" : {
+    "previous_marker" : "14338426-6afe-4019-996b-3a9525296e11",
+    "current_count" : 2
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Private NAT gateways queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateways
+
+
+ diff --git a/docs/natgw/api-ref/ListPrivateNatsByTags.html b/docs/natgw/api-ref/ListPrivateNatsByTags.html new file mode 100644 index 000000000..389f9bf42 --- /dev/null +++ b/docs/natgw/api-ref/ListPrivateNatsByTags.html @@ -0,0 +1,403 @@ + + +

Querying Private NAT Gateways

+

Function

  • This API is used to query private NAT gateways by tag.

    +

  • Tag Management Service (TMS) uses this API to filter and list private NAT gateways by tag.

    +
+
+

URI

POST /v3/{project_id}/private-nat-gateways/resource_instances/action

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

String

+

Specifies the index position. The query starts from the next data record indexed by this parameter. When querying resources on the first page, you do not need to specify this parameter. When querying resources on subsequent pages, set this parameter to the value returned in the response body for querying resources on the previous page. This parameter is not available when action is set to count. If action is set to filter, the value must be a positive number, and the default value is 0.

+

limit

+

No

+

String

+

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

+

action

+

Yes

+

String

+

Specifies the operation to be performed. The value can be filter or count.

+

The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned.

+

Enumeration values:

+

  • filter

    +

  • count

    +
+

matches

+

No

+

Array of Match objects

+

Specifies the search field. The tag key is the field to be matched, for example, resource_name. The tag value indicates the value to be matched. This field is a fixed dictionary value. You can determine whether fuzzy match is required based on different fields. For example, if key is set to resource_name, fuzzy search (case insensitive) is used by default. If value is an empty string, exact match is used. If key is set to resource_id, exact match is used. Currently, only resource_name is supported.

+

not_tags

+

No

+

Array of Tags objects

+

The resources to be queried do not contain tags listed in not_tags. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag 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 that do not contain the tags listed in not_tags will be returned.Keys are in AND relationship, and values in a tag are in OR relationship.If this parameter is not specified, all resources will be returned.

+

tags

+

No

+

Array of Tags objects

+

The resources to be queried contain tags listed in tags. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag 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 that contain the tags listed in *tags will be returned.Keys are in AND relationship, and values in a tag are in OR relationship.If this parameter is not specified, all resources will be returned.

+

tags_any

+

No

+

Array of Tags objects

+

The resources to be queried contain any tag listed in tags_any. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag 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 that contain any tag listed in *tags_any will be returned.Keys are in AND relationship, and values in a tag are in OR relationship.If this parameter is not specified, all resources will be returned.

+

not_tags_any

+

No

+

Array of Tags objects

+

The resources to be queried do not contain any tag listed in not_tags_any. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag 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 that do not contain any tag listed in not_tags_any will be returned.Keys are in AND relationship, and values in a tag are in OR relationship.If this parameter is not specified, all resources will be returned.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Match

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key used to search for resources.

+

value

+

Yes

+

String

+

Specifies the tag value used to search for resources.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 Tags

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. (The system does not verify key when searching for resources.) key cannot be left blank or be an empty string. key cannot contain spaces. Before using the value of key, delete spaces before and after the value.

+

values

+

Yes

+

Array of strings

+

Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. Before verifying and using values, delete SBC spaces before and after the value.

+

The value can be an empty array but cannot be left blank. If values is not specified, any parameter value can be queried.

+

The values are in the OR relationship. The system verifies the length, but not verifies the character set of values when searching for resources.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

resources

+

Array of Resource objects

+

Specifies the resource list.

+

request_id

+

String

+

Specifies the request ID.

+

total_count

+

Integer

+

Specifies the total number of records.

+

Value range:

+

0-1000000

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 Resource

Parameter

+

Type

+

Description

+

resource_detail

+

Object

+

Specifies the resource details. This parameter is used for extension and is left blank by default.

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_name

+

String

+

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

+

resource_tag

+

Array of ResourceTag objects

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key.

+

value

+

String

+

Specifies the tag value.

+
+
+
+

Example Requests

  • Querying private NAT gateways by tag (Setting action to filter and limit to 1000)

    +
    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/resource_instances/action
+
+{
+  "offset" : "0",
+  "limit" : "1000",
+  "action" : "filter",
+  "not_tags_any" : [ {
+    "key" : "owner",
+    "value" : "tag_1_value"
+  } ]
+}
    +

  • Querying private NAT gateways by tag (Setting action to count and adding tags)

    +
    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/resource_instances/action
+
+{
+  "action" : "count",
+  "tags" : [ {
+    "key" : "key1",
+    "values" : [ "value1", "value2" ]
+  } ],
+  "matches" : [ {
+    "key" : "resource_name",
+    "value" : "resource1"
+  } ]
+}
    +
+
+

Example Responses

Status code: 200

+

Query operation succeeded.

+

  • Example 1: the response body when action is set to filter

    +

  • Example 2: the response body when action is set to count

    +
+

  • Example 1

    +
    {
+  "resources" : [ {
+    "resource_detail" : null,
+    "resource_id" : "e5ad289f-9c56-4daf-b08b-2e53a983473a",
+    "resource_name" : "nat_gateways",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    }, {
+      "key" : "key2",
+      "value" : "value1"
+    } ]
+  } ],
+  "request_id" : "a67262f6b7242d63d4ae95e41abf2790",
+  "total_count" : 1
+}
    +

  • Example 2

    +
    {
+  "request_id" : "a67262f6b7242d63d4ae95e41abf2790",
+  "total_count" : 100
+}
    +
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Query operation succeeded.

+

  • Example 1: the response body when action is set to filter

    +

  • Example 2: the response body when action is set to count

    +
+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateway Tags
+
+
+ diff --git a/docs/natgw/api-ref/ListPrivateSnats.html b/docs/natgw/api-ref/ListPrivateSnats.html new file mode 100644 index 000000000..bacd00900 --- /dev/null +++ b/docs/natgw/api-ref/ListPrivateSnats.html @@ -0,0 +1,450 @@ + + +

Querying SNAT Rules

+

Function

This API is used to query SNAT rules.

+
+

URI

GET /v3/{project_id}/private-nat/snat-rules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Specifies the number of records displayed on each page.

+

The value ranges from 1 to 2000.

+

Default value: 2000

+

Value range:

+

1-2000

+

Default value:

+

2000

+

marker

+

No

+

String

+

Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

+

The value is obtained from next_marker or previous_marker in PageInfo queried last time.

+

page_reverse

+

No

+

Boolean

+

Specifies whether to query resources on the previous page.

+

id

+

No

+

Array of strings

+

Specifies the SNAT rule ID.

+

project_id

+

No

+

Array of strings

+

Specifies the project ID.

+

description

+

No

+

Array of strings

+

Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

gateway_id

+

No

+

Array of strings

+

Specifies the private NAT gateway ID.

+

cidr

+

No

+

Array of strings

+

Specifies the CIDR block that matches the SNAT rule.

+

virsubnet_id

+

No

+

Array of strings

+

Specifies the ID of the subnet that matches the SNAT rule.

+

transit_ip_id

+

No

+

Array of strings

+

Specifies the ID of the transit IP address.

+

transit_ip_address

+

No

+

Array of strings

+

Specifies the transit IP address.

+

enterprise_project_id

+

No

+

Array of strings

+

Specifies the ID of the enterprise project that is associated with the SNAT rule when the SNAT rule is created.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

snat_rules

+

Array of PrivateSnat objects

+

Specifies the response body for querying SNAT rules.

+

page_info

+

PageInfo object

+

Specifies the pagination information.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PrivateSnat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the SNAT rule ID.

+

project_id

+

String

+

Specifies the project ID.

+

gateway_id

+

String

+

Specifies the private NAT gateway ID.

+

cidr

+

String

+

Specifies the CIDR block that matches the SNAT rule.

+

Constraints:

+

  • Either this parameter or virsubnet_id must be specified.

    +

  • The CIDR block cannot be the same as that of an existing SNAT rule.

    +
+

virsubnet_id

+

String

+

Specifies the ID of the subnet that matches the SNAT rule.

+

Constraint: Either this parameter or cidr must be specified.

+

description

+

String

+

Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_associations

+

Array of AssociatedTransitIp objects

+

Specifies the list of details of associated transit IP addresses.

+

created_at

+

String

+

Specifies the time when the SNAT rule was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the SNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

enterprise_project_id

+

String

+

Specifies the enterprise project ID.

+

status

+

String

+

Specifies the SNAT rule status of a private NAT gateway.

+

The value can be:

+

  • ACTIVE: The SNAT rule is running properly.

    +

  • FROZEN: The SNAT rule is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 6 AssociatedTransitIp

Parameter

+

Type

+

Description

+

transit_ip_id

+

String

+

Specifies the ID of the transit IP address.

+

transit_ip_address

+

String

+

Specifies the transit IP address.

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

Parameter

+

Type

+

Description

+

next_marker

+

String

+

Specifies the ID of the last record in this query, which can be used in the next query.

+

previous_marker

+

String

+

Specifies the ID of the first record in the pagination query result. When page_reverse is set to true, this parameter is used together to query resources on the previous page.

+

current_count

+

Integer

+

Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page.

+

Value range:

+

1-2000

+
+
+
+

Example Requests

GET https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat/snat-rules
+
+

Example Responses

Status code: 200

+

SNAT rules queried.

+
{
+  "snat_rules" : [ {
+    "id" : "8a522ff9-8158-494b-83cd-533b045700e6",
+    "project_id" : "cfa563efb77d4b6d9960781d82530fd8",
+    "description" : "snat rule description",
+    "gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
+    "cidr" : "",
+    "virsubnet_id" : "95df1b88-d9bc-4edd-a808-a771dd4ded32",
+    "transit_ip_associations" : [ {
+      "transit_ip_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
+      "transit_ip_address" : "172.20.1.98"
+    } ],
+    "created_at" : "2019-10-22T03:33:07",
+    "updated_at" : "2019-10-22T03:33:07",
+    "status" : "ACTIVE"
+  }, {
+    "id" : "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81",
+    "project_id" : "cfa563efb77d4b6d9960781d82530fd8",
+    "description" : "snat rule description",
+    "gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
+    "cidr" : "",
+    "virsubnet_id" : "5b9ea497-727d-4ad0-a99e-3984b3f5aaed",
+    "transit_ip_associations" : [ {
+      "transit_ip_id" : "36a3049a-1682-48b3-b1cf-cb986a3350ef",
+      "transit_ip_address" : "172.20.1.10"
+    } ],
+    "created_at" : "2019-10-22T03:31:19",
+    "updated_at" : "2019-10-22T03:31:19",
+    "status" : "ACTIVE"
+  } ],
+  "page_info" : {
+    "next_marker" : "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81",
+    "previous_marker" : "8a522ff9-8158-494b-83cd-533b045700e6",
+    "current_count" : 2
+  },
+  "request_id" : "69806207-62e3-4950-b463-ff5c1779b714"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

SNAT rules queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: SNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/ListTransitIpTags.html b/docs/natgw/api-ref/ListTransitIpTags.html new file mode 100644 index 000000000..a1b3081eb --- /dev/null +++ b/docs/natgw/api-ref/ListTransitIpTags.html @@ -0,0 +1,160 @@ + + +

Querying Tags of All Transit IP Addresses in a Specified Project

+

Function

  • This API is used to query tags of all transit IP addresses owned by a tenant in a project.

    +

  • TMS uses this API to list tags of all transit IP addresses owned by a tenant. TMS also provides tag association when users tag or filter transit IP addresses.

    +
+
+

URI

GET /v3/{project_id}/transit-ips/tags

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

request_id

+

String

+

Specifies the request ID.

+

tags

+

Array of Tags objects

+

Specifies the tags.

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

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. (The system does not verify key when searching for resources.) key cannot be left blank or be an empty string. key cannot contain spaces. Before using the value of key, delete spaces before and after the value.

+

values

+

Array of strings

+

Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. Before verifying and using values, delete SBC spaces before and after the value.

+

The value can be an empty array but cannot be left blank. If values is not specified, any parameter value can be queried.

+

The values are in the OR relationship. The system verifies the length, but not verifies the character set of values when searching for resources.

+
+
+
+

Example Requests

GET  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/tags
+
+

Example Responses

Status code: 200

+

Query operation succeeded.

+
{
+  "request_id" : "36479272a29de0be0a8a8b294c02ab7a",
+  "tags" : [ {
+    "key" : "keys",
+    "values" : [ "value" ]
+  }, {
+    "key" : "key3",
+    "values" : [ "value3" ]
+  }, {
+    "key" : "key1",
+    "values" : [ "value1" ]
+  }, {
+    "key" : "key2",
+    "values" : [ "value2" ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Query operation succeeded.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Address Tags
+
+
+ diff --git a/docs/natgw/api-ref/ListTransitIps.html b/docs/natgw/api-ref/ListTransitIps.html new file mode 100644 index 000000000..60a3d1462 --- /dev/null +++ b/docs/natgw/api-ref/ListTransitIps.html @@ -0,0 +1,446 @@ + + +

Querying Transit IP Addresses

+

Function

This API is to query transit IP addresses.

+
+

Constraints

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.

+
+

URI

GET /v3/{project_id}/private-nat/transit-ips

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Specifies the number of records displayed on each page.

+

The value ranges from 1 to 2000.

+

Default value: 2000

+

Value range:

+

1-2000

+

Default value:

+

2000

+

marker

+

No

+

String

+

Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

+

The value is obtained from next_marker or previous_marker in PageInfo queried last time.

+

page_reverse

+

No

+

Boolean

+

Specifies whether to query resources on the previous page.

+

id

+

No

+

Array of strings

+

Specifies the ID of the transit IP address.

+

project_id

+

No

+

Array of strings

+

Specifies the project ID.

+

network_interface_id

+

No

+

Array of strings

+

Specifies the network interface ID of the transit IP address.

+

ip_address

+

No

+

Array of strings

+

Specifies the transit IP address.

+

gateway_id

+

No

+

Array of strings

+

Specifies the ID of the private NAT gateway associated with the transit IP address.

+

enterprise_project_id

+

No

+

Array of strings

+

Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is assigned.

+

virsubnet_id

+

No

+

Array of strings

+

Specifies the subnet ID of the current tenant.

+

transit_subnet_id

+

No

+

Array of strings

+

Specifies the transit subnet ID.

+

description

+

No

+

Array of strings

+

Provides supplementary information about the transit IP address. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

transit_ips

+

Array of TransitIp objects

+

Specifies the response body for querying transit IP addresses.

+

page_info

+

PageInfo object

+

Specifies the pagination information.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 TransitIp

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the ID of the transit IP address.

+

project_id

+

String

+

Specifies the project ID.

+

network_interface_id

+

String

+

Specifies the network interface ID of the transit IP address.

+

ip_address

+

String

+

Specifies the transit IP address.

+

created_at

+

String

+

Specifies the time when the transit IP address was assigned. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the transit IP address was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

virsubnet_id

+

String

+

Specifies the subnet ID of the current tenant.

+

Constraint: Either this parameter or transit_subnet_id must be specified. The default value is an empty string.

+

tags

+

Array of Tag objects

+

Specifies the list of tags.

+

gateway_id

+

String

+

Specifies the ID of the private NAT gateway associated with the transit IP address.

+

enterprise_project_id

+

String

+

Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is being assigned.

+

status

+

String

+

Specifies the transit IP address status.

+

The value can be:

+

  • ACTIVE: The transit IP address is running properly.

    +

  • FROZEN: The transit IP address is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

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

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

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

Parameter

+

Type

+

Description

+

next_marker

+

String

+

Specifies the ID of the last record in this query, which can be used in the next query.

+

previous_marker

+

String

+

Specifies the ID of the first record in the pagination query result. When page_reverse is set to true, this parameter is used together to query resources on the previous page.

+

current_count

+

Integer

+

Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page.

+

Value range:

+

1-2000

+
+
+
+

Example Requests

GET https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/transit-ips
+
+

Example Responses

Status code: 200

+

Transit IP addresses queried.

+
{
+  "transit_ips" : [ {
+    "id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
+    "project_id" : "da261828016849188f4dcc2ef94d9da9",
+    "network_interface_id" : "c91c43fb-8d66-48df-bfa9-b89053ac3737",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "gateway_id" : "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
+    "ip_address" : "192.168.1.68",
+    "created_at" : "2019-04-29T03:41:59",
+    "updated_at" : "2019-04-29T03:41:59",
+    "virsubnet_id" : "49ee5fb5-75bf-4320-946e-b21ef4c9c9c1",
+    "status" : "ACTIVE",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ]
+  }, {
+    "id" : "a2845109-3b2f-4627-b08f-09a726c0a6e7",
+    "project_id" : "da261828016849188f4dcc2ef94d9da9",
+    "network_interface_id" : "adebbdca-8c26-4c14-b34f-3f53cd2c42f2",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "gateway_id" : "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
+    "ip_address" : "192.168.1.68",
+    "created_at" : "2019-04-29T02:16:09",
+    "updated_at" : "2019-04-29T02:16:09",
+    "virsubnet_id" : "333e5fb5-75bf-4320-946e-b21ef4c9c2g5",
+    "status" : "ACTIVE",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ]
+  } ],
+  "request_id" : "747a911c17067a39692f75ac146fb47e"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Transit IP addresses queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Addresses
+
+
+ diff --git a/docs/natgw/api-ref/ListTransitIpsByTags.html b/docs/natgw/api-ref/ListTransitIpsByTags.html new file mode 100644 index 000000000..f158433ef --- /dev/null +++ b/docs/natgw/api-ref/ListTransitIpsByTags.html @@ -0,0 +1,403 @@ + + +

Querying Transit IP Addresses by Tag

+

Function

  • This API is used to query transit IP addresses by tag.

    +

  • TMS uses this API to filter and list transit IP addresses by tag.

    +
+
+

URI

POST /v3/{project_id}/transit-ips/resource_instances/action

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

String

+

Specifies the index position. The query starts from the next data record indexed by this parameter. When querying resources on the first page, you do not need to specify this parameter. When querying resources on subsequent pages, set this parameter to the value returned in the response body for querying resources on the previous page. This parameter is not available when action is set to count. If action is set to filter, the value must be a positive number, and the default value is 0.

+

limit

+

No

+

String

+

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

+

action

+

Yes

+

String

+

Specifies the operation to be performed. The value can be filter or count.

+

The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned.

+

Enumeration values:

+

  • filter

    +

  • count

    +
+

matches

+

No

+

Array of Match objects

+

Specifies the search field. The tag key is the field to be matched, for example, resource_name. The tag value indicates the value to be matched. This field is a fixed dictionary value. You can determine whether fuzzy match is required based on different fields. For example, if key is set to resource_name, fuzzy search (case insensitive) is used by default. If value is an empty string, exact match is used. If key is set to resource_id, exact match is used. Currently, only resource_name is supported.

+

not_tags

+

No

+

Array of Tags objects

+

The resources to be queried do not contain tags listed in not_tags. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag 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 that do not contain the tags listed in not_tags will be returned.Keys are in AND relationship, and values in a tag are in OR relationship.If this parameter is not specified, all resources will be returned.

+

tags

+

No

+

Array of Tags objects

+

The resources to be queried contain tags listed in tags. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag 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 that contain the tags listed in *tags will be returned.Keys are in AND relationship, and values in a tag are in OR relationship.If this parameter is not specified, all resources will be returned.

+

tags_any

+

No

+

Array of Tags objects

+

The resources to be queried contain any tag listed in tags_any. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag 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 that contain any tag listed in *tags_any will be returned.Keys are in AND relationship, and values in a tag are in OR relationship.If this parameter is not specified, all resources will be returned.

+

not_tags_any

+

No

+

Array of Tags objects

+

The resources to be queried do not contain any tag listed in not_tags_any. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag 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 that do not contain any tag listed in not_tags_any will be returned.Keys are in AND relationship, and values in a tag are in OR relationship.If this parameter is not specified, all resources will be returned.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Match

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key used to search for resources.

+

value

+

Yes

+

String

+

Specifies the tag value used to search for resources.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 Tags

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. (The system does not verify key when searching for resources.) key cannot be left blank or be an empty string. key cannot contain spaces. Before using the value of key, delete spaces before and after the value.

+

values

+

Yes

+

Array of strings

+

Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. Before verifying and using values, delete SBC spaces before and after the value.

+

The value can be an empty array but cannot be left blank. If values is not specified, any parameter value can be queried.

+

The values are in the OR relationship. The system verifies the length, but not verifies the character set of values when searching for resources.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

resources

+

Array of Resource objects

+

Specifies the resource list.

+

request_id

+

String

+

Specifies the request ID.

+

total_count

+

Integer

+

Specifies the total number of records.

+

Value range:

+

0-1000000

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 Resource

Parameter

+

Type

+

Description

+

resource_detail

+

Object

+

Specifies the resource details. This parameter is used for extension and is left blank by default.

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_name

+

String

+

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

+

resource_tag

+

Array of ResourceTag objects

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key.

+

value

+

String

+

Specifies the tag value.

+
+
+
+

Example Requests

  • Querying transit IP addresses by tag (Setting action to filter and limit to 1000)

    +
    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/resource_instances/action
+
+{
+  "offset" : "0",
+  "limit" : "1000",
+  "action" : "filter",
+  "not_tags_any" : [ {
+    "key" : "owner",
+    "value" : "tag_1_value"
+  } ]
+}
    +

  • Querying transit IP addresses by tag (Setting action to count and adding tags)

    +
    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/resource_instances/action
+
+{
+  "action" : "count",
+  "tags" : [ {
+    "key" : "key1",
+    "values" : [ "value1", "value2" ]
+  } ],
+  "matches" : [ {
+    "key" : "resource_name",
+    "value" : "resource1"
+  } ]
+}
    +
+
+

Example Responses

Status code: 200

+

Query operation succeeded.

+

  • Example 1: the response body when action is set to filter

    +

  • Example 2: the response body when action is set to count

    +
+

  • Example 1

    +
    {
+  "resources" : [ {
+    "resource_detail" : null,
+    "resource_id" : "ae33be9b-d2c0-441b-a8d0-f6dafedf1778",
+    "resource_name" : "transit_ips",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    }, {
+      "key" : "key2",
+      "value" : "value1"
+    } ]
+  } ],
+  "request_id" : "9e47d9476cfd346f864cb77acb274185",
+  "total_count" : 1
+}
    +

  • Example 2

    +
    {
+  "request_id" : "d70aabc854d3d301f9bb106e6b70ac99",
+  "total_count" : 100
+}
    +
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Query operation succeeded.

+

  • Example 1: the response body when action is set to filter

    +

  • Example 2: the response body when action is set to count

    +
+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Address Tags
+
+
+ diff --git a/docs/natgw/api-ref/PrivateNat.html b/docs/natgw/api-ref/PrivateNat.html new file mode 100644 index 000000000..042df850a --- /dev/null +++ b/docs/natgw/api-ref/PrivateNat.html @@ -0,0 +1,24 @@ + + +

Private NAT Gateways

+

+
+
+ + +
+
Parent topic: APIs for Private NAT Gateways (v3.0)
+
+
+ diff --git a/docs/natgw/api-ref/PrivateNatDnat.html b/docs/natgw/api-ref/PrivateNatDnat.html new file mode 100644 index 000000000..185983a99 --- /dev/null +++ b/docs/natgw/api-ref/PrivateNatDnat.html @@ -0,0 +1,24 @@ + + +

DNAT Rules

+

+
+
+ + +
+
Parent topic: APIs for Private NAT Gateways (v3.0)
+
+
+ diff --git a/docs/natgw/api-ref/PrivateNatSnat.html b/docs/natgw/api-ref/PrivateNatSnat.html new file mode 100644 index 000000000..0147e9149 --- /dev/null +++ b/docs/natgw/api-ref/PrivateNatSnat.html @@ -0,0 +1,24 @@ + + +

SNAT Rules

+

+
+
+ + +
+
Parent topic: APIs for Private NAT Gateways (v3.0)
+
+
+ diff --git a/docs/natgw/api-ref/PrivateNatTags.html b/docs/natgw/api-ref/PrivateNatTags.html new file mode 100644 index 000000000..39dbe6aca --- /dev/null +++ b/docs/natgw/api-ref/PrivateNatTags.html @@ -0,0 +1,26 @@ + + +

Private NAT Gateway Tags

+

+
+
+ + +
+
Parent topic: APIs for Private NAT Gateways (v3.0)
+
+
+ diff --git a/docs/natgw/api-ref/PrivateNatTransitIp.html b/docs/natgw/api-ref/PrivateNatTransitIp.html new file mode 100644 index 000000000..50a1d33e1 --- /dev/null +++ b/docs/natgw/api-ref/PrivateNatTransitIp.html @@ -0,0 +1,22 @@ + + +

Transit IP Addresses

+

+
+
+ + +
+
Parent topic: APIs for Private NAT Gateways (v3.0)
+
+
+ diff --git a/docs/natgw/api-ref/PrivateNatTransitIpTags.html b/docs/natgw/api-ref/PrivateNatTransitIpTags.html new file mode 100644 index 000000000..d860c1659 --- /dev/null +++ b/docs/natgw/api-ref/PrivateNatTransitIpTags.html @@ -0,0 +1,26 @@ + + +

Transit IP Address Tags

+

+
+
+ + +
+
Parent topic: APIs for Private NAT Gateways (v3.0)
+
+
+ diff --git a/docs/natgw/api-ref/ShowPrivateDnat.html b/docs/natgw/api-ref/ShowPrivateDnat.html new file mode 100644 index 000000000..f2555f3a1 --- /dev/null +++ b/docs/natgw/api-ref/ShowPrivateDnat.html @@ -0,0 +1,290 @@ + + +

Querying Details About a Specified DNAT Rule

+

Function

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

+
+

URI

GET /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

dnat_rule_id

+

Yes

+

String

+

Specifies the DNAT rule ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

dnat_rule

+

PrivateDnat object

+

Specifies the response body of the DNAT rule.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PrivateDnat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the DNAT rule ID.

+

project_id

+

String

+

Specifies the project ID.

+

description

+

String

+

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_id

+

String

+

Specifies the ID of the transit IP address.

+

gateway_id

+

String

+

Specifies the private NAT gateway ID.

+

network_interface_id

+

String

+

Specifies the network interface ID. Network interfaces of a compute instance, load balancer (v2 or v3), or virtual IP address are supported.

+

type

+

String

+

Specifies the backend resource type of the DNAT rule.

+

The type can be:

+

  • COMPUTE: The backend resource is a compute instance.

    +

  • VIP: The backend resource is a virtual IP address.

    +

  • ELB: The backend resource is a v2 load balancer.

    +

  • ELBv3: The backend resource is a v3 load balancer.

    +

  • CUSTOMIZE: The backend resource is a user-defined IP address.

    +
+

protocol

+

String

+

Specifies the protocol type.

+

TCP, UDP, and ANY are supported.

+

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

+

Enumeration values:

+

  • tcp

    +

  • udp

    +

  • any

    +
+

private_ip_address

+

String

+

Specifies the port IP address that the NAT gateway uses. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

internal_service_port

+

String

+

Specifies the port number of the resource, which can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

transit_service_port

+

String

+

Specifies the port number of the transit IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

enterprise_project_id

+

String

+

Specifies the ID of the enterprise project that is associated with the DNAT rule when the DNAT rule is created.

+

created_at

+

String

+

Specifies the time when the DNAT rule was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the DNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

status

+

String

+

Specifies the DNAT rule status of a private NAT gateway.

+

The value can be:

+

  • ACTIVE: The DNAT rule is running properly.

    +

  • FROZEN: The DNAT rule is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+
+
+
+

Example Requests

GET https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules/24dd6bf5-48f2-4915-ad0b-5bb111d39c83
+
+

Example Responses

Status code: 200

+

DNAT rule details queried.

+
{
+  "dnat_rule" : {
+    "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83",
+    "project_id" : "da261828016849188f4dcc2ef94d9da9",
+    "description" : "aa",
+    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
+    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707",
+    "type" : "COMPUTE",
+    "protocol" : "any",
+    "internal_service_port" : "0",
+    "transit_service_port" : "0",
+    "private_ip_address" : "192.168.1.72",
+    "created_at" : "2019-04-29T07:10:01",
+    "updated_at" : "2019-04-29T07:10:01",
+    "status" : "ACTIVE"
+  },
+  "request_id" : "747a911c17067a39692f75ac146fb47e"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

DNAT rule details queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: DNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/ShowPrivateNat.html b/docs/natgw/api-ref/ShowPrivateNat.html new file mode 100644 index 000000000..293461935 --- /dev/null +++ b/docs/natgw/api-ref/ShowPrivateNat.html @@ -0,0 +1,336 @@ + + +

Querying Details About a Specified Private NAT Gateway

+

Function

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

+
+

URI

GET /v3/{project_id}/private-nat/gateways/{gateway_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

gateway_id

+

Yes

+

String

+

Specifies the private NAT gateway ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

gateway

+

PrivateNat object

+

Specifies the response body for the private NAT gateway.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PrivateNat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the private NAT gateway ID.

+

project_id

+

String

+

Specifies the project ID.

+

name

+

String

+

Specifies the private NAT gateway name.

+

description

+

String

+

Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

spec

+

String

+

Specifies the private NAT gateway specifications.

+

The value can be:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

Default value:

+

Small

+

Enumeration values:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

status

+

String

+

Specifies the private NAT gateway status.

+

The value can be:

+

  • ACTIVE: The private NAT gateway is running properly.

    +

  • FROZEN: The private NAT gateway is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+

created_at

+

String

+

Specifies the time when the private NAT gateway was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the private NAT gateway was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

downlink_vpcs

+

Array of DownlinkVpc objects

+

Specifies the VPC where the private NAT gateway works.

+

tags

+

Array of Tag objects

+

Specifies the list of tags.

+

enterprise_project_id

+

String

+

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

+

rule_max

+

Integer

+

Specifies the maximum number of rules.

+

Value range:

+

0-65535

+

transit_ip_pool_size_max

+

Integer

+

Specifies the maximum number of transit IP addresses in a transit IP address pool.

+

Value range:

+

1-100

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 DownlinkVpc

Parameter

+

Type

+

Description

+

vpc_id

+

String

+

Specifies the ID of the VPC where the private NAT gateway works.

+

virsubnet_id

+

String

+

Specifies the ID of the subnet where the private NAT gateway works.

+

ngport_ip_address

+

String

+

Specifies the private IP address of the private NAT gateway.

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

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Example Requests

GET https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways/14338426-6afe-4019-996b-3a9525296e11
+
+

Example Responses

Status code: 200

+

Details about the private NAT gateway queried.

+
{
+  "gateway" : {
+    "id" : "14338426-6afe-4019-996b-3a9525296e11",
+    "name" : "private-nat-gateway-name",
+    "description" : "private-nat-gateway-description",
+    "spec" : "Small",
+    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "status" : "ACTIVE",
+    "created_at" : "2019-04-22T08:47:13",
+    "updated_at" : "2019-04-22T08:47:13",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ],
+    "downlink_vpcs" : [ {
+      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
+      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70",
+      "ngport_ip_address" : "10.0.0.17"
+    } ],
+    "transit_ip_pool_size_max" : 1,
+    "rule_max" : 20
+  },
+  "request_id" : "747a911c17067a39692f75ac146fb47e"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Details about the private NAT gateway queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateways
+
+
+ diff --git a/docs/natgw/api-ref/ShowPrivateNatTags.html b/docs/natgw/api-ref/ShowPrivateNatTags.html new file mode 100644 index 000000000..7e10f533f --- /dev/null +++ b/docs/natgw/api-ref/ShowPrivateNatTags.html @@ -0,0 +1,164 @@ + + +

Querying Tags of a Private NAT Gateway

+

Function

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

    +

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

    +
+
+

URI

GET /v3/{project_id}/private-nat-gateways/{resource_id}/tags

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_id

+

Yes

+

String

+

Specifies the private NAT gateway ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

request_id

+

String

+

Specifies the request ID.

+

tags

+

Array of Tag objects

+

Specifies the tags.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 Tag

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Example Requests

GET  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/b0399473-c352-4d0c-8ff4-cfde719cfde9/tags
+
+

Example Responses

Status code: 200

+

Query operation succeeded.

+
{
+  "request_id" : "80ef5f21-b81a-4546-b23d-84272507d330",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  }, {
+    "key" : "key3",
+    "value" : "value3"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Query operation succeeded.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateway Tags
+
+
+ diff --git a/docs/natgw/api-ref/ShowPrivateSnat.html b/docs/natgw/api-ref/ShowPrivateSnat.html new file mode 100644 index 000000000..c8df9a643 --- /dev/null +++ b/docs/natgw/api-ref/ShowPrivateSnat.html @@ -0,0 +1,269 @@ + + +

Querying Details About a Specified SNAT Rule

+

Function

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

+
+

URI

GET /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

snat_rule_id

+

Yes

+

String

+

Specifies the SNAT rule ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

snat_rule

+

PrivateSnat object

+

Specifies the response body of the SNAT rule.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PrivateSnat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the SNAT rule ID.

+

project_id

+

String

+

Specifies the project ID.

+

gateway_id

+

String

+

Specifies the private NAT gateway ID.

+

cidr

+

String

+

Specifies the CIDR block that matches the SNAT rule.

+

Constraints:

+

  • Either this parameter or virsubnet_id must be specified.

    +

  • The CIDR block cannot be the same as that of an existing SNAT rule.

    +
+

virsubnet_id

+

String

+

Specifies the ID of the subnet that matches the SNAT rule.

+

Constraint: Either this parameter or cidr must be specified.

+

description

+

String

+

Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_associations

+

Array of AssociatedTransitIp objects

+

Specifies the list of details of associated transit IP addresses.

+

created_at

+

String

+

Specifies the time when the SNAT rule was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the SNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

enterprise_project_id

+

String

+

Specifies the enterprise project ID.

+

status

+

String

+

Specifies the SNAT rule status of a private NAT gateway.

+

The value can be:

+

  • ACTIVE: The SNAT rule is running properly.

    +

  • FROZEN: The SNAT rule is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 5 AssociatedTransitIp

Parameter

+

Type

+

Description

+

transit_ip_id

+

String

+

Specifies the ID of the transit IP address.

+

transit_ip_address

+

String

+

Specifies the transit IP address.

+
+
+
+

Example Requests

GET https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat/snat-rules/8a522ff9-8158-494b-83cd-533b045700e6
+
+

Example Responses

Status code: 200

+

SNAT rule details queried.

+
{
+  "snat_rule" : {
+    "id" : "8a522ff9-8158-494b-83cd-533b045700e6",
+    "project_id" : "cfa563efb77d4b6d9960781d82530fd8",
+    "description" : "my_snat_rule02",
+    "gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
+    "cidr" : "",
+    "virsubnet_id" : "95df1b88-d9bc-4edd-a808-a771dd4ded32",
+    "transit_ip_associations" : [ {
+      "transit_ip_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
+      "transit_ip_address" : "172.20.1.98"
+    } ],
+    "created_at" : "2019-10-22T03:33:07",
+    "updated_at" : "2019-10-22T03:33:07",
+    "status" : "ACTIVE"
+  },
+  "request_id" : "c8b21002-a594-414d-9585-2cc5963d4c3e"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

SNAT rule details queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: SNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/ShowTransitIp.html b/docs/natgw/api-ref/ShowTransitIp.html new file mode 100644 index 000000000..155c1799e --- /dev/null +++ b/docs/natgw/api-ref/ShowTransitIp.html @@ -0,0 +1,266 @@ + + +

Querying Details About a Specified Transit IP Address

+

Function

This API is used to query details about a specified transit IP address.

+
+

URI

GET /v3/{project_id}/private-nat/transit-ips/{transit_ip_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

transit_ip_id

+

Yes

+

String

+

Specifies the ID of the transit IP address.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

transit_ip

+

TransitIp object

+

Specifies the response body of the transit IP address.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 TransitIp

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the ID of the transit IP address.

+

project_id

+

String

+

Specifies the project ID.

+

network_interface_id

+

String

+

Specifies the network interface ID of the transit IP address.

+

ip_address

+

String

+

Specifies the transit IP address.

+

created_at

+

String

+

Specifies the time when the transit IP address was assigned. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the transit IP address was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

virsubnet_id

+

String

+

Specifies the subnet ID of the current tenant.

+

Constraint: Either this parameter or transit_subnet_id must be specified. The default value is an empty string.

+

tags

+

Array of Tag objects

+

Specifies the list of tags.

+

gateway_id

+

String

+

Specifies the ID of the private NAT gateway associated with the transit IP address.

+

enterprise_project_id

+

String

+

Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is being assigned.

+

status

+

String

+

Specifies the transit IP address status.

+

The value can be:

+

  • ACTIVE: The transit IP address is running properly.

    +

  • FROZEN: The transit IP address is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

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

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Example Requests

GET https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/transit-ips/a2845109-3b2f-4627-b08f-09a726c0a6e7
+
+

Example Responses

Status code: 200

+

Details about a specified transit IP address queried.

+
{
+  "transit_ip" : {
+    "id" : "a2845109-3b2f-4627-b08f-09a726c0a6e7",
+    "project_id" : "da261828016849188f4dcc2ef94d9da9",
+    "network_interface_id" : "adebbdca-8c26-4c14-b34f-3f53cd2c42f2",
+    "ip_address" : "192.168.1.68",
+    "gateway_id" : "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "created_at" : "2019-04-29T02:16:09",
+    "updated_at" : "2019-04-29T02:16:09",
+    "virsubnet_id" : "49ee5fb5-75bf-4320-946e-b21ef4c9c9c1",
+    "status" : "ACTIVE",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ]
+  },
+  "request_id" : "747a911c17067a39692f75ac146fb47e"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Details about a specified transit IP address queried.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Addresses
+
+
+ diff --git a/docs/natgw/api-ref/ShowTransitIpTags.html b/docs/natgw/api-ref/ShowTransitIpTags.html new file mode 100644 index 000000000..a50bb444b --- /dev/null +++ b/docs/natgw/api-ref/ShowTransitIpTags.html @@ -0,0 +1,164 @@ + + +

Querying Tags of a Transit IP Address

+

Function

  • This API is used to query tags of a specified transit IP address.

    +

  • TMS uses this API to query all tags of a specified transit IP address.

    +
+
+

URI

GET /v3/{project_id}/transit-ips/{resource_id}/tags

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_id

+

Yes

+

String

+

Specifies the ID of the transit IP address.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

request_id

+

String

+

Specifies the request ID.

+

tags

+

Array of Tag objects

+

Specifies the tags.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 Tag

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Example Requests

GET  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/b0399473-c352-4d0c-8ff4-cfde719cfde9/tags
+
+

Example Responses

Status code: 200

+

Query operation succeeded.

+
{
+  "request_id" : "80ef5f21-b81a-4546-b23d-84272507d330",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  }, {
+    "key" : "key3",
+    "value" : "value3"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Query operation succeeded.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Transit IP Address Tags
+
+
+ diff --git a/docs/natgw/api-ref/UpdatePrivateDnat.html b/docs/natgw/api-ref/UpdatePrivateDnat.html new file mode 100644 index 000000000..b1abf5fc7 --- /dev/null +++ b/docs/natgw/api-ref/UpdatePrivateDnat.html @@ -0,0 +1,412 @@ + + +

Updating a DNAT Rule

+

Function

This API is used to update a specified DNAT rule.

+
+

URI

PUT /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

dnat_rule_id

+

Yes

+

String

+

Specifies the DNAT rule ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

dnat_rule

+

No

+

UpdatePrivateDnatOption object

+

Specifies the request body for updating a DNAT rule.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 UpdatePrivateDnatOption

Parameter

+

Mandatory

+

Type

+

Description

+

description

+

No

+

String

+

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_id

+

No

+

String

+

Specifies the ID of the transit IP address.

+

network_interface_id

+

No

+

String

+

Specifies the port ID of the resource that the NAT gateway is bound to. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address. Note: Either this parameter or private_ip_address must be specified. Otherwise, an error will be reported.

+

private_ip_address

+

No

+

String

+

Specifies the port IP address that the NAT gateway uses. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address. Note: Either this parameter or network_interface_id must be specified. Otherwise, an error will be reported.

+

protocol

+

No

+

String

+

Specifies the protocol type.

+

TCP, UDP, and ANY are supported.

+

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

+

Enumeration values:

+

  • tcp

    +

  • udp

    +

  • any

    +
+

internal_service_port

+

No

+

String

+

Specifies the port number of the resource, which can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

transit_service_port

+

No

+

String

+

Specifies the port number of the transit IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

dnat_rule

+

PrivateDnat object

+

Specifies the response body of the DNAT rule.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 PrivateDnat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the DNAT rule ID.

+

project_id

+

String

+

Specifies the project ID.

+

description

+

String

+

Provides supplementary information about the DNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_id

+

String

+

Specifies the ID of the transit IP address.

+

gateway_id

+

String

+

Specifies the private NAT gateway ID.

+

network_interface_id

+

String

+

Specifies the network interface ID. Network interfaces of a compute instance, load balancer (v2 or v3), or virtual IP address are supported.

+

type

+

String

+

Specifies the backend resource type of the DNAT rule.

+

The type can be:

+

  • COMPUTE: The backend resource is a compute instance.

    +

  • VIP: The backend resource is a virtual IP address.

    +

  • ELB: The backend resource is a v2 load balancer.

    +

  • ELBv3: The backend resource is a v3 load balancer.

    +

  • CUSTOMIZE: The backend resource is a user-defined IP address.

    +
+

protocol

+

String

+

Specifies the protocol type.

+

TCP, UDP, and ANY are supported.

+

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

+

Enumeration values:

+

  • tcp

    +

  • udp

    +

  • any

    +
+

private_ip_address

+

String

+

Specifies the port IP address that the NAT gateway uses. The resource can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

internal_service_port

+

String

+

Specifies the port number of the resource, which can be a compute instance, load balancer (v2 or v3), or virtual IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

transit_service_port

+

String

+

Specifies the port number of the transit IP address.

+

Value range:

+

0-65535

+

Default value:

+

0

+

enterprise_project_id

+

String

+

Specifies the ID of the enterprise project that is associated with the DNAT rule when the DNAT rule is created.

+

created_at

+

String

+

Specifies the time when the DNAT rule was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the DNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

status

+

String

+

Specifies the DNAT rule status of a private NAT gateway.

+

The value can be:

+

  • ACTIVE: The DNAT rule is running properly.

    +

  • FROZEN: The DNAT rule is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+
+
+
+

Example Requests

Updating a DNAT rule (Updating description to my dnat-rules 03)

+
PUT https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules/24dd6bf5-48f2-4915-ad0b-5bb111d39c83
+
+{
+  "dnat_rule" : {
+    "description" : "my dnat-rules 03"
+  }
+}
+
+

Example Responses

Status code: 200

+

DNAT rule updated.

+
{
+  "dnat_rule" : {
+    "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83",
+    "project_id" : "da261828016849188f4dcc2ef94d9da9",
+    "description" : "dnat rule description",
+    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
+    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707",
+    "type" : "COMPUTE",
+    "protocol" : "any",
+    "internal_service_port" : "0",
+    "transit_service_port" : "0",
+    "private_ip_address" : "192.168.1.72",
+    "created_at" : "2019-04-29T07:10:01",
+    "updated_at" : "2019-04-29T07:10:01",
+    "status" : "ACTIVE"
+  },
+  "request_id" : "747a911c17067a39692f75ac146fb47e"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

DNAT rule updated.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: DNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/UpdatePrivateNat.html b/docs/natgw/api-ref/UpdatePrivateNat.html new file mode 100644 index 000000000..b4c876cf9 --- /dev/null +++ b/docs/natgw/api-ref/UpdatePrivateNat.html @@ -0,0 +1,422 @@ + + +

Updating a Private NAT Gateway

+

Function

This API is used to update a private NAT gateway.

+
+

URI

PUT /v3/{project_id}/private-nat/gateways/{gateway_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

gateway_id

+

Yes

+

String

+

Specifies the private NAT gateway ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

gateway

+

Yes

+

UpdatePrivateNatOption object

+

Specifies the request body for updating the private NAT gateway.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 UpdatePrivateNatOption

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Specifies the private NAT gateway name.

+

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

+

description

+

No

+

String

+

Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

spec

+

No

+

String

+

Specifies the private NAT gateway specifications.

+

The value can be:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

Enumeration values:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

gateway

+

PrivateNat object

+

Specifies the response body for the private NAT gateway.

+

request_id

+

String

+

Specifies the request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 PrivateNat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the private NAT gateway ID.

+

project_id

+

String

+

Specifies the project ID.

+

name

+

String

+

Specifies the private NAT gateway name.

+

description

+

String

+

Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

spec

+

String

+

Specifies the private NAT gateway specifications.

+

The value can be:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

Default value:

+

Small

+

Enumeration values:

+

  • Small

    +

  • Medium

    +

  • Large

    +

  • Extra-large

    +
+

status

+

String

+

Specifies the private NAT gateway status.

+

The value can be:

+

  • ACTIVE: The private NAT gateway is running properly.

    +

  • FROZEN: The private NAT gateway is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+

created_at

+

String

+

Specifies the time when the private NAT gateway was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the private NAT gateway was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

downlink_vpcs

+

Array of DownlinkVpc objects

+

Specifies the VPC where the private NAT gateway works.

+

tags

+

Array of Tag objects

+

Specifies the list of tags.

+

enterprise_project_id

+

String

+

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

+

rule_max

+

Integer

+

Specifies the maximum number of rules.

+

Value range:

+

0-65535

+

transit_ip_pool_size_max

+

Integer

+

Specifies the maximum number of transit IP addresses in a transit IP address pool.

+

Value range:

+

1-100

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 7 DownlinkVpc

Parameter

+

Type

+

Description

+

vpc_id

+

String

+

Specifies the ID of the VPC where the private NAT gateway works.

+

virsubnet_id

+

String

+

Specifies the ID of the subnet where the private NAT gateway works.

+

ngport_ip_address

+

String

+

Specifies the private IP address of the private NAT gateway.

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

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank.

+

value

+

String

+

Specifies the tag value. Each value can contain up to 255 Unicode characters.

+
+
+
+

Example Requests

Updating a private NAT gateway. (Setting name to private-nat-gateway-name, description to private-nat-gateway-description, and spec to Medium)

+
PUT https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways/14338426-6afe-4019-996b-3a9525296e11
+
+{
+  "gateway" : {
+    "name" : "private-nat-gateway-name",
+    "description" : "private-nat-gateway-description",
+    "spec" : "Medium"
+  }
+}
+
+

Example Responses

Status code: 200

+

Private NAT gateway updated.

+
{
+  "gateway" : {
+    "id" : "14338426-6afe-4019-996b-3a9525296e11",
+    "name" : "private-nat-gateway-name",
+    "description" : "private-nat-gateway-description",
+    "spec" : "Medium",
+    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
+    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
+    "status" : "ACTIVE",
+    "created_at" : "2019-04-22T08:47:13",
+    "updated_at" : "2019-04-22T08:47:13",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ],
+    "downlink_vpcs" : [ {
+      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
+      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70",
+      "ngport_ip_address" : "10.0.0.17"
+    } ],
+    "transit_ip_pool_size_max" : 1,
+    "rule_max" : 20
+  },
+  "request_id" : "e7e3323e95b348708d26e68a0ddece71"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Private NAT gateway updated.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Private NAT Gateways
+
+
+ diff --git a/docs/natgw/api-ref/UpdatePrivateSnat.html b/docs/natgw/api-ref/UpdatePrivateSnat.html new file mode 100644 index 000000000..341923d18 --- /dev/null +++ b/docs/natgw/api-ref/UpdatePrivateSnat.html @@ -0,0 +1,332 @@ + + +

Updating an SNAT Rule

+

Function

This API is used to update a specified SNAT rule.

+
+

URI

PUT /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

snat_rule_id

+

Yes

+

String

+

Specifies the SNAT rule ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

Specifies the user token.

+

It is a response to the API used to obtain a user token. This API is the only one that does not require authentication.

+

The value of X-Subject-Token in the response header is the token value.

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

Parameter

+

Mandatory

+

Type

+

Description

+

snat_rule

+

Yes

+

UpdatePrivateSnatOption object

+

Specifies the request body for updating an SNAT rule.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 UpdatePrivateSnatOption

Parameter

+

Mandatory

+

Type

+

Description

+

transit_ip_ids

+

No

+

Array of strings

+

Specifies the ID list of transit IP addresses.

+

description

+

No

+

String

+

Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

request_id

+

String

+

Specifies the request ID.

+

snat_rule

+

PrivateSnat object

+

Specifies the response body of the SNAT rule.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 PrivateSnat

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the SNAT rule ID.

+

project_id

+

String

+

Specifies the project ID.

+

gateway_id

+

String

+

Specifies the private NAT gateway ID.

+

cidr

+

String

+

Specifies the CIDR block that matches the SNAT rule.

+

Constraints:

+

  • Either this parameter or virsubnet_id must be specified.

    +

  • The CIDR block cannot be the same as that of an existing SNAT rule.

    +
+

virsubnet_id

+

String

+

Specifies the ID of the subnet that matches the SNAT rule.

+

Constraint: Either this parameter or cidr must be specified.

+

description

+

String

+

Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

+

transit_ip_associations

+

Array of AssociatedTransitIp objects

+

Specifies the list of details of associated transit IP addresses.

+

created_at

+

String

+

Specifies the time when the SNAT rule was created. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

updated_at

+

String

+

Specifies the time when the SNAT rule was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format.

+

enterprise_project_id

+

String

+

Specifies the enterprise project ID.

+

status

+

String

+

Specifies the SNAT rule status of a private NAT gateway.

+

The value can be:

+

  • ACTIVE: The SNAT rule is running properly.

    +

  • FROZEN: The SNAT rule is frozen.

    +
+

Enumeration values:

+

  • ACTIVE

    +

  • FROZEN

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 7 AssociatedTransitIp

Parameter

+

Type

+

Description

+

transit_ip_id

+

String

+

Specifies the ID of the transit IP address.

+

transit_ip_address

+

String

+

Specifies the transit IP address.

+
+
+
+

Example Requests

Updating an SNAT rule (Setting transit_ip_ids to bbe7c2e7-3bad-445b-a067-b30acce66053 and description to my_snat_rule_update)

+
PUT https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat/snat-rules/af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81
+
+{
+  "snat_rule" : {
+    "description" : "my_snat_rule_update",
+    "transit_ip_ids" : [ "bbe7c2e7-3bad-445b-a067-b30acce66053" ]
+  }
+}
+
+

Example Responses

Status code: 200

+

SNAT rule updated.

+
{
+  "request_id" : "15bd32b2-1464-4817-b559-444d22499f6c",
+  "snat_rule" : {
+    "id" : "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81",
+    "project_id" : "cfa563efb77d4b6d9960781d82530fd8",
+    "description" : "my_snat_rule_update",
+    "gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
+    "cidr" : "10.1.1.64/30",
+    "virsubnet_id" : "",
+    "transit_ip_associations" : [ {
+      "transit_ip_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
+      "transit_ip_address" : "172.20.1.98"
+    } ],
+    "created_at" : "2019-10-22T03:31:19",
+    "updated_at" : "2019-10-22T03:39:52",
+    "status" : "ACTIVE"
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

SNAT rule updated.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: SNAT Rules
+
+
+ diff --git a/docs/natgw/api-ref/nat_api_0000.html b/docs/natgw/api-ref/nat_api_0000.html index e6875da1f..1b9656f0c 100644 --- a/docs/natgw/api-ref/nat_api_0000.html +++ b/docs/natgw/api-ref/nat_api_0000.html @@ -1,6 +1,6 @@ -

API v2.0

+

APIs for Public NAT Gateways (v2.0)

    diff --git a/docs/natgw/api-ref/nat_api_0001.html b/docs/natgw/api-ref/nat_api_0001.html index 094477a98..f042d39a1 100644 --- a/docs/natgw/api-ref/nat_api_0001.html +++ b/docs/natgw/api-ref/nat_api_0001.html @@ -17,7 +17,7 @@
-
Parent topic: API v2.0
+
Parent topic: APIs for Public NAT Gateways (v2.0)
diff --git a/docs/natgw/api-ref/nat_api_0002.html b/docs/natgw/api-ref/nat_api_0002.html index 917c4ef72..9cd167dea 100644 --- a/docs/natgw/api-ref/nat_api_0002.html +++ b/docs/natgw/api-ref/nat_api_0002.html @@ -108,7 +108,7 @@

Boolean

-
  • 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 whether the NAT gateway is started or stopped.
    • The state can be:
      • true: The NAT gateway is started.
      • false: The NAT gateway is stopped.
    @@ -118,7 +118,7 @@

    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.

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

    Boolean

    -
    • 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 whether the NAT gateway is started or stopped.
      • The state can be:
        • true: The NAT gateway is started.
        • false: The NAT gateway is stopped.
      @@ -228,7 +228,7 @@

      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

      @@ -288,7 +288,6 @@ "billinginfo": "", "dnat_rules_limit": 200, "snat_rule_public_ip_limit": 20, - "freeze_info": null, "sys_tags": [ "_sys_enterprise_project_id=0" ], @@ -307,7 +306,6 @@ "billinginfo": "", "dnat_rules_limit": 200, "snat_rule_public_ip_limit": 20, - "freeze_info": null, "sys_tags": [ "_sys_enterprise_project_id=0" ], diff --git a/docs/natgw/api-ref/nat_api_0003.html b/docs/natgw/api-ref/nat_api_0003.html index 553004fe8..a9690bd5c 100644 --- a/docs/natgw/api-ref/nat_api_0003.html +++ b/docs/natgw/api-ref/nat_api_0003.html @@ -194,7 +194,7 @@

      Boolean

      -
      • 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 whether the NAT gateway is started or stopped.
        • The state can be:
          • true: The NAT gateway is started.
          • false: The NAT gateway is stopped.
        @@ -202,7 +202,7 @@

        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

        @@ -212,13 +212,6 @@

        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>

        @@ -268,7 +261,6 @@ "billinginfo": "", "dnat_rules_limit": 200, "snat_rule_public_ip_limit": 20, - "freeze_info": null, "sys_tags": [ "_sys_enterprise_project_id=0" ], diff --git a/docs/natgw/api-ref/nat_api_0005.html b/docs/natgw/api-ref/nat_api_0005.html index a985f04dd..47e730fbf 100644 --- a/docs/natgw/api-ref/nat_api_0005.html +++ b/docs/natgw/api-ref/nat_api_0005.html @@ -15,7 +15,7 @@
      -
      Parent topic: API v2.0
      +
      Parent topic: APIs for Public NAT Gateways (v2.0)
      diff --git a/docs/natgw/api-ref/nat_api_0006.html b/docs/natgw/api-ref/nat_api_0006.html index 4e84c3aa6..50b687a2b 100644 --- a/docs/natgw/api-ref/nat_api_0006.html +++ b/docs/natgw/api-ref/nat_api_0006.html @@ -57,7 +57,7 @@

      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. Specify either this parameter or cidr.

      cidr

      @@ -66,7 +66,7 @@

      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.

      +

      Specifies CIDR, which can be in the format of a network segment or a host IP address. Specify either this parameter or network_id.

      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.

      @@ -167,16 +167,16 @@

      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

      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

      @@ -190,7 +190,7 @@

      String(1024)

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

      freezed_ip_address

      @@ -226,7 +226,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.

      diff --git a/docs/natgw/api-ref/nat_api_0007.html b/docs/natgw/api-ref/nat_api_0007.html index a506c8c3a..f62327ba0 100644 --- a/docs/natgw/api-ref/nat_api_0007.html +++ b/docs/natgw/api-ref/nat_api_0007.html @@ -68,7 +68,9 @@

      String

      -

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

      +

      Specifies CIDR, which can be in the format of a network segment or a host IP address. Specify either this parameter or network_id.

      +

      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

      @@ -134,7 +136,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.

      @@ -205,16 +207,16 @@

      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

      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

      @@ -264,7 +266,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.

      diff --git a/docs/natgw/api-ref/nat_api_0008.html b/docs/natgw/api-ref/nat_api_0008.html index e5faf53a2..1b2e32fa1 100644 --- a/docs/natgw/api-ref/nat_api_0008.html +++ b/docs/natgw/api-ref/nat_api_0008.html @@ -91,7 +91,9 @@

      String

      -

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

      +

      Specifies CIDR, which can be in the format of a network segment or a host IP address. Specify either this parameter or network_id.

      +

      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

      diff --git a/docs/natgw/api-ref/nat_api_0010.html b/docs/natgw/api-ref/nat_api_0010.html index 3aba29601..31eced5bf 100644 --- a/docs/natgw/api-ref/nat_api_0010.html +++ b/docs/natgw/api-ref/nat_api_0010.html @@ -15,7 +15,7 @@
    -
    Parent topic: API v2.0
    +
    Parent topic: APIs for Public NAT Gateways (v2.0)
    diff --git a/docs/natgw/api-ref/nat_api_0011.html b/docs/natgw/api-ref/nat_api_0011.html index 241a81d0d..180a8dc1c 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. 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.

    +

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

    +

    Request

    Table 1 describes the request parameter.

    @@ -57,7 +57,7 @@ - @@ -68,7 +68,7 @@ - @@ -78,7 +78,7 @@ - @@ -188,14 +188,14 @@ - - diff --git a/docs/natgw/api-ref/nat_api_0012.html b/docs/natgw/api-ref/nat_api_0012.html index 3fbe73e8f..853b6dbd8 100644 --- a/docs/natgw/api-ref/nat_api_0012.html +++ b/docs/natgw/api-ref/nat_api_0012.html @@ -61,7 +61,7 @@ - - - - - - - @@ -257,7 +257,7 @@
    Table 1 Request parameter

    Parameter

    String

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

    +

    Specifies the port ID of the cloud server (ECS or BMS). Specify either this parameter or private_ip.

    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 an on-premises network connected by a Direct Connect connection. This parameter and port_id are alternative.

    +

    Specifies the private IP address of a user, for example, the IP address of a VPC for Direct Connect connection. Specify either this parameter or port_id.

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

    Integer

    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.

    +

    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.

    String

    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.

    +

    This parameter is used in the Direct Connect scenario. Specify either this parameter or port_id.

    internal_service_port

    Integer

    Specifies the port number used by the cloud server (ECS or BMS) 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

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

    Boolean

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

    Integer

    Specifies the port number used by the cloud server (ECS or BMS) 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

    @@ -182,7 +182,7 @@

    String

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

    +

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

    private_ip

    @@ -196,7 +196,7 @@

    Integer

    Specifies the port number used by the cloud server (ECS or BMS) 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

    diff --git a/docs/natgw/api-ref/nat_api_0013.html b/docs/natgw/api-ref/nat_api_0013.html index ecfa5a1a8..bbd1148ac 100644 --- a/docs/natgw/api-ref/nat_api_0013.html +++ b/docs/natgw/api-ref/nat_api_0013.html @@ -84,7 +84,7 @@

    String

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

    +

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

    private_ip

    @@ -98,7 +98,7 @@

    Integer

    Specifies the port number used by the cloud server (ECS or BMS) 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

    diff --git a/docs/natgw/api-ref/nat_api_0015.html b/docs/natgw/api-ref/nat_api_0015.html index c648efab3..78cacd4c2 100644 --- a/docs/natgw/api-ref/nat_api_0015.html +++ b/docs/natgw/api-ref/nat_api_0015.html @@ -19,7 +19,7 @@
    -
    Parent topic: API v2.0
    +
    Parent topic: APIs for Public NAT Gateways (v2.0)
    diff --git a/docs/natgw/api-ref/nat_api_0016.html b/docs/natgw/api-ref/nat_api_0016.html index efabe6859..05deb8166 100644 --- a/docs/natgw/api-ref/nat_api_0016.html +++ b/docs/natgw/api-ref/nat_api_0016.html @@ -138,7 +138,7 @@

    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.

    +

    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 left blank or an empty string. The key cannot contain spaces. Before verification, delete spaces before and after the value.

    values

    @@ -232,7 +232,7 @@

    Specifies the resource ID.

    resouce_detail

    +

    resource_detail

    Object

    -
    Table 7 Parameter description of field resource_tag

    Parameter

    +
    @@ -384,7 +384,7 @@ 
    { 
     "resources": [
         {
-            "resource_detail": null, 
+            
             "resource_id": "e5ad289f-9c56-4daf-b08b-2e53a983473a", 
             "resource_name": "nat_gateways", 
             "tags": [
@@ -406,7 +406,7 @@
     "total_count": 1000
 }
    -

    Status Code

    See Status Codes.

    +

    Status Codes

    See Status Codes.

    diff --git a/docs/natgw/api-ref/nat_api_0024.html b/docs/natgw/api-ref/nat_api_0024.html index 059dfb37e..dfd6f7137 100644 --- a/docs/natgw/api-ref/nat_api_0024.html +++ b/docs/natgw/api-ref/nat_api_0024.html @@ -11,7 +11,7 @@
    -
    Parent topic: API v2.0
    +
    Parent topic: APIs for Public NAT Gateways (v2.0)
    diff --git a/docs/natgw/api-ref/nat_api_0027.html b/docs/natgw/api-ref/nat_api_0027.html index 9a3462782..c1c7f9a2a 100644 --- a/docs/natgw/api-ref/nat_api_0027.html +++ b/docs/natgw/api-ref/nat_api_0027.html @@ -15,6 +15,18 @@
  • NAT Gateway Tag v2.0
    • +
  • Private NAT Gateways
    +
    • +
  • Private NAT Gateway - Transit IP Address
    +
    • +
  • SNAT Rules of Private NAT Gateways
    +
    • +
  • DNAT Rules of Private NAT Gateways
    +
    • +
  • Private NAT Gateway - Tag
    +
    • +
  • Private NAT Gateway - Transit IP Address Tag
    +
    • diff --git a/docs/natgw/api-ref/nat_api_0032.html b/docs/natgw/api-ref/nat_api_0032.html index 19c261659..3727bd8c6 100644 --- a/docs/natgw/api-ref/nat_api_0032.html +++ b/docs/natgw/api-ref/nat_api_0032.html @@ -10,35 +10,35 @@ - - - - - diff --git a/docs/natgw/api-ref/nat_api_0033.html b/docs/natgw/api-ref/nat_api_0033.html index 1902ebe24..99da9fde9 100644 --- a/docs/natgw/api-ref/nat_api_0033.html +++ b/docs/natgw/api-ref/nat_api_0033.html @@ -10,28 +10,28 @@ - - - - diff --git a/docs/natgw/api-ref/nat_api_0034.html b/docs/natgw/api-ref/nat_api_0034.html index 9ad338fd1..43f880a07 100644 --- a/docs/natgw/api-ref/nat_api_0034.html +++ b/docs/natgw/api-ref/nat_api_0034.html @@ -10,28 +10,28 @@ - - - - diff --git a/docs/natgw/api-ref/nat_api_0036.html b/docs/natgw/api-ref/nat_api_0036.html index 90d320ff7..7a8646952 100644 --- a/docs/natgw/api-ref/nat_api_0036.html +++ b/docs/natgw/api-ref/nat_api_0036.html @@ -8,6 +8,8 @@
  • Error Code Description v2.0
    • +
  • Error Codes
    +
  • Resource Status Description
    • diff --git a/docs/natgw/api-ref/nat_api_0040.html b/docs/natgw/api-ref/nat_api_0040.html index f27640c55..d1176d23f 100644 --- a/docs/natgw/api-ref/nat_api_0040.html +++ b/docs/natgw/api-ref/nat_api_0040.html @@ -542,7 +542,7 @@

    - + + +
    Table 7 Parameter description of field resource_tag

    Parameter

    Type

    Creating NAT Gateways

    +

    Creating a NAT gateway

    POST /v2.0/nat_gateways

    nat:natGateways:create

    Querying NAT Gateways

    +

    Querying NAT gateways

    GET /v2.0/nat_gateways

    nat:natGateways:list

    Querying NAT Gateway Details

    +

    Querying details of a NAT gateway

    GET /v2.0/nat_gateways/{nat_gateway_id}

    nat:natGateways:get

    Updating NAT Gateways

    +

    Updating a NAT gateway

    PUT /v2.0/nat_gateways/{nat_gateway_id}

    nat:natGateways:update

    Deleting NAT Gateways

    +

    Deleting a NAT gateway

    DELETE /v2.0/nat_gateways/{nat_gateway_id}

    Creating SNAT Rules

    +

    Creating an SNAT rule

    POST /v2.0/snat_rules

    nat:snatRules:create

    Querying SNAT Rules

    +

    Querying SNAT rules

    GET /v2.0/snat_rules

    nat:snatRules:list

    Querying SNAT Rule Details

    +

    Querying details of an SNAT rule

    GET /v2.0/snat_rules/{snat_rule_id }

    nat:snatRules:get

    Deleting SNAT Rules

    +

    Deleting an SNAT rule

    DELETE /v2.0/snat_rules/{snat_rule_id}

    Creating DNAT Rules

    +

    Creating a DNAT rule

    POST /v2.0/dnat_rules

    nat:dnatRules:create

    Querying DNAT Rules

    +

    Querying DNAT rules

    GET /v2.0/dnat_rules

    nat:dnatRules:list

    Querying DNAT Rule Details

    +

    Querying details of a DNAT rule

    GET /v2.0/dnat_rules/{dnat_rule_id }

    nat:dnatRules:get

    Deleting DNAT Rules

    +

    Deleting a DNAT rule

    DELETE /v2.0/dnat_rules/{dnat_rule_id}

    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.

    +

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

    400

    diff --git a/docs/natgw/api-ref/nat_api_0046.html b/docs/natgw/api-ref/nat_api_0046.html index 44f19c8a8..833350def 100644 --- a/docs/natgw/api-ref/nat_api_0046.html +++ b/docs/natgw/api-ref/nat_api_0046.html @@ -8,7 +8,13 @@

    2024-01-15

    +

    2025-04-28

    +

    This issue incorporates the following change:

    +

    Added section "APIs for Private NAT Gateways".

    +

    2024-01-15

    This issue incorporates the following changes:

    @@ -23,7 +29,7 @@

    2022-10-31

    This release incorporates the following change:

    -

    Added Tags.

    +

    Added section "NAT Gateway Tags".

    2022-10-30

    @@ -35,31 +41,31 @@

    2019-09-18

    This release incorporates the following changes:

    - +
    • Added section "DNAT Rules".
    • Updated the field description in sections "NAT Gateways" and "Creating an SNAT Rule".
    • Updated error code description.
    • Added section "Resource Status Description".
    • Updated parameter types in the whole document.

    2019-01-10

    This release incorporates the following change:

    -

    Added parameters cidr and source_type in SNAT Rules.

    +

    Added parameters cidr and source_type in section "SNAT Rules".

    2019-01-04

    This release incorporates the following change:

    -

    Added API Version.

    +

    Added API version management.

    2018-02-24

    This release incorporates the following change:

    -

    Rectified the example request in Deleting an SNAT Rule.

    +

    Modified the example request for deleting an SNAT rule.

    2018-02-13

    This release incorporates the following change:

    -

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

    +

    Added the description of the request parameter router_id for 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 a9d40a19f..987c7a8be 100644 --- a/docs/natgw/api-ref/nat_api_0047.html +++ b/docs/natgw/api-ref/nat_api_0047.html @@ -1,8 +1,10 @@

    API Usage Guidelines

    -

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

    -

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

    +

    Public cloud Application Programming Interfaces (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 Uniform 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.

    +

    Welcome to NAT Gateway API Reference. Public NAT gateways provide the network address translation (NAT) function for servers, such as Elastic Cloud Servers (ECSs) in a Virtual Private Cloud (VPC) or for servers in on-premises data centers that connect to a VPC through Direct Connect or Virtual Private Network (VPN). It allows these servers to access the Internet using Elastic IP (EIP) or to provide services for the Internet. Private NAT gateways provide private IP address translation services for servers, such as Elastic Cloud Servers (ECSs) in a Virtual Private Cloud (VPC) or for servers in on-premises data centers that connect to a VPC through Direct Connect or Virtual Private Network (VPN). Private NAT gateways help avoid private IP address conflicts.

    +

    This document describes how to use application programming interfaces (APIs) to perform operations on NAT gateways, such as creating or deleting NAT gateways, or adding SNAT rules. For details about all supported operations, see API Overview.

    diff --git a/docs/natgw/api-ref/nat_api_0052.html b/docs/natgw/api-ref/nat_api_0052.html index 17dbe239d..02fe493d6 100644 --- a/docs/natgw/api-ref/nat_api_0052.html +++ b/docs/natgw/api-ref/nat_api_0052.html @@ -2,163 +2,331 @@

    API Overview

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

    -

    API v2.0

    -
    Table 1 NAT gateway API v2.0

    Type

    +

    If null will be returned for a request parameter, this parameter will not be returned in the response body.

    +
    +

    API v2.0 for Public NAT Gateways

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

    Type

    Description

    +

    Description

    NAT Gateway Service

    +

    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.

    +

    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

    +

    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.

    +

    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

    +

    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.

    +

    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

    +

    Tags

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

    +

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

    API Version

    +

    API Version

    Query all API versions or an API version.

    +

    Query all API versions or an API version.
    -
    Table 2 NAT gateway API (v2.0) description

    Type

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

    Type

    API

    +

    API

    Description

    +

    Description

    NAT Gateway Service

    +

    NAT Gateway Service

    Creating a NAT Gateway

    +

    Creating a NAT Gateway

    This API is used to create a NAT gateway.

    +

    This API is used to create a NAT gateway.

    Querying NAT Gateways

    +

    Querying NAT Gateways

    This API is used to query NAT gateways.

    +

    This API is used to query NAT gateways.

    Querying Details of a NAT Gateway

    +

    Querying Details of a NAT Gateway

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

    +

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

    Updating a NAT Gateway

    +

    Updating a NAT Gateway

    This API is used to update a NAT gateway.

    +

    This API is used to update a NAT gateway.

    Deleting a NAT Gateway

    +

    Deleting a NAT Gateway

    This API is used to delete a NAT gateway.

    +

    This API is used to delete a NAT gateway.

    SNAT Rules

    +

    SNAT Rules

    Creating an SNAT Rule

    +

    Creating an SNAT Rule

    This API is used to create an SNAT rule.

    +

    This API is used to create an SNAT rule.

    Querying SNAT Rules

    +

    Querying SNAT Rules

    This API is used to query SNAT rules.

    +

    This API is used to query SNAT rules.

    Querying Details of an SNAT Rule

    +

    Querying Details of an SNAT Rule

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

    +

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

    Deleting an SNAT Rule

    +

    Deleting an SNAT Rule

    This API is used to delete an SNAT rule.

    +

    This API is used to delete an SNAT rule.

    DNAT Rules

    +

    DNAT Rules

    Creating a DNAT Rule

    +

    Creating a DNAT Rule

    This API is used to create a DNAT rule.

    +

    This API is used to create a DNAT rule.

    Querying DNAT Rules

    +

    Querying DNAT Rules

    This API is used to query DNAT rules.

    +

    This API is used to query DNAT rules.

    Querying Details of a DNAT Rule

    +

    Querying Details of a DNAT Rule

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

    +

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

    Deleting a DNAT Rule

    +

    Deleting a DNAT Rule

    This API is used to delete a DNAT rule.

    +

    This API is used to delete a DNAT rule.

    Tags

    +

    Tags

    Querying NAT Gateways by Tag

    +

    Querying NAT Gateways by Tag

    This API is used to filter NAT gateways by tag.

    +

    This API is used to query NAT gateways by tag.

    Adding or Deleting NAT Gateway Tags in Batches

    +

    Adding or Deleting NAT Gateway Tags in Batches

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

    +

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

    Adding a NAT Gateway Tag

    +

    Adding a NAT Gateway Tag

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

    +

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

    Deleting a NAT Gateway Tag

    +

    Deleting a NAT Gateway Tag

    This API is used to delete NAT gateway tags.

    +

    This API is used to delete a NAT gateway tag.

    Querying NAT Gateway Tags

    +

    Querying NAT Gateway Tags

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

    +

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

    Querying Tags in a Project

    +

    Querying Tags in a Project

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

    +

    This API is used to query all NAT gateway tags in a project.

    API Version

    +

    API Version

    Querying All API Versions

    +

    Querying All API Versions

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

    +

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

    Querying an API Version

    +

    Querying an API Version

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

    +

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

    +
    +
    + +

    API v3.0 for Private NAT Gateways

    +
    + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Private NAT gateway APIs

    Type

    +

    Description

    +

    Private NAT gateways

    +

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

    +

    DNAT rules

    +

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

    +

    SNAT rules

    +

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

    +

    Transit IP addresses

    +

    Assign, query, and release transit IP addresses, including assigning a transit IP address, querying transit IP addresses, releasing a transit IP address, and querying details of a transit IP address.

    +

    Private NAT gateway tags

    +

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

    +

    Transit IP address tags

    +

    Tag transit IP addresses. Tags help you manage transit IP addresses. You can query, add, and delete tags of transit IP addresses.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/natgw/api-ref/nat_api_0061.html b/docs/natgw/api-ref/nat_api_0061.html index 8820b038a..acdc7b865 100644 --- a/docs/natgw/api-ref/nat_api_0061.html +++ b/docs/natgw/api-ref/nat_api_0061.html @@ -194,7 +194,7 @@ - @@ -269,7 +269,6 @@ "billinginfo": "", "dnat_rules_limit": 200, "snat_rule_public_ip_limit": 20, - "freeze_info": null, "sys_tags": [ "_sys_enterprise_project_id=0" ], diff --git a/docs/natgw/api-ref/nat_api_0062.html b/docs/natgw/api-ref/nat_api_0062.html index c0b750f28..cb7690157 100644 --- a/docs/natgw/api-ref/nat_api_0062.html +++ b/docs/natgw/api-ref/nat_api_0062.html @@ -123,7 +123,7 @@ - @@ -141,13 +141,6 @@ - - - -
    Table 4 Descriptions of private NAT gateway APIs

    Type

    +

    Description

    +

    Private NAT gateways

    +

    This API is used to query private NAT gateways.

    +

    This API is used to update a private NAT gateway.

    +

    This API is used to delete a private NAT gateway.

    +

    This API is used to create a private NAT gateway.

    +

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

    +

    DNAT rules

    +

    This API is used to query DNAT rules.

    +

    This API is used to update a DNAT rule.

    +

    This API is used to create a DNAT rule.

    +

    This API is used to delete a DNAT rule.

    +

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

    +

    SNAT rules

    +

    This API is used to query SNAT rules.

    +

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

    +

    This API is used to update an SNAT rule.

    +

    This API is used to create an SNAT rule.

    +

    This API is used to delete an SNAT rule.

    +

    Transit IP addresses

    +

    This API is used to query transit IP addresses.

    +

    This API is used to release a transit IP address.

    +

    This API is used to assign a transit IP address.

    +

    This API is used to query details of a transit IP address.

    +

    Private NAT gateway tags

    +

    +

    +

    +

    +

    +

    This API is used to query private NAT gateways by tag.

    +

    This API is used to query tags of all private NAT gateways owned by a tenant in a project.

    +

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

    +

    This API is used to add a tag to a private NAT gateway.

    +

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

    +

    This API is used to delete a private NAT gateway tag.

    +

    Transit IP address tags

    +

    +

    +

    +

    +

    +

    This API is used to query transit IP addresses by tag.

    +

    This API is used to query tags of all transit IP addresses owned by a tenant in a project.

    +

    This API is used to query tags of a transit IP address.

    +

    This API is used to add a tag to a transit IP address.

    +

    This API is used to add or delete tags to or from a transit IP address.

    +

    This API is used to delete a tag from a transit IP address.

    Boolean

    • 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 whether the NAT gateway is started or stopped.
    • The state can be:
      • true: The NAT gateway is started.
      • false: The NAT gateway is stopped.

    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 started or stopped.
    • The value can be:
      • true: The NAT gateway is started.
      • false: The NAT gateway is stopped.

    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>

    @@ -190,7 +183,6 @@ "billinginfo": "", "dnat_rules_limit": 200, "snat_rule_public_ip_limit": 20, - "freeze_info": null, "sys_tags": [ "_sys_enterprise_project_id=0" ], diff --git a/docs/natgw/api-ref/nat_api_0063.html b/docs/natgw/api-ref/nat_api_0063.html index 9050aa89c..76f70e446 100644 --- a/docs/natgw/api-ref/nat_api_0063.html +++ b/docs/natgw/api-ref/nat_api_0063.html @@ -2,12 +2,14 @@

    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.

    +

    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. The users then inherit permissions from the groups and can perform specified operations on cloud services based on the permissions they have been assigned.

    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.

    +

    An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query 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.
    +

    Private NAT gateways do not have dedicated permissions, please use public NAT gateway roles/policies.

    +

    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/nat_api_0070.html b/docs/natgw/api-ref/nat_api_0070.html new file mode 100644 index 000000000..8718beea6 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0070.html @@ -0,0 +1,69 @@ + + +

    Private NAT Gateways

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

    Permission

    +

    API

    +

    IAM Project

    +

    Enterprise Project

    +

    Creating a Private NAT Gateway

    +

    POST /v3/{project_id}/private-nat/gateways

    +

    √

    +

    √

    +

    Querying Private NAT Gateways

    +

    GET /v3/{project_id}/private-nat/gateways

    +

    √

    +

    √

    +

    Querying a Private NAT Gateway

    +

    GET /v3/{project_id}/private-nat/gateways/{gateway_id}

    +

    √

    +

    √

    +

    Updating a Private NAT Gateway

    +

    PUT /v3/{project_id}/private-nat/gateways/{gateway_id}

    +

    √

    +

    √

    +

    Deleting a Private NAT Gateway

    +

    DELETE /v3/{project_id}/private-nat/gateways/{gateway_id}

    +

    √

    +

    √

    +
    +
    +
    + + diff --git a/docs/natgw/api-ref/nat_api_0071.html b/docs/natgw/api-ref/nat_api_0071.html new file mode 100644 index 000000000..b2933ed1f --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0071.html @@ -0,0 +1,60 @@ + + +

    Private NAT Gateway - Transit IP Address

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

    Permission

    +

    API

    +

    IAM Project

    +

    Enterprise Project

    +

    Assigning a Transit IP Address

    +

    POST /v3/{project_id}/private-nat/transit-ips

    +

    √

    +

    √

    +

    Querying a Transit IP Address

    +

    GET /v3/{project_id}/private-nat/transit-ips/{transit_ip_id}

    +

    √

    +

    √

    +

    Querying Transit IP Addresses

    +

    GET /v3/{project_id}/private-nat/transit-ips

    +

    √

    +

    √

    +

    Releasing a Transit IP Address

    +

    DELETE /v3/{project_id}/private-nat/transit-ips/{transit_ip_id}

    +

    √

    +

    √

    +
    +
    +
    + + diff --git a/docs/natgw/api-ref/nat_api_0072.html b/docs/natgw/api-ref/nat_api_0072.html new file mode 100644 index 000000000..326b441c8 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0072.html @@ -0,0 +1,69 @@ + + +

    SNAT Rules of Private NAT Gateways

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

    Permission

    +

    API

    +

    IAM Project

    +

    Enterprise Project

    +

    Creating an SNAT Rule

    +

    POST /v3/{project_id}/private-nat/snat-rules

    +

    √

    +

    √

    +

    Querying an SNAT Rule

    +

    GET /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}

    +

    √

    +

    √

    +

    Querying SNAT Rules

    +

    GET /v3/{project_id}/private-nat/snat-rules

    +

    √

    +

    √

    +

    Updating an SNAT Rule

    +

    PUT /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}

    +

    √

    +

    √

    +

    Deleting an SNAT Rule

    +

    DELETE /v3/{project_id}/private-nat/snat-rules/{snat_rule_id}

    +

    √

    +

    √

    +
    +
    +
    + + diff --git a/docs/natgw/api-ref/nat_api_0073.html b/docs/natgw/api-ref/nat_api_0073.html new file mode 100644 index 000000000..f5858bf50 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0073.html @@ -0,0 +1,69 @@ + + +

    DNAT Rules of Private NAT Gateways

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

    Permission

    +

    API

    +

    IAM Project

    +

    Enterprise Project

    +

    Creating a DNAT Rule

    +

    POST /v3/{project_id}/private-nat/dnat-rules

    +

    √

    +

    √

    +

    Querying a DNAT Rule

    +

    GET /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}

    +

    √

    +

    √

    +

    Querying DNAT Rules

    +

    GET /v3/{project_id}/private-nat/dnat-rules

    +

    √

    +

    √

    +

    Updating a DNAT Rule

    +

    PUT /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}

    +

    √

    +

    √

    +

    Deleting a DNAT Rule

    +

    DELETE /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}

    +

    √

    +

    √

    +
    +
    +
    + + diff --git a/docs/natgw/api-ref/nat_api_0074.html b/docs/natgw/api-ref/nat_api_0074.html new file mode 100644 index 000000000..28f5f193c --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0074.html @@ -0,0 +1,82 @@ + + +

    Private NAT Gateway - Tag

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

    Permission

    +

    API

    +

    IAM Project

    +

    Enterprise Project

    +

    Adding a Tag to a Private NAT Gateway

    +

    POST

    +

    /v3/{project_id}/private-nat-gateways/{resource_id}/tags

    +

    √

    +

    √

    +

    Batch Adding or Deleting Tags to or from a Private NAT Gateway

    +

    POST

    +

    /v3/{project_id}/private-nat-gateways/{resource_id}/tags/action

    +

    √

    +

    √

    +

    Querying Private NAT Gateways by Tag

    +

    POST

    +

    /v3/{project_id}/private-nat-gateways/resource_instances/action

    +

    √

    +

    ×

    +

    Querying Tags of a Private NAT Gateway

    +

    GET /v3/{project_id}/private-nat-gateways/{resource_id}/tags

    +

    √

    +

    √

    +

    Querying Tags of All Private NAT Gateways in a Project

    +

    GET /v3/{project_id}/private-nat-gateways/tags

    +

    √

    +

    ×

    +

    Deleting a Tag from a Private NAT Gateway

    +

    DELETE

    +

    /v3/{project_id}/private-nat-gateways/{resource_id}/tags/{key}

    +

    √

    +

    √

    +
    +
    +
    + + diff --git a/docs/natgw/api-ref/nat_api_0075.html b/docs/natgw/api-ref/nat_api_0075.html new file mode 100644 index 000000000..798a84c23 --- /dev/null +++ b/docs/natgw/api-ref/nat_api_0075.html @@ -0,0 +1,84 @@ + + +

    Private NAT Gateway - Transit IP Address Tag

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

    Permission

    +

    API

    +

    IAM Project

    +

    Enterprise Project

    +

    Querying Transit IP Addresses by Tag

    +

    POST

    +

    /v3/{project_id}/transit-ips/resource_instances/action

    +

    √

    +

    ×

    +

    Batch Adding or Deleting Tags to or from a Transit IP Address

    +

    POST

    +

    /v3/{project_id}/transit-ips/{resource_id}/tags/action

    +

    √

    +

    √

    +

    Adding a Tag to a Transit IP Address

    +

    POST

    +

    /v3/{project_id}/transit-ips/{resource_id}/tags

    +

    √

    +

    √

    +

    Querying Tags of a Transit IP Address

    +

    GET

    +

    /v3/{project_id}/transit-ips/{resource_id}/tags

    +

    √

    +

    √

    +

    Deleting a Tag from a Transit IP Address

    +

    DELETE

    +

    /v3/{project_id}/transit-ips/{resource_id}/tags/{key}

    +

    √

    +

    √

    +

    Querying Tags of All Transit IP Addresses in a Project

    +

    GET

    +

    /v3/{project_id}/transit-ips/tags

    +

    √

    +

    ×

    +
    +
    +
    + + diff --git a/docs/natgw/api-ref/nat_private_0000.html b/docs/natgw/api-ref/nat_private_0000.html new file mode 100644 index 000000000..283dc4834 --- /dev/null +++ b/docs/natgw/api-ref/nat_private_0000.html @@ -0,0 +1,22 @@ + + +

    APIs for Private NAT Gateways (v3.0)

    +

    +
    + +