From 406cbf6c6ffcb6d6198900cf224e77cb02ce7939 Mon Sep 17 00:00:00 2001 From: fanqinying Date: Mon, 13 Apr 2026 19:54:24 +0000 Subject: [PATCH] EIP API 20251024 version MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reviewed-by: Hajba, László Antal Co-authored-by: fanqinying Co-committed-by: fanqinying --- docs/eip/api-ref/ALL_META.TXT.json | 751 +++++++++++++-- docs/eip/api-ref/AssociatePublicips.html | 24 +- docs/eip/api-ref/CLASS.TXT.json | 171 ++-- docs/eip/api-ref/CreatePublicIpV3.html | 853 +++++++++++++++++ docs/eip/api-ref/DeletePublicIp.html | 78 ++ docs/eip/api-ref/DisassociatePublicips.html | 20 +- docs/eip/api-ref/ErrorCode.html | 865 ++++++++++++------ docs/eip/api-ref/ListCommonPools.html | 4 +- docs/eip/api-ref/ListPublicipsV3.html | 28 +- docs/eip/api-ref/ShowPublicipV3.html | 30 +- docs/eip/api-ref/eip_api05_0001.html | 9 +- docs/eip/api-ref/eip_api06_0001.html | 7 +- docs/eip/api-ref/eip_api06_0003.html | 88 +- docs/eip/api-ref/eip_api07_0000.html | 38 +- docs/eip/api-ref/eip_apiBandwidth_0001.html | 37 +- docs/eip/api-ref/eip_apiBandwidth_0002.html | 111 ++- docs/eip/api-ref/eip_apiBandwidth_0003.html | 49 +- docs/eip/api-ref/eip_api_0001.html | 177 ++-- docs/eip/api-ref/eip_api_0002.html | 92 +- docs/eip/api-ref/eip_api_0003.html | 93 +- docs/eip/api-ref/eip_api_0004.html | 56 +- docs/eip/api-ref/eip_api_0005.html | 10 +- docs/eip/api-ref/eip_apieg_0002.html | 4 +- docs/eip/api-ref/eip_apieg_0003.html | 2 +- docs/eip/api-ref/eip_apifloatip_0001.html | 42 +- docs/eip/api-ref/eip_apifloatip_0002.html | 33 +- docs/eip/api-ref/eip_apifloatip_0003.html | 4 +- docs/eip/api-ref/eip_apifloatip_0004.html | 4 +- docs/eip/api-ref/eip_apifloatip_0005.html | 4 +- docs/eip/api-ref/eip_apipermission_0000.html | 4 +- docs/eip/api-ref/eip_apipermission_0002.html | 38 +- docs/eip/api-ref/eip_apipermission_0003.html | 24 +- docs/eip/api-ref/eip_apipermission_0004.html | 34 +- docs/eip/api-ref/eip_apipermission_0006.html | 36 +- docs/eip/api-ref/eip_apipermission_0007.html | 4 +- docs/eip/api-ref/eip_apipermission_0011.html | 71 ++ docs/eip/api-ref/eip_apiquota_0001.html | 38 +- .../api-ref/eip_apisharedbandwidth_0001.html | 81 +- .../api-ref/eip_apisharedbandwidth_0003.html | 6 +- .../api-ref/eip_apisharedbandwidth_0004.html | 52 +- .../api-ref/eip_apisharedbandwidth_0005.html | 28 +- docs/eip/api-ref/eip_apitag_0000.html | 6 +- docs/eip/api-ref/eip_apitag_0001.html | 16 +- docs/eip/api-ref/eip_apitag_0002.html | 12 +- docs/eip/api-ref/eip_apitag_0003.html | 10 +- docs/eip/api-ref/eip_apitag_0004.html | 16 +- docs/eip/api-ref/eip_apitag_0005.html | 46 +- docs/eip/api-ref/eip_apitag_0006.html | 14 +- docs/eip/api-ref/eip_apiv3_0100.html | 4 + docs/eip/api-ref/eip_openstackapi_0002.html | 4 +- docs/eip/api-ref/eip_openstackapi_0003.html | 14 +- docs/eip/api-ref/eip_openstackapi_0004.html | 53 +- docs/eip/api-ref/eip_openstackapi_0006.html | 116 ++- docs/eip/api-ref/eip_openstackapi_0007.html | 87 +- docs/eip/api-ref/eip_openstackapi_0008.html | 38 +- docs/eip/api-ref/eip_openstackapi_0009.html | 98 +- docs/eip/api-ref/eip_openstackapi_0010.html | 16 +- 57 files changed, 3625 insertions(+), 1025 deletions(-) create mode 100644 docs/eip/api-ref/CreatePublicIpV3.html create mode 100644 docs/eip/api-ref/DeletePublicIp.html create mode 100644 docs/eip/api-ref/eip_apipermission_0011.html diff --git a/docs/eip/api-ref/ALL_META.TXT.json b/docs/eip/api-ref/ALL_META.TXT.json index 278c4b460..437a430ab 100644 --- a/docs/eip/api-ref/ALL_META.TXT.json +++ b/docs/eip/api-ref/ALL_META.TXT.json @@ -1,671 +1,1314 @@ [ + { + "dockw":"API Reference" + }, { "uri":"eip_api01_0000.html", + "node_id":"eip_api01_0000.xml", "product_code":"eip", "code":"1", "des":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", "doc_type":"api", "kw":"API Usage Guidelines,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"API Usage Guidelines", "githuburl":"" }, { "uri":"eip_api02_0001.html", + "node_id":"eip_api02_0001.xml", "product_code":"eip", "code":"2", "des":"APIs provided by the EIP service include native OpenStack APIs and EIP APIs.A combination of these two types of APIs allows you to use all functions provided by the EIP s", "doc_type":"api", "kw":"API Overview,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"API Overview", "githuburl":"" }, { "uri":"eip_api04_0000.html", + "node_id":"eip_api04_0000.xml", "product_code":"eip", "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":"APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"APIs", "githuburl":"" }, { "uri":"eip_api_0000.html", + "node_id":"eip_api_0000.xml", "product_code":"eip", "code":"4", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"EIP", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"EIP", "githuburl":"" }, { "uri":"eip_api_0001.html", + "node_id":"eip_api_0001.xml", "product_code":"eip", "code":"5", - "des":"This API is used to assign an EIP.The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSs, B", + "des":"This API is used to assign an EIP.The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be flexibly bound to or unbound fro", "doc_type":"api", "kw":"Assigning an EIP,EIP,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Assigning an EIP", "githuburl":"" }, { "uri":"eip_api_0002.html", + "node_id":"eip_api_0002.xml", "product_code":"eip", "code":"6", "des":"This API is used to query a specific EIP.Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:In eu-de, EIPs of the Dedicated Load Balancer (", "doc_type":"api", "kw":"Querying an EIP,EIP,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying an EIP", "githuburl":"" }, { "uri":"eip_api_0003.html", + "node_id":"eip_api_0003.xml", "product_code":"eip", "code":"7", "des":"This API is used to query EIPs.Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:In eu-de, EIPs of the Dedicated Load Balancer (5_gray) ty", "doc_type":"api", "kw":"Querying EIPs,EIP,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying EIPs", "githuburl":"" }, { "uri":"eip_api_0004.html", + "node_id":"eip_api_0004.xml", "product_code":"eip", "code":"8", "des":"This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC.Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:In eu-de, EIPs of ", "doc_type":"api", "kw":"Updating an EIP,EIP,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Updating an EIP", "githuburl":"" }, { "uri":"eip_api_0005.html", + "node_id":"eip_api_0005.xml", "product_code":"eip", "code":"9", "des":"This API is used to release an EIP.Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:In eu-de, EIPs of the Dedicated Load Balancer (5_gray", "doc_type":"api", "kw":"Releasing an EIP,EIP,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Releasing an EIP", "githuburl":"" }, { "uri":"eip_apifloatip_0000.html", + "node_id":"eip_apifloatip_0000.xml", "product_code":"eip", "code":"10", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Floating IP Address (IPv6)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Floating IP Address (IPv6)", "githuburl":"" }, { "uri":"eip_apifloatip_0001.html", + "node_id":"eip_apifloatip_0001.xml", "product_code":"eip", "code":"11", "des":"This API is used to query all floating IP addresses accessible to the tenant submitting the request.GET /v2.0/eip/floatingips_v6Example:Table 1 describes the parameters.R", "doc_type":"api", "kw":"Querying Floating IP Addresses,Floating IP Address (IPv6),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying Floating IP Addresses", "githuburl":"" }, { "uri":"eip_apifloatip_0002.html", + "node_id":"eip_apifloatip_0002.xml", "product_code":"eip", "code":"12", "des":"This API is used to query details about a specific floating IP address accessible to the tenant submitting the request.GET /v2.0/eip/floatingips_v6/{floatingip_id}Request", "doc_type":"api", "kw":"Querying a Floating IP Address,Floating IP Address (IPv6),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying a Floating IP Address", "githuburl":"" }, { "uri":"eip_apifloatip_0003.html", + "node_id":"eip_apifloatip_0003.xml", "product_code":"eip", "code":"13", "des":"This API is used to assign a floating IP address and associates it with an internal port.RestrictionsYou can use GET /v2.0/networks?router:external=True or run the neutro", "doc_type":"api", "kw":"Assigning a Floating IP Address,Floating IP Address (IPv6),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Assigning a Floating IP Address", "githuburl":"" }, { "uri":"eip_apifloatip_0004.html", + "node_id":"eip_apifloatip_0004.xml", "product_code":"eip", "code":"14", "des":"This API is used to update a specific floating IP address and the port associated with the IP address. If port_id is left blank, the floating IP address has been unbound ", "doc_type":"api", "kw":"Updating a Floating IP Address,Floating IP Address (IPv6),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Updating a Floating IP Address", "githuburl":"" }, { "uri":"eip_apifloatip_0005.html", + "node_id":"eip_apifloatip_0005.xml", "product_code":"eip", "code":"15", "des":"This API is used to delete a floating IP address.DELETE /v2.0/eip/floatingips_v6/{floatingip_id}Request parameterNoneNoneExample requestDELETE https://{Endpoint}/v2.0/eip", "doc_type":"api", "kw":"Deleting a Floating IP Address,Floating IP Address (IPv6),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Deleting a Floating IP Address", "githuburl":"" }, { "uri":"eip_apiBandwidth_0000.html", + "node_id":"eip_apibandwidth_0000.xml", "product_code":"eip", "code":"16", "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":"Bandwidth", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Bandwidth", "githuburl":"" }, { "uri":"eip_apiBandwidth_0001.html", + "node_id":"eip_apibandwidth_0001.xml", "product_code":"eip", "code":"17", - "des":"This API is used to query details about a bandwidth.GET /v1/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionNameMandatoryDescr", + "des":"This API is used to query details about a bandwidth.GET /v1/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionParameterMandatory", "doc_type":"api", "kw":"Querying a Bandwidth,Bandwidth,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying a Bandwidth", "githuburl":"" }, { "uri":"eip_apiBandwidth_0002.html", + "node_id":"eip_apibandwidth_0002.xml", "product_code":"eip", "code":"18", - "des":"This API is used to query bandwidths using search criteria.GET /v1/{project_id}/bandwidthsTable 1 describes the parameters.Request parameterRequest parametersNameMandator", + "des":"This API is used to query bandwidths using search criteria.GET /v1/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionParameterMandatoryTypeDesc", "doc_type":"api", "kw":"Querying Bandwidths,Bandwidth,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying Bandwidths", "githuburl":"" }, { "uri":"eip_apiBandwidth_0003.html", + "node_id":"eip_apibandwidth_0003.xml", "product_code":"eip", "code":"19", - "des":"This API is used to update information about a bandwidth.PUT /v1/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionNameMandatory", + "des":"This API is used to update information about a bandwidth.PUT /v1/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionParameterMand", "doc_type":"api", "kw":"Updating a Bandwidth,Bandwidth,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Updating a Bandwidth", "githuburl":"" }, { "uri":"eip_apisharedbandwidth_0000.html", + "node_id":"eip_apisharedbandwidth_0000.xml", "product_code":"eip", "code":"20", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Bandwidth (V2.0)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Bandwidth (V2.0)", "githuburl":"" }, { "uri":"eip_apisharedbandwidth_0001.html", + "node_id":"eip_apisharedbandwidth_0001.xml", "product_code":"eip", "code":"21", - "des":"This API is used to assign a shared bandwidth.POST /v2.0/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionNameMandatoryDescriptionproject_idYe", + "des":"This API is used to assign a shared bandwidth.POST /v2.0/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionParameterMandatoryDescriptionproject", "doc_type":"api", "kw":"Assigning a Shared Bandwidth,Bandwidth (V2.0),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Assigning a Shared Bandwidth", "githuburl":"" }, { "uri":"eip_apisharedbandwidth_0003.html", + "node_id":"eip_apisharedbandwidth_0003.xml", "product_code":"eip", "code":"22", - "des":"This API is used to delete a shared bandwidth.DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionNameMandatoryDescri", + "des":"This API is used to delete a shared bandwidth.DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionParameterMandatoryD", "doc_type":"api", "kw":"Deleting a Shared Bandwidth,Bandwidth (V2.0),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Deleting a Shared Bandwidth", "githuburl":"" }, { "uri":"eip_apisharedbandwidth_0004.html", + "node_id":"eip_apisharedbandwidth_0004.xml", "product_code":"eip", "code":"23", - "des":"This API is used to add an EIP to a shared bandwidth.POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insertTable 1 describes the parameters.Parameter descriptionNameMan", + "des":"This API is used to add an EIP to a shared bandwidth.POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insertTable 1 describes the parameters.Parameter descriptionParamet", "doc_type":"api", "kw":"Adding an EIP to a Shared Bandwidth,Bandwidth (V2.0),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Adding an EIP to a Shared Bandwidth", "githuburl":"" }, { "uri":"eip_apisharedbandwidth_0005.html", + "node_id":"eip_apisharedbandwidth_0005.xml", "product_code":"eip", "code":"24", - "des":"This API is used to remove an EIP from a shared bandwidth.POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/removeTable 1 describes the parameters.Parameter descriptionNa", + "des":"This API is used to remove an EIP from a shared bandwidth.POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/removeTable 1 describes the parameters.Parameter descriptionPa", "doc_type":"api", "kw":"Removing an EIP from a Shared Bandwidth,Bandwidth (V2.0),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Removing an EIP from a Shared Bandwidth", "githuburl":"" }, { "uri":"eip_apiquota_0000.html", + "node_id":"eip_apiquota_0000.xml", "product_code":"eip", "code":"25", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Quota", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false" + } + ], "title":"Quota", "githuburl":"" }, { "uri":"eip_apiquota_0001.html", + "node_id":"eip_apiquota_0001.xml", "product_code":"eip", "code":"26", - "des":"This API is used to query network resource quotas of a tenant. The network resources include VPCs, subnets, security groups, security group rules, EIPs, and VPNs.This API", + "des":"This API is used to query the network resource quotas of a tenant. The network resources include VPCs, subnets, security groups, security group rules, EIPs, VPNs, and mor", "doc_type":"api", "kw":"Querying the Quota,Quota,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying the Quota", "githuburl":"" }, { "uri":"eip_apitag_0000.html", + "node_id":"eip_apitag_0000.xml", "product_code":"eip", "code":"27", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"EIP Tag Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"EIP Tag Management", "githuburl":"" }, { "uri":"eip_apitag_0001.html", + "node_id":"eip_apitag_0001.xml", "product_code":"eip", "code":"28", - "des":"This API is used to create a tag for an EIP.POST /v2.0/{project_id}/publicips/{publicip_id}/tagsTable 1 describes the parameters.Request parameterRequest parameterParamet", + "des":"This API is used to add a tag to an EIP.POST /v2.0/{project_id}/publicips/{publicip_id}/tagsTable 1 describes the parameters.Request parameterRequest parameterParameterTy", "doc_type":"api", - "kw":"Creating a Tag for an EIP,EIP Tag Management,API Reference", - "title":"Creating a Tag for an EIP", + "kw":"Adding a Tag to an EIP,EIP Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], + "title":"Adding a Tag to an EIP", "githuburl":"" }, { "uri":"eip_apitag_0002.html", + "node_id":"eip_apitag_0002.xml", "product_code":"eip", "code":"29", "des":"This API is used to query tags of a specified EIP.GET /v2.0/{project_id}/publicips/{publicip_id}/tagsTable 1 describes the parameters.Request parameterNoneNoneExample req", "doc_type":"api", "kw":"Querying EIP Tags,EIP Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying EIP Tags", "githuburl":"" }, { "uri":"eip_apitag_0003.html", + "node_id":"eip_apitag_0003.xml", "product_code":"eip", "code":"30", - "des":"This API is used to delete an EIP tag.DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}Table 1 describes the parameters.Request parameterNoneNoneExample reques", + "des":"This API is used to delete a tag from an EIP.DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}Table 1 describes the parameters.Request parameterNoneNoneExample", "doc_type":"api", - "kw":"Deleting an EIP Tag,EIP Tag Management,API Reference", - "title":"Deleting an EIP Tag", + "kw":"Deleting a Tag from an EIP,EIP Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], + "title":"Deleting a Tag from an EIP", "githuburl":"" }, { "uri":"eip_apitag_0004.html", + "node_id":"eip_apitag_0004.xml", "product_code":"eip", "code":"31", "des":"This API is used to add multiple tags to or delete multiple tags from an EIP at a time.This API is idempotent.If there are duplicate keys in the request body when you add", "doc_type":"api", - "kw":"Batch Creating or Deleting EIP Tags,EIP Tag Management,API Reference", - "title":"Batch Creating or Deleting EIP Tags", + "kw":"Batch Adding or Deleting EIP Tags,EIP Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], + "title":"Batch Adding or Deleting EIP Tags", "githuburl":"" }, { "uri":"eip_apitag_0005.html", + "node_id":"eip_apitag_0005.xml", "product_code":"eip", "code":"32", "des":"This API is used to query EIPs by tag.POST /v2.0/{project_id}/publicips/resource_instances/actionTable 1 describes the parameters.Request parameterRequest parameterParame", "doc_type":"api", "kw":"Querying EIPs by Tag,EIP Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying EIPs by Tag", "githuburl":"" }, { "uri":"eip_apitag_0006.html", + "node_id":"eip_apitag_0006.xml", "product_code":"eip", "code":"33", "des":"This API is used to query all EIP tags of a tenant in a specified region.GET /v2.0/{project_id}/publicips/tagsTable 1 describes the parameters.Request parameterNoneNoneEx", "doc_type":"api", "kw":"Querying EIP Tags in a Specified Project,EIP Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying EIP Tags in a Specified Project", "githuburl":"" }, { "uri":"eip_apiv3_0000.html", + "node_id":"eip_apiv3_0000.xml", "product_code":"eip", "code":"34", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"API V3", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"API V3", "githuburl":"" }, { "uri":"eip_apiv3_0100.html", + "node_id":"eip_apiv3_0100.xml", "product_code":"eip", "code":"35", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"EIPs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false" + } + ], "title":"EIPs", "githuburl":"" }, { "uri":"ListPublicipsV3.html", + "node_id":"listpublicipsv3.xml", "product_code":"eip", "code":"36", - "des":"This API is used to query all EIPs. (This API is not supported in eu-nl.)GET /v3/{project_id}/eip/publicipsNoneStatus code: 200NoneStatus code: 200Normal response to the ", + "des":"This API is used to query all EIPs.GET /v3/{project_id}/eip/publicipsNoneStatus code: 200NoneStatus code: 200Normal response to the GET operation{\n \"page_info\" : {\n \"", "doc_type":"api", "kw":"Querying All EIPs,EIPs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false" + } + ], "title":"Querying All EIPs", "githuburl":"" }, { "uri":"ShowPublicipV3.html", + "node_id":"showpublicipv3.xml", "product_code":"eip", "code":"37", "des":"This API is used to query EIP details. (This API is not supported in eu-nl.)GET /v3/{project_id}/eip/publicips/{publicip_id}NoneStatus code: 200NoneStatus code: 200Normal", "doc_type":"api", "kw":"Querying EIP Details,EIPs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false" + } + ], "title":"Querying EIP Details", "githuburl":"" }, { - "uri":"DisassociatePublicips.html", + "uri":"CreatePublicIpV3.html", + "node_id":"createpublicipv3.xml", "product_code":"eip", "code":"38", + "des":"Assign an EIP.POST /v3/{project_id}/eip/publicipsStatus code: 201Assign an IPv4 EIP with dedicated bandwidth.Status code: 201Normal creationSee Error Codes.", + "doc_type":"api", + "kw":"Assigning an EIP,EIPs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"true", + "operation_id":"CreatePublicIpV3;DeletePublicIp", + "version":"v3" + } + ], + "title":"Assigning an EIP", + "githuburl":"" + }, + { + "uri":"DeletePublicIp.html", + "node_id":"deletepublicip.xml", + "product_code":"eip", + "code":"39", + "des":"Release an EIP.DELETE /v3/{project_id}/eip/publicips/{publicip_id}NoneStatus code: 204Normal response to DELETE operationsNoneNoneNoneSee Error Codes.", + "doc_type":"api", + "kw":"Releasing an EIP,EIPs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"true", + "operation_id":"CreatePublicIpV3;DeletePublicIp", + "version":"v3" + } + ], + "title":"Releasing an EIP", + "githuburl":"" + }, + { + "uri":"DisassociatePublicips.html", + "node_id":"disassociatepublicips.xml", + "product_code":"eip", + "code":"40", "des":"This API is used to unbind an EIP. (This API is not supported in eu-nl.)POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instanceNoneStatus code: 200NoneSta", "doc_type":"api", "kw":"Unbinding an EIP,EIPs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false" + } + ], "title":"Unbinding an EIP", "githuburl":"" }, { "uri":"AssociatePublicips.html", + "node_id":"associatepublicips.xml", "product_code":"eip", - "code":"39", + "code":"41", "des":"This API is used to bind an EIP. (This API is not supported in eu-nl.)POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instanceStatus code: 200Status code: 200", "doc_type":"api", "kw":"Binding an EIP,EIPs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false" + } + ], "title":"Binding an EIP", "githuburl":"" }, { "uri":"eip_apiv3_0300.html", + "node_id":"eip_apiv3_0300.xml", "product_code":"eip", - "code":"40", + "code":"42", "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 Pools", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false" + } + ], "title":"Common Pools", "githuburl":"" }, { "uri":"ListCommonPools.html", + "node_id":"listcommonpools.xml", "product_code":"eip", - "code":"41", + "code":"43", "des":"This API is used to query common pools. (This API is not supported in eu-nl.)GET /v3/{project_id}/eip/publicip-pools/common-poolsNoneStatus code: 200NoneStatus code: 200N", "doc_type":"api", "kw":"Querying Common Pools,Common Pools,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false" + } + ], "title":"Querying Common Pools", "githuburl":"" }, { "uri":"eip_openstackapi_0000.html", + "node_id":"eip_openstackapi_0000.xml", "product_code":"eip", - "code":"42", + "code":"44", "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":"Native OpenStack Neutron APIs V2.0", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Native OpenStack Neutron APIs V2.0", "githuburl":"" }, { "uri":"eip_openstackapi_0001.html", + "node_id":"eip_openstackapi_0001.xml", "product_code":"eip", - "code":"43", + "code":"45", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"API Version Information", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"API Version Information", "githuburl":"" }, { "uri":"eip_openstackapi_0002.html", + "node_id":"eip_openstackapi_0002.xml", "product_code":"eip", - "code":"44", + "code":"46", "des":"This API is used to query all available versions of a native OpenStack API.GET /NoneSee Status Codes.See Error Codes.", "doc_type":"api", "kw":"Querying API Versions,API Version Information,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying API Versions", "githuburl":"" }, { "uri":"eip_openstackapi_0003.html", + "node_id":"eip_openstackapi_0003.xml", "product_code":"eip", - "code":"45", + "code":"47", "des":"This API is used to query the version of a specified API.GET /{api_version}Table 1 describes the parameters.NoneSee Status Codes.See Error Codes.", "doc_type":"api", "kw":"Querying a Specified API Version,API Version Information,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying a Specified API Version", "githuburl":"" }, { "uri":"eip_openstackapi_0004.html", + "node_id":"eip_openstackapi_0004.xml", "product_code":"eip", - "code":"46", - "des":"Neutron APIs v2.0 provides the pagination function. You can set parameters limit and marker in the URL to enable the desired number of items to be returned. All returned ", + "code":"48", + "des":"Neutron APIs v2.0 provides the pagination function. You can set parameters limit and marker in the URL of the list request to enable the desired number of items to be ret", "doc_type":"api", "kw":"Pagination,API Version Information,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Pagination", "githuburl":"" }, { "uri":"eip_openstackapi_0005.html", + "node_id":"eip_openstackapi_0005.xml", "product_code":"eip", - "code":"47", + "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":"Floating IP Address", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Floating IP Address", "githuburl":"" }, { "uri":"eip_openstackapi_0006.html", + "node_id":"eip_openstackapi_0006.xml", "product_code":"eip", - "code":"48", + "code":"50", "des":"This API is used to query all floating IP addresses accessible to the tenant submitting the request.You can query the detailed information about a specified floating IP a", "doc_type":"api", "kw":"Querying Floating IP Addresses,Floating IP Address,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying Floating IP Addresses", "githuburl":"" }, { "uri":"eip_openstackapi_0007.html", + "node_id":"eip_openstackapi_0007.xml", "product_code":"eip", - "code":"49", + "code":"51", "des":"This API is used to query details about a specified floating IP address, including the floating IP address status, ID of the router to which the floating IP address belon", "doc_type":"api", "kw":"Querying a Floating IP Address,Floating IP Address,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Querying a Floating IP Address", "githuburl":"" }, { "uri":"eip_openstackapi_0008.html", + "node_id":"eip_openstackapi_0008.xml", "product_code":"eip", - "code":"50", + "code":"52", "des":"When assigning a floating IP address, you need to obtain the external network ID floating_network_id of the floating IP address.You can use GET /v2.0/networks?router:exte", "doc_type":"api", "kw":"Assigning a Floating IP Address,Floating IP Address,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Assigning a Floating IP Address", "githuburl":"" }, { "uri":"eip_openstackapi_0009.html", + "node_id":"eip_openstackapi_0009.xml", "product_code":"eip", - "code":"51", + "code":"53", "des":"This API is used to update a floating IP address.During the update, the ID of the floating IP address must be provided in the URL.If port_id is left blank, the floating I", "doc_type":"api", "kw":"Updating a Floating IP Address,Floating IP Address,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Updating a Floating IP Address", "githuburl":"" }, { "uri":"eip_openstackapi_0010.html", + "node_id":"eip_openstackapi_0010.xml", "product_code":"eip", - "code":"52", + "code":"54", "des":"This API is used to delete a floating IP address.Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:In eu-de, EIPs of the Dedicated Load Ba", "doc_type":"api", "kw":"Deleting a Floating IP Address,Floating IP Address,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Deleting a Floating IP Address", "githuburl":"" }, { "uri":"eip_apieg_0000.html", + "node_id":"eip_apieg_0000.xml", "product_code":"eip", - "code":"53", + "code":"55", "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":"Application Examples", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Application Examples", "githuburl":"" }, { "uri":"eip_apieg_0002.html", + "node_id":"eip_apieg_0002.xml", "product_code":"eip", - "code":"54", - "des":"This section describes how to bind an EIP to an ECS by calling APIs.You have created an ECS. For details, see section \"Purchasing an ECS with Customized Configurations\" i", + "code":"56", + "des":"This section describes how to bind an EIP to an ECS by calling APIs.You have created an ECS. For details, see section \"Creating an ECS in Custom Config Mode\" in the Elast", "doc_type":"api", "kw":"Binding an EIP to an ECS,Application Examples,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Binding an EIP to an ECS", "githuburl":"" }, { "uri":"eip_apieg_0003.html", + "node_id":"eip_apieg_0003.xml", "product_code":"eip", - "code":"55", - "des":"This section describes how to unbind an EIP from an ECS by calling APIs.You have created an ECS. For details, see section \"Purchasing an ECS with Customized Configuration", + "code":"57", + "des":"This section describes how to unbind an EIP from an ECS by calling APIs.You have created an ECS. For details, see section \"Creating an ECS in Custom Config Mode\" in the E", "doc_type":"api", "kw":"Unbinding an EIP from an ECS,Application Examples,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Unbinding an EIP from an ECS", "githuburl":"" }, { "uri":"eip_apieg_0001.html", + "node_id":"eip_apieg_0001.xml", "product_code":"eip", - "code":"56", + "code":"58", "des":"This section describes how to assign an EIP with a specific shared bandwidth by calling APIs.If you use a token for authentication, you must obtain the token and add X-Au", "doc_type":"api", "kw":"Assigning an EIP with a Specific Shared Bandwidth,Application Examples,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Assigning an EIP with a Specific Shared Bandwidth", "githuburl":"" }, { "uri":"eip_apipermission_0000.html", + "node_id":"eip_apipermission_0000.xml", "product_code":"eip", - "code":"57", + "code":"59", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Permissions Policies and Supported Actions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false;true", + "operation_id":"ShowResourcesJobDetail;ChangePublicipToPeriod;CreatePublicip;ShowPublicip;ListPublicips;UpdatePublicip;DeletePublicip;CreatePrePaidPublicip;BatchCreatePublicips;BatchDeletePublicIp;BatchDisassociatePublicips;ShowBandwidth;ListBandwidths;UpdateBandwidth;BatchModifyBandwidth;ChangeBandwidthToPeriod;CreateSharedBandwidth;BatchCreateSharedBandwidths;DeleteSharedBandwidth;AddPublicipsIntoSharedBandwidth;UpdatePrePaidBandwidth;RemovePublicipsFromSharedBandwidth;ListBandwidthPkg;ListQuotas;CreatePublicipTag;ShowPublicipTags;DeletePublicipTag;BatchCreatePublicipTags;ListPublicipsByTags;ListPublicipTags;ListIPv6Floatingip;GetIPv6Floatingip;CreateIPv6Floatingip;UpdateIPv6Floatingip;DeleteIPv6Floatingip;CountPublicIpInstance;ShowPublicIpType;CountPublicIp;AttachShareBandwidth;AttachBatchPublicIp;DetachShareBandwidth;DetachBatchPublicIp;EnableNat64;DisableNat64;ListPublicipsV3;ShowPublicipV3;UpdatePublicips;DisassociatePublicips;AssociatePublicips;CountEipAvailableResources;ListShareBandwidthTypes;ListEipBandwidths;ListBandwidthsV3;ListBandwidthsLimit;ListCommonPools;ListPublicipPool;ShowPublicipPool;ListTenantVpcIgws;CreateTenantVpcIgw;DeleteTenantVpcIgw;ShowInternalVpcIgw;UpdateTenantVpcIgw;ListProjectGeipBindings;CreateGlobalEip;UpdateGlobalEip;ListGlobalEips;ShowGlobalEip;BatchCreateGlobalEip;DeleteGlobalEip;AttachInternetBandwidth;DetachInternetBandwidth;BatchAttachInternetBandwidth;BatchDetachInternetBandwidth;AssociateInstance;DisassociateInstance;CountGlobalEips;CreateInternetBandwidth;UpdateInternetBandwidth;ListInternetBandwidths;ShowInternetBandwidth;BatchCreateInternetBandwidth;DeleteInternetBandwidth;CountInternetBandwidth;ShowGlobalEipTags;AddGlobalEipTags;ListGlobalEipFilterTags;DeleteGlobalEipTag;ListGlobalEipCountFilterTags;ListGlobalEipDomainTags;BatchDeleteGlobalEipTags;BatchCreateGlobalEipTags;ShowInternetBandwidthTags;AddInternetBandwidthTags;ListInternetBandwidthFilterTags;DeleteInternetBandwidthTag;ListInternetBandwidthCountFilterTags;ListInternetBandwidthDomainTags;BatchDeleteInternetBandwidthTags;BatchCreateInternetBandwidthTags;CreateGlobalEipSegment;UpdateGlobalEipSegment;ListGlobalEipSegments;ShowGlobalEipSegment;DeleteGlobalEipSegment;BatchAttachGeipSegmentInternetBandwidth;BatchDetachGeipSegmentInternetBandwidth;AssociateGeipSegmentInstance;DisassociateGeipSegmentInstance;CountGlobalEipSegment;ShowGeipSegmentTags;AddGeipSegmentTags;ListGeipSegmentFilterTags;DeleteGeipSegmentTag;ListGeipSegmentCountFilterTags;ListGeipSegmentDomainTags;BatchDeleteGeipSegmentTags;BatchCreateGeipSegmentTags;ListGeipPools;ListGeipResourceQuotas;ListJobs;ShowJobs;ListInternetBandwidthLimits;ListSupportRegions;ListTenantGeipSupportInstances;ListSupportMasks;ListAccessSites;ShowUserDisclaimer;CreateUserDisclaimer;DeleteUserDisclaimer;AddSourcesToTrafficMirrorSession;BatchCreateTrafficMirrorFilterRules;CreateTrafficMirrorFilter;CreateTrafficMirrorFilterRule;CreateTrafficMirrorSession;DeleteTrafficMirrorFilter;DeleteTrafficMirrorFilterRule;DeleteTrafficMirrorSession;ListTrafficMirrorFilterRules;ListTrafficMirrorFilters;ListTrafficMirrorSessions;RemoveSourcesFromTrafficMirrorSession;ShowTrafficMirrorFilter;ShowTrafficMirrorFilterRule;ShowTrafficMirrorSessions;UpdateTrafficMirrorFilter;UpdateTrafficMirrorFilterRule;UpdateTrafficMirrorSessions;ListSecurityGroupsByTags;BatchCreateSecurityGroupTags;BatchDeleteSecurityGroupTags;ShowSecurityGroupTags;CreateSecurityGroupTag;DeleteSecurityGroupTag;ListSecurityGroupTags;NeutronListFloatingIps;NeutronShowFloatingIp;NeutronCreateFloatingIp;NeutronUpdateFloatingIp;NeutronDeleteFloatingIp", + "version":"v2;v3", + "IsMulti":"No", + "IsBot":"Yes" + } + ], "title":"Permissions Policies and Supported Actions", "githuburl":"" }, { "uri":"eip_apipermission_0002.html", + "node_id":"eip_apipermission_0002.xml", "product_code":"eip", - "code":"58", + "code":"60", "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":"EIP,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false;true", + "operation_id":"ShowResourcesJobDetail;ChangePublicipToPeriod;CreatePublicip;ShowPublicip;ListPublicips;UpdatePublicip;DeletePublicip;CreatePrePaidPublicip;BatchCreatePublicips;BatchDeletePublicIp;BatchDisassociatePublicips;ShowBandwidth;ListBandwidths;UpdateBandwidth;BatchModifyBandwidth;ChangeBandwidthToPeriod;CreateSharedBandwidth;BatchCreateSharedBandwidths;DeleteSharedBandwidth;AddPublicipsIntoSharedBandwidth;UpdatePrePaidBandwidth;RemovePublicipsFromSharedBandwidth;ListBandwidthPkg;ListQuotas;CreatePublicipTag;ShowPublicipTags;DeletePublicipTag;BatchCreatePublicipTags;ListPublicipsByTags;ListPublicipTags;ListIPv6Floatingip;GetIPv6Floatingip;CreateIPv6Floatingip;UpdateIPv6Floatingip;DeleteIPv6Floatingip;CountPublicIpInstance;ShowPublicIpType;CountPublicIp;AttachShareBandwidth;AttachBatchPublicIp;DetachShareBandwidth;DetachBatchPublicIp;EnableNat64;DisableNat64;ListPublicipsV3;ShowPublicipV3;UpdatePublicips;DisassociatePublicips;AssociatePublicips;CountEipAvailableResources;ListShareBandwidthTypes;ListEipBandwidths;ListBandwidthsV3;ListBandwidthsLimit;ListCommonPools;ListPublicipPool;ShowPublicipPool;ListTenantVpcIgws;CreateTenantVpcIgw;DeleteTenantVpcIgw;ShowInternalVpcIgw;UpdateTenantVpcIgw;ListProjectGeipBindings;CreateGlobalEip;UpdateGlobalEip;ListGlobalEips;ShowGlobalEip;BatchCreateGlobalEip;DeleteGlobalEip;AttachInternetBandwidth;DetachInternetBandwidth;BatchAttachInternetBandwidth;BatchDetachInternetBandwidth;AssociateInstance;DisassociateInstance;CountGlobalEips;CreateInternetBandwidth;UpdateInternetBandwidth;ListInternetBandwidths;ShowInternetBandwidth;BatchCreateInternetBandwidth;DeleteInternetBandwidth;CountInternetBandwidth;ShowGlobalEipTags;AddGlobalEipTags;ListGlobalEipFilterTags;DeleteGlobalEipTag;ListGlobalEipCountFilterTags;ListGlobalEipDomainTags;BatchDeleteGlobalEipTags;BatchCreateGlobalEipTags;ShowInternetBandwidthTags;AddInternetBandwidthTags;ListInternetBandwidthFilterTags;DeleteInternetBandwidthTag;ListInternetBandwidthCountFilterTags;ListInternetBandwidthDomainTags;BatchDeleteInternetBandwidthTags;BatchCreateInternetBandwidthTags;CreateGlobalEipSegment;UpdateGlobalEipSegment;ListGlobalEipSegments;ShowGlobalEipSegment;DeleteGlobalEipSegment;BatchAttachGeipSegmentInternetBandwidth;BatchDetachGeipSegmentInternetBandwidth;AssociateGeipSegmentInstance;DisassociateGeipSegmentInstance;CountGlobalEipSegment;ShowGeipSegmentTags;AddGeipSegmentTags;ListGeipSegmentFilterTags;DeleteGeipSegmentTag;ListGeipSegmentCountFilterTags;ListGeipSegmentDomainTags;BatchDeleteGeipSegmentTags;BatchCreateGeipSegmentTags;ListGeipPools;ListGeipResourceQuotas;ListJobs;ShowJobs;ListInternetBandwidthLimits;ListSupportRegions;ListTenantGeipSupportInstances;ListSupportMasks;ListAccessSites;ShowUserDisclaimer;CreateUserDisclaimer;DeleteUserDisclaimer;AddSourcesToTrafficMirrorSession;BatchCreateTrafficMirrorFilterRules;CreateTrafficMirrorFilter;CreateTrafficMirrorFilterRule;CreateTrafficMirrorSession;DeleteTrafficMirrorFilter;DeleteTrafficMirrorFilterRule;DeleteTrafficMirrorSession;ListTrafficMirrorFilterRules;ListTrafficMirrorFilters;ListTrafficMirrorSessions;RemoveSourcesFromTrafficMirrorSession;ShowTrafficMirrorFilter;ShowTrafficMirrorFilterRule;ShowTrafficMirrorSessions;UpdateTrafficMirrorFilter;UpdateTrafficMirrorFilterRule;UpdateTrafficMirrorSessions;ListSecurityGroupsByTags;BatchCreateSecurityGroupTags;BatchDeleteSecurityGroupTags;ShowSecurityGroupTags;CreateSecurityGroupTag;DeleteSecurityGroupTag;ListSecurityGroupTags;NeutronListFloatingIps;NeutronShowFloatingIp;NeutronCreateFloatingIp;NeutronUpdateFloatingIp;NeutronDeleteFloatingIp", + "version":"v2;v3", + "IsMulti":"No", + "IsBot":"Yes" + } + ], "title":"EIP", "githuburl":"" }, { "uri":"eip_apipermission_0003.html", + "node_id":"eip_apipermission_0003.xml", "product_code":"eip", - "code":"59", + "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":"Bandwidth,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false;true", + "operation_id":"ShowResourcesJobDetail;ChangePublicipToPeriod;CreatePublicip;ShowPublicip;ListPublicips;UpdatePublicip;DeletePublicip;CreatePrePaidPublicip;BatchCreatePublicips;BatchDeletePublicIp;BatchDisassociatePublicips;ShowBandwidth;ListBandwidths;UpdateBandwidth;BatchModifyBandwidth;ChangeBandwidthToPeriod;CreateSharedBandwidth;BatchCreateSharedBandwidths;DeleteSharedBandwidth;AddPublicipsIntoSharedBandwidth;UpdatePrePaidBandwidth;RemovePublicipsFromSharedBandwidth;ListBandwidthPkg;ListQuotas;CreatePublicipTag;ShowPublicipTags;DeletePublicipTag;BatchCreatePublicipTags;ListPublicipsByTags;ListPublicipTags;ListIPv6Floatingip;GetIPv6Floatingip;CreateIPv6Floatingip;UpdateIPv6Floatingip;DeleteIPv6Floatingip;CountPublicIpInstance;ShowPublicIpType;CountPublicIp;AttachShareBandwidth;AttachBatchPublicIp;DetachShareBandwidth;DetachBatchPublicIp;EnableNat64;DisableNat64;ListPublicipsV3;ShowPublicipV3;UpdatePublicips;DisassociatePublicips;AssociatePublicips;CountEipAvailableResources;ListShareBandwidthTypes;ListEipBandwidths;ListBandwidthsV3;ListBandwidthsLimit;ListCommonPools;ListPublicipPool;ShowPublicipPool;ListTenantVpcIgws;CreateTenantVpcIgw;DeleteTenantVpcIgw;ShowInternalVpcIgw;UpdateTenantVpcIgw;ListProjectGeipBindings;CreateGlobalEip;UpdateGlobalEip;ListGlobalEips;ShowGlobalEip;BatchCreateGlobalEip;DeleteGlobalEip;AttachInternetBandwidth;DetachInternetBandwidth;BatchAttachInternetBandwidth;BatchDetachInternetBandwidth;AssociateInstance;DisassociateInstance;CountGlobalEips;CreateInternetBandwidth;UpdateInternetBandwidth;ListInternetBandwidths;ShowInternetBandwidth;BatchCreateInternetBandwidth;DeleteInternetBandwidth;CountInternetBandwidth;ShowGlobalEipTags;AddGlobalEipTags;ListGlobalEipFilterTags;DeleteGlobalEipTag;ListGlobalEipCountFilterTags;ListGlobalEipDomainTags;BatchDeleteGlobalEipTags;BatchCreateGlobalEipTags;ShowInternetBandwidthTags;AddInternetBandwidthTags;ListInternetBandwidthFilterTags;DeleteInternetBandwidthTag;ListInternetBandwidthCountFilterTags;ListInternetBandwidthDomainTags;BatchDeleteInternetBandwidthTags;BatchCreateInternetBandwidthTags;CreateGlobalEipSegment;UpdateGlobalEipSegment;ListGlobalEipSegments;ShowGlobalEipSegment;DeleteGlobalEipSegment;BatchAttachGeipSegmentInternetBandwidth;BatchDetachGeipSegmentInternetBandwidth;AssociateGeipSegmentInstance;DisassociateGeipSegmentInstance;CountGlobalEipSegment;ShowGeipSegmentTags;AddGeipSegmentTags;ListGeipSegmentFilterTags;DeleteGeipSegmentTag;ListGeipSegmentCountFilterTags;ListGeipSegmentDomainTags;BatchDeleteGeipSegmentTags;BatchCreateGeipSegmentTags;ListGeipPools;ListGeipResourceQuotas;ListJobs;ShowJobs;ListInternetBandwidthLimits;ListSupportRegions;ListTenantGeipSupportInstances;ListSupportMasks;ListAccessSites;ShowUserDisclaimer;CreateUserDisclaimer;DeleteUserDisclaimer;AddSourcesToTrafficMirrorSession;BatchCreateTrafficMirrorFilterRules;CreateTrafficMirrorFilter;CreateTrafficMirrorFilterRule;CreateTrafficMirrorSession;DeleteTrafficMirrorFilter;DeleteTrafficMirrorFilterRule;DeleteTrafficMirrorSession;ListTrafficMirrorFilterRules;ListTrafficMirrorFilters;ListTrafficMirrorSessions;RemoveSourcesFromTrafficMirrorSession;ShowTrafficMirrorFilter;ShowTrafficMirrorFilterRule;ShowTrafficMirrorSessions;UpdateTrafficMirrorFilter;UpdateTrafficMirrorFilterRule;UpdateTrafficMirrorSessions;ListSecurityGroupsByTags;BatchCreateSecurityGroupTags;BatchDeleteSecurityGroupTags;ShowSecurityGroupTags;CreateSecurityGroupTag;DeleteSecurityGroupTag;ListSecurityGroupTags;NeutronListFloatingIps;NeutronShowFloatingIp;NeutronCreateFloatingIp;NeutronUpdateFloatingIp;NeutronDeleteFloatingIp", + "version":"v2;v3", + "IsMulti":"No", + "IsBot":"Yes" + } + ], "title":"Bandwidth", "githuburl":"" }, { "uri":"eip_apipermission_0004.html", + "node_id":"eip_apipermission_0004.xml", "product_code":"eip", - "code":"60", + "code":"62", "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":"Bandwidth (V2.0),Permissions Policies and Supported Actions,API Reference", - "title":"Bandwidth (V2.0)", + "kw":"Bandwidth (V2),Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false;true", + "operation_id":"ShowResourcesJobDetail;ChangePublicipToPeriod;CreatePublicip;ShowPublicip;ListPublicips;UpdatePublicip;DeletePublicip;CreatePrePaidPublicip;BatchCreatePublicips;BatchDeletePublicIp;BatchDisassociatePublicips;ShowBandwidth;ListBandwidths;UpdateBandwidth;BatchModifyBandwidth;ChangeBandwidthToPeriod;CreateSharedBandwidth;BatchCreateSharedBandwidths;DeleteSharedBandwidth;AddPublicipsIntoSharedBandwidth;UpdatePrePaidBandwidth;RemovePublicipsFromSharedBandwidth;ListBandwidthPkg;ListQuotas;CreatePublicipTag;ShowPublicipTags;DeletePublicipTag;BatchCreatePublicipTags;ListPublicipsByTags;ListPublicipTags;ListIPv6Floatingip;GetIPv6Floatingip;CreateIPv6Floatingip;UpdateIPv6Floatingip;DeleteIPv6Floatingip;CountPublicIpInstance;ShowPublicIpType;CountPublicIp;AttachShareBandwidth;AttachBatchPublicIp;DetachShareBandwidth;DetachBatchPublicIp;EnableNat64;DisableNat64;ListPublicipsV3;ShowPublicipV3;UpdatePublicips;DisassociatePublicips;AssociatePublicips;CountEipAvailableResources;ListShareBandwidthTypes;ListEipBandwidths;ListBandwidthsV3;ListBandwidthsLimit;ListCommonPools;ListPublicipPool;ShowPublicipPool;ListTenantVpcIgws;CreateTenantVpcIgw;DeleteTenantVpcIgw;ShowInternalVpcIgw;UpdateTenantVpcIgw;ListProjectGeipBindings;CreateGlobalEip;UpdateGlobalEip;ListGlobalEips;ShowGlobalEip;BatchCreateGlobalEip;DeleteGlobalEip;AttachInternetBandwidth;DetachInternetBandwidth;BatchAttachInternetBandwidth;BatchDetachInternetBandwidth;AssociateInstance;DisassociateInstance;CountGlobalEips;CreateInternetBandwidth;UpdateInternetBandwidth;ListInternetBandwidths;ShowInternetBandwidth;BatchCreateInternetBandwidth;DeleteInternetBandwidth;CountInternetBandwidth;ShowGlobalEipTags;AddGlobalEipTags;ListGlobalEipFilterTags;DeleteGlobalEipTag;ListGlobalEipCountFilterTags;ListGlobalEipDomainTags;BatchDeleteGlobalEipTags;BatchCreateGlobalEipTags;ShowInternetBandwidthTags;AddInternetBandwidthTags;ListInternetBandwidthFilterTags;DeleteInternetBandwidthTag;ListInternetBandwidthCountFilterTags;ListInternetBandwidthDomainTags;BatchDeleteInternetBandwidthTags;BatchCreateInternetBandwidthTags;CreateGlobalEipSegment;UpdateGlobalEipSegment;ListGlobalEipSegments;ShowGlobalEipSegment;DeleteGlobalEipSegment;BatchAttachGeipSegmentInternetBandwidth;BatchDetachGeipSegmentInternetBandwidth;AssociateGeipSegmentInstance;DisassociateGeipSegmentInstance;CountGlobalEipSegment;ShowGeipSegmentTags;AddGeipSegmentTags;ListGeipSegmentFilterTags;DeleteGeipSegmentTag;ListGeipSegmentCountFilterTags;ListGeipSegmentDomainTags;BatchDeleteGeipSegmentTags;BatchCreateGeipSegmentTags;ListGeipPools;ListGeipResourceQuotas;ListJobs;ShowJobs;ListInternetBandwidthLimits;ListSupportRegions;ListTenantGeipSupportInstances;ListSupportMasks;ListAccessSites;ShowUserDisclaimer;CreateUserDisclaimer;DeleteUserDisclaimer;AddSourcesToTrafficMirrorSession;BatchCreateTrafficMirrorFilterRules;CreateTrafficMirrorFilter;CreateTrafficMirrorFilterRule;CreateTrafficMirrorSession;DeleteTrafficMirrorFilter;DeleteTrafficMirrorFilterRule;DeleteTrafficMirrorSession;ListTrafficMirrorFilterRules;ListTrafficMirrorFilters;ListTrafficMirrorSessions;RemoveSourcesFromTrafficMirrorSession;ShowTrafficMirrorFilter;ShowTrafficMirrorFilterRule;ShowTrafficMirrorSessions;UpdateTrafficMirrorFilter;UpdateTrafficMirrorFilterRule;UpdateTrafficMirrorSessions;ListSecurityGroupsByTags;BatchCreateSecurityGroupTags;BatchDeleteSecurityGroupTags;ShowSecurityGroupTags;CreateSecurityGroupTag;DeleteSecurityGroupTag;ListSecurityGroupTags;NeutronListFloatingIps;NeutronShowFloatingIp;NeutronCreateFloatingIp;NeutronUpdateFloatingIp;NeutronDeleteFloatingIp", + "version":"v2;v3", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Bandwidth (V2)", + "githuburl":"" + }, + { + "uri":"eip_apipermission_0011.html", + "node_id":"eip_apipermission_0011.xml", + "product_code":"eip", + "code":"63", + "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":"EIP V3,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false;true", + "operation_id":"ShowResourcesJobDetail;ChangePublicipToPeriod;CreatePublicip;ShowPublicip;ListPublicips;UpdatePublicip;DeletePublicip;CreatePrePaidPublicip;BatchCreatePublicips;BatchDeletePublicIp;BatchDisassociatePublicips;ShowBandwidth;ListBandwidths;UpdateBandwidth;BatchModifyBandwidth;ChangeBandwidthToPeriod;CreateSharedBandwidth;BatchCreateSharedBandwidths;DeleteSharedBandwidth;AddPublicipsIntoSharedBandwidth;UpdatePrePaidBandwidth;RemovePublicipsFromSharedBandwidth;ListBandwidthPkg;ListQuotas;CreatePublicipTag;ShowPublicipTags;DeletePublicipTag;BatchCreatePublicipTags;ListPublicipsByTags;ListPublicipTags;ListIPv6Floatingip;GetIPv6Floatingip;CreateIPv6Floatingip;UpdateIPv6Floatingip;DeleteIPv6Floatingip;CountPublicIpInstance;ShowPublicIpType;CountPublicIp;AttachShareBandwidth;AttachBatchPublicIp;DetachShareBandwidth;DetachBatchPublicIp;EnableNat64;DisableNat64;ListPublicipsV3;ShowPublicipV3;UpdatePublicips;DisassociatePublicips;AssociatePublicips;CountEipAvailableResources;ListShareBandwidthTypes;ListEipBandwidths;ListBandwidthsV3;ListBandwidthsLimit;ListCommonPools;ListPublicipPool;ShowPublicipPool;ListTenantVpcIgws;CreateTenantVpcIgw;DeleteTenantVpcIgw;ShowInternalVpcIgw;UpdateTenantVpcIgw;ListProjectGeipBindings;CreateGlobalEip;UpdateGlobalEip;ListGlobalEips;ShowGlobalEip;BatchCreateGlobalEip;DeleteGlobalEip;AttachInternetBandwidth;DetachInternetBandwidth;BatchAttachInternetBandwidth;BatchDetachInternetBandwidth;AssociateInstance;DisassociateInstance;CountGlobalEips;CreateInternetBandwidth;UpdateInternetBandwidth;ListInternetBandwidths;ShowInternetBandwidth;BatchCreateInternetBandwidth;DeleteInternetBandwidth;CountInternetBandwidth;ShowGlobalEipTags;AddGlobalEipTags;ListGlobalEipFilterTags;DeleteGlobalEipTag;ListGlobalEipCountFilterTags;ListGlobalEipDomainTags;BatchDeleteGlobalEipTags;BatchCreateGlobalEipTags;ShowInternetBandwidthTags;AddInternetBandwidthTags;ListInternetBandwidthFilterTags;DeleteInternetBandwidthTag;ListInternetBandwidthCountFilterTags;ListInternetBandwidthDomainTags;BatchDeleteInternetBandwidthTags;BatchCreateInternetBandwidthTags;CreateGlobalEipSegment;UpdateGlobalEipSegment;ListGlobalEipSegments;ShowGlobalEipSegment;DeleteGlobalEipSegment;BatchAttachGeipSegmentInternetBandwidth;BatchDetachGeipSegmentInternetBandwidth;AssociateGeipSegmentInstance;DisassociateGeipSegmentInstance;CountGlobalEipSegment;ShowGeipSegmentTags;AddGeipSegmentTags;ListGeipSegmentFilterTags;DeleteGeipSegmentTag;ListGeipSegmentCountFilterTags;ListGeipSegmentDomainTags;BatchDeleteGeipSegmentTags;BatchCreateGeipSegmentTags;ListGeipPools;ListGeipResourceQuotas;ListJobs;ShowJobs;ListInternetBandwidthLimits;ListSupportRegions;ListTenantGeipSupportInstances;ListSupportMasks;ListAccessSites;ShowUserDisclaimer;CreateUserDisclaimer;DeleteUserDisclaimer;AddSourcesToTrafficMirrorSession;BatchCreateTrafficMirrorFilterRules;CreateTrafficMirrorFilter;CreateTrafficMirrorFilterRule;CreateTrafficMirrorSession;DeleteTrafficMirrorFilter;DeleteTrafficMirrorFilterRule;DeleteTrafficMirrorSession;ListTrafficMirrorFilterRules;ListTrafficMirrorFilters;ListTrafficMirrorSessions;RemoveSourcesFromTrafficMirrorSession;ShowTrafficMirrorFilter;ShowTrafficMirrorFilterRule;ShowTrafficMirrorSessions;UpdateTrafficMirrorFilter;UpdateTrafficMirrorFilterRule;UpdateTrafficMirrorSessions;ListSecurityGroupsByTags;BatchCreateSecurityGroupTags;BatchDeleteSecurityGroupTags;ShowSecurityGroupTags;CreateSecurityGroupTag;DeleteSecurityGroupTag;ListSecurityGroupTags;NeutronListFloatingIps;NeutronShowFloatingIp;NeutronCreateFloatingIp;NeutronUpdateFloatingIp;NeutronDeleteFloatingIp", + "version":"v2;v3", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"EIP V3", "githuburl":"" }, { "uri":"eip_apipermission_0006.html", + "node_id":"eip_apipermission_0006.xml", "product_code":"eip", - "code":"61", + "code":"64", "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":"Floating IP Address (OpenStack Neutron API),Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false;true", + "operation_id":"ShowResourcesJobDetail;ChangePublicipToPeriod;CreatePublicip;ShowPublicip;ListPublicips;UpdatePublicip;DeletePublicip;CreatePrePaidPublicip;BatchCreatePublicips;BatchDeletePublicIp;BatchDisassociatePublicips;ShowBandwidth;ListBandwidths;UpdateBandwidth;BatchModifyBandwidth;ChangeBandwidthToPeriod;CreateSharedBandwidth;BatchCreateSharedBandwidths;DeleteSharedBandwidth;AddPublicipsIntoSharedBandwidth;UpdatePrePaidBandwidth;RemovePublicipsFromSharedBandwidth;ListBandwidthPkg;ListQuotas;CreatePublicipTag;ShowPublicipTags;DeletePublicipTag;BatchCreatePublicipTags;ListPublicipsByTags;ListPublicipTags;ListIPv6Floatingip;GetIPv6Floatingip;CreateIPv6Floatingip;UpdateIPv6Floatingip;DeleteIPv6Floatingip;CountPublicIpInstance;ShowPublicIpType;CountPublicIp;AttachShareBandwidth;AttachBatchPublicIp;DetachShareBandwidth;DetachBatchPublicIp;EnableNat64;DisableNat64;ListPublicipsV3;ShowPublicipV3;UpdatePublicips;DisassociatePublicips;AssociatePublicips;CountEipAvailableResources;ListShareBandwidthTypes;ListEipBandwidths;ListBandwidthsV3;ListBandwidthsLimit;ListCommonPools;ListPublicipPool;ShowPublicipPool;ListTenantVpcIgws;CreateTenantVpcIgw;DeleteTenantVpcIgw;ShowInternalVpcIgw;UpdateTenantVpcIgw;ListProjectGeipBindings;CreateGlobalEip;UpdateGlobalEip;ListGlobalEips;ShowGlobalEip;BatchCreateGlobalEip;DeleteGlobalEip;AttachInternetBandwidth;DetachInternetBandwidth;BatchAttachInternetBandwidth;BatchDetachInternetBandwidth;AssociateInstance;DisassociateInstance;CountGlobalEips;CreateInternetBandwidth;UpdateInternetBandwidth;ListInternetBandwidths;ShowInternetBandwidth;BatchCreateInternetBandwidth;DeleteInternetBandwidth;CountInternetBandwidth;ShowGlobalEipTags;AddGlobalEipTags;ListGlobalEipFilterTags;DeleteGlobalEipTag;ListGlobalEipCountFilterTags;ListGlobalEipDomainTags;BatchDeleteGlobalEipTags;BatchCreateGlobalEipTags;ShowInternetBandwidthTags;AddInternetBandwidthTags;ListInternetBandwidthFilterTags;DeleteInternetBandwidthTag;ListInternetBandwidthCountFilterTags;ListInternetBandwidthDomainTags;BatchDeleteInternetBandwidthTags;BatchCreateInternetBandwidthTags;CreateGlobalEipSegment;UpdateGlobalEipSegment;ListGlobalEipSegments;ShowGlobalEipSegment;DeleteGlobalEipSegment;BatchAttachGeipSegmentInternetBandwidth;BatchDetachGeipSegmentInternetBandwidth;AssociateGeipSegmentInstance;DisassociateGeipSegmentInstance;CountGlobalEipSegment;ShowGeipSegmentTags;AddGeipSegmentTags;ListGeipSegmentFilterTags;DeleteGeipSegmentTag;ListGeipSegmentCountFilterTags;ListGeipSegmentDomainTags;BatchDeleteGeipSegmentTags;BatchCreateGeipSegmentTags;ListGeipPools;ListGeipResourceQuotas;ListJobs;ShowJobs;ListInternetBandwidthLimits;ListSupportRegions;ListTenantGeipSupportInstances;ListSupportMasks;ListAccessSites;ShowUserDisclaimer;CreateUserDisclaimer;DeleteUserDisclaimer;AddSourcesToTrafficMirrorSession;BatchCreateTrafficMirrorFilterRules;CreateTrafficMirrorFilter;CreateTrafficMirrorFilterRule;CreateTrafficMirrorSession;DeleteTrafficMirrorFilter;DeleteTrafficMirrorFilterRule;DeleteTrafficMirrorSession;ListTrafficMirrorFilterRules;ListTrafficMirrorFilters;ListTrafficMirrorSessions;RemoveSourcesFromTrafficMirrorSession;ShowTrafficMirrorFilter;ShowTrafficMirrorFilterRule;ShowTrafficMirrorSessions;UpdateTrafficMirrorFilter;UpdateTrafficMirrorFilterRule;UpdateTrafficMirrorSessions;ListSecurityGroupsByTags;BatchCreateSecurityGroupTags;BatchDeleteSecurityGroupTags;ShowSecurityGroupTags;CreateSecurityGroupTag;DeleteSecurityGroupTag;ListSecurityGroupTags;NeutronListFloatingIps;NeutronShowFloatingIp;NeutronCreateFloatingIp;NeutronUpdateFloatingIp;NeutronDeleteFloatingIp", + "version":"v2;v3", + "IsMulti":"No", + "IsBot":"Yes" + } + ], "title":"Floating IP Address (OpenStack Neutron API)", "githuburl":"" }, { "uri":"eip_apipermission_0007.html", + "node_id":"eip_apipermission_0007.xml", "product_code":"eip", - "code":"62", - "des":"If you have insufficient permissions, response code 200 will be returned when you query network resources and an empty list will be displayed.", + "code":"65", + "des":"Note:If you have insufficient permissions, response code 200 will be returned when you query network resources and an empty list will be displayed.You can apply for the p", "doc_type":"api", "kw":"Precautions for API Permissions,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip", + "opensource":"false;true", + "operation_id":"ShowResourcesJobDetail;ChangePublicipToPeriod;CreatePublicip;ShowPublicip;ListPublicips;UpdatePublicip;DeletePublicip;CreatePrePaidPublicip;BatchCreatePublicips;BatchDeletePublicIp;BatchDisassociatePublicips;ShowBandwidth;ListBandwidths;UpdateBandwidth;BatchModifyBandwidth;ChangeBandwidthToPeriod;CreateSharedBandwidth;BatchCreateSharedBandwidths;DeleteSharedBandwidth;AddPublicipsIntoSharedBandwidth;UpdatePrePaidBandwidth;RemovePublicipsFromSharedBandwidth;ListBandwidthPkg;ListQuotas;CreatePublicipTag;ShowPublicipTags;DeletePublicipTag;BatchCreatePublicipTags;ListPublicipsByTags;ListPublicipTags;ListIPv6Floatingip;GetIPv6Floatingip;CreateIPv6Floatingip;UpdateIPv6Floatingip;DeleteIPv6Floatingip;CountPublicIpInstance;ShowPublicIpType;CountPublicIp;AttachShareBandwidth;AttachBatchPublicIp;DetachShareBandwidth;DetachBatchPublicIp;EnableNat64;DisableNat64;ListPublicipsV3;ShowPublicipV3;UpdatePublicips;DisassociatePublicips;AssociatePublicips;CountEipAvailableResources;ListShareBandwidthTypes;ListEipBandwidths;ListBandwidthsV3;ListBandwidthsLimit;ListCommonPools;ListPublicipPool;ShowPublicipPool;ListTenantVpcIgws;CreateTenantVpcIgw;DeleteTenantVpcIgw;ShowInternalVpcIgw;UpdateTenantVpcIgw;ListProjectGeipBindings;CreateGlobalEip;UpdateGlobalEip;ListGlobalEips;ShowGlobalEip;BatchCreateGlobalEip;DeleteGlobalEip;AttachInternetBandwidth;DetachInternetBandwidth;BatchAttachInternetBandwidth;BatchDetachInternetBandwidth;AssociateInstance;DisassociateInstance;CountGlobalEips;CreateInternetBandwidth;UpdateInternetBandwidth;ListInternetBandwidths;ShowInternetBandwidth;BatchCreateInternetBandwidth;DeleteInternetBandwidth;CountInternetBandwidth;ShowGlobalEipTags;AddGlobalEipTags;ListGlobalEipFilterTags;DeleteGlobalEipTag;ListGlobalEipCountFilterTags;ListGlobalEipDomainTags;BatchDeleteGlobalEipTags;BatchCreateGlobalEipTags;ShowInternetBandwidthTags;AddInternetBandwidthTags;ListInternetBandwidthFilterTags;DeleteInternetBandwidthTag;ListInternetBandwidthCountFilterTags;ListInternetBandwidthDomainTags;BatchDeleteInternetBandwidthTags;BatchCreateInternetBandwidthTags;CreateGlobalEipSegment;UpdateGlobalEipSegment;ListGlobalEipSegments;ShowGlobalEipSegment;DeleteGlobalEipSegment;BatchAttachGeipSegmentInternetBandwidth;BatchDetachGeipSegmentInternetBandwidth;AssociateGeipSegmentInstance;DisassociateGeipSegmentInstance;CountGlobalEipSegment;ShowGeipSegmentTags;AddGeipSegmentTags;ListGeipSegmentFilterTags;DeleteGeipSegmentTag;ListGeipSegmentCountFilterTags;ListGeipSegmentDomainTags;BatchDeleteGeipSegmentTags;BatchCreateGeipSegmentTags;ListGeipPools;ListGeipResourceQuotas;ListJobs;ShowJobs;ListInternetBandwidthLimits;ListSupportRegions;ListTenantGeipSupportInstances;ListSupportMasks;ListAccessSites;ShowUserDisclaimer;CreateUserDisclaimer;DeleteUserDisclaimer;AddSourcesToTrafficMirrorSession;BatchCreateTrafficMirrorFilterRules;CreateTrafficMirrorFilter;CreateTrafficMirrorFilterRule;CreateTrafficMirrorSession;DeleteTrafficMirrorFilter;DeleteTrafficMirrorFilterRule;DeleteTrafficMirrorSession;ListTrafficMirrorFilterRules;ListTrafficMirrorFilters;ListTrafficMirrorSessions;RemoveSourcesFromTrafficMirrorSession;ShowTrafficMirrorFilter;ShowTrafficMirrorFilterRule;ShowTrafficMirrorSessions;UpdateTrafficMirrorFilter;UpdateTrafficMirrorFilterRule;UpdateTrafficMirrorSessions;ListSecurityGroupsByTags;BatchCreateSecurityGroupTags;BatchDeleteSecurityGroupTags;ShowSecurityGroupTags;CreateSecurityGroupTag;DeleteSecurityGroupTag;ListSecurityGroupTags;NeutronListFloatingIps;NeutronShowFloatingIp;NeutronCreateFloatingIp;NeutronUpdateFloatingIp;NeutronDeleteFloatingIp", + "version":"v2;v3", + "IsMulti":"No", + "IsBot":"Yes" + } + ], "title":"Precautions for API Permissions", "githuburl":"" }, { "uri":"eip_api06_0001.html", + "node_id":"eip_api06_0001.xml", "product_code":"eip", - "code":"63", + "code":"66", "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":"Appendix", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Appendix", "githuburl":"" }, { "uri":"eip_api06_0003.html", + "node_id":"eip_api06_0003.xml", "product_code":"eip", - "code":"64", + "code":"67", "des":"This section describes monitoring metrics reported by VPC to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the mon", "doc_type":"api", "kw":"VPC Monitoring Metrics,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"VPC Monitoring Metrics", "githuburl":"" }, { "uri":"eip_api05_0001.html", + "node_id":"eip_api05_0001.xml", "product_code":"eip", - "code":"65", + "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":"Status Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Status Codes", "githuburl":"" }, { "uri":"ErrorCode.html", + "node_id":"errorcode.xml", "product_code":"eip", - "code":"66", + "code":"69", "des":"If an error occurs when an API is called, error information is returned. This section describes the error information for EIP APIs (excluding native OpenStack APIs).", "doc_type":"api", "kw":"Error Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Error Codes", "githuburl":"" }, { "uri":"eip_api07_0000.html", + "node_id":"eip_api07_0000.xml", "product_code":"eip", - "code":"67", + "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":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"eip" + } + ], "title":"Change History", "githuburl":"" } diff --git a/docs/eip/api-ref/AssociatePublicips.html b/docs/eip/api-ref/AssociatePublicips.html index 614520122..42b560ad5 100644 --- a/docs/eip/api-ref/AssociatePublicips.html +++ b/docs/eip/api-ref/AssociatePublicips.html @@ -1,7 +1,7 @@

Binding an EIP

-

Function

This API is used to bind an EIP. (This API is not supported in eu-nl.)

+

Function

This API is used to bind an EIP. (This API is not supported in eu-nl.)

URI

POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance

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

Request Parameters

-
@@ -216,7 +217,7 @@ - - @@ -358,7 +359,7 @@ @@ -367,10 +368,19 @@ + + + +
Table 2 Request body parameter

Parameter

+
@@ -97,7 +97,7 @@ @@ -307,7 +307,7 @@ - @@ -420,7 +420,7 @@ @@ -429,10 +429,19 @@ + + + +
Table 2 Request body parameters

Parameter

Mandatory

  • ID of the instance that the port belongs to, for example, RDS instance ID.
  • Constraints:
    • If neither associate_instance_type nor associate_instance_id is left empty, the instance is bound.
    • associate_instance_id cannot be empty.
    • A dual-stack EIP cannot have its bound instance changed.
-

Minimum length: 0

+

Minimum length: 0

Maximum length: 36

String

  • Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.
  • For details about the dedicated EIP pool, see the APIs about publcip_pool.
+
  • Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.
  • For details about the dedicated EIP pool, see the APIs about publicip_pool.

Minimum length: 0

Maximum length: 64

String

  • ID of the instance that the port belongs to, for example, RDS instance ID.
  • The system automatically sets this parameter.
-

Minimum length: 0

+

Minimum length: 0

Maximum length: 36

String

  • Type of the instance that the port belongs to, for example, RDS.
  • The system automatically sets this parameter.
-

Minimum length: 0

+

Minimum length: 0

Maximum length: 36

port_vif_details

+

String

+
  • Details about the NIC virtual interface.
+

Minimum length: 0

+

Maximum length: 255

+
@@ -555,7 +564,8 @@ "private_ip_address" : "xx.xx.xx.xx", "vni" : null, "vpc_id" : "a26c231a-cf6f-48d3-83db-1e261d0e235a", - "vtep" : null + "vtep" : null, + "port_vif_details" : "{\"primary_interface\": true}" } }, "request_id" : "ead9f912bd1191e3d5f0037141098d91" diff --git a/docs/eip/api-ref/CLASS.TXT.json b/docs/eip/api-ref/CLASS.TXT.json index 409f465f4..12aa96554 100644 --- a/docs/eip/api-ref/CLASS.TXT.json +++ b/docs/eip/api-ref/CLASS.TXT.json @@ -36,7 +36,7 @@ "code":"4" }, { - "desc":"This API is used to assign an EIP.The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSs, B", + "desc":"This API is used to assign an EIP.The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be flexibly bound to or unbound fro", "product_code":"eip", "title":"Assigning an EIP", "uri":"eip_api_0001.html", @@ -144,7 +144,7 @@ "code":"16" }, { - "desc":"This API is used to query details about a bandwidth.GET /v1/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionNameMandatoryDescr", + "desc":"This API is used to query details about a bandwidth.GET /v1/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionParameterMandatory", "product_code":"eip", "title":"Querying a Bandwidth", "uri":"eip_apiBandwidth_0001.html", @@ -153,7 +153,7 @@ "code":"17" }, { - "desc":"This API is used to query bandwidths using search criteria.GET /v1/{project_id}/bandwidthsTable 1 describes the parameters.Request parameterRequest parametersNameMandator", + "desc":"This API is used to query bandwidths using search criteria.GET /v1/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionParameterMandatoryTypeDesc", "product_code":"eip", "title":"Querying Bandwidths", "uri":"eip_apiBandwidth_0002.html", @@ -162,7 +162,7 @@ "code":"18" }, { - "desc":"This API is used to update information about a bandwidth.PUT /v1/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionNameMandatory", + "desc":"This API is used to update information about a bandwidth.PUT /v1/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionParameterMand", "product_code":"eip", "title":"Updating a Bandwidth", "uri":"eip_apiBandwidth_0003.html", @@ -180,7 +180,7 @@ "code":"20" }, { - "desc":"This API is used to assign a shared bandwidth.POST /v2.0/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionNameMandatoryDescriptionproject_idYe", + "desc":"This API is used to assign a shared bandwidth.POST /v2.0/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionParameterMandatoryDescriptionproject", "product_code":"eip", "title":"Assigning a Shared Bandwidth", "uri":"eip_apisharedbandwidth_0001.html", @@ -189,7 +189,7 @@ "code":"21" }, { - "desc":"This API is used to delete a shared bandwidth.DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionNameMandatoryDescri", + "desc":"This API is used to delete a shared bandwidth.DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id}Table 1 describes the parameters.Parameter descriptionParameterMandatoryD", "product_code":"eip", "title":"Deleting a Shared Bandwidth", "uri":"eip_apisharedbandwidth_0003.html", @@ -198,7 +198,7 @@ "code":"22" }, { - "desc":"This API is used to add an EIP to a shared bandwidth.POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insertTable 1 describes the parameters.Parameter descriptionNameMan", + "desc":"This API is used to add an EIP to a shared bandwidth.POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insertTable 1 describes the parameters.Parameter descriptionParamet", "product_code":"eip", "title":"Adding an EIP to a Shared Bandwidth", "uri":"eip_apisharedbandwidth_0004.html", @@ -207,7 +207,7 @@ "code":"23" }, { - "desc":"This API is used to remove an EIP from a shared bandwidth.POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/removeTable 1 describes the parameters.Parameter descriptionNa", + "desc":"This API is used to remove an EIP from a shared bandwidth.POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/removeTable 1 describes the parameters.Parameter descriptionPa", "product_code":"eip", "title":"Removing an EIP from a Shared Bandwidth", "uri":"eip_apisharedbandwidth_0005.html", @@ -225,7 +225,7 @@ "code":"25" }, { - "desc":"This API is used to query network resource quotas of a tenant. The network resources include VPCs, subnets, security groups, security group rules, EIPs, and VPNs.This API", + "desc":"This API is used to query the network resource quotas of a tenant. The network resources include VPCs, subnets, security groups, security group rules, EIPs, VPNs, and mor", "product_code":"eip", "title":"Querying the Quota", "uri":"eip_apiquota_0001.html", @@ -243,9 +243,9 @@ "code":"27" }, { - "desc":"This API is used to create a tag for an EIP.POST /v2.0/{project_id}/publicips/{publicip_id}/tagsTable 1 describes the parameters.Request parameterRequest parameterParamet", + "desc":"This API is used to add a tag to an EIP.POST /v2.0/{project_id}/publicips/{publicip_id}/tagsTable 1 describes the parameters.Request parameterRequest parameterParameterTy", "product_code":"eip", - "title":"Creating a Tag for an EIP", + "title":"Adding a Tag to an EIP", "uri":"eip_apitag_0001.html", "doc_type":"api", "p_code":"27", @@ -261,9 +261,9 @@ "code":"29" }, { - "desc":"This API is used to delete an EIP tag.DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}Table 1 describes the parameters.Request parameterNoneNoneExample reques", + "desc":"This API is used to delete a tag from an EIP.DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}Table 1 describes the parameters.Request parameterNoneNoneExample", "product_code":"eip", - "title":"Deleting an EIP Tag", + "title":"Deleting a Tag from an EIP", "uri":"eip_apitag_0003.html", "doc_type":"api", "p_code":"27", @@ -272,7 +272,7 @@ { "desc":"This API is used to add multiple tags to or delete multiple tags from an EIP at a time.This API is idempotent.If there are duplicate keys in the request body when you add", "product_code":"eip", - "title":"Batch Creating or Deleting EIP Tags", + "title":"Batch Adding or Deleting EIP Tags", "uri":"eip_apitag_0004.html", "doc_type":"api", "p_code":"27", @@ -315,7 +315,7 @@ "code":"35" }, { - "desc":"This API is used to query all EIPs. (This API is not supported in eu-nl.)GET /v3/{project_id}/eip/publicipsNoneStatus code: 200NoneStatus code: 200Normal response to the ", + "desc":"This API is used to query all EIPs.GET /v3/{project_id}/eip/publicipsNoneStatus code: 200NoneStatus code: 200Normal response to the GET operation{\n \"page_info\" : {\n \"", "product_code":"eip", "title":"Querying All EIPs", "uri":"ListPublicipsV3.html", @@ -332,6 +332,24 @@ "p_code":"35", "code":"37" }, + { + "desc":"Assign an EIP.POST /v3/{project_id}/eip/publicipsStatus code: 201Assign an IPv4 EIP with dedicated bandwidth.Status code: 201Normal creationSee Error Codes.", + "product_code":"eip", + "title":"Assigning an EIP", + "uri":"CreatePublicIpV3.html", + "doc_type":"api", + "p_code":"35", + "code":"38" + }, + { + "desc":"Release an EIP.DELETE /v3/{project_id}/eip/publicips/{publicip_id}NoneStatus code: 204Normal response to DELETE operationsNoneNoneNoneSee Error Codes.", + "product_code":"eip", + "title":"Releasing an EIP", + "uri":"DeletePublicIp.html", + "doc_type":"api", + "p_code":"35", + "code":"39" + }, { "desc":"This API is used to unbind an EIP. (This API is not supported in eu-nl.)POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instanceNoneStatus code: 200NoneSta", "product_code":"eip", @@ -339,7 +357,7 @@ "uri":"DisassociatePublicips.html", "doc_type":"api", "p_code":"35", - "code":"38" + "code":"40" }, { "desc":"This API is used to bind an EIP. (This API is not supported in eu-nl.)POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instanceStatus code: 200Status code: 200", @@ -348,7 +366,7 @@ "uri":"AssociatePublicips.html", "doc_type":"api", "p_code":"35", - "code":"39" + "code":"41" }, { "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,7 +375,7 @@ "uri":"eip_apiv3_0300.html", "doc_type":"api", "p_code":"34", - "code":"40" + "code":"42" }, { "desc":"This API is used to query common pools. (This API is not supported in eu-nl.)GET /v3/{project_id}/eip/publicip-pools/common-poolsNoneStatus code: 200NoneStatus code: 200N", @@ -365,8 +383,8 @@ "title":"Querying Common Pools", "uri":"ListCommonPools.html", "doc_type":"api", - "p_code":"40", - "code":"41" + "p_code":"42", + "code":"43" }, { "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.", @@ -375,7 +393,7 @@ "uri":"eip_openstackapi_0000.html", "doc_type":"api", "p_code":"", - "code":"42" + "code":"44" }, { "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.", @@ -383,8 +401,8 @@ "title":"API Version Information", "uri":"eip_openstackapi_0001.html", "doc_type":"api", - "p_code":"42", - "code":"43" + "p_code":"44", + "code":"45" }, { "desc":"This API is used to query all available versions of a native OpenStack API.GET /NoneSee Status Codes.See Error Codes.", @@ -392,8 +410,8 @@ "title":"Querying API Versions", "uri":"eip_openstackapi_0002.html", "doc_type":"api", - "p_code":"43", - "code":"44" + "p_code":"45", + "code":"46" }, { "desc":"This API is used to query the version of a specified API.GET /{api_version}Table 1 describes the parameters.NoneSee Status Codes.See Error Codes.", @@ -401,17 +419,17 @@ "title":"Querying a Specified API Version", "uri":"eip_openstackapi_0003.html", "doc_type":"api", - "p_code":"43", - "code":"45" + "p_code":"45", + "code":"47" }, { - "desc":"Neutron APIs v2.0 provides the pagination function. You can set parameters limit and marker in the URL to enable the desired number of items to be returned. All returned ", + "desc":"Neutron APIs v2.0 provides the pagination function. You can set parameters limit and marker in the URL of the list request to enable the desired number of items to be ret", "product_code":"eip", "title":"Pagination", "uri":"eip_openstackapi_0004.html", "doc_type":"api", - "p_code":"43", - "code":"46" + "p_code":"45", + "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.", @@ -419,8 +437,8 @@ "title":"Floating IP Address", "uri":"eip_openstackapi_0005.html", "doc_type":"api", - "p_code":"42", - "code":"47" + "p_code":"44", + "code":"49" }, { "desc":"This API is used to query all floating IP addresses accessible to the tenant submitting the request.You can query the detailed information about a specified floating IP a", @@ -428,8 +446,8 @@ "title":"Querying Floating IP Addresses", "uri":"eip_openstackapi_0006.html", "doc_type":"api", - "p_code":"47", - "code":"48" + "p_code":"49", + "code":"50" }, { "desc":"This API is used to query details about a specified floating IP address, including the floating IP address status, ID of the router to which the floating IP address belon", @@ -437,8 +455,8 @@ "title":"Querying a Floating IP Address", "uri":"eip_openstackapi_0007.html", "doc_type":"api", - "p_code":"47", - "code":"49" + "p_code":"49", + "code":"51" }, { "desc":"When assigning a floating IP address, you need to obtain the external network ID floating_network_id of the floating IP address.You can use GET /v2.0/networks?router:exte", @@ -446,8 +464,8 @@ "title":"Assigning a Floating IP Address", "uri":"eip_openstackapi_0008.html", "doc_type":"api", - "p_code":"47", - "code":"50" + "p_code":"49", + "code":"52" }, { "desc":"This API is used to update a floating IP address.During the update, the ID of the floating IP address must be provided in the URL.If port_id is left blank, the floating I", @@ -455,8 +473,8 @@ "title":"Updating a Floating IP Address", "uri":"eip_openstackapi_0009.html", "doc_type":"api", - "p_code":"47", - "code":"51" + "p_code":"49", + "code":"53" }, { "desc":"This API is used to delete a floating IP address.Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:In eu-de, EIPs of the Dedicated Load Ba", @@ -464,8 +482,8 @@ "title":"Deleting a Floating IP Address", "uri":"eip_openstackapi_0010.html", "doc_type":"api", - "p_code":"47", - "code":"52" + "p_code":"49", + "code":"54" }, { "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.", @@ -474,25 +492,25 @@ "uri":"eip_apieg_0000.html", "doc_type":"api", "p_code":"", - "code":"53" + "code":"55" }, { - "desc":"This section describes how to bind an EIP to an ECS by calling APIs.You have created an ECS. For details, see section \"Purchasing an ECS with Customized Configurations\" i", + "desc":"This section describes how to bind an EIP to an ECS by calling APIs.You have created an ECS. For details, see section \"Creating an ECS in Custom Config Mode\" in the Elast", "product_code":"eip", "title":"Binding an EIP to an ECS", "uri":"eip_apieg_0002.html", "doc_type":"api", - "p_code":"53", - "code":"54" + "p_code":"55", + "code":"56" }, { - "desc":"This section describes how to unbind an EIP from an ECS by calling APIs.You have created an ECS. For details, see section \"Purchasing an ECS with Customized Configuration", + "desc":"This section describes how to unbind an EIP from an ECS by calling APIs.You have created an ECS. For details, see section \"Creating an ECS in Custom Config Mode\" in the E", "product_code":"eip", "title":"Unbinding an EIP from an ECS", "uri":"eip_apieg_0003.html", "doc_type":"api", - "p_code":"53", - "code":"55" + "p_code":"55", + "code":"57" }, { "desc":"This section describes how to assign an EIP with a specific shared bandwidth by calling APIs.If you use a token for authentication, you must obtain the token and add X-Au", @@ -500,8 +518,8 @@ "title":"Assigning an EIP with a Specific Shared Bandwidth", "uri":"eip_apieg_0001.html", "doc_type":"api", - "p_code":"53", - "code":"56" + "p_code":"55", + "code":"58" }, { "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.", @@ -510,7 +528,7 @@ "uri":"eip_apipermission_0000.html", "doc_type":"api", "p_code":"", - "code":"57" + "code":"59" }, { "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.", @@ -518,8 +536,8 @@ "title":"EIP", "uri":"eip_apipermission_0002.html", "doc_type":"api", - "p_code":"57", - "code":"58" + "p_code":"59", + "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.", @@ -527,17 +545,26 @@ "title":"Bandwidth", "uri":"eip_apipermission_0003.html", "doc_type":"api", - "p_code":"57", - "code":"59" + "p_code":"59", + "code":"61" }, { "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":"eip", - "title":"Bandwidth (V2.0)", + "title":"Bandwidth (V2)", "uri":"eip_apipermission_0004.html", "doc_type":"api", - "p_code":"57", - "code":"60" + "p_code":"59", + "code":"62" + }, + { + "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":"eip", + "title":"EIP V3", + "uri":"eip_apipermission_0011.html", + "doc_type":"api", + "p_code":"59", + "code":"63" }, { "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.", @@ -545,17 +572,17 @@ "title":"Floating IP Address (OpenStack Neutron API)", "uri":"eip_apipermission_0006.html", "doc_type":"api", - "p_code":"57", - "code":"61" + "p_code":"59", + "code":"64" }, { - "desc":"If you have insufficient permissions, response code 200 will be returned when you query network resources and an empty list will be displayed.", + "desc":"Note:If you have insufficient permissions, response code 200 will be returned when you query network resources and an empty list will be displayed.You can apply for the p", "product_code":"eip", "title":"Precautions for API Permissions", "uri":"eip_apipermission_0007.html", "doc_type":"api", - "p_code":"57", - "code":"62" + "p_code":"59", + "code":"65" }, { "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.", @@ -564,7 +591,7 @@ "uri":"eip_api06_0001.html", "doc_type":"api", "p_code":"", - "code":"63" + "code":"66" }, { "desc":"This section describes monitoring metrics reported by VPC to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the mon", @@ -572,8 +599,8 @@ "title":"VPC Monitoring Metrics", "uri":"eip_api06_0003.html", "doc_type":"api", - "p_code":"63", - "code":"64" + "p_code":"66", + "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.", @@ -581,8 +608,8 @@ "title":"Status Codes", "uri":"eip_api05_0001.html", "doc_type":"api", - "p_code":"63", - "code":"65" + "p_code":"66", + "code":"68" }, { "desc":"If an error occurs when an API is called, error information is returned. This section describes the error information for EIP APIs (excluding native OpenStack APIs).", @@ -590,8 +617,8 @@ "title":"Error Codes", "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"63", - "code":"66" + "p_code":"66", + "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.", @@ -600,6 +627,6 @@ "uri":"eip_api07_0000.html", "doc_type":"api", "p_code":"", - "code":"67" + "code":"70" } ] \ No newline at end of file diff --git a/docs/eip/api-ref/CreatePublicIpV3.html b/docs/eip/api-ref/CreatePublicIpV3.html new file mode 100644 index 000000000..81363f487 --- /dev/null +++ b/docs/eip/api-ref/CreatePublicIpV3.html @@ -0,0 +1,853 @@ + + +

Assigning an EIP

+

Function

Assign an EIP.

+
+

URI

POST /v3/{project_id}/eip/publicips

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+
  • Definition: Project ID.

    +
  • Range: None

    +
+

Maximum: 32

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

publicip

+

Yes

+

EIPAddDict object

+

Request body for assigning an EIP

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 EIPAddDict

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+
  • Definition: EIP ID.

    +
  • Constraints: The value is in the UUID format and can be specified only by the administrator.

    +
+

Minimum: 36

+

Maximum: 36

+

ip_version

+

No

+

Integer

+
  • Definition: IP address version.

    +
  • Constraints: The configured value must be supported by the system.

    +
  • Range:

    +
    • 4: IPv4 EIP

      +
    • 6: IPv6 EIP

      +
    +
+

Minimum: 4

+

Maximum: 6

+

alias

+

No

+

String

+

Definition: EIP name

+

Minimum: 0

+

Maximum: 255

+

type

+

No

+

String

+
  • Definition: EIP type.

    +
  • Constraints: N/A

    +
  • Range:

    +
    • EIP: IPv4 EIP.

      +
    • DUALSTACK: IPv6 EIP.

      +
    +
  • Default Value: N/A

    +
+

publicip_pool_name

+

Yes

+

String

+
  • Definition: Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.

    +
  • For details about a dedicated EIP pool, see the APIs about publicip_pool.

    +
+

public_ip_address

+

No

+

String

+
  • Definition: EIP to be assigned. The system automatically assigns an EIP if you do not specify it.

    +
  • Constraints: The value must be a valid IPv4 address in the available IP address range.

    +
+

Minimum: 0

+

Maximum: 64

+

public_ipv6_address

+

No

+

String

+
  • Definition: Obtained EIP if IPv6 EIPs are available. This parameter does not exist if only IPv4 EIPs are available.

    +
+

description

+

No

+

String

+
  • Definition: EIP description.

    +
  • Constraints: You can customize this value to identify your EIP, which is not perceived by the system.

    +
+

enterprise_project_id

+

No

+

String

+

Definition: Enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in the UUID format with hyphens (-). This is the ID of the enterprise project that you associate with the EIP when you assign the EIP.

+

bandwidth

+

Yes

+

PublicipBandwidthInfo object

+

Bandwidth bound to an EIP

+

associate_instance_type

+

No

+

String

+
  • Definition: Type of the instance that the EIP is bound to. It can be filtered by associate_instance_type.

    +
  • Range:

    +
    • PORT (Instance type, including ECS, BMS, and CCE)

      +
    • NATGW (NAT gateway type)

      +
    • ELB (Load balancer type)

      +
    • ELBV1 (ELBv1 instance type, classic ELBv1)

      +
    • VPN (VPN instance type)

      +
    +
+

associate_instance_id

+

No

+

String

+
  • Definition: ID of the bound instance

    +
  • Constraints: If neither associate_instance_type nor associate_instance_id is empty, an instance is bound. If both associate_instance_type and associate_instance_id are null, an instance is unbound.

    +
+

Minimum: 0

+

Maximum: 36

+

billing_info

+

No

+

String

+

Definition: Order information.

+

Minimum: 0

+

Maximum: 1024

+

cascade_delete_by_instance

+

No

+

Boolean

+

This parameter is supported when the ECS is called. If the value is true, the EIP is released when the ECS is deleted. If the value is false, the EIP is not released when the ECS is deleted.

+

Default: false

+

associate_mode

+

No

+

String

+
  • Definition: Passthrough mode. This parameter is available after the passthrough mode is enabled. (Not displayed by default)

    +
+

Minimum: 1

+

Maximum: 36

+

lock_infos

+

No

+

Array of strings

+

Frozen status of an EIP.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PublicipBandwidthInfo

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+
  • Definition: Bandwidth ID

    +
+

size

+

Yes

+

Integer

+
  • Definition: Bandwidth size.

    +
  • Range: The value ranges from 5 Mbit/s to 2000 Mbit/s by default.

    +
+

share_type

+

Yes

+

String

+
  • Definition: Whether the bandwidth is shared or dedicated.

    +
  • Range:

    +
    • PER: dedicated bandwidths

      +
    • WHOLE: shared bandwidth

      +
    +

    [- Constraints: IPv6 addresses do not support bandwidth whose type is "WHOLE".] (tag:hws,srg)

    +
+

charge_mode

+

No

+

String

+
  • Definition: Whether the billing is based on traffic or bandwidth.

    +
  • Range:

    +
    • bandwidth: billed by bandwidth

      +
    • traffic: billed by traffic

      +
    • 95peak_plus: 95th percentile bandwidth (enhanced)

      +
    +
+

name

+

Yes

+

String

+
  • Definition: Bandwidth name.

    +
  • Range: The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

    +
+

billing_info

+

No

+

String

+
  • Definition: Billing information If billinginfo is specified, the bandwidth is billed on a yearly/monthly basis.

    +
+
+
+
+

Response Parameters

Status code: 201

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

Parameter

+

Type

+

Description

+

publicip

+

PublicipResp object

+

EIP

+

request_id

+

String

+

Request ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 PublicipResp

Parameter

+

Type

+

Description

+

id

+

String

+
  • Definition: EIP ID, which uniquely identifies the EIP.

    +
+

project_id

+

String

+
  • Definition: Project ID.

    +
+

ip_version

+

Integer

+
  • Definition: EIP version.

    +
  • Range: The value can be 4 or 6. 6 indicates that the NAT64 capability is enabled.

    +
    • 4: IPv4 EIP

      +
    • 6: IPv6 EIP

      +
    +
+

public_ip_address

+

String

+
  • Definition: IPv4 EIP.

    +
+

public_ipv6_address

+

String

+
  • Definition: IPv6 EIP.

    +
+

status

+

String

+
  • Definition: EIP status

    +
  • Range: The value can be FREEZED, DOWN, ACTIVE, or ERROR.

    +
    • FREEZED: The EIP is frozen.

      +
    • DOWN: The EIP is not bound to any instance.

      +
    • ACTIVE: The EIP is bound to an instance and is in use.

      +
    • ERROR: The EIP status is abnormal.

      +
    +
+

description

+

String

+
  • Definition: Supplementary information about the EIP.

    +
  • Constraints: You can customize this value to identify your EIP, which is not perceived by the system.

    +
+

created_at

+

String

+
  • Definition: Time when an EIP was assigned.

    +
  • Constraints: The value is in UTC format, for example, 2018-12-25T10:07:24Z.

    +
+

updated_at

+

String

+
  • Definition: Time when an EIP is updated.

    +
  • Constraints: The value is in UTC format, for example, 2018-12-25T10:09:20Z.

    +
+

type

+

String

+
  • Definition: EIP type.

    +
  • Constraints: N/A

    +
  • Range:

    +
    • EIP: IPv4 EIP.

      +
    • DUALSTACK: IPv6 EIP.

      +
    +
  • Default Value: N/A

    +
+

vnic

+

VnicResp object

+
  • Definition: Port information of the instance that an EIP is bound to.

    +
  • Constraints: If the instance has no port, the value is null.

    +
+

bandwidth

+

BandwidthResp object

+
  • Definition: Bandwidth of the EIP.

    +
+

enterprise_project_id

+

String

+
  • Definition: Enterprise project ID of the EIP.

    +
+

billing_info

+

String

+
  • Definition: Order information of an EIP.

    +
  • Constraints: Order information is available only for yearly/monthly resources. This parameter is left empty for pay-per-use resources.

    +
+

lock_status

+

String

+
  • Definition: Frozen reason of the EIP.

    +
  • Constraints: The metadata type is used.

    +
  • Range:

    +
    • POLICE: frozen due to public security issues

      +
    • LOCKED: frozen due to common issues

      +
    • ARREAR: frozen due to arrears

      +
    • DELABLE: frozen and can be deleted

      +
    +
  • Default Value: N/A

    +
+

associate_instance_type

+

String

+
  • Definition: Type of the instance with an EIP bound.

    +
  • Range:

    +
    • PORT (Instance type, including ECS, BMS, and CCE)

      +
    • NATGW (NAT gateway type)

      +
    • ELB (Load balancer type)

      +
    • VPN (VPN instance type)

      +
    +

    +
+

associate_instance_id

+

String

+
  • Definition: ID of the instance with an EIP bound.

    +
+

publicip_pool_id

+

String

+
  • Definition: ID of the network that an EIP belongs to. It is the network ID corresponding to publicip_pool_name.

    +
+

publicip_pool_name

+

String

+
  • Definition: Network type of an EIP,

    +
+

including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool. For details about a dedicated EIP pool, see the APIs about publicip_pool.

+

alias

+

String

+
  • Definition: EIP alias.

    +
+

public_border_group

+

String

+
  • Definition: Whether it is a central or an edge resource. The value is CENTER for a central EIP and an edge AZ name for an edge EIP.

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 VnicResp

Parameter

+

Type

+

Description

+

private_ip_address

+

String

+
  • Definition: Private IP address of a port.

    +
+

device_id

+

String

+
  • Definition: ID of the device that the port belongs to. The device ID indicates the ID of the cloud service resource that uses the private IP address in the subnet, for example, the cloud server ID or load balancer ID.

    +
  • Constraints: If there is a port, the value of this parameter is the same as that of associate_instance_id, which is the instance ID.

    +
+

device_owner

+

String

+
  • Definition: Device that the port belongs to, that is, a cloud service resource that uses a private IP address in the subnet.

    +
  • Constraints: If there is a port, both this parameter and associate_instance_type can be used to identify the instance type.

    +
+

vtep

+

String

+
  • Definition: VTEP IP address.

    +
+

vni

+

String

+
  • Definition: VXLAN ID.

    +
+

vpc_id

+

String

+
  • Definition: ID of the VPC that the port belongs to.

    +
+

port_id

+

String

+
  • Definition: Port ID, which uniquely identifies a port.

    +
+

port_profile

+

String

+
  • Definition: Port profile.

    +
+

mac

+

String

+
  • Definition: MAC address of a port.

    +
+

instance_id

+

String

+
  • Definition: Port user, which is different from the owner of device_id. For example, the device_owner of a virtual IP address port is a virtual IP address, but the actual user of the port may be a VM or others.

    +
+

instance_type

+

String

+
  • Definition: Port user.

    +
  • Constraints: N/A

    +
  • Range:

    +
    • PORT: elastic network interface

      +
    • PEP_PORT: PEP elastic network interface

      +
    • EVPN: Ethernet virtual private network

      +
    • NATGW: NAT gateway

      +
    • P2CVPN: P2C virtual private network

      +
    +
  • Default Value: N/A

    +
+

port_vif_details

+

String

+
  • Definition: Details about the virtual interface of the network interface

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 BandwidthResp

Parameter

+

Type

+

Description

+

id

+

String

+
  • Definition: Bandwidth ID.

    +
+

size

+

Integer

+
  • Definition: Bandwidth size.

    +
+

share_type

+

String

+
  • Definition: Type.

    +
+

WHOLE indicates a shared bandwidth, and PER indicates a dedicated bandwidth.

+

charge_mode

+

String

+
  • Definition: Bandwidth billing mode.

    +
+

name

+

String

+
  • Definition: Bandwidth name.

    +
+

billing_info

+

String

+
  • Definition: Bandwidth order information.

    +
+
+
+
+

Example Requests

Assign an IPv4 EIP with dedicated bandwidth.

+
POST https://{Endpoint}/v3/{project_id}/eip/publicips
+
+{
+  "publicip" : {
+    "type" : "EIP",
+    "publicip_pool_name" : "5_telcom",
+    "bandwidth" : {
+      "size" : 300,
+      "share_type" : "PER",
+      "charge_mode" : "bandwidth",
+      "name" : "bandwidth-b556"
+    }
+  }
+}
+
+

Example Responses

Status code: 201

+

Normal creation

+
{
+  "publicip" : {
+    "id" : "0c464dad-86f3-4953-8bd4-c22bb0eb0bde",
+    "project_id" : "b2782e6708b8475c993e6064bc456bf8",
+    "alias" : "test eip",
+    "ip_version" : 4,
+    "public_ip_address" : "100.64.0.253",
+    "publicip_pool_name" : "5_telcom",
+    "status" : "ACTIVE",
+    "description" : "description test",
+    "created_at" : "2018-12-25T10:07:24Z",
+    "updated_at" : "2018-12-25T10:07:24Z",
+    "type" : "EIP",
+    "vnic" : {
+      "private_ip_address" : "172.16.1.75",
+      "device_id" : "b61769a5-f8c4-448f-ae5b-2cbe1baa20ca",
+      "device_owner" : "compute:AZ1",
+      "vpc_id" : "1314cd0b-5dea-4697-b45a-a2304ff87e9c",
+      "port_id" : "b01795fc-a246-4e4c-b770-0e4d58101592",
+      "mac" : "fa:16:3e:ac:a8:0b"
+    },
+    "bandwidth" : {
+      "id" : "b01795fc-a246-4e4c-b770-0e4d58101592",
+      "size" : 300,
+      "share_type" : "PER",
+      "charge_mode" : "traffic",
+      "name" : "bandwidth-b556"
+    },
+    "enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439",
+    "associate_instance_type" : "PORT",
+    "associate_instance_id" : "b61769a5-f8c4-448f-ae5b-2cbe1baa20ca",
+    "public_border_group" : "CENTER"
+  },
+  "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

201

+

Normal creation

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/eip/api-ref/DeletePublicIp.html b/docs/eip/api-ref/DeletePublicIp.html new file mode 100644 index 000000000..2365d81f3 --- /dev/null +++ b/docs/eip/api-ref/DeletePublicIp.html @@ -0,0 +1,78 @@ + + +

Releasing an EIP

+

Function

Release an EIP.

+
+

URI

DELETE /v3/{project_id}/eip/publicips/{publicip_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+
  • Definition: Project ID.

    +
  • Range: None

    +
+

Maximum: 32

+

publicip_id

+

Yes

+

String

+

EIP ID.

+

Maximum: 36

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 204

+

Normal response to DELETE operations

+

None

+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Normal response to DELETE operations

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/eip/api-ref/DisassociatePublicips.html b/docs/eip/api-ref/DisassociatePublicips.html index 047000aa4..2cd048aa2 100644 --- a/docs/eip/api-ref/DisassociatePublicips.html +++ b/docs/eip/api-ref/DisassociatePublicips.html @@ -1,7 +1,7 @@

Unbinding an EIP

-

Function

This API is used to unbind an EIP. (This API is not supported in eu-nl.)

+

Function

This API is used to unbind an EIP. (This API is not supported in eu-nl.)

URI

POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instance

@@ -110,6 +110,7 @@

public_ip_address

+

String

String

  • Type of the instance bound with an EIP.
  • Value range: PORT, NATGW, ELB, ELBV1, VPN or null
+
  • Type of the instance bound with an EIP.
  • Value range: PORT, NATGW, ELB, ELBV1, VPN or null

Minimum length: 0

Maximum length: 64

Enumerated values:

@@ -245,7 +246,7 @@

String

  • Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.
  • For details about the dedicated EIP pool, see the APIs about publcip_pool.
+
  • Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.
  • For details about the dedicated EIP pool, see the APIs about publicip_pool.

Minimum length: 0

Maximum length: 64

String

  • ID of the instance that the port belongs to, for example, RDS instance ID.
  • The system automatically sets this parameter.
-

Minimum length: 0

+

Minimum length: 0

Maximum length: 36

String

  • Type of the instance that the port belongs to, for example, RDS.
  • The system automatically sets this parameter.
-

Minimum length: 0

+

Minimum length: 0

Maximum length: 36

port_vif_details

+

String

+
  • Details about the NIC virtual interface.
+

Minimum length: 0

+

Maximum length: 255

+
diff --git a/docs/eip/api-ref/ErrorCode.html b/docs/eip/api-ref/ErrorCode.html index 6bf86e5fb..0f2f780ae 100644 --- a/docs/eip/api-ref/ErrorCode.html +++ b/docs/eip/api-ref/ErrorCode.html @@ -9,31 +9,31 @@ }

Error Code Description

-

Module

+
- - - - - - - - - @@ -73,24 +73,24 @@ - - - - - - - - - - - - - - - - - - - - - - - @@ -210,24 +210,24 @@ - - - - - @@ -238,31 +238,31 @@ - - - - - - @@ -295,7 +295,7 @@ - @@ -317,29 +317,18 @@ - - - - - - - - @@ -350,7 +339,7 @@ - @@ -361,7 +350,7 @@ - @@ -372,7 +361,7 @@ - @@ -383,7 +372,7 @@ - @@ -394,32 +383,44 @@ - - - + + + + + + + - - - @@ -441,7 +442,7 @@ - @@ -452,24 +453,24 @@ - - - - - - @@ -509,24 +510,24 @@ - - - - - - - - - - - - - - - - - - - - - @@ -625,7 +615,7 @@ - @@ -647,31 +637,44 @@ - - - + + + + + + + - - - @@ -682,7 +685,7 @@ - @@ -700,18 +703,18 @@ - - - - - @@ -740,7 +743,7 @@ - @@ -773,7 +776,7 @@ - @@ -784,7 +787,7 @@ - @@ -824,17 +827,17 @@ - - - - - - - - - - - - - - @@ -929,7 +925,7 @@ - @@ -940,7 +936,7 @@ - @@ -951,24 +947,24 @@ - - - - - - @@ -997,7 +993,7 @@ - @@ -1008,7 +1004,7 @@ - @@ -1030,32 +1026,32 @@ - - - - - - @@ -1066,31 +1062,31 @@ - - - - - - @@ -1101,32 +1097,31 @@ - - - - - - @@ -1137,47 +1132,44 @@ - - - - - - - - - - - - @@ -1188,7 +1180,7 @@ - @@ -1199,59 +1191,57 @@ - - - - - - - - - - - - - - - - - @@ -1262,25 +1252,25 @@ - - - - - - - - - - - @@ -1344,24 +1334,24 @@ - - - - - - - - - - - - - - - - - - @@ -1803,17 +1793,17 @@ - - - - - - - - - - @@ -1884,17 +1874,17 @@ - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Module

Status Code

+

Status Code

Error Code

Message

Description

+

Description

Handling Measure

+

Handling Measure

Public

+

Public

400

+

400

VPC.0002

Available zone Name is null.

+

AZ name is null.

The AZ is left blank.

+

The AZ is left blank.

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

+

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

404

@@ -51,7 +51,7 @@

VPC.0004

VPC is not active, please try later.

+

VPC is not active. Try again later.

The VPC status is abnormal.

VPC.0009

real-name authentication fail.

+

Real-name authentication failed.

Real-name authentication fails.

Contact technical support.

Public

+

Public

400

+

400

VPC.0007

urlTenantId is not equal tokenTenantId

+

Inconsistent tenant IDs.

Inconsistent tenant IDs.

+

Inconsistent tenant IDs.

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

+

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

401

@@ -108,25 +108,25 @@

VPC.2701

Token not allowed to do this action.

+

Token is not allowed to do this action.

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

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

Public

+

Public

403

+

403

VPC.0010

Rules on xx by ** disallowed by policy

+

Insufficient permissions to call the underlying system.

Insufficient permissions to make calls to the underlying system.

+

Insufficient permissions to make calls to the underlying system.

Obtain the required permissions.

+

Obtain the required permissions.

403

@@ -140,17 +140,17 @@

Obtain the required permissions.

Creating a VPC

+

Creating a VPC

400

+

400

VPC.0101

Param is invalid.

+

Invalid VPC parameter values.

VPC parameters are incorrect.

+

VPC parameters are incorrect.

Check whether the parameter values are valid based on the returned error message and API reference document.

+

Check whether the parameter values are valid based on the returned error message and API reference document.

409

@@ -168,31 +168,31 @@

VPC.0115

The router name has exist.

+

The router name exists.

The VPC name already exists.

Change the VPC name.

Querying a VPC

+

Querying a VPC

400

+

400

VPC.0101

getVpc error vpcId is invalid.

VPC parameters are incorrect.

+

VPC parameters are incorrect.

Ensure that the specified VPC ID is correct.

+

Ensure that the specified VPC ID is correct.

404/500

VPC.0105

Neutron Error.

+

Neutron error.

Calling the backend service fails.

Check whether the Neutron service is normal or contact technical support.

Querying VPCs

+

Querying VPCs

400

+

400

VPC.0101

Query vpc list error.

Failed to query the VPCs.

+

Failed to query the VPCs.

Check whether the parameter values are valid based on the returned error message.

+

Check whether the parameter values are valid based on the returned error message.

500

VPC.0105

Neutron Error.

+

Neutron error.

Calling the backend service fails.

VPC.0106

query routers or getList are null.

+

The response of router query or getList is null.

The response result of calls to the IaaS OpenStack system is null or empty.

Check whether the Neutron service is normal or contact technical support.

Deleting a VPC

+

Deleting a VPC

400/404

+

400/404

VPC.0101

Delete router error xx is invalid.

Invalid parameters.

+

Invalid parameters.

Check whether the parameter values are valid based on the returned error message.

+

Check whether the parameter values are valid based on the returned error message.

500

VPC.0102

Delete router fail.

+

Router deletion failed.

The interface fails to obtain the routing resources.

VPC.0105

Neutron Error.

+

Neutron error.

Calling the backend service fails.

VPC.0108

Router is used not allow deleted.

+

Router is being used and cannot be deleted.

Failed to delete the VPC because it has EIPs associated.

Delete the EIPs of the tenant first.

409

-

VPC.0109

-

Router is used not allow deleted.

-

Failed to delete the VPC because one or more VPNs have been created for it.

-

Delete VPNs of the tenant.

-

409

VPC.0110

deleteDefaultNetworkFromRouter router status is invalid.

+

The VPC cannot be deleted because it is not in the stable status.

The VPC cannot be deleted because its status is unstable.

VPC.0111

Database Error.

+

Database error.

An internal VPC exception occurs.

VPC.0112

Delete the securitygroup first before deleting the router.

+

Delete the security group first before deleting the router.

The VPC cannot be deleted because it contains security groups.

VPC.0118

ELB exists under this router, delete ELB firstly.

+

ELB exists under this router. Delete ELB first.

The VPC cannot be deleted because it contains load balancers.

VPC.0119

ELB Error.

+

ELB error.

An error occurred when the VPC service makes calls to the ELB service.

VPC.0120

exroutes exists under this router, delete exroutes firstly.

+

Extension routes exist under this router. Delete the routes first.

The VPC cannot be deleted because it contains extension routes.

Delete extension routes in the VPC.

Updating a VPC

-

+

Deleting a VPC

400

+

409

+

VPC.0109

+

Router is being used and cannot be deleted.

+

Failed to delete the VPC because one or more VPNs have been created for it.

+

Delete VPNs of the tenant.

+

Updating a VPC

+

400

VPC.0101

Update router xx is invalid.

Invalid parameters.

+

Invalid parameters.

Check whether the parameter values are valid based on the returned error message.

+

Check whether the parameter values are valid based on the returned error message.

404/500

VPC.0105

Neutron Error.

+

Neutron error.

Calling the backend service fails.

VPC.0115

The router name has exist.

+

The router name exists.

The VPC name already exists.

VPC.0117

Cidr can not contain subnetList cidr.

+

VPC CIDR block cannot contain the subnet CIDR block.

The subnet parameters are invalid. The VPC CIDR block does not contain all its subnet CIDR blocks.

Change the CIDR block of the VPC.

Creating a subnet

+

Creating a subnet

400

+

400

VPC.0201

Subnet name is invalid.

Incorrect subnet parameters.

+

Incorrect subnet parameters.

Check whether the parameter values are valid based on the returned error message and API reference document.

+

Check whether the parameter values are valid based on the returned error message and API reference document.

500

@@ -498,7 +499,7 @@

VPC.0204

The subnet has already existed in the VPC, or has been in conflict with the VPC subnet.

+

The subnet already exists in the VPC or conflicts with an existing VPC subnet.

The CIDR block of the subnet already exists in the VPC.

VPC.0212

The subnet cidr is not valid.

+

Invalid subnet CIDR block.

Invalid subnet CIDR block.

Check whether the subnet CIDR block is valid.

Querying a subnet

+

Querying a subnet

400

+

400

VPC.0201

Subnet ID is invalid.

Invalid subnet ID.

+

Invalid subnet ID.

Check whether the subnet ID is valid.

+

Check whether the subnet ID is valid.

404/500

@@ -540,17 +541,17 @@

Contact technical support.

Querying subnets

+

Querying subnets

400

+

400

VPC.0201

Query subnets list error.

Failed to query the subnets.

+

Failed to query the subnets.

Check whether the parameter values are valid based on the returned error message.

+

Check whether the parameter values are valid based on the returned error message.

500

@@ -564,41 +565,30 @@

Contact technical support.

Deleting a subnet

+

Deleting a subnet

400

+

400

VPC.0201

Subnet ID is invalid.

Invalid subnet ID.

+

Invalid subnet ID.

Check whether the parameter values are valid based on the returned error message.

+

Check whether the parameter values are valid based on the returned error message.

404/500

VPC.0202

Neutron Error.

+

Neutron error.

An internal error occurs in the subnet.

Contact technical support.

500

-

VPC.0206

-

Subnet has been used by VPN, please remove the subnet from the VPN and try again.

-

The subnet cannot be deleted because it is being used by the VPN.

-

Delete the subnet that is used by the VPN.

-

400

VPC.0207

@@ -614,7 +604,7 @@

VPC.0208

Subnet is used by private IP, can not be deleted.

+

The subnet cannot be deleted because it has private IP addresses that are being used.

The subnet cannot be deleted because it is being used by the private IP address.

VPC.0209

subnet is still used ,such as computer,LB.

+

The subnet is being used by an ECS or a load balancer.

The subnet cannot be deleted because it is being used by an ECS or load balancer.

VPC.0211

subnet is still used by LBaas.

+

The subnet is being used by a load balancer.

The subnet cannot be deleted because it is being used by load balancers.

Delete load balancers in the subnet.

Updating a subnet

+

Deleting a subnet

400

+

500

+

VPC.0206

+

Subnet has been used by VPN, please remove the subnet from the VPN and try again.

+

The subnet cannot be deleted because it is being used by the VPN.

+

Delete the subnet that is used by the VPN.

+

Updating a subnet

+

400

VPC.0201

xx is invalid.

Incorrect subnet parameters.

+

Incorrect subnet parameters.

Check whether the parameter values are valid based on the returned error message.

+

Check whether the parameter values are valid based on the returned error message.

404/500

VPC.0202

Neutron Error.

+

Neutron error.

An internal error occurs in the subnet.

VPC.0205

Subnet states is invalid, please try again later.

+

Invalid subnet status. Try again later.

The subnet cannot be updated because it is being processed.

Check whether the subnet is in the VPC.

Assigning an EIP

+

Assigning an EIP

400

+

400

VPC.0301

Bandwidth name or share_type is invalid.

The specified bandwidth parameter for assigning an EIP is invalid.

+

The specified bandwidth parameter for assigning an EIP is invalid.

Check whether the specified bandwidth parameter is valid.

+

Check whether the specified bandwidth parameter is valid.

400

@@ -729,7 +732,7 @@

VPC.0502

Tenant status is op_restricted.

+

You are not allowed to assign the EIP.

You are not allowed to assign the EIP.

VPC.0503

Creating publicIp failed.

+

Failed to assign the EIP.

Failed to assign the EIP.

VPC.0510

Floatingip has already associated with port.

+

EIP has already been bound to a port.

The EIP has already been bound to another ECS.

VPC.0511

Port has already associated with floatingip.

+

The port has already been bound with an EIP.

The port has already been associated with an EIP.

Release unbound EIPs or try again later.

Querying an EIP

+

Querying an EIP

400

+

400

VPC.0501

Invalid floatingip_id.

Invalid EIP parameters.

+

Invalid EIP parameters.

Check whether the EIP ID is valid.

+

Check whether the EIP ID is valid.

404

@@ -852,44 +855,37 @@

VPC.0514

Neutron Error.

+

Neutron error.

An exception occurs in the IaaS OpenStack system.

Check whether the Neutron service is normal or contact technical support.

Querying EIPs

+

Querying EIPs

400

+

400

VPC.0501

Invalid limit.

Invalid EIP parameters.

+

Invalid EIP parameters.

Check whether the parameter values are valid based on the returned error message and API reference document.

+

Check whether the parameter values are valid based on the returned error message and API reference document.

Releasing an EIP

-

-

-

-

-

-

-

+

Releasing an EIP

400

+

400

VPC.0501

Invalid param.

Invalid EIP parameters.

+

Invalid EIP parameters.

Contact technical support.

+

Contact technical support.

404

@@ -918,7 +914,7 @@

VPC.0513

getElementByKey error.

+

Network resources not found.

Network resources cannot be found.

VPC.0516

Publicip is in used by ELB.

+

EIP is being used by ELB.

Failed to release the EIP because it is being used by a load balancer.

VPC.0517

Floatingip has associated with port, please disassociate it firstly.

+

EIP is bound to a port. Unbind it first.

Failed to release the EIP because it is bound to an ECS.

VPC.0518

Public IP has firewall rules.

+

EIP has firewall rules.

Failed to release the EIP because it is being used by a firewall.

Contact technical support.

Updating an EIP

+

Updating an EIP

400

+

400

VPC.0501

Port id is invalid.

Invalid EIP parameters.

+

Invalid EIP parameters.

Check whether the port ID is valid.

+

Check whether the port ID is valid.

404

@@ -986,7 +982,7 @@

VPC.0509

Floating ip double status is invalid.

+

The port has already been bound with an EIP.

The port has already been associated with an EIP.

VPC.0510

Floatingip has already associated with port.

+

EIP has already been bound to a port.

The EIP has already been bound to another ECS.

VPC.0511

Port has already associated with floatingip.

+

The port has already been bound with an EIP.

Failed to bind the EIP to the ECS because another EIP has already been bound to the ECS.

VPC.0514

Neutron Error.

+

Neutron error.

An exception occurs in the IaaS OpenStack system.

Check whether the Neutron service is normal or contact technical support.

Querying a bandwidth

+

Querying a bandwidth

400

+

400

VPC.0301

getBandwidth error bandwidthId is invalid.

The bandwidth parameters are incorrect.

+

The bandwidth parameters are incorrect.

Check whether the bandwidth ID is valid.

+

Check whether the bandwidth ID is valid.

404

VPC.0306

No Eip bandwidth exist with id.

+

EIP bandwidth with the ID not found.

The bandwidth object does not exist.

VPC.0302

Neutron Error.

+

Neutron error.

An exception occurs in the IaaS OpenStack system.

Check whether the Neutron service is normal or contact technical support.

Querying bandwidths

+

Querying bandwidths

400

+

400

VPC.0301

Get bandwidths error limit is invalid.

The bandwidth parameters are incorrect.

+

The bandwidth parameters are incorrect.

Check whether the parameter values are valid based on the returned error message and API reference document.

+

Check whether the parameter values are valid based on the returned error message and API reference document.

404

VPC.0306

No Eip bandwidth exist with id.

+

EIP bandwidth with the ID not found.

The bandwidth object does not exist.

VPC.0302

Neutron Error.

+

Neutron error.

An exception occurs in the IaaS OpenStack system.

Check whether the Neutron service is normal or contact technical support.

Updating a bandwidth

-

+

Updating a bandwidth

400

+

400

VPC.0301

updateBandwidth input param is invalid.

The bandwidth parameters are incorrect.

+

The bandwidth parameters are incorrect.

Check whether the parameter values are valid based on the returned error message and API reference document.

+

Check whether the parameter values are valid based on the returned error message and API reference document.

500

VPC.0302

Neutron Error.

+

Neutron error.

Failed to obtain underlying resources.

VPC.0305

updateBandwidth error.

+

Bandwidth update error.

An internal error occurs during the bandwidth update.

Contact technical support.

Querying quotas

+

Querying quotas

400

+

400

VPC.1207

resource type is invalid.

+

Invalid resource type.

The specified resource type does not exist.

+

The specified resource type does not exist.

Use an existing resource type.

+

Use an existing resource type.

Assigning a private IP address

-

-

-

+

Assigning a private IP address

500

+

500

VPC.0701

The IP has been used.

+

The IP address is in use.

The private IP address already exists.

+

The private IP address already exists.

Change another private IP address and try again.

+

Change another private IP address and try again.

400

VPC.0705

IP address is not a valid IP for the specified subnet.

+

Invalid IP address for the specified subnet.

Invalid private IP address

VPC.2204

Query resource by id fail.

+

Resource query by ID failed.

The resource does not exist or the permission is insufficient.

VPC.0703

No more IP addresses available on network xxx.

+

No more IP addresses available on network xxx.

Insufficient IP addresses.

Check whether the subnet has sufficient IP addresses.

Querying a Private IP Address

+

Querying a Private IP Address

404

+

404

VPC.0704

Query resource by id fail.

+

Resource query by ID failed.

The private IP address does not exist.

+

The private IP address does not exist.

Check whether the private IP address exists.

+

Check whether the private IP address exists.

Querying Private IP Addresses

+

Querying Private IP Addresses

400

+

400

VPC.0702

query privateIps error.

+

Private IP address query error.

Invalid parameters.

+

Invalid parameters.

Check whether the parameter values are valid based on the returned error message.

+

Check whether the parameter values are valid based on the returned error message.

Releasing a Private IP Address

-

-

+

Releasing a Private IP Address

404

+

404

VPC.0704

Query resource by id fail.

+

Resource query by ID failed.

The private IP address does not exist.

+

The private IP address does not exist.

Check whether the private IP address exists.

+

Check whether the private IP address exists.

500

VPC.0706

Delete port fail.

+

Deleting port failed.

An error occurs when the private IP address is being released.

VPC.0707

privateIp is in use.

+

Private IP address is in use.

The private IP address is in use.

Check whether the private IP address is being used by other resource.

Creating a security group

+

Creating a security group

400

+

400

VPC.0601

Creating securitygroup name is invalid.

+

Invalid security group name.

The parameters of the security group are incorrect.

+

The parameters of the security group are incorrect.

Check whether the parameter values are valid based on the returned error message and API reference document.

+

Check whether the parameter values are valid based on the returned error message and API reference document.

500

@@ -1305,17 +1295,17 @@

Delete the security group that is no longer required or apply for increasing the quota.

Querying a security group

+

Querying a security group

400

+

400

VPC.0601

Securitygroup id is invalid.

The parameters of the security group are incorrect.

+

The parameters of the security group are incorrect.

Check whether the security group ID is valid.

+

Check whether the security group ID is valid.

500

@@ -1333,7 +1323,7 @@

VPC.0603

Securitygroup is not exist.

+

Security group does not exist.

The security group does not exist.

VPC.0612

Neutron Error.

+

Neutron error.

An internal error occurs in the security group.

Contact technical support.

Querying security groups

+

Querying security groups

400

+

400

VPC.0601

Query security groups error limit is invalid.

The parameters of the security group are incorrect.

+

The parameters of the security group are incorrect.

Check whether the parameter values are valid based on the returned error message and API reference document.

+

Check whether the parameter values are valid based on the returned error message and API reference document.

500

@@ -1375,17 +1365,17 @@

Check whether the Neutron service is normal or contact technical support.

Associating multiple NIC ports to or disassociating them from a security group at a time

+

Associating multiple NIC ports to or disassociating them from a security group at a time

400

+

400

VPC.0606

Security group id is invalid

Invalid security group ID.

+

Invalid security group ID.

Use a valid security group ID.

+

Use a valid security group ID.

400

@@ -1498,19 +1488,19 @@

Contact technical support.

Flow log

+

Flow log

400

+

400

VPC.3001

resource could not be found, flowlog id is invalid

Invalid parameters.

+

Invalid parameters.

Check whether the parameters are valid.

+

Check whether the parameters are valid.

400

@@ -1546,17 +1536,17 @@

Contact technical support.

Resource tags

+

Resource tags

400

+

400

VPC.1801

resource id is invalid.

Incorrect resource ID.

+

Incorrect resource ID.

Use a correct resource ID.

+

Use a correct resource ID.

400

@@ -1785,7 +1775,7 @@

VPC.1801

InvalidInput

+

Invalid input.

Incorrect request body format.

Use an existing resource or obtain required permission.

Querying the network IP address usage

+

Querying the network IP address usage

400

+

400

VPC.2301

parameter network_id is invalid.

+

Invalid parameter network_id.

The request parameter is incorrect.

+

The request parameter is incorrect.

Enter a valid network ID.

+

Enter a valid network ID.

400

@@ -1827,17 +1817,17 @@

Ensure that the network ID exists.

Creating a VPC flow log

+

Creating a VPC flow log

400

+

400

VPC.3001

resource_type/log_store_type/traffic_type/log_group_id/log_topic_id is invalid

Incorrect type or ID.

+

Incorrect type or ID.

Check whether the type is supported or whether the ID format is correct.

+

Check whether the type is supported or whether the ID format is correct.

400

@@ -1866,7 +1856,7 @@

VPC.3004

Content of flow log is duplicate: resource type xxx, reousce id xxx, traffic type all, log group id xxx, log topic id xxx, log store type xxx, log store name xxx.

+

Content of flow log is duplicate: resource type xxx, resource id xxx, traffic type all, log group id xxx, log topic id xxx, log store type xxx, log store name xxx.

This VPC flow log already exists.

Try again later or contact technical support.

Querying VPC flow logs

+

Querying VPC flow logs

404

+

404

VPC.3001

resource could not be found, xxx(listParam) is invalid

Invalid parameters.

+

Invalid parameters.

Check whether the parameter format is correct.

+

Check whether the parameter format is correct.

500

@@ -1908,17 +1898,17 @@

Try again later or contact technical support.

Querying a VPC flow log

+

Querying a VPC flow log

404

+

404

VPC.3001

resource could not be found, flowlog id is invalid.

Invalid VPC flow log ID.

+

Invalid VPC flow log ID.

Check whether the VPC flow log ID format is correct.

+

Check whether the VPC flow log ID format is correct.

404

@@ -1932,17 +1922,17 @@

Check whether the VPC flow log exists or whether its ID is correct.

Updating a VPC flow log

+

Updating a VPC flow log

404

+

404

VPC.3001

resource could not be found, flowlog id is invalid.

Invalid VPC flow log ID.

+

Invalid VPC flow log ID.

Check whether the VPC flow log ID format is correct.

+

Check whether the VPC flow log ID format is correct.

404

@@ -1967,17 +1957,17 @@

Try again later or contact technical support.

Deleting a VPC flow log

+

Deleting a VPC flow log

404

+

404

VPC.3001

resource could not be found, flowlog id is invalid.

Invalid VPC flow log ID.

+

Invalid VPC flow log ID.

Check whether the VPC flow log ID format is correct.

+

Check whether the VPC flow log ID format is correct.

404

@@ -2002,6 +1992,365 @@

Try again later or contact technical support.

Querying a VPC (V3)

+

404

+

VPC.9904

+

Vpc xxx could not be found.

+

The queried VPC does not exist.

+

Check whether the VPC to be queried exists.

+

Adding a secondary CIDR block to a VPC (V3)

+

400

+

VPC.9911

+

Invalid CIDR block format.

+

Invalid CIDR block format.

+

Enter a valid CIDR block.

+

400

+

VPC.9912

+

The number of secondary CIDR blocks to be added exceeds the upper limit.

+

The number of secondary CIDR blocks to be added exceeds the upper limit.

+

Check whether there are too many secondary CIDR blocks in the VPC.

+

409

+

VPC.9914

+

The secondary CIDR block conflicts with an existing CIDR block.

+

The secondary CIDR block conflicts with an existing CIDR block.

+

Enter a different secondary CIDR block.

+

400

+

VPC.9916

+

The secondary CIDR block overlaps with a blacklisted CIDR block.

+

The secondary CIDR block overlaps with a blacklisted CIDR block.

+

Enter a secondary CIDR block that is not blacklisted. For details about the secondary CIDR block blacklist, see the API Reference.

+

Removing a secondary CIDR block from a VPC (V3)

+

404

+

VPC.9915

+

The secondary CIDR block to be removed not found.

+

The secondary CIDR block to be removed does not exist.

+

Enter an existing secondary CIDR block.

+

Querying an IP address group

+

404

+

VPC.9904

+

Address_group xxx could not be found.

+

The IP address group does not exist.

+

Check whether the IP address group exists.

+

Creating an IP address group

+

400

+

VPC.9901

+

Duplicate ip_set in request body xxx.

+

The ip_set request body contains duplicate data.

+

Ensure that the ip_set request body does not contain duplicate data.

+

400

+

VPC.9901

+

Invalid ip_set:xxx parameter in request body.

+

Invalid data in the value of parameter ip_set.

+

Ensure that the data in the value of parameter ip_set is valid.

+

409

+

VPC.9905

+

Quota exceeded for resources: 'address_group'.

+

Insufficient IP address group quota.

+

Delete the address groups that are not required or increase the quota.

+

Updating an IP address group

+

400

+

VPC.9901

+

Duplicate ip_set in request body xxx.

+

The ip_set request body contains duplicate data.

+

Ensure that the ip_set request body does not contain duplicate data.

+

400

+

VPC.9901

+

Invalid ip_set:xxx parameter in request body.

+

Invalid data in the value of parameter ip_set.

+

Ensure that the data in the value of parameter ip_set is valid.

+

404

+

VPC.9904

+

Address_group xxx could not be found.

+

The IP address group to be updated does not exist.

+

Check whether the IP address group exists.

+

409

+

VPC.9905

+

Quota exceeded for resources: ['address_group_contain_ipset'].

+

Insufficient IP address group rule quota.

+

Delete rules that are not required from the IP address group or increase the rule quota.

+

Deleting an IP address group

+

404

+

VPC.9904

+

Address_group xxx could not be found.

+

The IP address group to be deleted does not exist.

+

Check whether the IP address group exists.

+

409

+

VPC.9907

+

1. The IP address group is used by a security group rule.\n2. The IP address group is used by a network ACL rule.

+

1. The IP address group is used by a security group rule.

+

2. The IP address group is used by a network ACL rule.

+

Check whether the security group rule or network ACL rule is required. If not, use the API for forcibly deleting the IP address group.

+

Querying a security group (V3)

+

404

+

VPC.9904

+

Security group xxx does not exist.

+

The security group to be queried does not exist.

+

Check whether the security group to be queried exists.

+

Creating a security group (V3)

+

409

+

VPC.9905

+

Quota exceeded for resources: security_group.

+

Insufficient security group quota.

+

Delete the security groups that are not required or increase the quota.

+

Updating a security group (V3)

+

404

+

VPC.9904

+

Security group xxx could not be found.

+

The security group to be updated does not exist.

+

Check whether the security group to be queried exists.

+

Deleting a security group (V3)

+

404

+

VPC.9904

+

Security_group xxx could not be found.

+

The security group to be deleted does not exist.

+

Check whether the security group exists.

+

409

+

VPC.9902

+

Security group xxx is in use.

+

The security group to be deleted is associated with a port.

+

Disassociate the port from the security group and try again.

+

Querying a security group rule (V3)

+

404

+

VPC.9904

+

Security_group_rule xxx could not be found.

+

The security group rule to be queried does not exist.

+

Check whether the security group rule exists.

+

Creating a security group rule (V3)

+

409

+

VPC.9905

+

Quota exceeded for resources: ['security_group_rule'].

+

Insufficient security group rule quota.

+

Delete the security group rules that are not required or increase the quota.

+

404

+

VPC.9904

+

security_group_id xxx could not be found.

+

The security group defined by security_group_id does not exist.

+

Check whether the security group information is correct.

+

404

+

VPC.9904

+

remote security group xxx could not be found.

+

The security group defined by remote_group_id does not exist.

+

Check whether the security group information is correct.

+

404

+

VPC.9904

+

Address group xxx does not exist.

+

The IP address group defined by remote_address_group_id does not exist.

+

Check whether the IP address group information is correct.

+

400

+

VPC.9902

+

Security group rule for ethertype xxx not supported. Allowed values are [IPv4, IPv6].

+

Invalid ethertype value.

+

Modify the request parameter. Enter a valid ethertype value. Supported values are IPv4 and IPv6, which are case insensitive.

+

400

+

VPC.9902

+

Ethertype xxx and address_group ip_version xxx not match

+

The ethertype value in the request is inconsistent with the IP version of the IP address group.

+

Check the IP version of the IP address group defined by remote_address_group_id. The IP address version must be the same as the ethertype value.

+

409

+

VPC.9902

+

Security group rule already exists. Rule id is xxx.

+

The security group rule already exists.

+

Ensure that the specified security group rule does not conflict with existing rules.

+

Deleting a security group rule (V3)

+

404

+

VPC.9904

+

Security_group_rule xxx could not be found.

+

The security group rule to be queried does not exist.

+

Check whether the security group rule exists.

+
diff --git a/docs/eip/api-ref/ListCommonPools.html b/docs/eip/api-ref/ListCommonPools.html index 6d205ee27..c90a4bd80 100644 --- a/docs/eip/api-ref/ListCommonPools.html +++ b/docs/eip/api-ref/ListCommonPools.html @@ -1,7 +1,7 @@

Querying Common Pools

-

Function

This API is used to query common pools. (This API is not supported in eu-nl.)

+

Function

This API is used to query common pools. (This API is not supported in eu-nl.)

URI

GET /v3/{project_id}/eip/publicip-pools/common-pools

@@ -199,7 +199,7 @@

Status Codes

See Status Codes.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/eip/api-ref/ListPublicipsV3.html b/docs/eip/api-ref/ListPublicipsV3.html index 92648e3a6..2e257403d 100644 --- a/docs/eip/api-ref/ListPublicipsV3.html +++ b/docs/eip/api-ref/ListPublicipsV3.html @@ -1,11 +1,11 @@

Querying All EIPs

-

Function

This API is used to query all EIPs. (This API is not supported in eu-nl.)

+

Function

This API is used to query all EIPs.

URI

GET /v3/{project_id}/eip/publicips

-
Table 1 Path parameter

Parameter

+
@@ -565,7 +565,7 @@ - - @@ -721,7 +721,7 @@ - @@ -878,6 +878,15 @@

Maximum length: 36

+ + + +
Table 1 Path parameters

Parameter

Mandatory

String

  • EIP status.
  • The value can be:
    • FREEZED (Frozen)
    • BIND_ERROR (Binding failed)
    • BINDING (Binding)
    • PENDING_DELETE (Releasing)
    • PENDING_CREATE (Assigning)
    • NOTIFYING
    • NOTIFY_DELETE
    • PENDING_UPDATE (Updating)
    • DOWN (Unbound)
    • ACTIVE (Bound)
    • ELB (Bound to a load balancer)
    • VPN (Bound to a VPN)
    • ERROR
    +
  • EIP status.
  • The value can be:
    • FREEZED (Frozen)
    • BIND_ERROR (Binding failed)
    • BINDING (Binding)
    • PENDING_DELETE (Releasing)
    • PENDING_CREATE (Assigning)
    • NOTIFYING (Notify that EIP is assigned)
    • NOTIFY_DELETE (Notify to release an EIP)
    • PENDING_UPDATE (Updating)
    • DOWN (Unbound)
    • ACTIVE (Bound)
    • ELB (Bound to a load balancer)
    • VPN (Bound to a VPN)
    • ERROR (Assignment failed)

Minimum length: 0

Maximum length: 64

@@ -696,7 +696,7 @@

String

  • Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.
  • For details about the dedicated EIP pool, see the APIs about publcip_pool.
+
  • Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.
  • For details about the dedicated EIP pool, see the APIs about publicip_pool.

Minimum length: 0

Maximum length: 64

Boolean

  • Whether an EIP can change its BGP type. If the value is true, the EIP can change its BGP type. If the value is false, the EIP cannot change its BGP type. (The parameter is not displayed by default.)
+
  • Whether an EIP can change its BGP type. If the value is true, the EIP can change its BGP type. If the value is false, the EIP cannot change its BGP type. (The parameter is not displayed by default.)

Enumerated values:

  • true
  • false

port_vif_details

+

String

+
  • Details about the NIC virtual interface.
+

Minimum length: 0

+

Maximum length: 255

+
@@ -1144,8 +1153,7 @@

Example Request

None

Example Response

Status code: 200

-

Normal response to the GET operation

-
{
+
Normal response to the GET operation
{
   "page_info" : {
     "current_count" : 1,
     "next_marker" : "0490aeae-ab8f-4764-b012-45645e9c0aa9",
@@ -1178,7 +1186,8 @@
       "vni" : null,
       "instance_id" : "",
       "instance_type" : "",
-      "port_profile" : null
+      "port_profile" : null,
+      "port_vif_details": ""
     },
     "bandwidth" : {
       "id" : "149ff19b-5de4-4436-958f-2eca39952e93",
@@ -1199,9 +1208,10 @@
   "total_count" : 100
 }
+

Status Codes

See Status Codes.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/eip/api-ref/ShowPublicipV3.html b/docs/eip/api-ref/ShowPublicipV3.html index d89f57f82..ad7078201 100644 --- a/docs/eip/api-ref/ShowPublicipV3.html +++ b/docs/eip/api-ref/ShowPublicipV3.html @@ -1,7 +1,7 @@

Querying EIP Details

-

Function

This API is used to query EIP details. (This API is not supported in eu-nl.)

+

Function

This API is used to query EIP details. (This API is not supported in eu-nl.)

URI

GET /v3/{project_id}/eip/publicips/{publicip_id}

@@ -41,7 +41,7 @@
-
- @@ -641,7 +650,7 @@
  • FREEZED
  • UNFREEZED
- @@ -703,8 +712,7 @@

Example Request

None

Example Response

Status code: 200

-

Normal response to the GET operation

-
{
+
Normal response to the GET operation
{
   "publicip" : {
     "created_at" : "2022-03-17T09:46:22Z",
     "updated_at" : "2022-03-30T02:46:04Z",
@@ -732,7 +740,8 @@
       "vni" : null,
       "instance_id" : "",
       "instance_type" : "",
-      "port_profile" : null
+      "port_profile" : null,
+      "port_vif_details": ""
     },
     "bandwidth" : {
       "id" : "149ff19b-5de4-4436-958f-2eca39952e93",
@@ -752,9 +761,10 @@
   "request_id" : "ce1a33a85d2e105040497a21bbe58c26"
 }
+

Status Codes

See Status Codes.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/eip/api-ref/eip_api05_0001.html b/docs/eip/api-ref/eip_api05_0001.html index 755c26c2f..d10093c37 100644 --- a/docs/eip/api-ref/eip_api05_0001.html +++ b/docs/eip/api-ref/eip_api05_0001.html @@ -24,6 +24,13 @@
+ + + +
Table 2 Query parameter

Parameter

+
@@ -294,7 +294,7 @@ - @@ -319,7 +319,7 @@ - @@ -476,6 +476,15 @@

Maximum length: 36

+ + + +
Table 2 Query parameters

Parameter

Mandatory

String

  • Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.
  • For details about the dedicated EIP pool, see the APIs about publcip_pool.
+
  • Network type of an EIP, including public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.
  • For details about the dedicated EIP pool, see the APIs about publicip_pool.

Minimum length: 0

Maximum length: 64

Boolean

  • Whether an EIP can change its BGP type. If the value is true, the EIP can change its BGP type. If the value is false, the EIP cannot change its BGP type. (The parameter is not displayed by default.)
+
  • Whether an EIP can change its BGP type. If the value is true, the EIP can change its BGP type. If the value is false, the EIP cannot change its BGP type. (The parameter is not displayed by default.)

Enumerated values:

  • true
  • false

port_vif_details

+

String

+
  • Details about the NIC virtual interface.
+

Minimum length: 0

+

Maximum length: 255

+
@@ -596,7 +605,7 @@

Boolean

  • Whether an EIP can change its BGP type. If the value is true, the EIP can change its BGP type. If the value is false, the EIP cannot change its BGP type.
+
  • Whether an EIP can change its BGP type. If the value is true, the EIP can change its BGP type. If the value is false, the EIP cannot change its BGP type.

Enumerated values:

  • true
  • false

bandwith_info

+

bandwidth_info

BandwidthInfoResp object

Specifies the normal response code for the POST operation of the OpenStack Neutron API.

202

+

Accepted

+

Specifies the normal response to the pre-check request of the V3 API.

+

204

No Content

@@ -37,7 +44,7 @@
- diff --git a/docs/eip/api-ref/eip_api06_0001.html b/docs/eip/api-ref/eip_api06_0001.html index 534405f7c..bd604905e 100644 --- a/docs/eip/api-ref/eip_api06_0001.html +++ b/docs/eip/api-ref/eip_api06_0001.html @@ -1,8 +1,11 @@ -

Appendix

-

+ +

Appendix

+ +

+
Table 2 Abnormal values

Returned Value

Description

+

Description

Table 1 EIP and bandwidth metrics

ID

+
- - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + diff --git a/docs/eip/api-ref/eip_api07_0000.html b/docs/eip/api-ref/eip_api07_0000.html index 08045320c..29fb94634 100644 --- a/docs/eip/api-ref/eip_api07_0000.html +++ b/docs/eip/api-ref/eip_api07_0000.html @@ -8,7 +8,39 @@ - + + + + + + + + + + + + + + +
Table 1 EIP and bandwidth metrics

ID

Name

+

Name

Description

+

Description

Value Range

+

Value Range

Monitored Object

+

Unit

Monitoring Interval (Raw Data)

+

Conversion Rule

+

Monitored Object (Dimension)

+

Monitoring Interval (Raw Data)

upstream_bandwidth

+

upstream_bandwidth

Outbound Bandwidth

+

Outbound Bandwidth

Network rate of outbound traffic

-

Unit: bit/s

+

Network rate of outbound traffic

≥ 0 bit/s

+

≥ 0

Bandwidth or EIP

+

bit/s

1 minute

+

1000 (SI)

+

bandwidth_id

+

publicip_id

+

1 minute

downstream_bandwidth

+

downstream_bandwidth

Inbound Bandwidth

+

Inbound Bandwidth

Network rate of inbound traffic

-

Unit: bit/s

+

Network rate of inbound traffic

≥ 0 bit/s

+

≥ 0

Bandwidth or EIP

+

bit/s

1 minute

+

1000 (SI)

+

bandwidth_id

+

publicip_id

+

1 minute

up_stream

+

up_stream

Outbound Traffic

+

Outbound Traffic

Network traffic going out of the cloud platform in a minute

-

Unit: byte

+

Network traffic going out of the cloud platform in a minute

≥ 0 bytes

+

≥ 0

Bandwidth or EIP

+

Byte

1 minute

+

1000 (SI)

+

bandwidth_id

+

publicip_id

+

1 minute

down_stream

+

down_stream

Inbound Traffic

+

Inbound Traffic

Network traffic going into the cloud platform in a minute

-

Unit: byte

+

Network traffic going into the cloud platform in a minute

≥ 0 bytes

+

≥ 0

Bandwidth or EIP

+

Byte

1 minute

+

1000 (SI)

+

bandwidth_id

+

publicip_id

+

1 minute

2023-07-26

+

2026-04-12

+

This release incorporates the following changes:

+ +

2026-03-30

+

This release incorporates the following changes:

+

Restored the project_id, created_at, and updated_at fields in the response example in Assigning a Floating IP Address and Updating a Floating IP Address.

+

Added a request example in Assigning an EIP.

+

2026-03-13

+

This release incorporates the following changes:

+

Deleted the region constraints on using APIs in Querying All EIPs.

+

Added Assigning an EIP and Releasing an EIP.

+

2025-10-24

+

This release incorporates the following changes:

+

Added the public_border_group parameter in Updating a Bandwidth.

+

2023-08-07

+

This release incorporates the following changes:

+

Added description about interconnection with IAM fine-grained authorization in Permissions Policies and Supported Actions.

+

2023-07-26

This release incorporates the following changes:

Added descriptions in the function description in Querying All EIPs, Querying EIP Details, Unbinding an EIP, and Binding an EIP.

@@ -143,7 +175,7 @@

2020-12-16

This release incorporates the following changes:

- +

2020-03-20

@@ -156,7 +188,7 @@

2020-02-25

This release incorporates the following changes:

- +

Added section Bandwidth (V2.0).

2018-09-14

diff --git a/docs/eip/api-ref/eip_apiBandwidth_0001.html b/docs/eip/api-ref/eip_apiBandwidth_0001.html index 0d330c0fd..f38697f2d 100644 --- a/docs/eip/api-ref/eip_apiBandwidth_0001.html +++ b/docs/eip/api-ref/eip_apiBandwidth_0001.html @@ -5,7 +5,7 @@

URI

GET /v1/{project_id}/bandwidths/{bandwidth_id}

Table 1 describes the parameters. -
Table 1 Parameter description

Name

+
@@ -32,12 +32,12 @@ -

Request Message

  • Request parameter

    None

    -
  • Example request
    Get https://{Endpoint}//v1/{project_id}/bandwidths/{bandwidth_id}
    +

    Request Parameters

    • Request parameter

      None

      +
    • Example request
      GET https://{Endpoint}/v1/{project_id}/bandwidths/{bandwidth_id}
    -

    Response Message

    • Response parameter -
Table 1 Parameter description

Parameter

Mandatory

Table 2 Response parameter

Name

+

Response Parameters

  • Response parameter +
    @@ -56,7 +56,7 @@
    Table 2 Response parameter

    Parameter

    Type

    -
    Table 3 Description of the bandwidth field

    Name

    +
    @@ -135,16 +135,14 @@ - - @@ -160,13 +158,24 @@ + + + +
    Table 3 Description of the bandwidth field

    Parameter

    Type

    String

    • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
    • When creating a bandwidth, associate the enterprise project ID with the bandwidth.
    • If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
    -
    NOTE:

    This parameter is unsupported. Do not use it.

    -
    +
    • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
    • When creating a bandwidth, associate the enterprise project ID with the bandwidth.
    • If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.

    status

    String

    • Specifies the bandwidth status.
    • Possible values are as follows:
      • FREEZED (Frozen)
      • NORMAL (Normal)
      +
    • Specifies the bandwidth status.
    • Range:
      • FREEZED (Frozen)
      • NORMAL (Normal)

    String

    • Specifies the time (UTC) when the bandwidth is updated.
    • Format: yyyy-MM-ddTHH:mm:ss
    +

    public_border_group

    +

    String

    +

    Specifies whether it is in a central site or an edge site.

    +

    Range:

    +
    • center
    • Edge site name
    +

    An EIP can only be bound to a resource of the same region.

    +
    -
    Table 4 publicip_info object

    Name

    +
    @@ -192,7 +201,7 @@ - @@ -200,7 +209,8 @@ - @@ -214,6 +224,7 @@ "name": "EIPResourceSetup_1553594229", "size": 5, "share_type": "PER", + "public_border_group": "center", "publicip_info": [ { "publicip_id": "22b02f40-b95f-465a-ae9b-7c8b0f042a41", diff --git a/docs/eip/api-ref/eip_apiBandwidth_0002.html b/docs/eip/api-ref/eip_apiBandwidth_0002.html index e9134ad7b..8fe4c88a8 100644 --- a/docs/eip/api-ref/eip_apiBandwidth_0002.html +++ b/docs/eip/api-ref/eip_apiBandwidth_0002.html @@ -4,68 +4,65 @@

    Function

    This API is used to query bandwidths using search criteria.

    URI

    GET /v1/{project_id}/bandwidths

    -

    Table 1 describes the parameters.

    -
    -

    Request Message

    • Request parameter -
    Table 4 publicip_info object

    Parameter

    Type

    Integer

    • Specifies the IP address version.
    • Possible values are as follows:
      • 4: IPv4
      • 6: IPv6 (IPv6 is not supported currently.)
      +
    • Specifies the IP address version.
    • Range:
      • 4: IPv4
      • 6: IPv6

    String

    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
    • Constraints:
      • The configured value must be supported by the system.
      • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
      +
    • Specifies the EIP type.
    • Range:
      • For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
      • For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
      +
    • Constraints:
      • The configured value must be supported by the system.
      • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
    Table 1 Request parameters

    Name

    +
    Table 1 describes the parameters. +
    - - - - - - - - - - - - - - - - - - -
    Table 1 Parameter description

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Specifies the project ID.

    +

    Specifies the project ID.

    marker

    +

    marker

    No

    +

    No

    String

    +

    String

    Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.

    +

    Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.

    This parameter can work together with the parameter limit.

    -
    • If parameters marker and limit are not passed, resource records on the first page will be returned.
    • If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
    • If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
    • If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
    +
    • If parameters marker and limit are not passed, resource records on the first page will be returned.
    • If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
    • If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
    • If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, 11th to 2,000th resource records will be returned. The default value of limit is 2000.

    limit

    +

    limit

    No

    +

    No

    Integer

    +

    Integer

    Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.

    +

    Specifies the number of records that will be returned on each page. The value is from 0 to 2000. The default value is 2000.

    limit can be used together with marker. For details, see the parameter description of marker.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    • Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project.
    • The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set all_granted_eps.
    -
    NOTE:

    This parameter is unsupported. Do not use it.

    -
    +
    • Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project.
    • The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set all_granted_eps.
    -
  • Example request
    GET https://{Endpoint}/v1/{project_id}/bandwidths?limit={limit}&marker={marker}
    -
  • -

    Response Message

    • Response parameter -
      Table 2 Response parameter

      Name

      + +
      • Example request
        GET https://{Endpoint}/v1/{project_id}/bandwidths?limit={limit}&marker={marker}
        +
      +

      Response Parameters

      • Response parameter +
        @@ -84,7 +81,7 @@
        Table 2 Response parameter

        Parameter

        Type

        -
        Table 3 Description of the bandwidths field

        Name

        +
        @@ -117,7 +114,7 @@ - @@ -165,8 +162,6 @@ + + + + @@ -196,7 +202,7 @@

        -
        Table 3 Description of the bandwidths field

        Parameter

        Type

        String

        • Possible values are as follows:
          • PER: Dedicated bandwidth
          • WHOLE: Shared bandwidth
          +
        • Possible values are as follows:
          • PER: Dedicated bandwidth
          • WHOLE: Shared bandwidth

        If this parameter is not set, the list of all bandwidths will be returned by default.

        String

        • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set all_granted_eps.
        • When creating a bandwidth, associate the enterprise project ID with the bandwidth.
        -
        NOTE:

        This parameter is unsupported. Do not use it.

        -

        status

        @@ -189,6 +184,17 @@

        String

        • Specifies the time (UTC) when the bandwidth is updated.
        • Format: yyyy-MM-ddTHH:mm:ss
        +

        public_border_group

        +

        String

        +

        Specifies whether it is in a central site or an edge site.

        +

        The value can be:

        +
        • center
        • Edge site name
        +

        An EIP can only be bound to a resource of the same region.

        +
        Table 4 publicip_info object

        Name

        +
        @@ -218,11 +224,20 @@ + + + + - @@ -234,15 +249,18 @@ "bandwidths": [ { "id": "09b99c91-da7c-449f-94e2-f4934c5b2a71", - "name": "vpngw-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977", + "name": "test-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977", "size": 200, "share_type": "PER", + "public_border_group": "center", + "created_at": "2024-04-27T00:14:36Z", + "updated_at": "2024-04-27T00:14:36Z", "publicip_info": [ { "publicip_id": "2a65923c-7133-415d-ae3b-cf9635a942c5", "publicip_address": "10.xx.xx.3", "ip_version": 4, - "publicip_type": "5_bgp", + "publicip_type": "5_bgp" } ], "tenant_id": "26ae5181a416420998eb2093aaed84d9", @@ -254,15 +272,18 @@ }, { "id": "0a583ff1-b43e-4000-ade3-e7af0097f832", - "name": "vpngw-7e880d5b-f458-40ad-a7e5-735c44cd8b7d", + "name": "test-7e880d5b-f458-40ad-a7e5-735c44cd8b7d", "size": 300, "share_type": "PER", + "public_border_group": "center", + "created_at": "2024-04-27T00:14:36Z", + "updated_at": "2024-04-27T00:14:36Z", "publicip_info": [ { "publicip_id": "c754bc9a-16d5-4763-9674-d7561917aa80", "publicip_address": "10.xx.xx.9", "ip_version": 4, - "publicip_type": "5_bgp", + "publicip_type": "5_bgp" } ], "tenant_id": "26ae5181a416420998eb2093aaed84d9", @@ -277,12 +298,15 @@ "name": "bandwidth123", "size": 10, "share_type": "PER", + "public_border_group": "center", + "created_at": "2024-04-27T00:14:36Z", + "updated_at": "2024-04-27T00:14:36Z", "publicip_info": [ { "publicip_id": "cec7fb70-2f82-4561-bd83-2121fb642fdc", "publicip_address": "10.xx.xx.184", "ip_version": 4, - "publicip_type": "5_bgp", + "publicip_type": "5_bgp" } ], "tenant_id": "26ae5181a416420998eb2093aaed84d9", @@ -297,12 +321,15 @@ "name": "bandwidth123", "size": 100, "share_type": "PER", + "public_border_group": "center", + "created_at": "2024-04-27T00:14:36Z", + "updated_at": "2024-04-27T00:14:36Z", "publicip_info": [ { "publicip_id": "24232038-e178-40ad-80e4-5abb75db84be", "publicip_address": "10.xx.xx.101", "ip_version": 4, - "publicip_type": "5_bgp", + "publicip_type": "5_bgp" } ], "tenant_id": "26ae5181a416420998eb2093aaed84d9", diff --git a/docs/eip/api-ref/eip_apiBandwidth_0003.html b/docs/eip/api-ref/eip_apiBandwidth_0003.html index 6d8f1eef0..c5e475801 100644 --- a/docs/eip/api-ref/eip_apiBandwidth_0003.html +++ b/docs/eip/api-ref/eip_apiBandwidth_0003.html @@ -5,7 +5,7 @@

        URI

        PUT /v1/{project_id}/bandwidths/{bandwidth_id}

        Table 1 describes the parameters. -
        Table 4 publicip_info object

        Parameter

        Type

        Specifies the obtained EIP if only IPv4 EIPs are available.

        ip_version

        +

        Integer

        +
        • Specifies the IP address version.
        • Possible values are as follows:
          • 4: IPv4
          • 6: IPv6
          +
        +

        publicip_type

        String

        • Specifies the EIP type.
        • The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
        • Constraints:
          • The configured value must be supported by the system.
          • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
          +
        • Specifies the EIP type.
        • Range:
          • For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
          • For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
          +
        • Constraints:
          • The configured value must be supported by the system.
          • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
        Table 1 Parameter description

        Name

        +
        @@ -32,8 +32,8 @@ -

        Request Message

        • Request parameter -
        Table 1 Parameter description

        Parameter

        Mandatory

        Table 2 Request parameter

        Name

        +

        Request Parameters

        • Request parameter +
          @@ -56,7 +56,7 @@
          Table 2 Request parameter

          Parameter

          Mandatory

          -
          Table 3 Description of the bandwidth field

          Name

          +
          @@ -81,7 +81,7 @@ - @@ -99,8 +99,8 @@ } -

          Response Message

          • Response parameter -
          Table 3 Description of the bandwidth field

          Parameter

          Mandatory

          Integer

          • Specifies the bandwidth size in Mbit/s.
          • The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) If the parameter is not included, the bandwidth size is not changed.
          • Either parameter name or size must be specified.
          • If a decimal fraction (for example 10.2) or a character string (for example "10") is specified, the specified value will be automatically converted to an integer.
          • The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
            • The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
            • The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
            • The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
            +
          • Specifies the bandwidth size in Mbit/s.
          • The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) If the parameter is not included, the bandwidth size is not changed.
          • Either parameter name or size must be specified.
          • If a decimal fraction (for example 10.2) or a character string (for example "10") is specified, the specified value will be automatically converted to an integer.
          • The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
            • The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
            • The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
            • The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
          Table 4 Response parameter

          Name

          +

          Response Parameters

          • Response parameter +
            @@ -119,7 +119,7 @@
            Table 4 Response parameter

            Parameter

            Type

            -
            Table 5 Description of the bandwidth field

            Name

            +
            @@ -152,7 +152,7 @@ - @@ -199,15 +199,13 @@ - @@ -223,13 +221,24 @@ + + + +
            Table 5 Description of the bandwidth field

            Parameter

            Type

            String

            • Possible values are as follows:
              • PER: Dedicated bandwidth
              • WHOLE: Shared bandwidth
              +
            • Range:
              • PER: Dedicated bandwidth
              • WHOLE: Shared bandwidth

            String

            • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set all_granted_eps.
            • When creating a bandwidth, associate the enterprise project ID with the bandwidth.
            -
            NOTE:

            This parameter is unsupported. Do not use it.

            -

            status

            String

            • Specifies the bandwidth status.
            • Possible values are as follows:
              • FREEZED (Frozen)
              • NORMAL (Normal)
              +
            • Specifies the bandwidth status.
            • Range:
              • FREEZED (Frozen)
              • NORMAL (Normal)

            String

            • Specifies the time (UTC) when the bandwidth is updated.
            • Format: yyyy-MM-ddTHH:mm:ss
            +

            public_border_group

            +

            String

            +

            Specifies whether it is in a central site or an edge site.

            +

            Range:

            +
            • center
            • Edge site name
            +

            An EIP can only be bound to a resource of the same region.

            +
            -
            Table 6 publicip_info objects

            Name

            +
            @@ -251,11 +260,20 @@ + + + + - @@ -269,6 +287,9 @@ "name": "bandwidth123", "size": 10, "share_type": "PER", + "public_border_group": "center", + "created_at": "2024-04-27T00:14:36Z", + "updated_at": "2024-04-27T00:14:36Z", "publicip_info": [ { "publicip_id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0", diff --git a/docs/eip/api-ref/eip_api_0001.html b/docs/eip/api-ref/eip_api_0001.html index 44c15680d..fd09466d9 100644 --- a/docs/eip/api-ref/eip_api_0001.html +++ b/docs/eip/api-ref/eip_api_0001.html @@ -2,15 +2,15 @@

            Assigning an EIP

            Function

            This API is used to assign an EIP.

            -

            The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSs, BMSs, virtual IP addresses, NAT gateways, or load balancers.

            -
            Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
            • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
            • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
              • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
              • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
              • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
              • You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
              -
            • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
            +

            The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be flexibly bound to or unbound from ECSs, BMSs, virtual IP addresses, NAT gateways, or load balancers.

            +
            Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
            • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
            • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
              • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
              • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
              • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
              • You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.
              +
            • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.

            URI

            POST /v1/{project_id}/publicips

            Table 1 describes the parameters. -
            Table 6 publicip_info objects

            Parameter

            Type

            Specifies the obtained EIP if only IPv4 EIPs are available.

            ip_version

            +

            Integer

            +
            • Specifies the IP address version.
            • Range:
              • 4: IPv4
              • 6: IPv6
              +
            +

            publicip_type

            String

            • Specifies the EIP type.
            • The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
            • Constraints:
              • The configured value must be supported by the system.
              • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
              +
            • Specifies the EIP type.
            • Range:
              • For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
              • For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
              +
            • Constraints:
              • The configured value must be supported by the system.
              • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
            Table 1 Parameter description

            Name

            +
            @@ -31,7 +31,7 @@

            Request Parameters

            -
            Table 1 Parameter description

            Parameter

            Mandatory

            Table 2 Request body parameter

            Name

            +
            @@ -59,57 +59,56 @@ - - - - -
            Table 2 Request body parameter

            Parameter

            Mandatory

            Specifies the bandwidth object. For details, see Table 4.

            enterprise_project_id

            -

            No

            -

            String

            -
            • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
            • When you assign an EIP, associate an enterprise project ID with the EIP.
            • If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
            -
            NOTE:

            This parameter is unsupported. Do not use it.

            -
            -
            -
            Table 3 Description of the publicip field

            Name

            +
            - - - - - - - - - - - + + + + +
            Table 3 Description of the publicip field

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            type

            +

            type

            Yes

            +

            Yes

            String

            +

            String

            • Specifies the EIP type.
            • The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
            • Constraints:
              • The configured value must be supported by the system.
              • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
              +
            • Specifies the EIP type.
            • Range:
              • For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
              • For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
              +
            • Constraints:
              • The configured value must be supported by the system.
              • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.

            ip_version

            +

            ip_version

            No

            +

            No

            Integer

            +

            Integer

            • Specifies the EIP version.
            • The value can be 4 and 6, indicating IPv4 address and IPv6 address, respectively. IPv6 is not supported currently.
            • Constraints:
              • The configured value must be supported by the system.
              • If this parameter is left blank or is an empty string, IPv4 address is created by default.
              +
            • Specifies the EIP version.
            • The value can be 4 and 6, indicating IPv4 address and IPv6 address, respectively. IPv6 is not supported currently.
            • Constraints:
              • The configured value must be supported by the system.
              • If this parameter is left blank or is an empty string, IPv4 address is created by default.

            alias

            +

            No

            +

            String

            +
            • Specifies the EIP name.
            • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
            +
            -
            Table 4 Description of the bandwidth field

            Name

            +
            @@ -134,7 +133,7 @@ - @@ -153,7 +152,7 @@ - @@ -163,13 +162,14 @@ -
            Table 4 Description of the bandwidth field

            Parameter

            Mandatory

            Integer

            • Specifies the bandwidth size.
            • The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.)
            • This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified.
            • The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
              • The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
              • The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
              • The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
              +
            • Specifies the bandwidth size.
            • The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.)
            • This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified.
            • The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
              • The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
              • The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
              • The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.

            String

            • Specifies the bandwidth type.
            • Possible values are as follows:
              • PER: Dedicated bandwidth
              • WHOLE: Shared bandwidth
              +
            • Specifies the bandwidth type.
            • Range:
              • PER: Dedicated bandwidth
              • WHOLE: Shared bandwidth
            • If this parameter is set to WHOLE, the bandwidth ID must be specified.

            String

            • The value is traffic, indicating that the billing is based on traffic.
            +
            • Specifies whether the bandwidth is billed by traffic or by bandwidth size.
            • The value is traffic, indicating that the billing is based on traffic.
            -
            • Example request (IPv4 EIP with dedicated bandwidth)
              POST https://{Endpoint}/v1/{project_id}/publicips
              +
              +

              Example Request

              Example request (IPv4 EIP with dedicated bandwidth)
              POST https://{Endpoint}/v1/{project_id}/publicips
               
               {
                   "publicip": {
              @@ -180,113 +180,134 @@
                       "name": "bandwidth123",
                       "size": 10,
                       "share_type": "PER"
              -    },
              -    "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
              +    }
               }
              -
            -

            Response Message

            • Response parameter -
              Table 5 Response parameter

              Name

              + +

              Response Parameters

              • Response parameter +
                - - - - -
                Table 5 Response parameter

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                publicip

                +

                publicip

                publicip object

                +

                publicip object

                Specifies the EIP object. For details, see Table 6.

                +

                Specifies the EIP object. For details, see Table 6.

                -
                Table 6 Description of the publicip field

                Name

                +
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
                Table 6 Description of the publicip field

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                id

                +

                id

                String

                +

                String

                Specifies the unique identifier of an EIP.

                +

                Specifies the unique identifier of an EIP.

                status

                +

                status

                String

                +

                String

                • Specifies the EIP status.
                • Possible values are as follows:
                  • FREEZED (Frozen)
                  • BIND_ERROR (Binding failed)
                  • BINDING (Binding)
                  • PENDING_DELETE (Releasing)
                  • PENDING_CREATE (Assigning)
                  • PENDING_UPDATE (Updating)
                  • NOTIFYING (Assigning)
                  • NOTIFY_DELETE (Release)
                  • DOWN (Unbound)
                  • ACTIVE (Bound)
                  • ELB (Bound to a load balancer)
                  • VPN (Bound to a VPN)
                  • ERROR (Exceptions)
                  +
                • Specifies the EIP status.
                • Range:
                  • FREEZED (Frozen)
                  • BIND_ERROR (Binding failed)
                  • BINDING (Binding)
                  • PENDING_DELETE (Releasing)
                  • PENDING_CREATE (Assigning)
                  • PENDING_UPDATE (Updating)
                  • NOTIFYING (Assigning)
                  • NOTIFY_DELETE (Release)
                  • DOWN (Unbound)
                  • ACTIVE (Bound)
                  • ELB (Bound to a load balancer)
                  • VPN (Bound to a VPN)
                  • ERROR (Exceptions)

                type

                +

                type

                String

                +

                String

                • Specifies the EIP type.
                • The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
                • Constraints:
                  • The configured value must be supported by the system.
                  • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
                  +
                • Specifies the EIP type.
                • Range:
                  • For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
                  • For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
                  +
                • Constraints:
                  • The configured value must be supported by the system.
                  • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.

                public_ip_address

                +

                public_ip_address

                String

                +

                String

                Specifies the obtained EIP if only IPv4 EIPs are available.

                +

                Specifies the obtained EIP if only IPv4 EIPs are available.

                ip_version

                +

                ip_version

                Integer

                +

                Integer

                Specifies the IP address version. The value can be 4 or 6.

                +

                Specifies the IP address version. The value can be 4 or 6.

                • 4: IPv4
                • 6: IPv6 (IPv6 is not supported currently.)

                tenant_id

                +

                tenant_id

                String

                +

                String

                Specifies the project ID.

                +

                Specifies the project ID.

                create_time

                +

                create_time

                String

                +

                String

                Specifies the time (UTC) when the EIP is assigned.

                +

                Specifies the time (UTC) when the EIP is assigned.

                +

                Format: yyyy-MM-dd HH:mm:ss

                bandwidth_size

                +

                bandwidth_size

                Integer

                +

                Integer

                Specifies the bandwidth (Mbit/s).

                +

                Specifies the bandwidth (Mbit/s).

                enterprise_project_id

                +

                alias

                String

                +

                String

                • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
                • When you assign an EIP, associate an enterprise project ID with the EIP.
                • If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
                -
                NOTE:

                This parameter is unsupported. Do not use it.

                -
                +

                Specifies the EIP name.

                +

                enterprise_project_id

                +

                String

                +
                • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
                • When you assign an EIP, associate an enterprise project ID with the EIP.
                • If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
                +

                public_border_group

                +

                String

                +

                Specifies whether it is in a central site or an edge site.

                +

                Range:

                +
                • center
                • Edge site name
                +

                This resource can only be associated with an EIP of the same region.

                +
                -
              • Example response (IPv4 EIP with dedicated bandwidth)
                {
                +
              • + +

                Example Response

                Example response (IPv4 EIP with dedicated bandwidth)
                {
                     "publicip": {
                         "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706",
                +        "alias": "tom",
                +        "public_border_group": "center",
                         "status": "PENDING_CREATE",
                         "type": "5_bgp",
                         "public_ip_address": "161.xx.xx.7",
                @@ -294,10 +315,10 @@
                         "ip_version": 4,
                         "create_time": "2015-07-16 04:10:52",
                         "bandwidth_size": 0,
                -        "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
                +        "enterprise_project_id": "b261ac1f-2489-4bc7-b31b-c33c3346a439"
                     }
                 }
                - +

                Status Code

                See Status Codes.

                diff --git a/docs/eip/api-ref/eip_api_0002.html b/docs/eip/api-ref/eip_api_0002.html index 956977875..a48f99768 100644 --- a/docs/eip/api-ref/eip_api_0002.html +++ b/docs/eip/api-ref/eip_api_0002.html @@ -2,14 +2,14 @@

                Querying an EIP

                Function

                This API is used to query a specific EIP.

                -
                Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
                • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
                • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
                  • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
                  • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
                  • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
                  • You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
                  -
                • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
                +
                Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
                • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
                • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
                  • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
                  • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
                  • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
                  • You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.
                  +
                • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.

                URI

                GET /v1/{project_id}/publicips/{publicip_id}

                Table 1 describes the parameters. -
                Table 1 Parameter description

                Name

                +
                @@ -36,12 +36,12 @@ -

                Request Message

                • Request parameter

                  None

                  -
                • Example request
                  Get https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}
                  +

                  Request Parameters

                  • Request parameter

                    None

                    +
                  • Example request
                    GET https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}
                  -

                  Response Message

                  • Response parameter -
                Table 1 Parameter description

                Parameter

                Mandatory

                Table 2 Response parameter

                Name

                +

                Response Parameters

                • Response parameter +
                  @@ -60,7 +60,7 @@
                  Table 2 Response parameter

                  Parameter

                  Type

                  -
                  Table 3 Description of the publicip field

                  Name

                  +
                  @@ -95,7 +95,8 @@ - @@ -119,7 +120,7 @@ @@ -128,7 +129,7 @@ @@ -144,6 +145,7 @@ + + + + + + + + + + + + + + + +
                  Table 3 Description of the publicip field

                  Parameter

                  Type

                  String

                  • Specifies the EIP type.
                  • The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
                  • Constraints:
                    • The configured value must be supported by the system.
                    • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
                    +
                  • Specifies the EIP type.
                  • Range:
                    • For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
                    • For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
                    +
                  • Constraints:
                    • The configured value must be supported by the system.
                    • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.

                  String

                  • Specifies the private IP address bound to the EIP.
                  • This parameter is returned only if the private IP address is bound to the EIP.
                  -
                  NOTE:

                  The value of private_ip_address is null if the EIP is bound to a dedicated load balancer.

                  +
                  NOTE:

                  This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS.

                  String

                  • Specifies the port ID.
                  • This parameter is returned only when a port is associated with the EIP.
                  -
                  NOTE:

                  The value of port_id is null if the EIP is bound to a dedicated load balancer.

                  +
                  NOTE:

                  The value of port_id is null if the EIP is bound to a dedicated load balancer.

                  String

                  Specifies the time (UTC) when the EIP is assigned.

                  +

                  Format: yyyy-MM-dd HH:mm:ss

                  bandwidth_id

                  @@ -175,6 +177,13 @@

                  Specifies the bandwidth name.

                  alias

                  +

                  String

                  +

                  Specifies the EIP name.

                  +

                  enterprise_project_id

                  String

                  @@ -184,11 +193,37 @@

                  public_border_group

                  +

                  String

                  +

                  Specifies whether it is in a central site or an edge site.

                  +

                  The value can be:

                  +
                  • center
                  • Edge site name
                  +

                  An EIP can only be bound to a resource of the same region.

                  + +

                  allow_share_bandwidth_types

                  +

                  Array of strings

                  +

                  Specifies types of the shared bandwidth that an EIP can be added to. If this parameter is left blank, the EIP cannot be added to any shared bandwidth.

                  +

                  The EIP can be added only to the shared bandwidth of these types.

                  +

                  tags

                  +

                  Array of strings

                  +

                  Specifies the list of tags. The list elements are in the format of key=value.

                  +
                  -
                  Table 4 Description of the profile field

                  Name

                  +
                  @@ -227,12 +262,45 @@
                  Table 4 Description of the profile field

                  Parameter

                  Type

                  + +
                  + + + + + + + + + + + + + +
                  Table 5 ResourceTagResp

                  Parameter

                  +

                  Type

                  +

                  Description

                  +

                  key

                  +

                  String

                  +
                  • Tag key
                  • Constraints:
                    • Cannot be left blank.
                    • Can contain a maximum of 36 characters.
                    • Can contain letters and special characters, including hyphens (-), underscores (_), and at signs (@).
                    • The tag key of an EIP must be unique.
                    +
                  +

                  Minimum length: 0

                  +

                  Maximum length: 36

                  +

                  value

                  +

                  String

                  +
                  • Tag value
                  • Constraints:
                    • Can contain a maximum of 43 characters.
                    • Can contain letters and special characters, including hyphens (-), underscores (_), and at signs (@).
                    • The tag key of an EIP must be unique.
                    +
                  +

                  Minimum length: 0

                  +

                  Maximum length: 43

                  +
                  +
                  • Example response
                    {
                         "publicip": {
                             "id": "2ec9b78d-9368-46f3-8f29-d1a95622a568",
                             "status": "DOWN",
                    +        "alias": "tom",
                             "profile": {},
                             "type": "5_bgp",
                             "public_ip_address": "161.xx.xx.12",
                    diff --git a/docs/eip/api-ref/eip_api_0003.html b/docs/eip/api-ref/eip_api_0003.html
                    index 58922528c..c027d97f0 100644
                    --- a/docs/eip/api-ref/eip_api_0003.html
                    +++ b/docs/eip/api-ref/eip_api_0003.html
                    @@ -2,14 +2,14 @@
                     
                     

                    Querying EIPs

                    Function

                    This API is used to query EIPs.

                    -
                    Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
                    • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
                    • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
                      • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
                      • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
                      • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
                      • You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
                      -
                    • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
                    +
                    Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
                    • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
                    • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
                      • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
                      • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
                      • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
                      • You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.
                      +
                    • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.

                    URI

                    GET /v1/{project_id}/publicips

                    Table 1 describes the parameters. -
                    Table 1 Parameter description

                    Name

                    +
                    @@ -36,7 +36,7 @@ - @@ -65,12 +65,12 @@ -

                    Request Message

                    • Request parameter

                      None

                      +

                      Request Parameters

                      • Request parameter

                        None

                      • Example request
                        GET https://{Endpoint}/v1/{project_id}/publicips?limit={limit}&marker={marker}
                      -

                      Response Message

                      • Response parameter -
                    Table 1 Parameter description

                    Parameter

                    Mandatory

                    Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.

                    This parameter can work together with the parameter limit.

                    -
                    • If parameters marker and limit are not passed, resource records on the first page will be returned.
                    • If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
                    • If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
                    • If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
                    +
                    • If parameters marker and limit are not passed, resource records on the first page will be returned.
                    • If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
                    • If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
                    • If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, 11th to 2,000th resource records will be returned. The default value of limit is 2000.

                    limit

                    @@ -45,7 +45,7 @@

                    Integer

                    Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.

                    +

                    Specifies the number of records that will be returned on each page. The value is from 0 to 2000. The default value is 2000.

                    limit can be used together with marker. For details, see the parameter description of marker.

                    Table 2 Response parameter

                    Name

                    +

                    Response Parameters

                    • Response parameter +
                      @@ -89,7 +89,7 @@
                      Table 2 Response parameter

                      Parameter

                      Type

                      -
                      Table 3 Description of the publicips field

                      Name

                      +
                      @@ -124,7 +124,8 @@ - @@ -148,7 +149,7 @@ @@ -157,7 +158,7 @@ @@ -173,6 +174,7 @@ + + + + + + + + + + + + + + + +
                      Table 3 Description of the publicips field

                      Parameter

                      Type

                      String

                      • Specifies the EIP type.
                      • The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
                      • Constraints:
                        • The configured value must be supported by the system.
                        • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
                        +
                      • Specifies the EIP type.
                      • Range:
                        • For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
                        • For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
                        +
                      • Constraints:
                        • The configured value must be supported by the system.
                        • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.

                      String

                      • Specifies the private IP address bound to the EIP.
                      • This parameter is returned only if the private IP address is bound to the EIP.
                      -
                      NOTE:

                      The value of private_ip_address is null if the EIP is bound to a dedicated load balancer.

                      +
                      NOTE:

                      This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS.

                      String

                      • Specifies the port ID.
                      • This parameter is returned only when a port is associated with the EIP.
                      -
                      NOTE:

                      The value of port_id is null if the EIP is bound to a dedicated load balancer.

                      +
                      NOTE:

                      The value of port_id is null if the EIP is bound to a dedicated load balancer.

                      String

                      Specifies the time (UTC) when the EIP is assigned.

                      +

                      Format: yyyy-MM-dd HH:mm:ss

                      bandwidth_id

                      @@ -204,6 +206,13 @@

                      Specifies the bandwidth name.

                      alias

                      +

                      String

                      +

                      Specifies the EIP name.

                      +

                      enterprise_project_id

                      String

                      @@ -213,11 +222,36 @@

                      public_border_group

                      +

                      String

                      +

                      Specifies whether it is in a central site or an edge site.

                      +

                      The value can be:

                      +
                      • center
                      • Edge site name
                      +

                      An EIP can only be bound to a resource of the same region.

                      + +

                      allow_share_bandwidth_types

                      +

                      Array of strings

                      +
                      • Specifies the types of the shared bandwidth to which the EIP can be added.
                      • If the list is empty, the EIP cannot be added to any shared bandwidth.
                      • The EIP can be added only to the shared bandwidth of these types.
                      +

                      tags

                      +

                      Array of strings

                      +

                      Specifies the list of tags. The list elements are in the format of key=value.

                      +
                      -
                      Table 4 Description of the profile field

                      Name

                      +
                      @@ -256,11 +290,44 @@
                      Table 4 Description of the profile field

                      Parameter

                      Type

                      + +
                      + + + + + + + + + + + + + +
                      Table 5 ResourceTagResp

                      Parameter

                      +

                      Type

                      +

                      Description

                      +

                      key

                      +

                      String

                      +
                      • Tag name
                      • Constraints:
                        • Cannot be left blank.
                        • Can contain a maximum of 36 characters.
                        • Can contain letters and special characters, including hyphens (-), underscores (_), and at signs (@).
                        • The tag key of an EIP must be unique.
                        +
                      +

                      Minimum length: 0

                      +

                      Maximum length: 36

                      +

                      value

                      +

                      String

                      +
                      • Tag value
                      • Constraints:
                        • Can contain a maximum of 43 characters.
                        • Can contain letters and special characters, including hyphens (-), underscores (_), and at signs (@).
                        • The tag key of an EIP must be unique.
                        +
                      +

                      Minimum length: 0

                      +

                      Maximum length: 43

                      +
                      +
                    • Example response
                      {
                           "publicips": [
                               {
                                   "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                                   "status": "DOWN",
                      +            "alias": "tom",
                                   "profile": {},
                                   "type": "5_bgp",
                                   "public_ip_address": "161.xx.xx.9",
                      diff --git a/docs/eip/api-ref/eip_api_0004.html b/docs/eip/api-ref/eip_api_0004.html
                      index f90176b68..1b77ae40e 100644
                      --- a/docs/eip/api-ref/eip_api_0004.html
                      +++ b/docs/eip/api-ref/eip_api_0004.html
                      @@ -2,14 +2,14 @@
                       
                       

                      Updating an EIP

                      Function

                      This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC.

                      -
                      Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
                      • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
                      • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
                        • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
                        • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
                        • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
                        • You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
                        -
                      • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
                      +
                      Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
                      • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
                      • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
                        • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
                        • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
                        • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
                        • You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.
                        +
                      • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.

                      URI

                      PUT /v1/{project_id}/publicips/{publicip_id}

                      Table 1 describes the parameters. -
                      Table 1 Parameter description

                      Name

                      +
                      @@ -36,8 +36,8 @@ -

                      Request Message

                      • Request parameter -
                      Table 1 Parameter description

                      Parameter

                      Mandatory

                      Table 2 Request parameter

                      Name

                      +

                      Request Parameters

                      • Request parameter +
                        @@ -60,7 +60,7 @@
                        Table 2 Request parameter

                        Parameter

                        Mandatory

                        -
                        Table 3 Description of the publicip field

                        Name

                        +
                        @@ -80,6 +80,15 @@ + + + + +
                        Table 3 Description of the publicip field

                        Parameter

                        Mandatory

                        alias

                        +

                        No

                        +

                        String

                        +
                        • Specifies the EIP name.
                        • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
                        +
                        @@ -92,8 +101,8 @@ } -

                        Response Message

                        • Response parameter -
                          Table 4 Response parameter

                          Name

                          +

                          Response Parameters

                          • Response parameter +
                            @@ -112,7 +121,7 @@
                            Table 4 Response parameter

                            Parameter

                            Type

                            -
                            Table 5 Description of the publicips field

                            Name

                            +
                            @@ -147,7 +156,8 @@ - @@ -171,7 +181,7 @@ @@ -180,7 +190,7 @@ @@ -196,6 +206,7 @@ + + + + + + + +
                            Table 5 Description of the publicips field

                            Parameter

                            Type

                            String

                            • Specifies the EIP type.
                            • The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
                            • Constraints:
                              • The configured value must be supported by the system.
                              • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
                              +
                            • Specifies the EIP type.
                            • Range:
                              • For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
                              • For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
                              +
                            • Constraints:
                              • The configured value must be supported by the system.
                              • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.

                            String

                            • Specifies the private IP address bound to the EIP.
                            • This parameter is returned only when a port is associated with the EIP.
                            -
                            NOTE:

                            The value of private_ip_address is null if the EIP is bound to a dedicated load balancer.

                            +
                            NOTE:

                            This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS.

                            String

                            • Specifies the port ID.
                            • This parameter is returned only when a port is associated with the EIP.
                            -
                            NOTE:

                            The value of port_id is null if the EIP is bound to a dedicated load balancer.

                            +
                            NOTE:

                            The value of port_id is null if the EIP is bound to a dedicated load balancer.

                            String

                            Specifies the time (UTC) when the EIP is assigned.

                            +

                            Format: yyyy-MM-dd HH:mm:ss

                            bandwidth_id

                            @@ -220,6 +231,13 @@

                            alias

                            +

                            String

                            +

                            Specifies the EIP name.

                            +

                            enterprise_project_id

                            String

                            @@ -227,13 +245,24 @@
                            • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
                            • When you assign an EIP, associate an enterprise project ID with the EIP.
                            • If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
                            NOTE:

                            This parameter is unsupported. Do not use it.

                            +

                            public_border_group

                            +

                            String

                            +

                            Specifies whether it is in a central site or an edge site.

                            +

                            The value can be:

                            +
                            • center
                            • Edge site name
                            +

                            An EIP can only be bound to a resource of the same region.

                            +
                            -
                            Table 6 Description of the profile field

                            Name

                            +
                            @@ -276,6 +305,7 @@ "publicip": { "id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb", "status": "ACTIVE", + "alias": "tom", "profile": {}, "type": "5_bgp", "port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe", diff --git a/docs/eip/api-ref/eip_api_0005.html b/docs/eip/api-ref/eip_api_0005.html index 0a2f5c2fe..ed4f487e7 100644 --- a/docs/eip/api-ref/eip_api_0005.html +++ b/docs/eip/api-ref/eip_api_0005.html @@ -2,14 +2,14 @@

                            Releasing an EIP

                            Function

                            This API is used to release an EIP.

                            -
                            Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
                            • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
                            • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
                              • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
                              • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
                              • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
                              • You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
                              -
                            • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
                            +
                            Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:
                            • In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
                            • Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
                              • The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
                              • You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
                              • EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
                              • You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.
                              +
                            • Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.

                            URI

                            DELETE /v1/{project_id}/publicips/{publicip_id}

                            Table 1 describes the parameters. -
                            Table 6 Description of the profile field

                            Parameter

                            Type

                            Table 1 Parameter description

                            Name

                            +
                            @@ -36,11 +36,11 @@ -

                            Request Message

                            • Request parameter

                              None

                              +

                              Request Parameters

                              • Request parameter

                                None

                              • Example request
                                DELETE https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}
                              -

                              Response Message

                              • Response parameter

                                None

                                +

                                Response Parameters

                                • Response parameter

                                  None

                                • Example response

                                  None

                                  Or

                                  {
                                  diff --git a/docs/eip/api-ref/eip_apieg_0002.html b/docs/eip/api-ref/eip_apieg_0002.html
                                  index d6c22b78e..db76f9077 100644
                                  --- a/docs/eip/api-ref/eip_apieg_0002.html
                                  +++ b/docs/eip/api-ref/eip_apieg_0002.html
                                  @@ -3,11 +3,11 @@
                                   

                                  Binding an EIP to an ECS

                                  Scenarios

                                  This section describes how to bind an EIP to an ECS by calling APIs.

                                  -

                                  Prerequisites

                                  • You have created an ECS. For details, see section "Purchasing an ECS with Customized Configurations" in the Elastic Cloud Server User Guide.
                                  • If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header when making an API call.

                                    The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequent calling.

                                    +

                                    Prerequisites

                                    • You have created an ECS. For details, see section "Creating an ECS in Custom Config Mode" in the Elastic Cloud Server User Guide.
                                    • If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header when making an API call.

                                      The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequent calling.

                                    -

                                    Procedure

                                    1. Obtain the NIC information based on the ECS ID. For details, see section "Querying a Port" in the Virtual Private Cloud API Reference.
                                      1. Send GET https://VPC endpoint/v1/project_id/ports?device_id=ecs_id. Parameter project_id indicates the project ID.
                                      2. Add X-Auth-Token to the request header.
                                      3. Check the response message.
                                        • The request is successful if the following response is displayed.
                                          { 
                                          +

                                          Procedure

                                          1. Obtain the NIC information based on the ECS ID. For details, see section "Querying a Port" in the Virtual Private Cloud API Reference.
                                            1. Send GET https://VPC endpoint/v1/project_id/ports?device_id=ecs_id. Parameter project_id indicates the project ID.
                                            2. Add X-Auth-Token to the request header.
                                            3. Check the response message.
                                              • The request is successful if the following response is displayed.
                                                { 
                                                      "ports": [{ 
                                                          "id": "02c72193-efec-42fb-853b-c33f2b802467", 
                                                          "name": "", 
                                                diff --git a/docs/eip/api-ref/eip_apieg_0003.html b/docs/eip/api-ref/eip_apieg_0003.html
                                                index 1aa1340d3..3ec4e6a86 100644
                                                --- a/docs/eip/api-ref/eip_apieg_0003.html
                                                +++ b/docs/eip/api-ref/eip_apieg_0003.html
                                                @@ -3,7 +3,7 @@
                                                 

                                                Unbinding an EIP from an ECS

                                                Scenarios

                                                This section describes how to unbind an EIP from an ECS by calling APIs.

                                                -

                                                Prerequisites

                                                • You have created an ECS. For details, see section "Purchasing an ECS with Customized Configurations" in the Elastic Cloud Server User Guide.
                                                • If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header when making an API call.

                                                  The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequent calling.

                                                  +

                                                  Prerequisites

                                                  • You have created an ECS. For details, see section "Creating an ECS in Custom Config Mode" in the Elastic Cloud Server User Guide.
                                                  • If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header when making an API call.

                                                    The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequent calling.

                                                  diff --git a/docs/eip/api-ref/eip_apifloatip_0001.html b/docs/eip/api-ref/eip_apifloatip_0001.html index f68509bfc..0e49bb715 100644 --- a/docs/eip/api-ref/eip_apifloatip_0001.html +++ b/docs/eip/api-ref/eip_apifloatip_0001.html @@ -85,14 +85,23 @@
                            + + + + +
                            Table 1 Parameter description

                            Parameter

                            Mandatory

                            Specifies the project ID.

                            project_id

                            +

                            No

                            +

                            String

                            +

                            Specifies the project ID.

                            +
                            -

                            Request Message

                            • Request parameter

                              None

                              +

                              Request Parameters

                              • Request parameter

                                None

                              • Example request

                                None

                              -

                              Response Message

                              • Response parameter
                              +

                              Response Parameters

                              • Response parameter
                              @@ -178,6 +187,29 @@ + + + + + + + + + + + +
                              Table 2 Response parameter

                              Parameter

                              Specifies the project ID.

                              project_id

                              +

                              String

                              +

                              Specifies the project ID.

                              +

                              created_at

                              +

                              String

                              +

                              Specifies the time when the resource was created.

                              +

                              Format: yyyy-MM-ddTHH:mm:ss

                              +

                              updated_at

                              +

                              String

                              +

                              Specifies the time when the resource was updated.

                              +

                              Format: yyyy-MM-ddTHH:mm:ss

                              +

                              floatingips_links

                              Array of strings

                              @@ -195,13 +227,13 @@ "status": "DOWN", "router_id": null, "tenant_id": "26ae5181a416420998eb2093aaed84d9", - "project_id": "26ae5181a416420998eb2093aaed84d9", "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "fixed_ip_address": null, "floating_ip_address": "cdcd:910a:2222:5498:8475:1111:c613:16e3", "port_id": null, - "created_at": "2019-03-26T09:52:41", - "updated_at": "2019-03-26T09:52:45" + "project_id": "26ae5181a416420998eb2093aaed84d9", + "created_at": "2024-05-23T09:20:59", + "updated_at": "2024-05-28T15:02:53" } ], "floatingips_links": [ diff --git a/docs/eip/api-ref/eip_apifloatip_0002.html b/docs/eip/api-ref/eip_apifloatip_0002.html index e28114e79..087fd3b78 100644 --- a/docs/eip/api-ref/eip_apifloatip_0002.html +++ b/docs/eip/api-ref/eip_apifloatip_0002.html @@ -5,11 +5,11 @@

                              URI

                              GET /v2.0/eip/floatingips_v6/{floatingip_id}

                              -

                              Request Message

                              • Request parameter

                                None

                                +

                                Request Parameters

                                • Request parameter

                                  None

                                • Example request
                                  GET https://{Endpoint}//v2.0/eip/floatingips_v6/2dedb5e7-cb70-4e78-b50f-d88c8321d161
                                -

                                Response Message

                                • Response parameter +

                                  Response Parameters

                                  • Response parameter
                                    + + + + + + + + + + + +
                                    Table 1 Response parameter

                                    Parameter

                                    Type

                                    @@ -94,6 +94,29 @@

                                    Specifies the project ID.

                                    project_id

                                    +

                                    String

                                    +

                                    Specifies the project ID.

                                    +

                                    created_at

                                    +

                                    String

                                    +

                                    Specifies the time when the resource was created.

                                    +

                                    Format: yyyy-MM-ddTHH:mm:ss

                                    +

                                    updated_at

                                    +

                                    String

                                    +

                                    Specifies the time when the resource was updated.

                                    +

                                    Format: yyyy-MM-ddTHH:mm:ss

                                    +
                                    @@ -103,13 +126,13 @@ "status": "DOWN", "router_id": null, "tenant_id": "26ae5181a416420998eb2093aaed84d9", - "project_id": "26ae5181a416420998eb2093aaed84d9", "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "fixed_ip_address": null, "floating_ip_address": "cdcd:910a:2222:5498:8475:1111:c613:16e3", "port_id": null, - "created_at": "2019-03-26T09:52:41", - "updated_at": "2019-03-26T09:52:45" + "project_id": "26ae5181a416420998eb2093aaed84d9", + "created_at": "2024-05-23T09:20:59", + "updated_at": "2024-05-28T15:02:53" } }
                                  diff --git a/docs/eip/api-ref/eip_apifloatip_0003.html b/docs/eip/api-ref/eip_apifloatip_0003.html index adcf210e5..b9f0704e0 100644 --- a/docs/eip/api-ref/eip_apifloatip_0003.html +++ b/docs/eip/api-ref/eip_apifloatip_0003.html @@ -8,7 +8,7 @@

                                  URI

                                  POST /v2.0/eip/floatingips_v6

                                  -

                                  Request Message

                                  • Request parameter
                                  +

                                  Request Parameters

                                  • Request parameter
                                  @@ -123,7 +123,7 @@ } } -

                                  Response Message

                                  • Response parameter +

                                    Response Parameters

                                    • Response parameter
                                  Table 1 Request parameter

                                  Parameter

                                  Table 3 Response parameter

                                  Parameter

                                  Type

                                  diff --git a/docs/eip/api-ref/eip_apifloatip_0004.html b/docs/eip/api-ref/eip_apifloatip_0004.html index 62ed48de3..0ecf9b1df 100644 --- a/docs/eip/api-ref/eip_apifloatip_0004.html +++ b/docs/eip/api-ref/eip_apifloatip_0004.html @@ -8,7 +8,7 @@

                                  URI

                                  PUT /v2.0/eip/floatingips_v6/{floatingip_id}

                                  -

                                  Request Message

                                  • Request parameter +

                                    Request Parameters

                                    • Request parameter
                                      Table 1 Request parameter

                                      Parameter

                                      Type

                                      @@ -72,7 +72,7 @@ } } -

                                      Response Message

                                      • Response parameter +

                                        Response Parameters

                                        • Response parameter
                                          Table 3 Response parameter

                                          Parameter

                                          Type

                                          diff --git a/docs/eip/api-ref/eip_apifloatip_0005.html b/docs/eip/api-ref/eip_apifloatip_0005.html index 478982ade..81b9f8f38 100644 --- a/docs/eip/api-ref/eip_apifloatip_0005.html +++ b/docs/eip/api-ref/eip_apifloatip_0005.html @@ -5,11 +5,11 @@

                                          URI

                                          DELETE /v2.0/eip/floatingips_v6/{floatingip_id}

                                          -

                                          Request Message

                                          • Request parameter

                                            None

                                            +

                                            Request Parameters

                                            • Request parameter

                                              None

                                            • Example request
                                              DELETE https://{Endpoint}/v2.0/eip/floatingips_v6/a95ec431-8473-463b-aede-34fb048ee3a7
                                            -

                                            Response Message

                                            • Response parameter

                                              None

                                              +

                                              Response Parameters

                                              • Response parameter

                                                None

                                              • Example response

                                                None

                                              diff --git a/docs/eip/api-ref/eip_apipermission_0000.html b/docs/eip/api-ref/eip_apipermission_0000.html index dacd89924..0d7aac707 100644 --- a/docs/eip/api-ref/eip_apipermission_0000.html +++ b/docs/eip/api-ref/eip_apipermission_0000.html @@ -8,7 +8,9 @@
                                            • - + diff --git a/docs/eip/api-ref/eip_apipermission_0002.html b/docs/eip/api-ref/eip_apipermission_0002.html index 6b117403a..3a3fd65db 100644 --- a/docs/eip/api-ref/eip_apipermission_0002.html +++ b/docs/eip/api-ref/eip_apipermission_0002.html @@ -1,48 +1,48 @@ -

                                              EIP

                                              +

                                              EIP

                                              -

                                              Permission

                                              +
                                              - - - - - - - - - - - - - - - - - diff --git a/docs/eip/api-ref/eip_apipermission_0003.html b/docs/eip/api-ref/eip_apipermission_0003.html index 6424a2697..4bce0e4c2 100644 --- a/docs/eip/api-ref/eip_apipermission_0003.html +++ b/docs/eip/api-ref/eip_apipermission_0003.html @@ -2,33 +2,33 @@

                                              Bandwidth

                                              -

                                              Permission

                                              API

                                              +

                                              API

                                              Action

                                              +

                                              Action

                                              Assigns an EIP.

                                              +

                                              Assigning an EIP

                                              POST /v1/{project_id}/publicips

                                              +

                                              POST /v1/{project_id}/publicips

                                              vpc:publicIps:create

                                              +

                                              vpc:publicIps:create

                                              Queries an EIP.

                                              +

                                              Querying an EIP

                                              GET /v1/{project_id}/publicips/{publicip_id}

                                              +

                                              GET /v1/{project_id}/publicips/{publicip_id}

                                              vpc:publicIps:get

                                              +

                                              vpc:publicIps:get

                                              Queries EIPs.

                                              +

                                              Querying EIPs

                                              GET /v1/{project_id}/publicips

                                              +

                                              GET /v1/{project_id}/publicips

                                              vpc:publicIps:list

                                              +

                                              vpc:publicIps:list

                                              Updates an EIP.

                                              +

                                              Updating an EIP

                                              PUT /v1/{project_id}/publicips/{publicip_id}

                                              +

                                              PUT /v1/{project_id}/publicips/{publicip_id}

                                              vpc:publicIps:update

                                              +

                                              vpc:publicIps:update

                                              Release an EIP.

                                              +

                                              Releasing an EIP

                                              DELETE /v1/{project_id}/publicips/{publicip_id}

                                              +

                                              DELETE /v1/{project_id}/publicips/{publicip_id}

                                              vpc:publicIps:delete

                                              +

                                              vpc:publicIps:delete

                                              Permission

                                              +
                                              - - - - - - - - - - - diff --git a/docs/eip/api-ref/eip_apipermission_0004.html b/docs/eip/api-ref/eip_apipermission_0004.html index 83307a74b..75ffbc6b0 100644 --- a/docs/eip/api-ref/eip_apipermission_0004.html +++ b/docs/eip/api-ref/eip_apipermission_0004.html @@ -1,47 +1,47 @@ -

                                              Bandwidth (V2.0)

                                              +

                                              Bandwidth (V2)

                                              -

                                              Permission

                                              API

                                              +

                                              API

                                              Action

                                              +

                                              Action

                                              Queries a bandwidth.

                                              +

                                              Querying a bandwidth

                                              GET /v1/{project_id}/bandwidths/{bandwidth_id}

                                              +

                                              GET /v1/{project_id}/bandwidths/{bandwidth_id}

                                              vpc:bandwidths:get

                                              +

                                              vpc:bandwidths:get

                                              Queries bandwidths.

                                              +

                                              Querying bandwidths

                                              GET /v1/{project_id}/bandwidths

                                              +

                                              GET /v1/{project_id}/bandwidths

                                              vpc:bandwidths:list

                                              +

                                              vpc:bandwidths:list

                                              Updates a bandwidth.

                                              +

                                              Updating a bandwidth

                                              PUT /v1/{project_id}/bandwidths/{bandwidth_id}

                                              +

                                              PUT /v1/{project_id}/bandwidths/{bandwidth_id}

                                              vpc:bandwidths:update

                                              +

                                              vpc:bandwidths:update

                                              Permission

                                              +
                                              - - - - - - - - - - - - - -

                                              Permission

                                              API

                                              +

                                              API

                                              Action

                                              +

                                              Action

                                              Allocates a shared bandwidth.

                                              +

                                              Assigning a shared bandwidth

                                              POST /v2.0/{project_id}/bandwidths

                                              +

                                              POST /v2.0/{project_id}/bandwidths

                                              vpc:bandwidths:create

                                              +

                                              vpc:bandwidths:create

                                              Deletes a shared bandwidth.

                                              +

                                              Deleting a shared bandwidth

                                              DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id}

                                              +

                                              DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id}

                                              vpc:bandwidths:delete

                                              +

                                              vpc:bandwidths:delete

                                              Adds an EIP to a shared bandwidth.

                                              +

                                              Adding an EIP to a shared bandwidth

                                              POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert

                                              +

                                              POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert

                                              vpc:publicIps:insert

                                              +

                                              vpc:publicIps:insert

                                              Removes an EIP from a shared bandwidth.

                                              +

                                              Removing an EIP from a shared bandwidth

                                              POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/remove

                                              +

                                              POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/remove

                                              vpc:publicIps:remove

                                              +

                                              vpc:publicIps:remove

                                              -

                                              +