vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/natgw/api-ref/CLASS.TXT.json
Qin Ying, Fan 388d58fc5d NATGW API 20230922 version 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2024-01-16 14:31:30 +00:00

362 lines
14 KiB
JSON
Raw Blame History

[
{
"desc":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ",
"product_code":"nat",
"title":"API Usage Guidelines",
"uri":"nat_api_0047.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"desc":"NAT Gateway APIs allow you to use all NAT Gateway functions.",
"product_code":"nat",
"title":"API Overview",
"uri":"nat_api_0052.html",
"doc_type":"api",
"p_code":"",
"code":"2"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"API v2.0",
"uri":"nat_api_0000.html",
"doc_type":"api",
"p_code":"",
"code":"3"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"NAT Gateway Service",
"uri":"nat_api_0001.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
"desc":"This API is used to create a NAT gateway.POST /v2.0/nat_gatewaysTable 1 describes the request parameter.Table 3 lists response parameters.Example requestPOST https://{End",
"product_code":"nat",
"title":"Creating a NAT Gateway",
"uri":"nat_api_0061.html",
"doc_type":"api",
"p_code":"4",
"code":"5"
},
{
"desc":"This API is used to query NAT gateways. Unless otherwise specified, exact match is applied.GET /v2.0/nat_gatewaysYou can type the question mark (?) and ampersand (&) at t",
"product_code":"nat",
"title":"Querying NAT Gateways",
"uri":"nat_api_0002.html",
"doc_type":"api",
"p_code":"4",
"code":"6"
},
{
"desc":"This API is used to query details of a NAT gateway.GET /v2.0/nat_gateways/{nat_gateway_id}NoneTable 2 lists response parameter.Example requestGET https://{Endpoint}/v2.0/",
"product_code":"nat",
"title":"Querying Details of a NAT Gateway",
"uri":"nat_api_0062.html",
"doc_type":"api",
"p_code":"4",
"code":"7"
},
{
"desc":"This API is used to update a NAT gateway.admin_state_up = True & status = \"ACTIVE\" can be updated. The name, description, and type of a NAT gateway can be updated.PUT /v2",
"product_code":"nat",
"title":"Updating a NAT Gateway",
"uri":"nat_api_0003.html",
"doc_type":"api",
"p_code":"4",
"code":"8"
},
{
"desc":"This API is used to delete a NAT gateway.DELETE /v2.0/nat_gateways/{nat_gateway_id}NoneNoneExample requestDELETE https://{Endpoint}/v2.0/nat_gateways/a78fb3eb-1654-4710-8",
"product_code":"nat",
"title":"Deleting a NAT Gateway",
"uri":"nat_api_0004.html",
"doc_type":"api",
"p_code":"4",
"code":"9"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"SNAT Rules",
"uri":"nat_api_0005.html",
"doc_type":"api",
"p_code":"3",
"code":"10"
},
{
"desc":"This API is used to create an SNAT rule.You can create an SNAT rule only when status of the NAT gateway is set to ACTIVE and admin_state_up of the NAT gateway administrat",
"product_code":"nat",
"title":"Creating an SNAT Rule",
"uri":"nat_api_0006.html",
"doc_type":"api",
"p_code":"10",
"code":"11"
},
{
"desc":"This API is used to query SNAT rules.GET /v2.0/snat_rulesYou can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. Al",
"product_code":"nat",
"title":"Querying SNAT Rules",
"uri":"nat_api_0007.html",
"doc_type":"api",
"p_code":"10",
"code":"12"
},
{
"desc":"This API is used to query details of an SNAT rule.GET /v2.0/snat_rules/{snat_rule_id}NoneTable 2 lists response parameter.Example requestGET https://{Endpoint}/v2.0/snat_",
"product_code":"nat",
"title":"Querying Details of an SNAT Rule",
"uri":"nat_api_0008.html",
"doc_type":"api",
"p_code":"10",
"code":"13"
},
{
"desc":"This API is used to delete an SNAT rule.DELETE /v2.0/snat_rules/{snat_rule_id}NoneNoneExample requestDELETE https://{Endpoint}/v2.0/snat_rules/a78fb3eb-1654-4710-8742-3fc",
"product_code":"nat",
"title":"Deleting an SNAT Rule",
"uri":"nat_api_0009.html",
"doc_type":"api",
"p_code":"10",
"code":"14"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"DNAT Rules",
"uri":"nat_api_0010.html",
"doc_type":"api",
"p_code":"3",
"code":"15"
},
{
"desc":"This API is used to create a DNAT rule.You can create a DNAT rule only when status of the NAT gateway is set to ACTIVE and admin_state_up of the NAT gateway administrator",
"product_code":"nat",
"title":"Creating a DNAT Rule",
"uri":"nat_api_0011.html",
"doc_type":"api",
"p_code":"15",
"code":"16"
},
{
"desc":"This API is used to query DNAT rules.GET /v2.0/dnat_rulesYou can type a question mark (?) and an ampersand (&) at the end of the URI to define different search criteria. ",
"product_code":"nat",
"title":"Querying DNAT Rules",
"uri":"nat_api_0012.html",
"doc_type":"api",
"p_code":"15",
"code":"17"
},
{
"desc":"This API is used to query details of a DNAT rule.GET /v2.0/dnat_rules/{dnat_rule_id}NoneTable 2 lists response parameter.Example requestGET https://{Endpoint}/v2.0/dnat_r",
"product_code":"nat",
"title":"Querying Details of a DNAT Rule",
"uri":"nat_api_0013.html",
"doc_type":"api",
"p_code":"15",
"code":"18"
},
{
"desc":"This API is used to delete a DNAT rule.DELETE /v2.0/dnat_rules/{dnat_rule_id}NoneNoneExample requestDELETE https://{Endpoint}/v2.0/dnat_rules/a78fb3eb-1654-4710-8742-3fc4",
"product_code":"nat",
"title":"Deleting a DNAT Rule",
"uri":"nat_api_0014.html",
"doc_type":"api",
"p_code":"15",
"code":"19"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"Tags",
"uri":"nat_api_0015.html",
"doc_type":"api",
"p_code":"3",
"code":"20"
},
{
"desc":"This API is used to filter NAT gateways by tag.TMS uses this API to filter and list NAT gateways by tag.By default, NAT gateways and tags are sorted in descending order o",
"product_code":"nat",
"title":"Querying NAT Gateways by Tag",
"uri":"nat_api_0016.html",
"doc_type":"api",
"p_code":"20",
"code":"21"
},
{
"desc":"This API is used to add or delete tags of a specific NAT gateway in batches.TMS uses this API to manage service resource tags.You can add a maximum of 20 tags to a NAT ga",
"product_code":"nat",
"title":"Adding or Deleting NAT Gateway Tags in Batches",
"uri":"nat_api_0017.html",
"doc_type":"api",
"p_code":"20",
"code":"22"
},
{
"desc":"This API is used to add tags to a NAT gateway. You can add a maximum of 20 tags to a NAT gateway.This API is idempotent.If a to-be-created tag has the same key as an exis",
"product_code":"nat",
"title":"Adding a NAT Gateway Tag",
"uri":"nat_api_0018.html",
"doc_type":"api",
"p_code":"20",
"code":"23"
},
{
"desc":"This API is idempotent.When a tag is deleted, it is not verified. The tag key cannot be left blank or be an empty string. If the key of the tag to be deleted does not exi",
"product_code":"nat",
"title":"Deleting a NAT Gateway Tag",
"uri":"nat_api_0019.html",
"doc_type":"api",
"p_code":"20",
"code":"24"
},
{
"desc":"This API is used to query tags of a specified NAT gateway.TMS uses this API to query all tags of a specified NAT gateway.GET /v2.0/{project_id}/nat_gateways/{nat_gateway_",
"product_code":"nat",
"title":"Querying NAT Gateway Tags",
"uri":"nat_api_0020.html",
"doc_type":"api",
"p_code":"20",
"code":"25"
},
{
"desc":"This API is used to query all tags of a resource type in a specified region.TMS uses this API to list tags created by a tenant to facilitate tag creation and resource fil",
"product_code":"nat",
"title":"Querying Tags in a Project",
"uri":"nat_api_0021.html",
"doc_type":"api",
"p_code":"20",
"code":"26"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"API Version",
"uri":"nat_api_0024.html",
"doc_type":"api",
"p_code":"3",
"code":"27"
},
{
"desc":"This API is used to query all API versions of NAT Gateway.GET/NoneTable 1 lists response parameters.Example responseSee Status Codes.",
"product_code":"nat",
"title":"Querying All API Versions",
"uri":"nat_api_0025.html",
"doc_type":"api",
"p_code":"27",
"code":"28"
},
{
"desc":"This API is used to query an API version of NAT Gateway.GET/{api_version}NoneTable 2 lists response parameters.Example responseSee Status Codes.",
"product_code":"nat",
"title":"Querying an API Version",
"uri":"nat_api_0026.html",
"doc_type":"api",
"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":"Permissions Policies and Supported Actions",
"uri":"nat_api_0027.html",
"doc_type":"api",
"p_code":"",
"code":"30"
},
{
"desc":"This section describes fine-grained permissions management for your NAT gateways. If your account does not need individual IAM users, then you may skip this section.By de",
"product_code":"nat",
"title":"Introduction",
"uri":"nat_api_0063.html",
"doc_type":"api",
"p_code":"30",
"code":"31"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"NAT Gateway v2.0",
"uri":"nat_api_0032.html",
"doc_type":"api",
"p_code":"30",
"code":"32"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"SNAT Rule v2.0",
"uri":"nat_api_0033.html",
"doc_type":"api",
"p_code":"30",
"code":"33"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"DNAT Rule v2.0",
"uri":"nat_api_0034.html",
"doc_type":"api",
"p_code":"30",
"code":"34"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"NAT Gateway Tag v2.0",
"uri":"nat_api_0035.html",
"doc_type":"api",
"p_code":"30",
"code":"35"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"Common Parameters",
"uri":"nat_api_0036.html",
"doc_type":"api",
"p_code":"",
"code":"36"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"Status Codes",
"uri":"nat_api_0038.html",
"doc_type":"api",
"p_code":"36",
"code":"37"
},
{
"desc":"An error code returned by an API does not correspond to one error message. The following table lists only common error messages.Most NAT Gateway APIs are asynchronous. So",
"product_code":"nat",
"title":"Error Code Description v2.0",
"uri":"nat_api_0040.html",
"doc_type":"api",
"p_code":"36",
"code":"38"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"Resource Status Description",
"uri":"nat_api_0042.html",
"doc_type":"api",
"p_code":"36",
"code":"39"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nat",
"title":"Change History",
"uri":"nat_api_0046.html",
"doc_type":"api",
"p_code":"",
"code":"40"
}
]
View Git Blame Copy Permalink