From aca2e5c3334d9952f39bc5e1e5d640aaa906104b Mon Sep 17 00:00:00 2001 From: "Qin Ying, Fan" Date: Mon, 31 Oct 2022 11:11:49 +0000 Subject: [PATCH] EIP API 1027 version Reviewed-by: gtema Co-authored-by: Qin Ying, Fan Co-committed-by: Qin Ying, Fan --- docs/eip/api-ref/ALL_META.TXT.json | 542 +++++ docs/eip/api-ref/CLASS.TXT.json | 488 +++++ docs/eip/api-ref/PARAMETERS.txt | 3 + docs/eip/api-ref/eip_api01_0000.html | 8 + docs/eip/api-ref/eip_api04_0000.html | 21 + docs/eip/api-ref/eip_api05_0001.html | 123 ++ docs/eip/api-ref/eip_api05_0002.html | 1840 +++++++++++++++++ docs/eip/api-ref/eip_api06_0001.html | 16 + docs/eip/api-ref/eip_api06_0003.html | 110 + docs/eip/api-ref/eip_api07_0000.html | 93 + docs/eip/api-ref/eip_apiBandwidth_0000.html | 19 + docs/eip/api-ref/eip_apiBandwidth_0001.html | 246 +++ docs/eip/api-ref/eip_apiBandwidth_0002.html | 330 +++ docs/eip/api-ref/eip_apiBandwidth_0003.html | 307 +++ docs/eip/api-ref/eip_api_0000.html | 23 + docs/eip/api-ref/eip_api_0001.html | 308 +++ docs/eip/api-ref/eip_api_0002.html | 256 +++ docs/eip/api-ref/eip_api_0003.html | 302 +++ docs/eip/api-ref/eip_api_0004.html | 299 +++ docs/eip/api-ref/eip_api_0005.html | 58 + docs/eip/api-ref/eip_apifloatip_0000.html | 23 + docs/eip/api-ref/eip_apifloatip_0001.html | 226 ++ docs/eip/api-ref/eip_apifloatip_0002.html | 127 ++ docs/eip/api-ref/eip_apifloatip_0003.html | 239 +++ docs/eip/api-ref/eip_apifloatip_0004.html | 200 ++ docs/eip/api-ref/eip_apifloatip_0005.html | 26 + docs/eip/api-ref/eip_apipermission_0000.html | 19 + docs/eip/api-ref/eip_apipermission_0002.html | 57 + docs/eip/api-ref/eip_apipermission_0003.html | 43 + docs/eip/api-ref/eip_apipermission_0004.html | 51 + docs/eip/api-ref/eip_apipermission_0006.html | 57 + docs/eip/api-ref/eip_apipermission_0007.html | 11 + docs/eip/api-ref/eip_apiquota_0000.html | 15 + docs/eip/api-ref/eip_apiquota_0001.html | 221 ++ .../api-ref/eip_apisharedbandwidth_0000.html | 21 + .../api-ref/eip_apisharedbandwidth_0001.html | 299 +++ .../api-ref/eip_apisharedbandwidth_0003.html | 58 + .../api-ref/eip_apisharedbandwidth_0004.html | 318 +++ .../api-ref/eip_apisharedbandwidth_0005.html | 165 ++ docs/eip/api-ref/eip_apitag_0000.html | 25 + docs/eip/api-ref/eip_apitag_0001.html | 121 ++ docs/eip/api-ref/eip_apitag_0002.html | 110 + docs/eip/api-ref/eip_apitag_0003.html | 65 + docs/eip/api-ref/eip_apitag_0004.html | 159 ++ docs/eip/api-ref/eip_apitag_0005.html | 338 +++ docs/eip/api-ref/eip_apitag_0006.html | 111 + docs/eip/api-ref/eip_openstackapi_0000.html | 13 + docs/eip/api-ref/eip_openstackapi_0001.html | 19 + docs/eip/api-ref/eip_openstackapi_0002.html | 119 ++ docs/eip/api-ref/eip_openstackapi_0003.html | 157 ++ docs/eip/api-ref/eip_openstackapi_0004.html | 143 ++ docs/eip/api-ref/eip_openstackapi_0005.html | 23 + docs/eip/api-ref/eip_openstackapi_0006.html | 288 +++ docs/eip/api-ref/eip_openstackapi_0007.html | 173 ++ docs/eip/api-ref/eip_openstackapi_0008.html | 228 ++ docs/eip/api-ref/eip_openstackapi_0009.html | 253 +++ docs/eip/api-ref/eip_openstackapi_0010.html | 51 + .../public_sys-resources/ExpandCollapse.js | 1 + .../caution_3.0-en-us.png | Bin 0 -> 2752 bytes .../public_sys-resources/commonltr.css | 1 + .../public_sys-resources/commonltr_print.css | 1 + .../public_sys-resources/commonrtl.css | 2 + .../public_sys-resources/danger_3.0-en-us.png | Bin 0 -> 2771 bytes .../api-ref/public_sys-resources/delta.gif | Bin 0 -> 836 bytes .../api-ref/public_sys-resources/deltaend.gif | Bin 0 -> 834 bytes .../public_sys-resources/icon-arrowdn.gif | Bin 0 -> 68 bytes .../public_sys-resources/icon-arrowrt.gif | Bin 0 -> 70 bytes .../public_sys-resources/icon-caution.gif | Bin 0 -> 1086 bytes .../public_sys-resources/icon-danger.gif | Bin 0 -> 1086 bytes .../public_sys-resources/icon-huawei.gif | Bin 0 -> 2767 bytes .../public_sys-resources/icon-note.gif | Bin 0 -> 983 bytes .../public_sys-resources/icon-notice.gif | Bin 0 -> 962 bytes .../api-ref/public_sys-resources/icon-tip.gif | Bin 0 -> 879 bytes .../public_sys-resources/icon-warning.gif | Bin 0 -> 1086 bytes .../public_sys-resources/note_3.0-en-us.png | Bin 0 -> 1080 bytes .../public_sys-resources/notice_3.0-en-us.png | Bin 0 -> 1672 bytes .../eip/api-ref/public_sys-resources/popup.js | 1 + .../warning_3.0-en-us.png | Bin 0 -> 3164 bytes 78 files changed, 9970 insertions(+) create mode 100644 docs/eip/api-ref/ALL_META.TXT.json create mode 100644 docs/eip/api-ref/CLASS.TXT.json create mode 100644 docs/eip/api-ref/PARAMETERS.txt create mode 100644 docs/eip/api-ref/eip_api01_0000.html create mode 100644 docs/eip/api-ref/eip_api04_0000.html create mode 100644 docs/eip/api-ref/eip_api05_0001.html create mode 100644 docs/eip/api-ref/eip_api05_0002.html create mode 100644 docs/eip/api-ref/eip_api06_0001.html create mode 100644 docs/eip/api-ref/eip_api06_0003.html create mode 100644 docs/eip/api-ref/eip_api07_0000.html create mode 100644 docs/eip/api-ref/eip_apiBandwidth_0000.html create mode 100644 docs/eip/api-ref/eip_apiBandwidth_0001.html create mode 100644 docs/eip/api-ref/eip_apiBandwidth_0002.html create mode 100644 docs/eip/api-ref/eip_apiBandwidth_0003.html create mode 100644 docs/eip/api-ref/eip_api_0000.html create mode 100644 docs/eip/api-ref/eip_api_0001.html create mode 100644 docs/eip/api-ref/eip_api_0002.html create mode 100644 docs/eip/api-ref/eip_api_0003.html create mode 100644 docs/eip/api-ref/eip_api_0004.html create mode 100644 docs/eip/api-ref/eip_api_0005.html create mode 100644 docs/eip/api-ref/eip_apifloatip_0000.html create mode 100644 docs/eip/api-ref/eip_apifloatip_0001.html create mode 100644 docs/eip/api-ref/eip_apifloatip_0002.html create mode 100644 docs/eip/api-ref/eip_apifloatip_0003.html create mode 100644 docs/eip/api-ref/eip_apifloatip_0004.html create mode 100644 docs/eip/api-ref/eip_apifloatip_0005.html create mode 100644 docs/eip/api-ref/eip_apipermission_0000.html create mode 100644 docs/eip/api-ref/eip_apipermission_0002.html create mode 100644 docs/eip/api-ref/eip_apipermission_0003.html create mode 100644 docs/eip/api-ref/eip_apipermission_0004.html create mode 100644 docs/eip/api-ref/eip_apipermission_0006.html create mode 100644 docs/eip/api-ref/eip_apipermission_0007.html create mode 100644 docs/eip/api-ref/eip_apiquota_0000.html create mode 100644 docs/eip/api-ref/eip_apiquota_0001.html create mode 100644 docs/eip/api-ref/eip_apisharedbandwidth_0000.html create mode 100644 docs/eip/api-ref/eip_apisharedbandwidth_0001.html create mode 100644 docs/eip/api-ref/eip_apisharedbandwidth_0003.html create mode 100644 docs/eip/api-ref/eip_apisharedbandwidth_0004.html create mode 100644 docs/eip/api-ref/eip_apisharedbandwidth_0005.html create mode 100644 docs/eip/api-ref/eip_apitag_0000.html create mode 100644 docs/eip/api-ref/eip_apitag_0001.html create mode 100644 docs/eip/api-ref/eip_apitag_0002.html create mode 100644 docs/eip/api-ref/eip_apitag_0003.html create mode 100644 docs/eip/api-ref/eip_apitag_0004.html create mode 100644 docs/eip/api-ref/eip_apitag_0005.html create mode 100644 docs/eip/api-ref/eip_apitag_0006.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0000.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0001.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0002.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0003.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0004.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0005.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0006.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0007.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0008.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0009.html create mode 100644 docs/eip/api-ref/eip_openstackapi_0010.html create mode 100644 docs/eip/api-ref/public_sys-resources/ExpandCollapse.js create mode 100644 docs/eip/api-ref/public_sys-resources/caution_3.0-en-us.png create mode 100644 docs/eip/api-ref/public_sys-resources/commonltr.css create mode 100644 docs/eip/api-ref/public_sys-resources/commonltr_print.css create mode 100644 docs/eip/api-ref/public_sys-resources/commonrtl.css create mode 100644 docs/eip/api-ref/public_sys-resources/danger_3.0-en-us.png create mode 100644 docs/eip/api-ref/public_sys-resources/delta.gif create mode 100644 docs/eip/api-ref/public_sys-resources/deltaend.gif create mode 100644 docs/eip/api-ref/public_sys-resources/icon-arrowdn.gif create mode 100644 docs/eip/api-ref/public_sys-resources/icon-arrowrt.gif create mode 100644 docs/eip/api-ref/public_sys-resources/icon-caution.gif create mode 100644 docs/eip/api-ref/public_sys-resources/icon-danger.gif create mode 100644 docs/eip/api-ref/public_sys-resources/icon-huawei.gif create mode 100644 docs/eip/api-ref/public_sys-resources/icon-note.gif create mode 100644 docs/eip/api-ref/public_sys-resources/icon-notice.gif create mode 100644 docs/eip/api-ref/public_sys-resources/icon-tip.gif create mode 100644 docs/eip/api-ref/public_sys-resources/icon-warning.gif create mode 100644 docs/eip/api-ref/public_sys-resources/note_3.0-en-us.png create mode 100644 docs/eip/api-ref/public_sys-resources/notice_3.0-en-us.png create mode 100644 docs/eip/api-ref/public_sys-resources/popup.js create mode 100644 docs/eip/api-ref/public_sys-resources/warning_3.0-en-us.png diff --git a/docs/eip/api-ref/ALL_META.TXT.json b/docs/eip/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..ab1952b28 --- /dev/null +++ b/docs/eip/api-ref/ALL_META.TXT.json @@ -0,0 +1,542 @@ +[ + { + "uri":"eip_api01_0000.html", + "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", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"eip_api04_0000.html", + "product_code":"eip", + "code":"2", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"APIs", + "title":"APIs", + "githuburl":"" + }, + { + "uri":"eip_api_0000.html", + "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":"Elastic IP", + "title":"Elastic IP", + "githuburl":"" + }, + { + "uri":"eip_api_0001.html", + "product_code":"eip", + "code":"4", + "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", + "doc_type":"api", + "kw":"Assigning an EIP,Elastic IP,API Reference", + "title":"Assigning an EIP", + "githuburl":"" + }, + { + "uri":"eip_api_0002.html", + "product_code":"eip", + "code":"5", + "des":"This API is used to query a specific EIP.GET /v1/{project_id}/publicips/{publicip_id}Table 1 describes the parameters.Parameter descriptionNameMandatoryDescriptionproject", + "doc_type":"api", + "kw":"Querying an EIP,Elastic IP,API Reference", + "title":"Querying an EIP", + "githuburl":"" + }, + { + "uri":"eip_api_0003.html", + "product_code":"eip", + "code":"6", + "des":"This API is used to query EIPs.GET /v1/{project_id}/publicipsTable 1 describes the parameters.Parameter descriptionNameMandatoryTypeDescriptionproject_idYesStringSpecifie", + "doc_type":"api", + "kw":"Querying EIPs,Elastic IP,API Reference", + "title":"Querying EIPs", + "githuburl":"" + }, + { + "uri":"eip_api_0004.html", + "product_code":"eip", + "code":"7", + "des":"This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC.This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer.PUT /v1/{p", + "doc_type":"api", + "kw":"Updating an EIP,Elastic IP,API Reference", + "title":"Updating an EIP", + "githuburl":"" + }, + { + "uri":"eip_api_0005.html", + "product_code":"eip", + "code":"8", + "des":"This API is used to release an EIP.DELETE /v1/{project_id}/publicips/{publicip_id}Table 1 describes the parameters.Parameter descriptionNameMandatoryDescriptionproject_id", + "doc_type":"api", + "kw":"Releasing an EIP,Elastic IP,API Reference", + "title":"Releasing an EIP", + "githuburl":"" + }, + { + "uri":"eip_apifloatip_0000.html", + "product_code":"eip", + "code":"9", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Floating IP Address (IPv6)", + "title":"Floating IP Address (IPv6)", + "githuburl":"" + }, + { + "uri":"eip_apifloatip_0001.html", + "product_code":"eip", + "code":"10", + "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", + "title":"Querying Floating IP Addresses", + "githuburl":"" + }, + { + "uri":"eip_apifloatip_0002.html", + "product_code":"eip", + "code":"11", + "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", + "title":"Querying a Floating IP Address", + "githuburl":"" + }, + { + "uri":"eip_apifloatip_0003.html", + "product_code":"eip", + "code":"12", + "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", + "title":"Assigning a Floating IP Address", + "githuburl":"" + }, + { + "uri":"eip_apifloatip_0004.html", + "product_code":"eip", + "code":"13", + "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", + "title":"Updating a Floating IP Address", + "githuburl":"" + }, + { + "uri":"eip_apifloatip_0005.html", + "product_code":"eip", + "code":"14", + "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", + "title":"Deleting a Floating IP Address", + "githuburl":"" + }, + { + "uri":"eip_apiBandwidth_0000.html", + "product_code":"eip", + "code":"15", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Bandwidth", + "title":"Bandwidth", + "githuburl":"" + }, + { + "uri":"eip_apiBandwidth_0001.html", + "product_code":"eip", + "code":"16", + "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", + "doc_type":"api", + "kw":"Querying a Bandwidth,Bandwidth,API Reference", + "title":"Querying a Bandwidth", + "githuburl":"" + }, + { + "uri":"eip_apiBandwidth_0002.html", + "product_code":"eip", + "code":"17", + "des":"This API is used to query bandwidths using search criteria.GET /v1/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionNameMandatoryTypeDescripti", + "doc_type":"api", + "kw":"Querying Bandwidths,Bandwidth,API Reference", + "title":"Querying Bandwidths", + "githuburl":"" + }, + { + "uri":"eip_apiBandwidth_0003.html", + "product_code":"eip", + "code":"18", + "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", + "doc_type":"api", + "kw":"Updating a Bandwidth,Bandwidth,API Reference", + "title":"Updating a Bandwidth", + "githuburl":"" + }, + { + "uri":"eip_apisharedbandwidth_0000.html", + "product_code":"eip", + "code":"19", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Bandwidth (V2.0)", + "title":"Bandwidth (V2.0)", + "githuburl":"" + }, + { + "uri":"eip_apisharedbandwidth_0001.html", + "product_code":"eip", + "code":"20", + "des":"This API is used to assign a shared bandwidth.POST /v2.0/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionNameMandatoryDescriptionproject_idYe", + "doc_type":"api", + "kw":"Assigning a Shared Bandwidth,Bandwidth (V2.0),API Reference", + "title":"Assigning a Shared Bandwidth", + "githuburl":"" + }, + { + "uri":"eip_apisharedbandwidth_0003.html", + "product_code":"eip", + "code":"21", + "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", + "doc_type":"api", + "kw":"Deleting a Shared Bandwidth,Bandwidth (V2.0),API Reference", + "title":"Deleting a Shared Bandwidth", + "githuburl":"" + }, + { + "uri":"eip_apisharedbandwidth_0004.html", + "product_code":"eip", + "code":"22", + "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", + "doc_type":"api", + "kw":"Adding an EIP to a Shared Bandwidth,Bandwidth (V2.0),API Reference", + "title":"Adding an EIP to a Shared Bandwidth", + "githuburl":"" + }, + { + "uri":"eip_apisharedbandwidth_0005.html", + "product_code":"eip", + "code":"23", + "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", + "doc_type":"api", + "kw":"Removing an EIP from a Shared Bandwidth,Bandwidth (V2.0),API Reference", + "title":"Removing an EIP from a Shared Bandwidth", + "githuburl":"" + }, + { + "uri":"eip_apiquota_0000.html", + "product_code":"eip", + "code":"24", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Quota", + "title":"Quota", + "githuburl":"" + }, + { + "uri":"eip_apiquota_0001.html", + "product_code":"eip", + "code":"25", + "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", + "doc_type":"api", + "kw":"Querying the Quota,Quota,API Reference", + "title":"Querying the Quota", + "githuburl":"" + }, + { + "uri":"eip_apitag_0000.html", + "product_code":"eip", + "code":"26", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"EIP Tag Management", + "title":"EIP Tag Management", + "githuburl":"" + }, + { + "uri":"eip_apitag_0001.html", + "product_code":"eip", + "code":"27", + "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", + "doc_type":"api", + "kw":"Creating a Tag for an EIP,EIP Tag Management,API Reference", + "title":"Creating a Tag for an EIP", + "githuburl":"" + }, + { + "uri":"eip_apitag_0002.html", + "product_code":"eip", + "code":"28", + "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", + "title":"Querying EIP Tags", + "githuburl":"" + }, + { + "uri":"eip_apitag_0003.html", + "product_code":"eip", + "code":"29", + "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", + "doc_type":"api", + "kw":"Deleting an EIP Tag,EIP Tag Management,API Reference", + "title":"Deleting an EIP Tag", + "githuburl":"" + }, + { + "uri":"eip_apitag_0004.html", + "product_code":"eip", + "code":"30", + "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", + "githuburl":"" + }, + { + "uri":"eip_apitag_0005.html", + "product_code":"eip", + "code":"31", + "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", + "title":"Querying EIPs by Tag", + "githuburl":"" + }, + { + "uri":"eip_apitag_0006.html", + "product_code":"eip", + "code":"32", + "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", + "title":"Querying EIP Tags in a Specified Project", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0000.html", + "product_code":"eip", + "code":"33", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Native OpenStack Neutron APIs V2.0", + "title":"Native OpenStack Neutron APIs V2.0", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0001.html", + "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 Version Information", + "title":"API Version Information", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0002.html", + "product_code":"eip", + "code":"35", + "des":"This API is used to query all available versions of a native OpenStack API.GET /Request parameterNoneExample requestResponse parameterExample responseSee Status Codes.See", + "doc_type":"api", + "kw":"Querying API Versions,API Version Information,API Reference", + "title":"Querying API Versions", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0003.html", + "product_code":"eip", + "code":"36", + "des":"This API is used to query the version of a specified API.GET /{api_version}Table 1 describes the parameters.Request parameterNoneNoneExample requestGET https://{Endpoint}", + "doc_type":"api", + "kw":"Querying a Specified API Version,API Version Information,API Reference", + "title":"Querying a Specified API Version", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0004.html", + "product_code":"eip", + "code":"37", + "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 ", + "doc_type":"api", + "kw":"Pagination,API Version Information,API Reference", + "title":"Pagination", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0005.html", + "product_code":"eip", + "code":"38", + "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", + "title":"Floating IP Address", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0006.html", + "product_code":"eip", + "code":"39", + "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", + "title":"Querying Floating IP Addresses", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0007.html", + "product_code":"eip", + "code":"40", + "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", + "title":"Querying a Floating IP Address", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0008.html", + "product_code":"eip", + "code":"41", + "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", + "title":"Assigning a Floating IP Address", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0009.html", + "product_code":"eip", + "code":"42", + "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", + "title":"Updating a Floating IP Address", + "githuburl":"" + }, + { + "uri":"eip_openstackapi_0010.html", + "product_code":"eip", + "code":"43", + "des":"This API is used to delete a floating IP address.DELETE /v2.0/floatingips/{floatingip_id}Table 1 describes the parameters.NoneNoneExample requestExample responseNoneSee S", + "doc_type":"api", + "kw":"Deleting a Floating IP Address,Floating IP Address,API Reference", + "title":"Deleting a Floating IP Address", + "githuburl":"" + }, + { + "uri":"eip_apipermission_0000.html", + "product_code":"eip", + "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":"Permissions Policies and Supported Actions", + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"eip_apipermission_0002.html", + "product_code":"eip", + "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":"Elastic IP,Permissions Policies and Supported Actions,API Reference", + "title":"Elastic IP", + "githuburl":"" + }, + { + "uri":"eip_apipermission_0003.html", + "product_code":"eip", + "code":"46", + "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", + "title":"Bandwidth", + "githuburl":"" + }, + { + "uri":"eip_apipermission_0004.html", + "product_code":"eip", + "code":"47", + "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)", + "githuburl":"" + }, + { + "uri":"eip_apipermission_0006.html", + "product_code":"eip", + "code":"48", + "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", + "title":"Floating IP Address (OpenStack Neutron API)", + "githuburl":"" + }, + { + "uri":"eip_apipermission_0007.html", + "product_code":"eip", + "code":"49", + "des":"If you have insufficient permissions, response code 200 will be returned when you query network resources and an empty list will be displayed.", + "doc_type":"api", + "kw":"Precautions for API Permissions,Permissions Policies and Supported Actions,API Reference", + "title":"Precautions for API Permissions", + "githuburl":"" + }, + { + "uri":"eip_api06_0001.html", + "product_code":"eip", + "code":"50", + "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", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"eip_api06_0003.html", + "product_code":"eip", + "code":"51", + "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", + "title":"VPC Monitoring Metrics", + "githuburl":"" + }, + { + "uri":"eip_api05_0001.html", + "product_code":"eip", + "code":"52", + "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", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"eip_api05_0002.html", + "product_code":"eip", + "code":"53", + "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", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"eip_api07_0000.html", + "product_code":"eip", + "code":"54", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/eip/api-ref/CLASS.TXT.json b/docs/eip/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..85d79e321 --- /dev/null +++ b/docs/eip/api-ref/CLASS.TXT.json @@ -0,0 +1,488 @@ +[ + { + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", + "product_code":"eip", + "title":"API Usage Guidelines", + "uri":"eip_api01_0000.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"APIs", + "uri":"eip_api04_0000.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"Elastic IP", + "uri":"eip_api_0000.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "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", + "product_code":"eip", + "title":"Assigning an EIP", + "uri":"eip_api_0001.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This API is used to query a specific EIP.GET /v1/{project_id}/publicips/{publicip_id}Table 1 describes the parameters.Parameter descriptionNameMandatoryDescriptionproject", + "product_code":"eip", + "title":"Querying an EIP", + "uri":"eip_api_0002.html", + "doc_type":"api", + "p_code":"3", + "code":"5" + }, + { + "desc":"This API is used to query EIPs.GET /v1/{project_id}/publicipsTable 1 describes the parameters.Parameter descriptionNameMandatoryTypeDescriptionproject_idYesStringSpecifie", + "product_code":"eip", + "title":"Querying EIPs", + "uri":"eip_api_0003.html", + "doc_type":"api", + "p_code":"3", + "code":"6" + }, + { + "desc":"This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC.This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer.PUT /v1/{p", + "product_code":"eip", + "title":"Updating an EIP", + "uri":"eip_api_0004.html", + "doc_type":"api", + "p_code":"3", + "code":"7" + }, + { + "desc":"This API is used to release an EIP.DELETE /v1/{project_id}/publicips/{publicip_id}Table 1 describes the parameters.Parameter descriptionNameMandatoryDescriptionproject_id", + "product_code":"eip", + "title":"Releasing an EIP", + "uri":"eip_api_0005.html", + "doc_type":"api", + "p_code":"3", + "code":"8" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"Floating IP Address (IPv6)", + "uri":"eip_apifloatip_0000.html", + "doc_type":"api", + "p_code":"2", + "code":"9" + }, + { + "desc":"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", + "product_code":"eip", + "title":"Querying Floating IP Addresses", + "uri":"eip_apifloatip_0001.html", + "doc_type":"api", + "p_code":"9", + "code":"10" + }, + { + "desc":"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", + "product_code":"eip", + "title":"Querying a Floating IP Address", + "uri":"eip_apifloatip_0002.html", + "doc_type":"api", + "p_code":"9", + "code":"11" + }, + { + "desc":"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", + "product_code":"eip", + "title":"Assigning a Floating IP Address", + "uri":"eip_apifloatip_0003.html", + "doc_type":"api", + "p_code":"9", + "code":"12" + }, + { + "desc":"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 ", + "product_code":"eip", + "title":"Updating a Floating IP Address", + "uri":"eip_apifloatip_0004.html", + "doc_type":"api", + "p_code":"9", + "code":"13" + }, + { + "desc":"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", + "product_code":"eip", + "title":"Deleting a Floating IP Address", + "uri":"eip_apifloatip_0005.html", + "doc_type":"api", + "p_code":"9", + "code":"14" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"Bandwidth", + "uri":"eip_apiBandwidth_0000.html", + "doc_type":"api", + "p_code":"2", + "code":"15" + }, + { + "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", + "product_code":"eip", + "title":"Querying a Bandwidth", + "uri":"eip_apiBandwidth_0001.html", + "doc_type":"api", + "p_code":"15", + "code":"16" + }, + { + "desc":"This API is used to query bandwidths using search criteria.GET /v1/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionNameMandatoryTypeDescripti", + "product_code":"eip", + "title":"Querying Bandwidths", + "uri":"eip_apiBandwidth_0002.html", + "doc_type":"api", + "p_code":"15", + "code":"17" + }, + { + "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", + "product_code":"eip", + "title":"Updating a Bandwidth", + "uri":"eip_apiBandwidth_0003.html", + "doc_type":"api", + "p_code":"15", + "code":"18" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"Bandwidth (V2.0)", + "uri":"eip_apisharedbandwidth_0000.html", + "doc_type":"api", + "p_code":"2", + "code":"19" + }, + { + "desc":"This API is used to assign a shared bandwidth.POST /v2.0/{project_id}/bandwidthsTable 1 describes the parameters.Parameter descriptionNameMandatoryDescriptionproject_idYe", + "product_code":"eip", + "title":"Assigning a Shared Bandwidth", + "uri":"eip_apisharedbandwidth_0001.html", + "doc_type":"api", + "p_code":"19", + "code":"20" + }, + { + "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", + "product_code":"eip", + "title":"Deleting a Shared Bandwidth", + "uri":"eip_apisharedbandwidth_0003.html", + "doc_type":"api", + "p_code":"19", + "code":"21" + }, + { + "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", + "product_code":"eip", + "title":"Adding an EIP to a Shared Bandwidth", + "uri":"eip_apisharedbandwidth_0004.html", + "doc_type":"api", + "p_code":"19", + "code":"22" + }, + { + "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", + "product_code":"eip", + "title":"Removing an EIP from a Shared Bandwidth", + "uri":"eip_apisharedbandwidth_0005.html", + "doc_type":"api", + "p_code":"19", + "code":"23" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"Quota", + "uri":"eip_apiquota_0000.html", + "doc_type":"api", + "p_code":"2", + "code":"24" + }, + { + "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", + "product_code":"eip", + "title":"Querying the Quota", + "uri":"eip_apiquota_0001.html", + "doc_type":"api", + "p_code":"24", + "code":"25" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"EIP Tag Management", + "uri":"eip_apitag_0000.html", + "doc_type":"api", + "p_code":"2", + "code":"26" + }, + { + "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", + "product_code":"eip", + "title":"Creating a Tag for an EIP", + "uri":"eip_apitag_0001.html", + "doc_type":"api", + "p_code":"26", + "code":"27" + }, + { + "desc":"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", + "product_code":"eip", + "title":"Querying EIP Tags", + "uri":"eip_apitag_0002.html", + "doc_type":"api", + "p_code":"26", + "code":"28" + }, + { + "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", + "product_code":"eip", + "title":"Deleting an EIP Tag", + "uri":"eip_apitag_0003.html", + "doc_type":"api", + "p_code":"26", + "code":"29" + }, + { + "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", + "uri":"eip_apitag_0004.html", + "doc_type":"api", + "p_code":"26", + "code":"30" + }, + { + "desc":"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", + "product_code":"eip", + "title":"Querying EIPs by Tag", + "uri":"eip_apitag_0005.html", + "doc_type":"api", + "p_code":"26", + "code":"31" + }, + { + "desc":"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", + "product_code":"eip", + "title":"Querying EIP Tags in a Specified Project", + "uri":"eip_apitag_0006.html", + "doc_type":"api", + "p_code":"26", + "code":"32" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"Native OpenStack Neutron APIs V2.0", + "uri":"eip_openstackapi_0000.html", + "doc_type":"api", + "p_code":"", + "code":"33" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"API Version Information", + "uri":"eip_openstackapi_0001.html", + "doc_type":"api", + "p_code":"33", + "code":"34" + }, + { + "desc":"This API is used to query all available versions of a native OpenStack API.GET /Request parameterNoneExample requestResponse parameterExample responseSee Status Codes.See", + "product_code":"eip", + "title":"Querying API Versions", + "uri":"eip_openstackapi_0002.html", + "doc_type":"api", + "p_code":"34", + "code":"35" + }, + { + "desc":"This API is used to query the version of a specified API.GET /{api_version}Table 1 describes the parameters.Request parameterNoneNoneExample requestGET https://{Endpoint}", + "product_code":"eip", + "title":"Querying a Specified API Version", + "uri":"eip_openstackapi_0003.html", + "doc_type":"api", + "p_code":"34", + "code":"36" + }, + { + "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 ", + "product_code":"eip", + "title":"Pagination", + "uri":"eip_openstackapi_0004.html", + "doc_type":"api", + "p_code":"34", + "code":"37" + }, + { + "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":"Floating IP Address", + "uri":"eip_openstackapi_0005.html", + "doc_type":"api", + "p_code":"33", + "code":"38" + }, + { + "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", + "product_code":"eip", + "title":"Querying Floating IP Addresses", + "uri":"eip_openstackapi_0006.html", + "doc_type":"api", + "p_code":"38", + "code":"39" + }, + { + "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", + "product_code":"eip", + "title":"Querying a Floating IP Address", + "uri":"eip_openstackapi_0007.html", + "doc_type":"api", + "p_code":"38", + "code":"40" + }, + { + "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", + "product_code":"eip", + "title":"Assigning a Floating IP Address", + "uri":"eip_openstackapi_0008.html", + "doc_type":"api", + "p_code":"38", + "code":"41" + }, + { + "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", + "product_code":"eip", + "title":"Updating a Floating IP Address", + "uri":"eip_openstackapi_0009.html", + "doc_type":"api", + "p_code":"38", + "code":"42" + }, + { + "desc":"This API is used to delete a floating IP address.DELETE /v2.0/floatingips/{floatingip_id}Table 1 describes the parameters.NoneNoneExample requestExample responseNoneSee S", + "product_code":"eip", + "title":"Deleting a Floating IP Address", + "uri":"eip_openstackapi_0010.html", + "doc_type":"api", + "p_code":"38", + "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.", + "product_code":"eip", + "title":"Permissions Policies and Supported Actions", + "uri":"eip_apipermission_0000.html", + "doc_type":"api", + "p_code":"", + "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.", + "product_code":"eip", + "title":"Elastic IP", + "uri":"eip_apipermission_0002.html", + "doc_type":"api", + "p_code":"44", + "code":"45" + }, + { + "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", + "uri":"eip_apipermission_0003.html", + "doc_type":"api", + "p_code":"44", + "code":"46" + }, + { + "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)", + "uri":"eip_apipermission_0004.html", + "doc_type":"api", + "p_code":"44", + "code":"47" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"Floating IP Address (OpenStack Neutron API)", + "uri":"eip_apipermission_0006.html", + "doc_type":"api", + "p_code":"44", + "code":"48" + }, + { + "desc":"If you have insufficient permissions, response code 200 will be returned when you query network resources and an empty list will be displayed.", + "product_code":"eip", + "title":"Precautions for API Permissions", + "uri":"eip_apipermission_0007.html", + "doc_type":"api", + "p_code":"44", + "code":"49" + }, + { + "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":"Appendix", + "uri":"eip_api06_0001.html", + "doc_type":"api", + "p_code":"", + "code":"50" + }, + { + "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", + "product_code":"eip", + "title":"VPC Monitoring Metrics", + "uri":"eip_api06_0003.html", + "doc_type":"api", + "p_code":"50", + "code":"51" + }, + { + "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":"Status Codes", + "uri":"eip_api05_0001.html", + "doc_type":"api", + "p_code":"50", + "code":"52" + }, + { + "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).", + "product_code":"eip", + "title":"Error Codes", + "uri":"eip_api05_0002.html", + "doc_type":"api", + "p_code":"50", + "code":"53" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"eip", + "title":"Change History", + "uri":"eip_api07_0000.html", + "doc_type":"api", + "p_code":"", + "code":"54" + } +] \ No newline at end of file diff --git a/docs/eip/api-ref/PARAMETERS.txt b/docs/eip/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/eip/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/eip/api-ref/eip_api01_0000.html b/docs/eip/api-ref/eip_api01_0000.html new file mode 100644 index 000000000..5d19f2586 --- /dev/null +++ b/docs/eip/api-ref/eip_api01_0000.html @@ -0,0 +1,8 @@ + + +

API Usage Guidelines

+

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

+

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

+

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

+
+ diff --git a/docs/eip/api-ref/eip_api04_0000.html b/docs/eip/api-ref/eip_api04_0000.html new file mode 100644 index 000000000..79bb0a510 --- /dev/null +++ b/docs/eip/api-ref/eip_api04_0000.html @@ -0,0 +1,21 @@ + + +

APIs

+
+
+ +
+ diff --git a/docs/eip/api-ref/eip_api05_0001.html b/docs/eip/api-ref/eip_api05_0001.html new file mode 100644 index 000000000..e9561a9c8 --- /dev/null +++ b/docs/eip/api-ref/eip_api05_0001.html @@ -0,0 +1,123 @@ + + +

Status Codes

+
+
+ + + + + + + + + + + + + + + + + +
Table 1 Normal values

Normal Response Code

+

Type

+

Description

+

200

+

OK

+

Specifies the normal response code for the GET, PUT, and POST operations.

+

201

+

Created

+

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

+

204

+

No Content

+

Specifies the normal response code for the DELETE operation.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Abnormal values

Returned Value

+

Description

+

400 Bad Request

+

The server failed to process the request.

+

401 Unauthorized

+

You must enter a username and password to access the requested page.

+

403 Forbidden

+

You are forbidden to access the requested page.

+

404 Not Found

+

The server could not find the requested page.

+

405 Method Not Allowed

+

You are not allowed to use the method specified in the request.

+

406 Not Acceptable

+

The response generated by the server could not be accepted by the client.

+

407 Proxy Authentication Required

+

You must use the proxy server for authentication so that the request can be processed.

+

408 Request Timeout

+

The request timed out.

+

409 Conflict

+

The request could not be processed due to a conflict.

+

500 Internal Server Error

+

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

+

501 Not Implemented

+

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

+

502 Bad Gateway

+

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

+

503 Service Unavailable

+

Failed to complete the request because the service is unavailable.

+

504 Gateway Timeout

+

A gateway timeout error occurred.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/eip/api-ref/eip_api05_0002.html b/docs/eip/api-ref/eip_api05_0002.html new file mode 100644 index 000000000..09a63eec6 --- /dev/null +++ b/docs/eip/api-ref/eip_api05_0002.html @@ -0,0 +1,1840 @@ + + +

Error Codes

+

Description

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

+
+

Example of Returned Error Information

{
+    "code": "VPC.0504",
+    "message": "Floating IP could not be found."
+}
+
+

Error Code Description

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

Module

+

Status Code

+

Error Code

+

Message

+

Description

+

Handling Measure

+

Public

+

400

+

VPC.0002

+

Available zone Name is null.

+

The AZ is left blank.

+

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

+

404

+

VPC.0003

+

VPC does not exist.

+

The VPC does not exist.

+

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

+

400

+

VPC.0004

+

VPC is not active, please try later.

+

The VPC status is abnormal.

+

Try again later or contact technical support.

+

401

+

VPC.0005

+

Lack of user authority.

+

User restricted.

+

Check whether the account is in arrears or has not applied for the OBT permission.

+

401

+

VPC.0009

+

real-name authentication fail.

+

Real-name authentication fails.

+

Contact technical support.

+

Public

+

400

+

VPC.0007

+

urlTenantId is not equal tokenTenantId

+

Inconsistent tenant IDs.

+

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

+

401

+

VPC.0008

+

Invalid token in the header.

+

Invalid token.

+

Check whether the token in the request header is valid.

+

403

+

VPC.2701

+

Token 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

+

+

403

+

VPC.0010

+

Rules on xx by ** disallowed by policy

+

Insufficient permissions to make calls to the underlying system.

+

Obtain the required permissions.

+

403

+

VPC.2201

+

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

+

Insufficient fine-grained permissions.

+

Obtain the required permissions.

+

Creating a VPC

+

400

+

VPC.0101

+

Param is invalid.

+

VPC parameters are incorrect.

+

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

+

409

+

VPC.0114

+

Quota exceeded for resources: ['router'].

+

The number of VPCs has reached the maximum allowed limit specified by the quota.

+

Clear VPC resources that no longer will be used or apply for expanding the VPC resource quota.

+

400

+

VPC.0115

+

The router name has exist.

+

The VPC name already exists.

+

Change the VPC name.

+

Querying a VPC

+

400

+

VPC.0101

+

getVpc error vpcId is invalid.

+

VPC parameters are incorrect.

+

Ensure that the specified VPC ID is correct.

+

404/500

+

VPC.0105

+

Neutron Error.

+

Calling the backend service fails.

+

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

+

500

+

VPC.0106

+

get router is null.

+

An error is returned for the failure to call the backend service.

+

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

+

Querying VPCs

+

400

+

VPC.0101

+

Query vpc list error.

+

Failed to query the VPCs.

+

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

+

500

+

VPC.0105

+

Neutron Error.

+

Calling the backend service fails.

+

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

+

500

+

VPC.0106

+

query routers or getList are 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

+

400/404

+

VPC.0101

+

Delete router error xx is invalid.

+

Invalid parameters.

+

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

+

500

+

VPC.0102

+

Delete router fail.

+

The interface fails to obtain the routing resources.

+

Contact technical support.

+

409

+

VPC.0103

+

Resource status is busy, try it again later.

+

The VPC cannot be deleted because it is being created.

+

Contact technical support.

+

409

+

VPC.0104

+

Router contains subnets, please delete subnet first.

+

The VPC cannot be deleted because it contains subnets.

+

Delete the subnet in the VPC.

+

404/500

+

VPC.0105

+

Neutron Error.

+

Calling the backend service fails.

+

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

+

409

+

VPC.0107

+

Delete the firewall first before deleting the router.

+

Failed to delete the VPC because it has firewalls associated.

+

Delete the firewalls of the tenant first.

+

409

+

VPC.0108

+

Router is used not allow 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 its status is unstable.

+

Contact technical support.

+

500

+

VPC.0111

+

Database Error.

+

An internal VPC exception occurs.

+

Contact technical support.

+

409

+

VPC.0112

+

Delete the securitygroup first before deleting the router.

+

The VPC cannot be deleted because it contains security groups.

+

Delete security groups of the tenant.

+

409

+

VPC.0118

+

ELB exists under this router, delete ELB firstly.

+

The VPC cannot be deleted because it contains load balancers.

+

Delete load balancers in the VPC.

+

500

+

VPC.0119

+

ELB Error.

+

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

+

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

+

409

+

VPC.0120

+

exroutes exists under this router, delete exroutes firstly.

+

The VPC cannot be deleted because it contains extension routes.

+

Delete extension routes in the VPC.

+

Updating a VPC

+

+

400

+

VPC.0101

+

Update router xx is invalid.

+

Invalid parameters.

+

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

+

404/500

+

VPC.0105

+

Neutron Error.

+

Calling the backend service fails.

+

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

+

500

+

VPC.0113

+

Router status is not active.

+

The VPC cannot be updated because the status of the VPC is abnormal.

+

Try again later or contact technical support.

+

400

+

VPC.0115

+

The router name has exist.

+

The VPC name already exists.

+

Change the VPC name.

+

400

+

VPC.0117

+

Cidr can not contain subnetList cidr.

+

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

+

400

+

VPC.0201

+

Subnet name is invalid.

+

Incorrect subnet parameters.

+

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

+

500

+

VPC.0202

+

Create subnet failed.

+

An internal error occurs in the subnet.

+

Contact technical support.

+

400

+

VPC.0203

+

Subnet is not in the range of VPC.

+

The CIDR block of the subnet is not in the range of the VPC.

+

Change the CIDR block of the subnet.

+

400

+

VPC.0204

+

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

+

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

+

Change the CIDR block of the subnet.

+

400

+

VPC.0212

+

The subnet cidr is not valid.

+

Invalid subnet CIDR block.

+

Check whether the subnet CIDR block is valid.

+

Querying a subnet

+

400

+

VPC.0201

+

Subnet ID is invalid.

+

Invalid subnet ID.

+

Check whether the subnet ID is valid.

+

404/500

+

VPC.0202

+

Query subnet fail.

+

Failed to query the subnet.

+

Contact technical support.

+

Querying subnets

+

400

+

VPC.0201

+

Query subnets list error.

+

Failed to query the subnets.

+

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

+

500

+

VPC.0202

+

List subnets error.

+

Failed to query the subnets.

+

Contact technical support.

+

Deleting a subnet

+

400

+

VPC.0201

+

Subnet ID is invalid.

+

Invalid subnet ID.

+

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

+

404/500

+

VPC.0202

+

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

+

Subnet does not belong to the VPC.

+

This operation is not allowed because the subnet does not belong to the VPC.

+

Check whether the subnet is in the VPC.

+

500

+

VPC.0208

+

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

+

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

+

Delete the private IP address of the subnet.

+

500

+

VPC.0209

+

subnet is still used ,such as computer,LB.

+

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

+

Delete the ECS or load balancer in the subnet.

+

500

+

VPC.0210

+

Subnet has been used by routes, please remove the routes first and try again.

+

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

+

Delete the custom route.

+

500

+

VPC.0211

+

subnet is still used by LBaas.

+

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

+

Delete load balancers in the subnet.

+

Updating a subnet

+

400

+

VPC.0201

+

xx is invalid.

+

Incorrect subnet parameters.

+

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

+

404/500

+

VPC.0202

+

Neutron Error.

+

An internal error occurs in the subnet.

+

Contact technical support.

+

500

+

VPC.0205

+

Subnet states is invalid, please try again later.

+

The subnet cannot be updated because it is being processed.

+

Try again later or contact technical support.

+

400

+

VPC.0207

+

Subnet does not belong to the VPC.

+

This operation is not allowed because the subnet does not belong to the VPC.

+

Check whether the subnet is in the VPC.

+

Assigning an EIP

+

+

400

+

VPC.0301

+

Bandwidth name or share_type is invalid.

+

The specified bandwidth parameter for assigning an EIP is invalid.

+

Check whether the specified bandwidth parameter is valid.

+

400

+

VPC.0501

+

Bandwidth share_type is invalid.

+

Invalid EIP parameters.

+

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

+

403

+

VPC.0502

+

Tenant status is op_restricted.

+

You are not allowed to assign the EIP.

+

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

+

500

+

VPC.0503

+

Creating publicIp failed.

+

Failed to assign the EIP.

+

Contact technical support.

+

500

+

VPC.0504

+

FloatIp is null.

+

Failed to assign the EIP because no IP address is found.

+

Contact technical support.

+

500

+

VPC.0508

+

Port is invalid.

+

Port-related resources could not be found.

+

Contact technical support.

+

409

+

VPC.0510

+

Floatingip has already associated with port.

+

The EIP has already been bound to another ECS.

+

Unbind the EIP from the ECS.

+

409

+

VPC.0511

+

Port has already associated with floatingip.

+

The port has already been associated with an EIP.

+

Disassociate the port from the EIP.

+

409

+

VPC.0521

+

Quota exceeded for resources: ['floatingip'].

+

Insufficient EIP quota.

+

Release the unbound EIPs or request to increase the EIP quota.

+

409

+

VPC.0522

+

The IP address is in use.

+

The IP address is invalid or in use.

+

Check whether the IP address format is valid or replace it with another IP address.

+

409

+

VPC.0532

+

No more IP addresses available on network.

+

Failed to assign the IP address because no IP addresses are available.

+

Release unbound EIPs or try again later.

+

Querying an EIP

+

400

+

VPC.0501

+

Invalid floatingip_id.

+

Invalid EIP parameters.

+

Check whether the EIP ID is valid.

+

404

+

VPC.0504

+

Floating IP could not be found.

+

The EIP could not be found.

+

Check whether the specified EIP ID is valid.

+

500

+

VPC.0514

+

Neutron Error.

+

An exception occurs in the IaaS OpenStack system.

+

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

+

Querying EIPs

+

400

+

VPC.0501

+

Invalid limit.

+

Invalid EIP parameters.

+

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

+

Releasing an EIP

+

+

+

+

+

+

+

+

400

+

VPC.0501

+

Invalid param.

+

Invalid EIP parameters.

+

Contact technical support.

+

404

+

VPC.0504

+

Floating IP could not be found.

+

The EIP could not be found.

+

Check whether the specified EIP ID is valid.

+

409

+

VPC.0512

+

Resource status is busy, try it again later.

+

The EIP status is abnormal.

+

Try again later or contact technical support.

+

500

+

VPC.0513

+

getElementByKey error.

+

Network resources cannot be found.

+

Contact technical support.

+

500

+

VPC.0516

+

Publicip is in used by ELB.

+

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

+

Unbind the EIP from the load balancer.

+

409

+

VPC.0517

+

Floatingip has associated with port, please disassociate it firstly.

+

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

+

Unbind the EIP from the ECS.

+

500

+

VPC.0518

+

Public IP has firewall rules.

+

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

+

Contact technical support.

+

Updating an EIP

+

400

+

VPC.0501

+

Port id is invalid.

+

Invalid EIP parameters.

+

Check whether the port ID is valid.

+

404

+

VPC.0504

+

Floating IP could not be found.

+

The EIP could not be found.

+

Check whether the specified EIP ID is valid.

+

500

+

VPC.0509

+

Floating ip double status is invalid.

+

The port has already been associated with an EIP.

+

Disassociate the port from the EIP.

+

409

+

VPC.0510

+

Floatingip has already associated with port.

+

The EIP has already been bound to another ECS.

+

Unbind the EIP from the ECS.

+

409

+

VPC.0511

+

Port has already associated with floatingip.

+

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

+

Unbind the EIP from the ECS.

+

409

+

VPC.0512

+

Resource status is busy, try it again later.

+

The EIP status is abnormal.

+

Try again later or contact technical support.

+

404/500

+

VPC.0514

+

Neutron Error.

+

An exception occurs in the IaaS OpenStack system.

+

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

+

Querying a bandwidth

+

+

400

+

VPC.0301

+

getBandwidth error bandwidthId is invalid.

+

The bandwidth parameters are incorrect.

+

Check whether the bandwidth ID is valid.

+

404

+

VPC.0306

+

No Eip bandwidth exist with id.

+

The bandwidth object does not exist.

+

The bandwidth object to be queried does not exist.

+

500

+

VPC.0302

+

Neutron Error.

+

An exception occurs in the IaaS OpenStack system.

+

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

+

Querying bandwidths

+

400

+

VPC.0301

+

Get bandwidths error limit is invalid.

+

The bandwidth parameters are incorrect.

+

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.

+

The bandwidth object does not exist.

+

The bandwidth object to be queried does not exist.

+

500

+

VPC.0302

+

Neutron Error.

+

An exception occurs in the IaaS OpenStack system.

+

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

+

Updating a bandwidth

+

+

400

+

VPC.0301

+

updateBandwidth input param is invalid.

+

The bandwidth parameters are incorrect.

+

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

+

500

+

VPC.0302

+

Neutron Error.

+

Failed to obtain underlying resources.

+

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

+

500

+

VPC.0305

+

updateBandwidth error.

+

An internal error occurs during the bandwidth update.

+

Contact technical support.

+

Querying quotas

+

400

+

VPC.1207

+

resource type is invalid.

+

The specified resource type does not exist.

+

Use an existing resource type.

+

Assigning a private IP address

+

+

+

+

500

+

VPC.0701

+

The IP has been used.

+

The private IP address already exists.

+

Change another private IP address and try again.

+

400

+

VPC.0705

+

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

+

Invalid private IP address

+

Check whether the specified IP address in the request body is within the subnet CIDR block.

+

404

+

VPC.2204

+

Query resource by id fail.

+

The resource does not exist or the permission is insufficient.

+

Check whether the specified subnet in the request body exists or the current account has the permission to query the subnet.

+

409

+

VPC.0703

+

No more IP addresses available on network xxx.

+

Insufficient IP addresses.

+

Check whether the subnet has sufficient IP addresses.

+

Querying a Private IP Address

+

404

+

VPC.0704

+

Query resource by id fail.

+

The private IP address does not exist.

+

Check whether the private IP address exists.

+

Querying Private IP Addresses

+

400

+

VPC.0702

+

query privateIps error.

+

Invalid parameters.

+

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

+

Releasing a Private IP Address

+

+

+

404

+

VPC.0704

+

Query resource by id fail.

+

The private IP address does not exist.

+

Check whether the private IP address exists.

+

500

+

VPC.0706

+

Delete port fail.

+

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

+

Try again later or contact technical support.

+

409

+

VPC.0707

+

privateIp 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

+

+

400

+

VPC.0601

+

Creating securitygroup name is invalid.

+

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.

+

500

+

VPC.0602

+

Add security group fail.

+

An internal error occurs in the security group.

+

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

+

409

+

VPC.0604

+

Quota exceeded for resources: ['security_group'].

+

Insufficient security group quota.

+

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

+

Querying a security group

+

400

+

VPC.0601

+

Securitygroup id is invalid.

+

The parameters of the security group are incorrect.

+

Check whether the security group ID is valid.

+

500

+

VPC.0602

+

Query security group fail.

+

An internal error occurs in the security group.

+

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

+

404

+

VPC.0603

+

Securitygroup is not exist.

+

The security group does not exist.

+

Check whether the security group ID is correct or whether the security group exists under the tenant.

+

404/500

+

VPC.0612

+

Neutron Error.

+

An internal error occurs in the security group.

+

Contact technical support.

+

Querying security groups

+

400

+

VPC.0601

+

Query security groups error limit is invalid.

+

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.

+

500

+

VPC.0602

+

Query security groups fail.

+

An internal error occurs in the security group.

+

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

+

400

+

VPC.0606

+

Security group id is invalid

+

Invalid security group ID.

+

Use a valid security group ID.

+

400

+

VPC.0606

+

Request is invalid

+

The request structure is missing.

+

Use a valid request body.

+

400

+

VPC.0606

+

Request is null

+

The request is empty.

+

Use a valid request body.

+

400

+

VPC.0606

+

Action is invalid

+

Invalid action value.

+

Use a valid action value (add or remove).

+

400

+

VPC.0606

+

Ports list is empty

+

The ports are an empty list.

+

Use a valid ports list.

+

400

+

VPC.0606

+

Port id is invalid

+

The ports list contains invalid port IDs.

+

Use a valid ports list.

+

400

+

VPC.0609

+

Ports list exceeds limit

+

The ports list contains more than 20 IDs.

+

Use a valid ports list.

+

400

+

VPC.0606

+

Endpoint is invalid

+

Invalid endpoint.

+

Contact technical support.

+

200

+

VPC.0607

+

Security group of this instance doesn't exist

+

The security group does not exist.

+

Use a valid security group ID.

+

200

+

VPC.0607

+

An instance must belong to at least one security group

+

Do not disassociate the instance from the security group when it is associated with only one security group.

+

Perform other operations.

+

200

+

VPC.0608

+

Neutron Error

+

An internal error occurs when you perform batch operations.

+

Contact technical support.

+

Flow log

+

+

+

400

+

VPC.3001

+

resource could not be found, flowlog id is invalid

+

Invalid parameters.

+

Check whether the parameters are valid.

+

400

+

VPC.3002

+

create its topic failed

+

An error occurred during log topic creation in LTS.

+

Check whether the parameters are valid.

+

404

+

VPC.3002

+

NeutronError

+

Failed to query the flow log.

+

Check whether the parameters are valid.

+

500

+

VPC.3002

+

NeutronError

+

Failed to create the flow log.

+

Contact technical support.

+

Resource tags

+

400

+

VPC.1801

+

resource id is invalid.

+

Incorrect resource ID.

+

Use a correct resource ID.

+

400

+

VPC.1801

+

action is invalid.

+

Invalid action value.

+

Ensure that the value of action is create or delete.

+

400

+

VPC.1801

+

Tag length is invalid. The key length must be in range [1,36] and value in range [0,43]

+

Invalid key length. The key can contain 1 to 36 characters.

+

Use a valid key value.

+

400

+

VPC.1801

+

Tag length is invalid. The key length must be in range [1,36] and value in range [0,43]

+

Invalid value length.

+

The value can contain 0 to 43 characters.

+

Use a value of valid length.

+

400

+

VPC.1801

+

Resource_type xxx is invalid.

+

Incorrect resource type.

+

Ensure that the value of resource_type is vpcs.

+

400

+

VPC.1801

+

Tag can not be null.

+

The tag list contains value null.

+

Use valid tags.

+

400

+

VPC.1801

+

The list of matches contains null.

+

The matches list contains value null.

+

Use valid matches.

+

400

+

VPC.1801

+

Tag value can not be null.

+

The tags exist, but their values are null.

+

Use valid tags.

+

400

+

VPC.1801

+

The value of Matches in resourceInstancesReq is null.

+

The matches exist, and the value is null.

+

Use valid matches.

+

400

+

VPC.1801

+

number of tags exceeds max num of 10.

+

The tag list contains more than 10 keys.

+

Use valid tags.

+

400

+

VPC.1801

+

Tag key is repeated.

+

The tag list contains duplicate keys.

+

Use valid tags.

+

400

+

VPC.1801

+

Value of tags in resourceInstancesReq is duplicate.

+

There are duplicate tag values in the tag list.

+

Use valid tags.

+

400

+

VPC.1801

+

number of tags exceeds max num of 10.

+

The tag in the tag list has more than 10 tag values.

+

Use valid tags.

+

400

+

VPC.1801

+

The key of matches is invalid.

+

The key in matches is not the resource name.

+

Use valid matches.

+

400

+

VPC.1801

+

Limit in resourceInstancesReq is invalid.

+

Offset in resourceInstancesReq is invalid.

+

Invalid limit or offset value.

+

Use valid limit and offset values.

+

400

+

VPC.1801

+

ResourceInstancesReq is null or invalid.

+

The tags dictionary structure is missing.

+

Use a valid tags dictionary structure.

+

400

+

VPC.1801

+

Tag length is invalid. The key length must be in range [1,36] and value in range [0,43]

+

The key in tags exceeds the maximum length or is left blank.

+

Use valid keys in tags.

+

400

+

VPC.1801

+

Tag length is invalid. The key length must be in range [1,36] and value in range [0,43]

+

A value in tags exceeds the maximum length.

+

Use valid values in tags.

+

400

+

VPC.1801

+

ResourceInstancesReq is null or invalid.

+

The matches dictionary structure is missing.

+

Use a valid matches dictionary structure.

+

400

+

VPC.1801

+

The number of Matches in resourceInstancesReq is 0.

+

The matches are an empty list.

+

Use a valid matches list.

+

400

+

VPC.1801

+

The value's length of Matches in resourceInstancesReq is more than 255.

+

The matches list contains tag values that contain more than 255 Unicode characters.

+

Use a valid matches list.

+

500

+

VPC.1801

+

InvalidInput

+

Incorrect request body format.

+

Use the correct request body format.

+

404

+

VPC.2204

+

Query subnet by id fail.

+

The resource does not exist or the permission is insufficient.

+

Use an existing resource or obtain required permission.

+

Querying the network IP address usage

+

400

+

VPC.2301

+

parameter network_id is invalid.

+

The request parameter is incorrect.

+

Enter a valid network ID.

+

400

+

VPC.2302

+

Network xxx could not be found.

+

The network is not found.

+

Ensure that the network ID exists.

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/eip/api-ref/eip_api06_0001.html b/docs/eip/api-ref/eip_api06_0001.html new file mode 100644 index 000000000..777acba7a --- /dev/null +++ b/docs/eip/api-ref/eip_api06_0001.html @@ -0,0 +1,16 @@ + + +

Appendix

+

+
+
+ +
+ diff --git a/docs/eip/api-ref/eip_api06_0003.html b/docs/eip/api-ref/eip_api06_0003.html new file mode 100644 index 000000000..8ee81851a --- /dev/null +++ b/docs/eip/api-ref/eip_api06_0003.html @@ -0,0 +1,110 @@ + + +

VPC Monitoring Metrics

+

Description

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 monitoring metrics of the monitored object and alarms generated for VPC.

+
+

Namespace

SYS.VPC

+
+

Metrics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 EIP and bandwidth metrics

ID

+

Name

+

Description

+

Value Range

+

Monitored Object

+

Monitoring Interval (Raw Data)

+

upstream_bandwidth

+

Outbound Bandwidth

+

Network rate of outbound traffic

+

Unit: bit/s

+

≥ 0 bit/s

+

Bandwidth or EIP

+

1 minute

+

downstream_bandwidth

+

Inbound Bandwidth

+

Network rate of inbound traffic

+

Unit: bit/s

+

≥ 0 bit/s

+

Bandwidth or EIP

+

1 minute

+

up_stream

+

Outbound Traffic

+

Network traffic going out of the cloud platform

+

Unit: byte

+

≥ 0 bytes

+

Bandwidth or EIP

+

1 minute

+

down_stream

+

Inbound Traffic

+

Network traffic going into the cloud platform

+

Unit: byte

+

≥ 0 bytes

+

Bandwidth or EIP

+

1 minute

+
+
+
+

Dimension

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

Key

+

Value

+

publicip_id

+

EIP ID

+

bandwidth_id

+

Bandwidth ID

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/eip/api-ref/eip_api07_0000.html b/docs/eip/api-ref/eip_api07_0000.html new file mode 100644 index 000000000..98c302837 --- /dev/null +++ b/docs/eip/api-ref/eip_api07_0000.html @@ -0,0 +1,93 @@ + + +

Change History

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

Released On

+

Description

+

2022-06-25

+

This release incorporates the following changes:

+

Modified the load balancer types applicable to the 5_gray type in Assigning an EIP, Querying an EIP, Querying EIPs, Updating an EIP, Querying a Bandwidth, Querying Bandwidths, Updating a Bandwidth, Assigning a Shared Bandwidth, and Adding an EIP to a Shared Bandwidth.

+

2022-03-03

+

This release incorporates the following changes:

+

Added descriptions of parameters private_ip_address and port_id in Querying an EIP, Querying EIPs, and Updating an EIP.

+

2022-02-15

+

This release incorporates the following changes:

+ +

2021-12-31

+

This release incorporates the following change:

+ +

2021-08-25

+

This release incorporates the following changes:

+ +

2021-06-18

+

This release incorporates the following changes:

+ +

2021-05-25

+

This release incorporates the following changes:

+ +

2021-05-10

+

This release incorporates the following changes:

+ +

2021-03-16

+

This release incorporates the following changes:

+

Added description that leaving parameter port_id blank cannot be used to unbind an EIP from a dedicated load balancer in sections Updating an EIP and Updating a Floating IP Address.

+

2020-12-16

+

This release incorporates the following changes:

+ +

2020-03-20

+

This release incorporates the following changes:

+

Added the value of 5_mailbgp for parameters type and publicip_type

+

in sections Assigning an EIP, Bandwidth, and Bandwidth (V2.0).

+

2020-02-25

+

This release incorporates the following changes:

+ +

2018-09-14

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/eip/api-ref/eip_apiBandwidth_0000.html b/docs/eip/api-ref/eip_apiBandwidth_0000.html new file mode 100644 index 000000000..f415305ed --- /dev/null +++ b/docs/eip/api-ref/eip_apiBandwidth_0000.html @@ -0,0 +1,19 @@ + + +

Bandwidth

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/eip/api-ref/eip_apiBandwidth_0001.html b/docs/eip/api-ref/eip_apiBandwidth_0001.html new file mode 100644 index 000000000..2804f042e --- /dev/null +++ b/docs/eip/api-ref/eip_apiBandwidth_0001.html @@ -0,0 +1,246 @@ + + +

Querying a Bandwidth

+

Function

This API is used to query details about a bandwidth.

+
+

URI

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

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

bandwidth_id

+

Yes

+

Specifies the bandwidth ID, which uniquely identifies the bandwidth.

+
+
+
+
+

Request Message

  • Request parameter

    None

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

Response Message

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

    Name

    +

    Type

    +

    Description

    +

    bandwidth

    +

    bandwidth object

    +

    Specifies the bandwidth object.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Description of the bandwidth field

    Name

    +

    Type

    +

    Description

    +

    name

    +

    String

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

    size

    +

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

    id

    +

    String

    +

    Specifies the bandwidth ID, which uniquely identifies the bandwidth.

    +

    share_type

    +

    String

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

    publicip_info

    +

    Array of publicip_info objects

    +
    • Specifies information about the EIP that uses the bandwidth. For details, see Table 4.
    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    bandwidth_type

    +

    String

    +
    • Specifies the bandwidth type.
    • The value can be:
      • share: Shared bandwidth
      • gray: Dedicated load balancer
      • bgp: Dynamic BGP
      +
    +

    charge_mode

    +

    String

    +    		 +

    If the value is traffic, the billing is based on traffic.

    +

    billing_info

    +

    String

    +

    Specifies the bill information.

    +

    If billing_info is specified, the bandwidth is in yearly/monthly billing mode.

    +

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

    +
    +

    status

    +

    String

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

    created_at

    +

    String

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

    updated_at

    +

    String

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

    Name

    +

    Type

    +

    Description

    +

    publicip_id

    +

    String

    +

    Specifies the ID of the EIP that uses the bandwidth.

    +

    publicip_address

    +

    String

    +

    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 (IPv6 is not supported currently.)
      +
    +

    publicip_type

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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.
      +
    +
    +
    +
+
  • Example response
    {
+  "bandwidth": {
+    "id": "3cbd5ae9-368f-4bc8-8841-f2ecc322c64a",
+    "name": "EIPResourceSetup_1553594229",
+    "size": 5,
+    "share_type": "PER",
+    "publicip_info": [
+      {
+        "publicip_id": "22b02f40-b95f-465a-ae9b-7c8b0f042a41",
+        "publicip_address": "10.xx.xx.62",
+        "ip_version": 4,
+        "publicip_type": "5_bgp",
+      }
+    ],
+    "tenant_id": "26ae5181a416420998eb2093aaed84d9",
+    "bandwidth_type": "bgp",
+    "charge_mode": "traffic",
+    "enterprise_project_id": "0",
+    "status": "NORMAL",
+    "created_at": "2020-04-21T07:58:02Z",
+    "updated_at": "2020-04-21T07:58:02Z"
+  }
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Bandwidth
+
+
+ diff --git a/docs/eip/api-ref/eip_apiBandwidth_0002.html b/docs/eip/api-ref/eip_apiBandwidth_0002.html new file mode 100644 index 000000000..541e16e5b --- /dev/null +++ b/docs/eip/api-ref/eip_apiBandwidth_0002.html @@ -0,0 +1,330 @@ + + +

Querying Bandwidths

+

Function

This API is used to query bandwidths using search criteria.

+
+

URI

GET /v1/{project_id}/bandwidths

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

Name

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

marker

+

No

+

String

+

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, all resource records 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.
+

limit

+

No

+

Integer

+

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

+

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

+

enterprise_project_id

+

No

+

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.

+
+
+
+
+
+

Request Message

  • Request parameter

    None

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

Response Message

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

    Name

    +

    Type

    +

    Description

    +

    bandwidths

    +

    Array of bandwidths objects

    +

    Specifies the bandwidth objects. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Description of the bandwidths field

    Name

    +

    Type

    +

    Description

    +

    name

    +

    String

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

    size

    +

    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 bandwidth range of each region on the management console.)
    +

    id

    +

    String

    +

    Specifies the bandwidth ID, which uniquely identifies the bandwidth.

    +

    share_type

    +

    String

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

    +

    publicip_info

    +

    Array of publicip_info objects

    +
    • Specifies the information about the EIP that uses the bandwidth. For details, see Table 4.
    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    bandwidth_type

    +

    String

    +
    • Specifies the bandwidth type.
    • The value can be:
      • share: Shared bandwidth
      • gray: Dedicated load balancer
      • bgp: Dynamic BGP
      +
    +

    charge_mode

    +

    String

    +    		 +

    If the value is traffic, the bandwidth is billed by traffic.

    +

    billing_info

    +

    String

    +

    Specifies the bill information.

    +

    If billing_info is specified, the bandwidth is in yearly/monthly billing mode.

    +

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

    created_at

    +

    String

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

    updated_at

    +

    String

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

    + +
    + + + + + + + + + + + + + + + + + +
    Table 4 publicip_info object

    Name

    +

    Type

    +

    Description

    +

    publicip_id

    +

    String

    +

    Specifies the ID of the EIP that uses the bandwidth.

    +

    publicip_address

    +

    String

    +

    Specifies the obtained EIP if only IPv4 EIPs are available.

    +

    publicip_type

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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.
      +
    +
    +
    +
+
  • Example response
    {
+  "bandwidths": [
+    {
+      "id": "09b99c91-da7c-449f-94e2-f4934c5b2a71",
+      "name": "vpngw-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977",
+      "size": 200,
+      "share_type": "PER",
+      "publicip_info": [
+        {
+          "publicip_id": "2a65923c-7133-415d-ae3b-cf9635a942c5",
+          "publicip_address": "10.xx.xx.3",
+          "ip_version": 4,
+          "publicip_type": "5_bgp",
+        }
+      ],
+      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
+      "bandwidth_type": "bgp",
+      "charge_mode": "traffic",
+      "billing_info": "",
+      "enterprise_project_id": "0",
+      "status": "NORMAL"
+    },
+    {
+      "id": "0a583ff1-b43e-4000-ade3-e7af0097f832",
+      "name": "vpngw-7e880d5b-f458-40ad-a7e5-735c44cd8b7d",
+      "size": 300,
+      "share_type": "PER",
+      "publicip_info": [
+        {
+          "publicip_id": "c754bc9a-16d5-4763-9674-d7561917aa80",
+          "publicip_address": "10.xx.xx.9",
+          "ip_version": 4,
+          "publicip_type": "5_bgp",
+        }
+      ],
+      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
+      "bandwidth_type": "bgp",
+      "charge_mode": "traffic",
+      "billing_info": "",
+      "enterprise_project_id": "0",
+      "status": "NORMAL"
+    },
+    {
+      "id": "0a673f00-3640-4a13-949e-7049b2916baf",
+      "name": "bandwidth123",
+      "size": 10,
+      "share_type": "PER",
+      "publicip_info": [
+        {
+          "publicip_id": "cec7fb70-2f82-4561-bd83-2121fb642fdc",
+          "publicip_address": "10.xx.xx.184",
+          "ip_version": 4,
+          "publicip_type": "5_bgp",
+        }
+      ],
+      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
+      "bandwidth_type": "bgp",
+      "charge_mode": "traffic",
+      "billing_info": "",
+      "enterprise_project_id": "0",
+      "status": "NORMAL"
+    },
+    {
+      "id": "0dde1eae-1783-46dc-998c-930fbe261ff9",
+      "name": "bandwidth123",
+      "size": 100,
+      "share_type": "PER",
+      "publicip_info": [
+        {
+          "publicip_id": "24232038-e178-40ad-80e4-5abb75db84be",
+          "publicip_address": "10.xx.xx.101",
+          "ip_version": 4,
+          "publicip_type": "5_bgp",
+        }
+      ],
+      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
+      "bandwidth_type": "bgp",
+      "charge_mode": "traffic",
+      "billing_info": "",
+      "enterprise_project_id": "0",
+      "status": "NORMAL"
+    }
+  ]
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Bandwidth
+
+
+ diff --git a/docs/eip/api-ref/eip_apiBandwidth_0003.html b/docs/eip/api-ref/eip_apiBandwidth_0003.html new file mode 100644 index 000000000..c63afbe34 --- /dev/null +++ b/docs/eip/api-ref/eip_apiBandwidth_0003.html @@ -0,0 +1,307 @@ + + +

Updating a Bandwidth

+

Function

This API is used to update information about a bandwidth.

+
+

URI

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

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

bandwidth_id

+

Yes

+

Specifies the bandwidth ID, which uniquely identifies the bandwidth.

+
+
+
+
+

Request Message

  • Request parameter +
    + + + + + + + + + + + +
    Table 2 Request parameter

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    bandwidth

    +

    Yes

    +

    bandwidth object

    +

    Specifies the bandwidth objects. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 Description of the bandwidth field

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    No

    +

    String

    +
    • Specifies the bandwidth name.
    • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). If the value is left blank, the name of the bandwidth is not changed.
    • Either parameter name or size must be specified.
    +

    size

    +

    No

    +

    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.
      +
    +
    +
    +
+
  • Example request
    PUT https://{Endpoint}/v1/{project_id}/bandwidths/{bandwidth_id} 
+
+{
+    "bandwidth":
+        {"name": "bandwidth123",
+         "size": 10
+        }
+}
    +
+
+

Response Message

  • Response parameter +
    + + + + + + + + + +
    Table 4 Response parameter

    Name

    +

    Type

    +

    Description

    +

    bandwidth

    +

    bandwidth object

    +

    Specifies the bandwidth objects. For details, see Table 5.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Description of the bandwidth field

    Name

    +

    Type

    +

    Description

    +

    name

    +

    String

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

    size

    +

    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 bandwidth range of each region on the management console.)
    +

    id

    +

    String

    +

    Specifies the bandwidth ID, which uniquely identifies the bandwidth.

    +

    share_type

    +

    String

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

    publicip_info

    +

    Array of publicip_info objects

    +
    • Specifies the information about the EIP that uses the bandwidth. For details, see Table 6.
    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    bandwidth_type

    +

    String

    +
    • Specifies the bandwidth type.
    • The value can be bgp or share.
      • share: Shared bandwidth
      • bgp: Dynamic BGP
      +
    +

    charge_mode

    +

    String

    +    		 +

    If the value is traffic, the bandwidth is billed by traffic.

    +

    billing_info

    +

    String

    +

    Specifies the bill information.

    +

    If billing_info is specified, the bandwidth is in yearly/monthly billing mode.

    +

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

    created_at

    +

    String

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

    updated_at

    +

    String

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

    Name

    +

    Type

    +

    Description

    +

    publicip_id

    +

    String

    +

    Specifies the ID of the EIP that uses the bandwidth.

    +

    publicip_address

    +

    String

    +

    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 (IPv6 is not supported currently.)
      +
    +

    publicip_type

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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.
      +
    +
    +
    +
+
  • Example response
    {
+    "bandwidth": {
+        "id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
+        "name": "bandwidth123",
+        "size": 10,
+        "share_type": "PER",
+        "publicip_info": [
+            {
+                "publicip_id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
+                "publicip_address": "161.xx.xx.9",
+                "publicip_type": "5_bgp",
+                "ip_version": 4            
+            }
+        ],
+        "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
+        "bandwidth_type": "bgp",
+        "charge_mode": "traffic",
+        "billing_info": "",
+        "status": "NORMAL"
+    }
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Bandwidth
+
+
+ diff --git a/docs/eip/api-ref/eip_api_0000.html b/docs/eip/api-ref/eip_api_0000.html new file mode 100644 index 000000000..31a2a54ab --- /dev/null +++ b/docs/eip/api-ref/eip_api_0000.html @@ -0,0 +1,23 @@ + + +

Elastic IP

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/eip/api-ref/eip_api_0001.html b/docs/eip/api-ref/eip_api_0001.html new file mode 100644 index 000000000..8abc65556 --- /dev/null +++ b/docs/eip/api-ref/eip_api_0001.html @@ -0,0 +1,308 @@ + + +

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, load balancers, and NAT gateways.

+
+

URI

POST /v1/{project_id}/publicips

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+
+
+
+
+

Request Message

  • Request parameter +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameter

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    publicip

    +

    Yes

    +

    publicip object

    +

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

    +

    bandwidth

    +

    Yes

    +

    bandwidth object

    +

    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

    +

    Mandatory

    +

    Type

    +

    Description

    +

    type

    +

    Yes

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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_address

    +

    No

    +

    String

    +
    • Specifies the EIP to be assigned. The system automatically assigns an EIP if you do not specify it.
    • The value must be a valid IPv4 address in the available IP address range.
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Description of the bandwidth field

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +
    • Specifies the bandwidth name.
    • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
    • 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.
    +

    size

    +

    Yes

    +

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

    id

    +

    No

    +

    String

    +
    • Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP.
    • The value can be the ID of the shared bandwidth whose type is set to WHOLE.
    +

    share_type

    +

    Yes

    +

    String

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

    charge_mode

    +

    No

    +

    String

    +
    • 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
+
+{
+    "publicip": {
+        "type": "5_bgp",
+        "ip_version": 4
+    },
+    "bandwidth": {
+        "name": "bandwidth123",
+        "size": 10,
+        "share_type": "PER"
+    },
+    "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
+}
    +
+
+

Response Message

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

    Name

    +

    Type

    +

    Description

    +

    publicip

    +

    publicip object

    +

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

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

    Name

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique identifier of an EIP.

    +

    status

    +

    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)
      • DOWN (Unbound)
      • ACTIVE (Bound)
      • ELB (Bound to a load balancer)
      • ERROR (Exceptions)
      +
    +

    type

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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

    +

    String

    +

    Specifies the obtained EIP if only IPv4 EIPs are available.

    +

    ip_version

    +

    Integer

    +

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

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

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    create_time

    +

    String

    +

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

    +

    bandwidth_size

    +

    Integer

    +

    Specifies the bandwidth (Mbit/s).

    +

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

    This parameter is unsupported. Do not use it.

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

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Elastic IP
+
+
+ diff --git a/docs/eip/api-ref/eip_api_0002.html b/docs/eip/api-ref/eip_api_0002.html new file mode 100644 index 000000000..cb0738975 --- /dev/null +++ b/docs/eip/api-ref/eip_api_0002.html @@ -0,0 +1,256 @@ + + +

Querying an EIP

+

Function

This API is used to query a specific EIP.

+
+

URI

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

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

publicip_id

+

Yes

+

Specifies the unique identifier of an EIP.

+
+
+
+
+

Request Message

  • Request parameter

    None

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

Response Message

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

    Name

    +

    Type

    +

    Description

    +

    publicip

    +

    publicip object

    +

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

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

    Name

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique identifier of an EIP.

    +

    status

    +

    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)
      • DOWN (Unbound)
      • ACTIVE (Bound)
      • ELB (Bound to a load balancer)
      • ERROR (Exceptions)
      +
    +

    profile

    +

    profile object

    +

    Specifies the additional parameters, including the order ID and product ID. For details, see Table 4.

    +

    type

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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

    +

    String

    +

    Specifies the obtained EIP if only IPv4 EIPs are available. Specifies the IPv4 address corresponding to the IPv6 address if IPv6 EIPs are available. IPv6 is not supported currently.

    +

    ip_version

    +

    Integer

    +
    Specifies the IP address version. The value can be 4 or 6.
    • 4: IPv4
    • 6: IPv6 (IPv6 is not supported currently.)
    +
    +

    private_ip_address

    +

    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.

    +
    +

    port_id

    +

    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.

    +
    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    create_time

    +

    String

    +

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

    +

    bandwidth_id

    +

    String

    +

    Specifies the ID of the EIP bandwidth.

    +

    bandwidth_size

    +

    Integer

    +

    Specifies the bandwidth (Mbit/s).

    +

    bandwidth_share_type

    +

    String

    +
    • Specifies the EIP bandwidth type.
    • The value can be PER or WHOLE.
      • PER: Dedicated bandwidth
      • WHOLE: Shared bandwidth
      +
    +

    bandwidth_name

    +

    String

    +

    Specifies the bandwidth 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 assigning an EIP, you need to 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 4 Description of the profile field

    Name

    +

    Type

    +

    Description

    +

    order_id

    +

    String

    +

    Specifies the order ID.

    +

    product_id

    +

    String

    +

    Specifies the product ID.

    +

    region_id

    +

    String

    +

    Specifies the region ID.

    +

    user_id

    +

    String

    +

    Specifies the user ID.

    +
    +
    +
+
+
  • Example response
    {
+    "publicip": {
+        "id": "2ec9b78d-9368-46f3-8f29-d1a95622a568",
+        "status": "DOWN",
+        "profile": {},
+        "type": "5_bgp",
+        "public_ip_address": "161.xx.xx.12",
+        "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
+        "private_ip_address": "192.168.10.5",
+        "create_time": "2015-07-16 04:32:50",
+        "bandwidth_id": "49c8825b-bed9-46ff-9416-704b96d876a2",
+        "bandwidth_share_type": "PER",
+"bandwidth_size": 10,    //The EIP bandwidth size is 10 Mbit/s.
+        "bandwidth_name": "bandwidth-test",
+        "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
+        "ip_version": 4
+    }
+}
    +
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Elastic IP
+
+
+ diff --git a/docs/eip/api-ref/eip_api_0003.html b/docs/eip/api-ref/eip_api_0003.html new file mode 100644 index 000000000..aa9b700db --- /dev/null +++ b/docs/eip/api-ref/eip_api_0003.html @@ -0,0 +1,302 @@ + + +

Querying EIPs

+

Function

This API is used to query EIPs.

+
+

URI

GET /v1/{project_id}/publicips

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

Name

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

marker

+

No

+

String

+

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, all resource records 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.
+

limit

+

No

+

Integer

+

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

+

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

+

enterprise_project_id

+

No

+

String

+
  • Specifies the enterprise project ID. This field can be used to filter the EIPs of an 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 EIPs bound to all enterprise projects of the user, set all_granted_eps.
+
NOTE:

This parameter is unsupported. Do not use it.

+
+
+
+
+
+

Request Message

  • Request parameter

    None

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

Response Message

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

    Name

    +

    Type

    +

    Description

    +

    publicips

    +

    Array of publicips objects

    +

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

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Description of the publicips field

    Name

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique identifier of an EIP.

    +

    status

    +

    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)
      • DOWN (Unbound)
      • ACTIVE (Bound)
      • ELB (Bound to a load balancer)
      • ERROR (Exceptions)
      +
    +

    profile

    +

    Object

    +

    Specifies the additional parameters, including the order ID and product ID. For details, see Table 4.

    +

    type

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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

    +

    String

    +

    Specifies the obtained EIP if only IPv4 EIPs are available.

    +

    ip_version

    +

    Integer

    +

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

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

    private_ip_address

    +

    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.

    +
    +

    port_id

    +

    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.

    +
    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    create_time

    +

    String

    +

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

    +

    bandwidth_id

    +

    String

    +

    Specifies the ID of the EIP bandwidth.

    +

    bandwidth_size

    +

    Integer

    +

    Specifies the bandwidth (Mbit/s).

    +

    bandwidth_share_type

    +

    String

    +
    • Specifies the EIP bandwidth type.
    • The value can be PER or WHOLE.
      • PER: Dedicated bandwidth
      • WHOLE: Shared bandwidth
      +
    +

    bandwidth_name

    +

    String

    +

    Specifies the bandwidth 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 assigning an EIP, you need to 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 4 Description of the profile field

    Name

    +

    Type

    +

    Description

    +

    order_id

    +

    String

    +

    Specifies the order ID.

    +

    product_id

    +

    String

    +

    Specifies the product ID.

    +

    region_id

    +

    String

    +

    Specifies the region ID.

    +

    user_id

    +

    String

    +

    Specifies the user ID.

    +
    +
    +
  • Example response
    {
+    "publicips": [
+        {
+            "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
+            "status": "DOWN",
+            "profile": {},
+            "type": "5_bgp",
+            "public_ip_address": "161.xx.xx.9",
+            "private_ip_address": "192.168.10.5",
+            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
+            "create_time": "2015-07-16 04:22:32",
+            "bandwidth_id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
+            "bandwidth_share_type": "PER",
+            "bandwidth_size": 5,
+            "bandwidth_name": "bandwidth-test",
+            "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
+            "ip_version": 4
+        },
+        {
+            "id": "80d5b82e-43b9-4f82-809a-37bec5793bd4",
+            "status": "DOWN",
+            "profile": {},
+            "type": "5_bgp",
+            "public_ip_address": "161.xx.xx.10",
+            "private_ip_address": "192.168.10.6",
+            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
+            "create_time": "2015-07-16 04:23:03",
+            "bandwidth_id": "a79fd11a-047b-4f5b-8f12-99c178cc780a",
+            "bandwidth_share_type": "PER",
+            "bandwidth_size": 5,
+            "bandwidth_name": "bandwidth-test1",
+            "enterprise_project_id":"0",
+            "ip_version": 4
+        }
+    ]
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Elastic IP
+
+
+ diff --git a/docs/eip/api-ref/eip_api_0004.html b/docs/eip/api-ref/eip_api_0004.html new file mode 100644 index 000000000..4afb4d2d0 --- /dev/null +++ b/docs/eip/api-ref/eip_api_0004.html @@ -0,0 +1,299 @@ + + +

Updating an EIP

+

Function

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

+

This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer.

+
+
+

URI

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

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

publicip_id

+

Yes

+

Specifies the unique identifier of an EIP.

+
+
+
+
+

Request Message

  • Request parameter +
    + + + + + + + + + + + +
    Table 2 Request parameter

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    publicip

    +

    Yes

    +

    publicip object

    +

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

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

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    port_id

    +

    No

    +

    String

    +
    • Specifies the port ID.
    • The value must be an existing port ID. If this parameter is not included or the parameter value is left blank, the EIP is unbound. If the specified port ID does not exist or has already been bound with an EIP, an error message will be displayed.

      Leaving this parameter blank does not unbind the EIP from the dedicated load balancer.

      +
    +
    +
    +
  • Example request 1 (Binding an EIP to a NIC)
    PUT https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}
+
+{
+    "publicip": {
+        "port_id": "f588ccfa-8750-4d7c-bf5d-2ede24414706"
+    }
+}
    +
+
+

Response Message

  • Response parameter +
    + + + + + + + + + +
    Table 4 Response parameter

    Name

    +

    Type

    +

    Description

    +

    publicip

    +

    publicip object

    +

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

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Description of the publicips field

    Name

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique identifier of an EIP.

    +

    status

    +

    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)
      • DOWN (Unbound)
      • ACTIVE (Bound)
      • ELB (Bound to a load balancer)
      • ERROR (Exceptions)
      +
    +

    profile

    +

    profile object

    +

    Specifies the additional parameters, including the order ID and product ID. For details, see Table 6.

    +

    type

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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

    +

    String

    +

    Specifies the obtained EIP if only IPv4 EIPs are available.

    +

    ip_version

    +

    Integer

    +

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

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

    private_ip_address

    +

    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.

    +
    +

    port_id

    +

    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.

    +
    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    create_time

    +

    String

    +

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

    +

    bandwidth_id

    +

    String

    +

    Specifies the ID of the EIP bandwidth.

    +

    bandwidth_size

    +

    Integer

    +

    Specifies the bandwidth (Mbit/s).

    +

    bandwidth_share_type

    +

    String

    +
    • Specifies the EIP bandwidth type.
    • The value can be PER or WHOLE.
      • PER: Dedicated bandwidth
      • WHOLE: Shared bandwidth
      +
    +

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

    This parameter is unsupported. Do not use it.

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 6 Description of the profile field

    Name

    +

    Type

    +

    Description

    +

    order_id

    +

    String

    +

    Specifies the order ID.

    +

    product_id

    +

    String

    +

    Specifies the product ID.

    +

    region_id

    +

    String

    +

    Specifies the region ID.

    +

    user_id

    +

    String

    +

    Specifies the user ID.

    +
    +
    +
  • Example response (Binding an EIP to a NIC)
    {
+  "publicip": {
+    "id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb",
+    "status": "ACTIVE",
+    "profile": {}, 
+    "type": "5_bgp",
+    "port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe",
+    "public_ip_address": "10.xx.xx.162",
+    "private_ip_address": "192.168.1.131",
+    "tenant_id": "26ae5181a416420998eb2093aaed84d9",
+    "create_time": "2019-03-27 01:33:18",
+    "bandwidth_size": 7,
+    "ip_version": 4
+  }
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Elastic IP
+
+
+ diff --git a/docs/eip/api-ref/eip_api_0005.html b/docs/eip/api-ref/eip_api_0005.html new file mode 100644 index 000000000..ccf50eb50 --- /dev/null +++ b/docs/eip/api-ref/eip_api_0005.html @@ -0,0 +1,58 @@ + + +

Releasing an EIP

+

Function

This API is used to release an EIP.

+
+

URI

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

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

publicip_id

+

Yes

+

Specifies the unique identifier of an EIP.

+
+
+
+
+

Request Message

  • Request parameter

    None

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

Response Message

  • Response parameter

    None

    +
  • Example response

    None

    +

    Or

    +
    {
+       "code":"xxx",
+       "message":"xxxxx"
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Elastic IP
+
+
+ diff --git a/docs/eip/api-ref/eip_apifloatip_0000.html b/docs/eip/api-ref/eip_apifloatip_0000.html new file mode 100644 index 000000000..a254fc54a --- /dev/null +++ b/docs/eip/api-ref/eip_apifloatip_0000.html @@ -0,0 +1,23 @@ + + +

Floating IP Address (IPv6)

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/eip/api-ref/eip_apifloatip_0001.html b/docs/eip/api-ref/eip_apifloatip_0001.html new file mode 100644 index 000000000..d251795b5 --- /dev/null +++ b/docs/eip/api-ref/eip_apifloatip_0001.html @@ -0,0 +1,226 @@ + + +

Querying Floating IP Addresses

+

Function

This API is used to query all floating IP addresses accessible to the tenant submitting the request.

+
+

URI

GET /v2.0/eip/floatingips_v6

+

Example:

+
GET https://{Endpoint}/v2.0/eip/floatingips_v6?id={id}&router_id={router_id}&floating_network_id={floating_network_id}&floating_ip_address={floating_ip_address}&port_id={port_id }&fixed_ip_address={fixed_ip_address}&tenant_id={tenant_id}
+

Table 1 describes the parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

Specifies the floating IP address ID.

+

floating_ip_address

+

No

+

String

+

Specifies the floating IPv6 address.

+

floating_network_id

+

No

+

String

+

Specifies the external network ID.

+

You can only use fixed external network.

+

You can use GET /v2.0/networks?router:external=True or

+

GET /v2.0/networks?name={floating_network} or run the neutron net-external-list command to obtain information about the external network.

+

router_id

+

No

+

String

+

Specifies the ID of the belonged router.

+

port_id

+

No

+

String

+

Specifies the port ID.

+

fixed_ip_address

+

No

+

String

+

Specifies the private IP address of the associated port.

+

tenant_id

+

No

+

String

+

Specifies the project ID.

+
+
+

Request Message

  • Request parameter

    None

    +
  • Example request

    None

    +
+
+

Response Message

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

Parameter

+

Type

+

Description

+

floatingips

+

Array of floatingip objects

+

Specifies the floating IP address list. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 floatingip objects

Parameter

+

Type

+

Description

+

status

+

String

+

Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

+
  • ACTIVE indicates that the floating IP address has been bound.
  • ERROR indicates that the floating IP address is abnormal.
  • DOWN indicates that the floating IP address has not been bound.
+

id

+

String

+

Specifies the floating IP address ID.

+

floating_ip_address

+

String

+

Specifies the floating IPv6 address.

+

floating_network_id

+

String

+

Specifies the external network ID.

+

router_id

+

String

+

Specifies the ID of the belonged router.

+

port_id

+

String

+

Specifies the port ID.

+

fixed_ip_address

+

String

+

Specifies the private IP address of the associated port.

+

tenant_id

+

String

+

Specifies the project ID.

+

floatingips_links

+

Array of strings

+

Specifies the request URL.

+
+
+
  • Example response
    {
+  "floatingips": [
+    {
+      "id": "861a4c5b-b17b-4a1d-b653-f3e95dcb3345",
+      "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"
+    }
+  ],
+  "floatingips_links": [
+    {
+      "href": "https://network.region.cn-southwest-2.hwclouds.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True",
+      "rel": "previous"
+    }
+  ]
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address (IPv6)
+
+
+ diff --git a/docs/eip/api-ref/eip_apifloatip_0002.html b/docs/eip/api-ref/eip_apifloatip_0002.html new file mode 100644 index 000000000..5ac0ad5d3 --- /dev/null +++ b/docs/eip/api-ref/eip_apifloatip_0002.html @@ -0,0 +1,127 @@ + + +

Querying a Floating IP Address

+

Function

This API is used to query details about a specific floating IP address accessible to the tenant submitting the request.

+
+

URI

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

+
+

Request Message

  • Request parameter

    None

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

Response Message

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

    Parameter

    +

    Type

    +

    Description

    +

    floatingip

    +

    floatingip object

    +

    Specifies the floating IP address list. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 floatingip objects

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

    +
    • ACTIVE indicates that the floating IP address has been bound.
    • ERROR indicates that the floating IP address is abnormal.
    • DOWN indicates that the floating IP address has not been bound.
    +

    id

    +

    String

    +

    Specifies the floating IP address ID.

    +

    floating_ip_address

    +

    String

    +

    Specifies the floating IPv6 address.

    +

    floating_network_id

    +

    String

    +

    Specifies the external network ID.

    +

    router_id

    +

    String

    +

    Specifies the ID of the belonged router.

    +

    port_id

    +

    String

    +

    Specifies the port ID.

    +

    fixed_ip_address

    +

    String

    +

    Specifies the private IP address of the associated port.

    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +
    +
    +
  • Example response
    {
+  "floatingip": {
+    "id": "861a4c5b-b17b-4a1d-b653-f3e95dcb3345",
+    "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"
+  }
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address (IPv6)
+
+
+ diff --git a/docs/eip/api-ref/eip_apifloatip_0003.html b/docs/eip/api-ref/eip_apifloatip_0003.html new file mode 100644 index 000000000..6afec0931 --- /dev/null +++ b/docs/eip/api-ref/eip_apifloatip_0003.html @@ -0,0 +1,239 @@ + + +

Assigning a Floating IP Address

+

Function

This API is used to assign a floating IP address and associates it with an internal port.

+

Restrictions

+

You can use GET /v2.0/networks?router:external=True or run the neutron net-external-list command to obtain the UUID of the external network required for assigning a floating IP address.

+

The port_id parameter value must be the ECS port ID, which can be obtained from the NIC ID parameter in the ECS NIC details.

+
+

URI

POST /v2.0/eip/floatingips_v6

+
+

Request Message

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

Parameter

+

Type

+

Mandatory

+

Description

+

floatingip

+

floatingip object

+

Yes

+

Specifies the floating IP address list. For details, see Table 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 floatingip objects

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

Specifies the floating IP address ID.

+

floating_ip_address

+

No

+

String

+

Specifies the floating IPv6 address.

+

floating_network_id

+

No

+

String

+

Specifies the external network ID.

+

You can only use fixed external network.

+

You can use GET /v2.0/networks?router:external=True or

+

GET /v2.0/networks?name={floating_network} or run the neutron net-external-list command to obtain information about the external network.

+

router_id

+

No

+

String

+

Specifies the ID of the belonged router.

+

port_id

+

No

+

String

+

Specifies the port ID.

+

fixed_ip_address

+

No

+

String

+

Specifies the private IP address of the associated port.

+

This value can only be dynamically assigned by the system.

+

tenant_id

+

No

+

String

+

Specifies the project ID.

+
+
+
  • Example request
+
POST https://{Endpoint}/v2.0/eip/floatingips_v6
+
+{
+    "floatingip": {
+        "floating_network_id": "5ce655fa-c911-4d2c-99f7-445bc1162ef8",
+        "port_id": "552389f5-8f4c-4bb7-9991-07233c315d60"
+    }
+}
+
+

Response Message

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

    Parameter

    +

    Type

    +

    Description

    +

    floatingip

    +

    floatingip object

    +

    Specifies the floating IP address list. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 floatingip objects

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

    +
    • ACTIVE indicates that the floating IP address has been bound.
    • ERROR indicates that the floating IP address is abnormal.
    • DOWN indicates that the floating IP address has not been bound.
    +

    id

    +

    String

    +

    Specifies the floating IP address ID.

    +

    floating_ip_address

    +

    String

    +

    Specifies the floating IPv6 address.

    +

    floating_network_id

    +

    String

    +

    Specifies the external network ID.

    +

    router_id

    +

    String

    +

    Specifies the ID of the belonged router.

    +

    port_id

    +

    String

    +

    Specifies the port ID.

    +

    fixed_ip_address

    +

    String

    +

    Specifies the private IP address of the associated port.

    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +
    +
    +
+
  • Example response
    {
+    "floatingip": {
+        "router_id": "76c052d6-6a92-444c-b67d-147ee166a480",
+        "status": "DOWN",
+        "tenant_id": "6fd9b5fdb997425f97bc5ba1f0846084",
+        "floating_network_id": "5ce655fa-c911-4d2c-99f7-445bc1162ef8",
+        "fixed_ip_address": "12.xx.xx.5",
+        "floating_ip_address": "cdcd:910a:2222:5498:8475:1111:c013:8096",
+        "port_id": "552389f5-8f4c-4bb7-9991-07233c315d60",
+        "id": "2567f393-5c76-42db-a397-477723ce41f7"
+    }
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address (IPv6)
+
+
+ diff --git a/docs/eip/api-ref/eip_apifloatip_0004.html b/docs/eip/api-ref/eip_apifloatip_0004.html new file mode 100644 index 000000000..738535e93 --- /dev/null +++ b/docs/eip/api-ref/eip_apifloatip_0004.html @@ -0,0 +1,200 @@ + + +

Updating a Floating IP Address

+

Function

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 from the port.

+

Restrictions

+

When you bind a floating IP address, if the floating IP address is in the error state, try unbinding the address first.

+

You are not allowed to bind a floating IP address that has been bound to a port to another port. You must first unbind the IP address from its original port and bind it to the required port.

+
+

URI

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

+
+

Request Message

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

    Parameter

    +

    Type

    +

    Mandatory

    +

    Description

    +

    floatingip

    +

    floatingip object

    +

    Yes

    +

    Specifies the floating IP address list. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 2 floatingip objects

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    port_id

    +

    No

    +

    String

    +

    Specifies the port ID.

    +
    +
    +
  • Example request 1 (Binding to a port)
    PUT https://{Endpoint}/v2.0/eip/floatingips_v6/b639c937-4737-4107-8978-fecc7327a5ae
+
+{
+    "floatingip": {
+        "port_id": "21b5c483-84e9-40a1-86b3-3041606106f5",
+        "fixed_ip_address": "10.0.2.2"
+    }
+}
    +
+
+
  • Example request 2 (Unbinding from a port)
    PUT https://{Endpoint}/v2.0/eip/floatingips_v6/3870858f-91dc-489f-92a1-c04dbdc6d781
+
+{
+    "floatingip": {
+        "port_id": null
+    }
+}
    +
+

Response Message

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

    Parameter

    +

    Type

    +

    Description

    +

    floatingip

    +

    floatingip object

    +

    Specifies the floating IP address list. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 floatingip objects

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

    +
    • ACTIVE indicates that the floating IP address has been bound.
    • ERROR indicates that the floating IP address is abnormal.
    • DOWN indicates that the floating IP address has not been bound.
    +

    id

    +

    String

    +

    Specifies the floating IP address ID.

    +

    floating_ip_address

    +

    String

    +

    Specifies the floating IPv6 address.

    +

    floating_network_id

    +

    String

    +

    Specifies the external network ID.

    +

    router_id

    +

    String

    +

    Specifies the ID of the belonged router.

    +

    port_id

    +

    String

    +

    Specifies the port ID.

    +

    fixed_ip_address

    +

    String

    +

    Specifies the private IP address of the associated port.

    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +
    +
    +
  • Example response 1 (Binding a specified floating IP address to a port)
    {
+    "floatingip": {
+        "router_id": "76c052d6-6a92-444c-b67d-147ee166a480",
+        "status": "ACTIVE",
+        "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
+        "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
+        "fixed_ip_address": "10.0.2.2",
+        "floating_ip_address": "cdcd:910a:2222:5498:8475:1111:c013:8096",
+        "port_id": "21b5c483-84e9-40a1-86b3-3041606106f5",
+        "id": "b639c937-4737-4107-8978-fecc7327a5ae"
+    }
+}
    +
+
+
  • Example response 2 (Unbinding a specified floating IP address from a port)
    {
+    "floatingip": {
+        "floating_network_id": "809fdbbc-2e3e-426e-897c-cb632b081a72",
+        "router_id": null,
+        "fixed_ip_address": null,
+        "floating_ip_address": "cdcd:910a:2222:5498:8475:1111:c013:8096",
+        "tenant_id": "3c8c36e1520147ccbc83d2ccfbb9ab24",
+        "status": "ACTIVE",
+        "port_id": null,
+        "id": "3870858f-91dc-489f-92a1-c04dbdc6d781"
+    }
+}
    +
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address (IPv6)
+
+
+ diff --git a/docs/eip/api-ref/eip_apifloatip_0005.html b/docs/eip/api-ref/eip_apifloatip_0005.html new file mode 100644 index 000000000..a05a79e4c --- /dev/null +++ b/docs/eip/api-ref/eip_apifloatip_0005.html @@ -0,0 +1,26 @@ + + +

Deleting a Floating IP Address

+

Function

This API is used to delete a floating IP address.

+
+

URI

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

+
+

Request Message

  • Request parameter

    None

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

Response Message

  • Response parameter

    None

    +
  • Example response

    None

    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address (IPv6)
+
+
+ diff --git a/docs/eip/api-ref/eip_apipermission_0000.html b/docs/eip/api-ref/eip_apipermission_0000.html new file mode 100644 index 000000000..6f67c61fa --- /dev/null +++ b/docs/eip/api-ref/eip_apipermission_0000.html @@ -0,0 +1,19 @@ + + +

Permissions Policies and Supported Actions

+
+
+ +
+ diff --git a/docs/eip/api-ref/eip_apipermission_0002.html b/docs/eip/api-ref/eip_apipermission_0002.html new file mode 100644 index 000000000..922ce034c --- /dev/null +++ b/docs/eip/api-ref/eip_apipermission_0002.html @@ -0,0 +1,57 @@ + + +

Elastic IP

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

Permission

+

API

+

Action

+

Assigns an EIP.

+

POST /v1/{project_id}/publicips

+

vpc:publicIps:create

+

Queries an EIP.

+

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

+

vpc:publicIps:get

+

Queries EIPs.

+

GET /v1/{project_id}/publicips

+

vpc:publicIps:list

+

Updates an EIP.

+

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

+

vpc:publicIps:update

+

Release an EIP.

+

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

+

vpc:publicIps:delete

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/eip/api-ref/eip_apipermission_0003.html b/docs/eip/api-ref/eip_apipermission_0003.html new file mode 100644 index 000000000..bb92c37f5 --- /dev/null +++ b/docs/eip/api-ref/eip_apipermission_0003.html @@ -0,0 +1,43 @@ + + +

Bandwidth

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

Permission

+

API

+

Action

+

Queries a bandwidth.

+

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

+

vpc:bandwidths:get

+

Queries bandwidths.

+

GET /v1/{project_id}/bandwidths

+

vpc:bandwidths:list

+

Updates a bandwidth.

+

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

+

vpc:bandwidths:update

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/eip/api-ref/eip_apipermission_0004.html b/docs/eip/api-ref/eip_apipermission_0004.html new file mode 100644 index 000000000..e18d0092f --- /dev/null +++ b/docs/eip/api-ref/eip_apipermission_0004.html @@ -0,0 +1,51 @@ + + +

Bandwidth (V2.0)

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

Permission

+

API

+

Action

+

Allocates a shared bandwidth.

+

POST /v2.0/{project_id}/bandwidths

+

vpc:bandwidths:create

+

Deletes a shared bandwidth.

+

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

+

vpc:bandwidths:delete

+

Adds an EIP to a shared bandwidth.

+

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

+

vpc:publicIps:insert

+

Removes an EIP from a shared bandwidth.

+

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

+

vpc:publicIps:remove

+
+
+

+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/eip/api-ref/eip_apipermission_0006.html b/docs/eip/api-ref/eip_apipermission_0006.html new file mode 100644 index 000000000..fdc3b1532 --- /dev/null +++ b/docs/eip/api-ref/eip_apipermission_0006.html @@ -0,0 +1,57 @@ + + +

Floating IP Address (OpenStack Neutron API)

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

Permission

+

API

+

Action

+

Queries floating IP addresses.

+

GET /v2.0/floatingips

+

vpc:floatingIps:get

+

Queries a floating IP address.

+

GET /v2.0/floatingips/{floatingip_id}

+

vpc:floatingIps:get

+

Creates a floating IP address.

+

POST /v2.0/floatingips

+

vpc:floatingIps:create

+

Updates a floating IP address.

+

PUT /v2.0/floatingips/{floatingip_id}

+

vpc:floatingIps:update

+

Deletes a floating IP address.

+

DELETE /v2.0/floatingips/{floatingip_id}

+

vpc:floatingIps:delete

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/eip/api-ref/eip_apipermission_0007.html b/docs/eip/api-ref/eip_apipermission_0007.html new file mode 100644 index 000000000..4379dd1c3 --- /dev/null +++ b/docs/eip/api-ref/eip_apipermission_0007.html @@ -0,0 +1,11 @@ + + +

Precautions for API Permissions

+

If you have insufficient permissions, response code 200 will be returned when you query network resources and an empty list will be displayed.

+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/eip/api-ref/eip_apiquota_0000.html b/docs/eip/api-ref/eip_apiquota_0000.html new file mode 100644 index 000000000..2c17dfdee --- /dev/null +++ b/docs/eip/api-ref/eip_apiquota_0000.html @@ -0,0 +1,15 @@ + + +

Quota

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/eip/api-ref/eip_apiquota_0001.html b/docs/eip/api-ref/eip_apiquota_0001.html new file mode 100644 index 000000000..4a5ecbe4f --- /dev/null +++ b/docs/eip/api-ref/eip_apiquota_0001.html @@ -0,0 +1,221 @@ + + +

Querying the Quota

+

Function

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 is used to query both the EIP and VPC quotas.

+
+
+

URI

GET /v1/{project_id}/quotas

+
Example:
GET https://{Endpoint}/v1/{project_id}/quotas?type={type}
+
+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Name

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

type

+

No

+

String

+
  • Specifies the resource type.
  • Values:
    • vpc
    • subnet
    • securityGroup
    • securityGroupRule
    • publicIp
    • vpn
    • vpngw
    • vpcPeer
    • loadbalancer
    • listener
    • physicalConnect
    • virtualInterface
    • firewall
    • shareBandwidthIP
    • shareBandwidth
    • address_group
    • flow_log
    • vpcContainRoutetable
    • routetableContainRoutes
    +
+
+
+
+
+

Request Message

  • Request parameter
    None
    +
  • Example request
    GET https://{Endpoint}/v1/{project_id}/quotas
    +
+
+

Response Message

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

    Name

    +

    Type

    +

    Description

    +

    quotas

    +

    quotas object

    +

    Specifies the quota object. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + +
    Table 3 Description of the quotas field

    Name

    +

    Type

    +

    Description

    +

    resources

    +

    Array of resource objects

    +

    Specifies the resource objects. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Description of the resource field

    Name

    +

    Type

    +

    Description

    +

    type

    +

    String

    +
    • Specifies the resource type.
    • Values:
      • vpc
      • subnet
      • securityGroup
      • securityGroupRule
      • publicIp
      • vpn
      • vpngw
      • vpcPeer
      • loadbalancer
      • listener
      • physicalConnect
      • virtualInterface
      • firewall
      • shareBandwidthIP
      • shareBandwidth
      • address_group
      • flow_log
      • vpcContainRoutetable
      • routetableContainRoutes
      +
    +

    used

    +

    Integer

    +
    • Specifies the number of created network resources.
    • The value ranges from 0 to the value of quota.
    +

    quota

    +

    Integer

    +
    • Specifies the maximum quota values for the resources.
    • The value ranges from the default quota value to the maximum quota value.
    • The default quota values can be changed. Configure the quota values in the underlying system in advance.

      Default quota values:

      +
      • VPC: 150
      • Subnet: 400
      • Security group: 100
      • Security group rule: 5000
      • EIPs: 10
      • VPNs: 5
      • VPC peering connections: 50
      • Load balancers: 10
      • Listeners: 10
      • Firewalls: 200
      • EIPs that can be added to a shared bandwidth: 20
      • Shared bandwidths: 5
      • IP address groups: 50
      • Route table per VPC: 1
      • Routes per route table: 200
      +
    +

    min

    +

    Integer

    +

    Specifies the minimum quota value allowed.

    +
    +
    +
  • Example response
    {
+    "quotas": {
+        "resources": [
+            {
+                "type": "vpc",
+                "used": 4,
+                "quota": 150,
+                "min": 0
+            },
+            {
+                "type": "subnet",
+                "used": 5,
+                "quota": 400,
+                "min": 0
+            },
+            {
+                "type": "securityGroup",
+                "used": 1,
+                "quota": 100,
+                "min": 0
+            },
+            {
+                "type": "securityGroupRule",
+                "used": 6,
+                "quota": 5000,
+                "min": 0
+            },
+            {
+                "type": "publicIp",
+                "used": 2,
+                "quota": 10,
+                "min": 0
+            },
+            {
+                "type": "vpn",
+                "used": 0,
+                "quota": 5,
+                "min": 0
+            },
+            {
+                "type": "vpcPeer",
+                "used": 0,
+                "quota": 50,
+                "min": 0
+            },
+            {
+                "type": "firewall",
+                "used": 0,
+                "quota": 200,
+                "min": 0
+            },
+            {
+                "type": "shareBandwidth",
+                "used": 0,
+                "quota": 5,
+                "min": 0
+            },
+            {
+                "type": "shareBandwidthIP",
+                "used": 0,
+                "quota": 20,
+                "min": 0
+            },
+            {
+                "type": "loadbalancer",
+                "used": 0,
+                "quota": 10,
+                "min": 0
+            },
+            {
+                "type": "listener",
+                "used": 0,
+                "quota": 10,
+                "min": 0
+            }
+        ]
+    }
+}
    +
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Quota
+
+
+ diff --git a/docs/eip/api-ref/eip_apisharedbandwidth_0000.html b/docs/eip/api-ref/eip_apisharedbandwidth_0000.html new file mode 100644 index 000000000..46d6bc4cb --- /dev/null +++ b/docs/eip/api-ref/eip_apisharedbandwidth_0000.html @@ -0,0 +1,21 @@ + + +

Bandwidth (V2.0)

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/eip/api-ref/eip_apisharedbandwidth_0001.html b/docs/eip/api-ref/eip_apisharedbandwidth_0001.html new file mode 100644 index 000000000..623d236db --- /dev/null +++ b/docs/eip/api-ref/eip_apisharedbandwidth_0001.html @@ -0,0 +1,299 @@ + + +

Assigning a Shared Bandwidth

+

Function

This API is used to assign a shared bandwidth.

+
+

URI

POST /v2.0/{project_id}/bandwidths

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+
+
+
+
+

Request Message

  • Request parameter +
    + + + + + + + + + + + +
    Table 2 Request parameter

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    bandwidth

    +

    Yes

    +

    bandwidth object

    +

    Specifies the bandwidth objects. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Description of the bandwidth field

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    Yes

    +

    String

    +

    Specifies the bandwidth name.

    +

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

    +

    size

    +

    Yes

    +

    Integer

    +
    • Specifies the bandwidth size. The shared bandwidth has a minimum limit, which may vary depending on sites. The default minimum value is 5 Mbit/s.
    • The value ranges from 5 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 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.
      +
    +

    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 (-). Value 0 indicates the default enterprise project.
    • When creating a shared bandwidth, associate the enterprise project ID with the shared bandwidth.
    +
    NOTE:

    This parameter is unsupported. Do not use it.

    +
    +
    +
    +
+
+
  • Example request
    POST https://{Endpoint}/v2.0/{project_id}/bandwidths
+
+{
+    "bandwidth": {
+        "name": "bandwidth123",
+        "size": 10,
+        "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
+    }
+}
    +
+

Response Message

  • Response parameter +
    + + + + + + + + + +
    Table 4 Response parameter

    Name

    +

    Type

    +

    Description

    +

    bandwidth

    +

    bandwidth object

    +

    Specifies the bandwidth objects. For details, see Table 5.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Description of the bandwidth field

    Name

    +

    Type

    +

    Description

    +

    name

    +

    String

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

    size

    +

    Integer

    +
    • Specifies the bandwidth size.
    • The value ranges from 5 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.)
    +

    id

    +

    String

    +

    Specifies the bandwidth ID, which uniquely identifies the bandwidth.

    +

    share_type

    +

    String

    +
    • Specifies whether the bandwidth is shared or dedicated.
    • The value can be PER or WHOLE.
      • WHOLE: Shared bandwidth
      • PER: Dedicated bandwidth
      +
    +

    publicip_info

    +

    Array of publicip_info objects

    +
    • Specifies information about the EIP that uses the bandwidth. For details, see Table 6.
    • The bandwidth, whose type is WHOLE, can be used by multiple EIPs. The bandwidth, whose type is PER, can be used by only one EIP.
    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    bandwidth_type

    +

    String

    +
    • Specifies the bandwidth type. The default value for the shared bandwidth is share.
    +

    charge_mode

    +

    String

    +
    • Specifies that the bandwidth is billed by bandwidth.
    • The value can be traffic.
    +

    billing_info

    +

    String

    +

    Specifies the bill information.

    +

    If billing_info is specified, the bandwidth is in yearly/monthly billing mode.

    +

    enterprise_project_id

    +

    String

    +
    • Specifies the enterprise project ID. The value is 0 or a UUID that can contain a maximum of 36 characters, including hyphens (-). Value 0 indicates the default enterprise project.
    • When creating a shared bandwidth, associate the enterprise project ID with the shared 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)
      +
    +

    created_at

    +

    String

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

    updated_at

    +

    String

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

    Name

    +

    Type

    +

    Description

    +

    publicip_id

    +

    String

    +

    Specifies the ID of the EIP that uses the bandwidth.

    +

    publicip_address

    +

    String

    +

    Specifies the obtained EIP if only IPv4 EIPs are available.

    +

    publicip_type

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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.
      +
    +
    +
    +
+
  • Example response
    {
+  "bandwidth": {
+    "id": "1bffc5f2-ff19-45a6-96d2-dfdca49cc387",
+    "name": "bandwidth123",
+    "size": 10,
+    "share_type": "WHOLE",
+    "publicip_info": [],
+    "tenant_id": "26ae5181a416420998eb2093aaed84d9",
+    "bandwidth_type": "share",
+    "charge_mode": "traffic",
+    "billing_info": "",
+    "enterprise_project_id": "0",
+    "status": "NORMAL",
+    "created_at": "2020-04-21T07:58:02Z", 
+    "updated_at": "2020-04-21T07:58:02Z"
+  }
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Bandwidth (V2.0)
+
+
+ diff --git a/docs/eip/api-ref/eip_apisharedbandwidth_0003.html b/docs/eip/api-ref/eip_apisharedbandwidth_0003.html new file mode 100644 index 000000000..0ab67bd7b --- /dev/null +++ b/docs/eip/api-ref/eip_apisharedbandwidth_0003.html @@ -0,0 +1,58 @@ + + +

Deleting a Shared Bandwidth

+

Function

This API is used to delete a shared bandwidth.

+
+

URI

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

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

bandwidth_id

+

Yes

+

Specifies the bandwidth ID, which uniquely identifies the bandwidth.

+

Currently, only the shared bandwidth can be deleted.

+
+
+
+
+

Request Message

  • Request parameter

    None

    +
  • Example request
    DELETE https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}
    +
+
+

Response Message

  • Response parameter

    None

    +
  • Example response

    Or

    +
    {
+       "code":"xxx",
+       "message":"xxxxx"
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Bandwidth (V2.0)
+
+
+ diff --git a/docs/eip/api-ref/eip_apisharedbandwidth_0004.html b/docs/eip/api-ref/eip_apisharedbandwidth_0004.html new file mode 100644 index 000000000..ffdc30ab4 --- /dev/null +++ b/docs/eip/api-ref/eip_apisharedbandwidth_0004.html @@ -0,0 +1,318 @@ + + +

Adding an EIP to a Shared Bandwidth

+

Function

This API is used to add an EIP to a shared bandwidth.

+
+

URI

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

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

bandwidth_id

+

Yes

+

Specifies the bandwidth ID, which uniquely identifies the bandwidth.

+
+
+
+
+

Request Message

  • Request parameter +
    + + + + + + + + + + + +
    Table 2 Request parameter

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    bandwidth

    +

    Yes

    +

    bandwidth object

    +

    Specifies the bandwidth objects. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 3 Description of the bandwidth field

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    publicip_info

    +

    Yes

    +

    Array of publicip_info objects

    +
    • Specifies information about the EIP to be added to the shared bandwidth. For details, see Table 4.
    • The bandwidth, whose type is WHOLE, can be used by multiple EIPs. The number of EIPs varies depending on the tenant quota. By default, a shared bandwidth can be used by up to 20 EIPs.
    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 4 publicip_info object

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    publicip_id

    +

    Yes

    +

    String

    +

    Specifies the ID of the EIP that uses the bandwidth.

    +

    publicip_type

    +

    No

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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.
      +
    +
    +
    +
+
  • Example request
    POST https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}/insert
+
+{
+  "bandwidth": {
+    "publicip_info": [
+      {
+        "publicip_id": "29b114d1-2d41-4741-a1f0-b6f80aabceff",
+        "publicip_type": "5_bgp",
+      }
+    ]
+  }
+}
    +
+
+

Response Message

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

    Name

    +

    Type

    +

    Description

    +

    bandwidth

    +

    bandwidth object

    +

    Specifies the bandwidth objects. For details, see Table 6.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6 Description of the bandwidth field

    Name

    +

    Type

    +

    Description

    +

    name

    +

    String

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

    size

    +

    Integer

    +
    • Specifies the bandwidth size.
    • The value ranges from 5 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.)
    +

    id

    +

    String

    +

    Specifies the bandwidth ID, which uniquely identifies the bandwidth.

    +

    share_type

    +

    String

    +
    • Specifies whether the bandwidth is shared or dedicated.
    • The value can be PER or WHOLE.
      • WHOLE: Shared bandwidth
      • PER: Dedicated bandwidth
      +
    +

    publicip_info

    +

    Array of publicip_info objects

    +
    • Specifies information about the EIP that uses the bandwidth. For details, see Table 7.
    • The bandwidth, whose type is WHOLE, can be used by multiple EIPs. The bandwidth, whose type is PER, can be used by only one EIP.
    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    bandwidth_type

    +

    String

    +
    • Specifies the bandwidth type. The default value for the shared bandwidth is share.
    +

    charge_mode

    +

    String

    +
    • Specifies that the bandwidth is billed by bandwidth.
    • The value can be traffic.
    +

    billing_info

    +

    String

    +

    Specifies the bill information.

    +

    If billing_info is specified, the bandwidth is in yearly/monthly billing mode.

    +

    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 (-). Value 0 indicates the default enterprise project.
    • When creating a shared bandwidth, associate the enterprise project ID with the shared 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)
      +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 7 publicip_info objects

    Name

    +

    Type

    +

    Description

    +

    publicip_id

    +

    String

    +

    Specifies the ID of the EIP that uses the bandwidth.

    +

    publicip_address

    +

    String

    +

    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 (IPv6 is not supported currently.)
      +
    +

    publicip_type

    +

    String

    +
    • Specifies the EIP type.
    • The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
    • 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.
      +
    +
    +
    +
+
  • Example response
    {
+    "bandwidth": {
+        "id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
+        "name": "bandwidth123",
+        "size": 10,
+        "share_type": "WHOLE",
+        "publicip_info": [
+            {
+                "publicip_id": "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f",
+                "publicip_address": "99.xx.xx.82",
+                "publicip_type": "5_bgp",
+                "ip_version": 4
+            }
+        ],
+        "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
+        "charge_mode": "traffic",
+        "billing_info": "",
+        "bandwidth_type": "share",
+        "status": "NORMAL"
+    }
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Bandwidth (V2.0)
+
+
+ diff --git a/docs/eip/api-ref/eip_apisharedbandwidth_0005.html b/docs/eip/api-ref/eip_apisharedbandwidth_0005.html new file mode 100644 index 000000000..ba53d9c79 --- /dev/null +++ b/docs/eip/api-ref/eip_apisharedbandwidth_0005.html @@ -0,0 +1,165 @@ + + +

Removing an EIP from a Shared Bandwidth

+

Function

This API is used to remove an EIP from a shared bandwidth.

+
+

URI

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

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

bandwidth_id

+

Yes

+

Specifies the bandwidth ID, which uniquely identifies the bandwidth.

+
+
+
+
+

Request Message

  • Request parameter +
    + + + + + + + + + + + +
    Table 2 Request parameter

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    bandwidth

    +

    Yes

    +

    bandwidth object

    +

    Specifies the bandwidth objects. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Description of the bandwidth field

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    publicip_info

    +

    Yes

    +

    Array of publicip_info objects

    +
    • Specifies information about the EIP to be removed from the bandwidth. For details, see Table 4.
    • The bandwidth, whose type is WHOLE, can be used by multiple EIPs. The number of EIPs varies depending on the tenant quota. By default, a shared bandwidth can be used by up to 20 EIPs.
    +

    charge_mode

    +

    Yes

    +

    String

    +

    After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth.

    +

    Specifies whether the dedicated bandwidth used by the EIP that has been removed from a shared bandwidth is billed by traffic or by bandwidth.

    +

    The value can be bandwidth or traffic.

    +

    size

    +

    Yes

    +

    Integer

    +

    After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth.

    +

    Specifies the size (Mbit/s) of the dedicated bandwidth used by the EIP that has been removed from a shared bandwidth.

    +

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

    +
    +
    + +
    + + + + + + + + + + + +
    Table 4 publicip_info object

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    publicip_id

    +

    Yes

    +

    String

    +

    Specifies the ID of the EIP that uses the bandwidth.

    +
    +
    +
+
  • Example request
    POST https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}/remove
+
+{
+    "bandwidth": {
+        "publicip_info": [
+            {
+                "publicip_id": "d91b0028-6f6b-4478-808a-297b75b6812a"
+ 
+            },
+            {
+                "publicip_id": "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f"
+            }
+        ],
+        "charge_mode": "traffic",
+        "size": 22
+    }
+}
    +
+
+

Response Message

  • Response parameter

    None

    +
  • Example response

    None

    +

    Or

    +
    {
+       "code":"xxx",
+       "message":"xxxxx"
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Bandwidth (V2.0)
+
+
+ diff --git a/docs/eip/api-ref/eip_apitag_0000.html b/docs/eip/api-ref/eip_apitag_0000.html new file mode 100644 index 000000000..d35725d8b --- /dev/null +++ b/docs/eip/api-ref/eip_apitag_0000.html @@ -0,0 +1,25 @@ + + +

EIP Tag Management

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/eip/api-ref/eip_apitag_0001.html b/docs/eip/api-ref/eip_apitag_0001.html new file mode 100644 index 000000000..240c5360e --- /dev/null +++ b/docs/eip/api-ref/eip_apitag_0001.html @@ -0,0 +1,121 @@ + + +

Creating a Tag for an EIP

+

Function

This API is used to create a tag for an EIP.

+
+

URI

POST /v2.0/{project_id}/publicips/{publicip_id}/tags

+

Table 1 describes the parameters.

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

publicip_id

+

Yes

+

Specifies the unique identifier of an EIP.

+
+
+
+

Request Message

  • Request parameter +
    + + + + + + + + + + + +
    Table 2 Request parameter

    Parameter

    +

    Type

    +

    Mandatory

    +

    Description

    +

    tag

    +

    tag object

    +

    Yes

    +

    Specifies the tag objects. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 tag objects

    Attribute

    +

    Type

    +

    Mandatory

    +

    Description

    +

    key

    +

    String

    +

    Yes

    +
    • Specifies the tag key.
    • Cannot be left blank.
    • Can contain a maximum of 36 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)
      +
    • The tag key of a VPC must be unique.
    +

    value

    +

    String

    +

    Yes

    +
    • Specifies the tag value.
    • Can contain a maximum of 43 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)
      +
    +
    +
    +
  • Example request
    POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags
+
+{
+    "tag": {
+        "key": "key1",
+        "value": "value1"
+    }
+}
    +
+
+

Response Message

  • Response parameter

    None

    +
  • Example response

    None

    +

    Or

    +
    {
+       "code":"xxx",
+       "message":"xxxxx"
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: EIP Tag Management
+
+
+ diff --git a/docs/eip/api-ref/eip_apitag_0002.html b/docs/eip/api-ref/eip_apitag_0002.html new file mode 100644 index 000000000..c3e63121c --- /dev/null +++ b/docs/eip/api-ref/eip_apitag_0002.html @@ -0,0 +1,110 @@ + + +

Querying EIP Tags

+

Function

This API is used to query tags of a specified EIP.

+
+

URI

GET /v2.0/{project_id}/publicips/{publicip_id}/tags

+

Table 1 describes the parameters.

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

publicip_id

+

Yes

+

Specifies the unique identifier of an EIP.

+
+
+
+

Request Message

  • Request parameter

    None

    +
  • Example request
    GET https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags
    +
+
+

Response Message

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

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    Array of tag objects

    +

    Specifies the tag object list. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 tag objects

    Attribute

    +

    Type

    +

    Description

    +

    key

    +

    String

    +
    • Specifies the tag key.
    • Cannot be left blank.
    • Can contain a maximum of 36 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)
      +
    • The tag key of a VPC must be unique.
    +

    value

    +

    String

    +
    • Specifies the tag value.
    • Can contain a maximum of 43 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)
      +
    +
    +
    +
  • Example response
    {
+    "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key2",
+            "value": "value3"
+        }
+    ]
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: EIP Tag Management
+
+
+ diff --git a/docs/eip/api-ref/eip_apitag_0003.html b/docs/eip/api-ref/eip_apitag_0003.html new file mode 100644 index 000000000..61966ceed --- /dev/null +++ b/docs/eip/api-ref/eip_apitag_0003.html @@ -0,0 +1,65 @@ + + +

Deleting an EIP Tag

+

Function

This API is used to delete an EIP tag.

+
+

URI

DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}

+

Table 1 describes the parameters.

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

publicip_id

+

Yes

+

Specifies the unique identifier of an EIP.

+

key

+

Yes

+

Specifies the tag key.

+
+
+
+

Request Message

  • Request parameter

    None

    +
  • Example request
    DELETE https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags/{key}
    +
+
+

Response Message

  • Response parameter

    None

    +
  • Example response

    None

    +

    Or

    +
    {
+       "code":"xxx",
+       "message":"xxxxx"
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: EIP Tag Management
+
+
+ diff --git a/docs/eip/api-ref/eip_apitag_0004.html b/docs/eip/api-ref/eip_apitag_0004.html new file mode 100644 index 000000000..31d0f6374 --- /dev/null +++ b/docs/eip/api-ref/eip_apitag_0004.html @@ -0,0 +1,159 @@ + + +

Batch Creating or Deleting EIP Tags

+

Function

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 tags, an error is reported.

+

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

+

During tag deletion, if some tags do not exist, the operation is considered to be successful by default. The character set of the tags will not be checked. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.

+
+

URI

POST /v2.0/{project_id}/publicips/{publicip_id}/tags/action

+

Table 1 describes the parameters.

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+

publicip_id

+

Yes

+

Specifies the unique identifier of an EIP.

+
+
+
+

Request Message

  • Request parameter +
    + + + + + + + + + + + + + + + + +
    Table 2 Request parameter

    Parameter

    +

    Type

    +

    Mandatory

    +

    Description

    +

    tags

    +

    Array of tag objects

    +

    Yes

    +

    Specifies the tag object list. For details, see Table 3.

    +

    action

    +

    String

    +

    Yes

    +

    Specifies the operation. Possible values are as follows:

    +
    • create
    • delete
    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 tag objects

    Attribute

    +

    Type

    +

    Mandatory

    +

    Description

    +

    key

    +

    String

    +

    Yes

    +
    • Specifies the tag key.
    • Cannot be left blank.
    • Can contain a maximum of 36 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)
      +
    • The tag key of a VPC must be unique.
    +

    value

    +

    String

    +

    Yes

    +
    • Specifies the tag value.
    • Can contain a maximum of 43 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)
      +
    +
    +
    +
+
+
  • Request example 1: Creating tags in batches
    POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags/action
+
+{
+    "action": "create",
+    "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key2",
+            "value": "value3"
+        }
+    ]
+}
    +
+
  • Request example 2: Deleting tags in batches
    POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags/action
+
+{
+    "action": "delete",
+    "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key2",
+            "value": "value3"
+        }
+    ]
+}
    +
+

Response Message

  • Response parameter

    None

    +
  • Example response

    None

    +

    Or

    +
    {
+       "code":"xxx",
+       "message":"xxxxx"
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: EIP Tag Management
+
+
+ diff --git a/docs/eip/api-ref/eip_apitag_0005.html b/docs/eip/api-ref/eip_apitag_0005.html new file mode 100644 index 000000000..82de163fb --- /dev/null +++ b/docs/eip/api-ref/eip_apitag_0005.html @@ -0,0 +1,338 @@ + + +

Querying EIPs by Tag

+

Function

This API is used to query EIPs by tag.

+
+

URI

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

+

Table 1 describes the parameters.

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+
+
+
+

Request Message

  • Request parameter +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameter

    Parameter

    +

    Type

    +

    Mandatory

    +

    Description

    +

    tags

    +

    Array of tags objects

    +

    No

    +

    Specifies the included tags. A maximum of 20 tag keys are allowed for each query operation. Each tag key can have up to 10 tag values. The structure body must be included. The tag key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique.

    +

    limit

    +

    Integer

    +

    No

    +

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

    +

    offset

    +

    Integer

    +

    No

    +

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

    +

    action

    +

    String

    +

    Yes

    +

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

    +

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

    +

    matches

    +

    Array of match objects

    +

    No

    +

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

    +
    +
    +
    +
    + + + + + + + + + + + + + + + + +
    Table 3 Description of the tags field

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.)

    +

    values

    +

    Yes

    +

    Array of strings

    +

    Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The values are in the OR relationship.

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

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. Currently, the tag key can only be the resource name.

    +

    value

    +

    Yes

    +

    String

    +

    Specifies the tag value. Each value can contain a maximum of 255 Unicode characters.

    +
    +
    +
    +
+
+
  • Example request 1: Setting action to filter
    POST https://{Endpoint}/v2.0/{project_id}/publicips/resource_instances/action
+
+{
+    "offset": "0",
+    "limit": "100",
+    "action": "filter",
+    "matches": [
+        {
+            "key": "resource_name",
+            "value": "resource1"
+        }
+    ],
+    "tags": [
+        {
+            "key": "key1",
+            "values": [
+                "*value1",
+                "value2"
+            ]
+        }
+    ]
+}
    +
  • Example request 2: Setting action to count
    {
+    "action": "count",
+    "tags": [
+        {
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        },
+        {
+            "key": "key2",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "matches": [
+        {
+            "key": "resource_name",
+            "value": "resource1"
+        }
+    ]
+}
    +
+

Response Message

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

    Name

    +

    Type

    +

    Description

    +

    resources

    +

    Array of resource objects

    +

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

    +

    total_count

    +

    Integer

    +

    Specifies the total number of query records.

    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 6 resource objects

    Name

    +

    Type

    +

    Description

    +

    resource_id

    +

    String

    +

    Specifies the resource ID.

    +

    resource_detail

    +

    Object

    +

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

    +

    tags

    +

    Array of tags objects

    +

    Specifies the tag list. This parameter is an empty array by default if there is no tag. For details, see Table 7.

    +

    resource_name

    +

    String

    +

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

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 7 Description of the tags field

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.)

    +

    value

    +

    Yes

    +

    String

    +

    Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The values are in the OR relationship.

    +
    +
    +
  • Example response 1: Setting action to filter
    { 
+      "resources": [
+         {
+            "resource_detail": null, 
+            "resource_id": "cdfs_cefs_wesas_12_dsad", 
+            "resource_name": "resouece1", 
+            "tags": [
+                {
+                   "key": "key1",
+                   "value": "value1"
+                },
+                {
+                   "key": "key2",
+                   "value": "value1"
+                }
+             ]
+         }
+       ], 
+      "total_count": 1000
+}
    +
  • Example response 2: Setting action to count
    {
+       "total_count": 1000
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: EIP Tag Management
+
+
+ diff --git a/docs/eip/api-ref/eip_apitag_0006.html b/docs/eip/api-ref/eip_apitag_0006.html new file mode 100644 index 000000000..dd57b2eca --- /dev/null +++ b/docs/eip/api-ref/eip_apitag_0006.html @@ -0,0 +1,111 @@ + + +

Querying EIP Tags in a Specified Project

+

Function

This API is used to query all EIP tags of a tenant in a specified region.

+
+

URI

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

+

Table 1 describes the parameters.

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

Name

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID.

+
+
+
+

Request Message

  • Request parameter

    None

    +
  • Example request
    GET /v2.0/{project_id}/publicips/tags
    +
+
+

Response Message

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

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    Array of tag objects

    +

    Specifies the tag object list. For details, see Table 3.

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

    Name

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key.

    +
    • Cannot be left blank.
    • Can contain a maximum of 36 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)
      +
    +

    values

    +

    Array of strings

    +

    Specifies the tag value list.

    +
    • Can contain a maximum of 43 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)
      +
    +
    +
    +
  • Example response
    {
+    "tags": [
+        {
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        },
+        {
+            "key": "key2",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ]
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: EIP Tag Management
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0000.html b/docs/eip/api-ref/eip_openstackapi_0000.html new file mode 100644 index 000000000..6de6ecd33 --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0000.html @@ -0,0 +1,13 @@ + + +

Native OpenStack Neutron APIs V2.0

+
+
+ +
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0001.html b/docs/eip/api-ref/eip_openstackapi_0001.html new file mode 100644 index 000000000..5a0ccf4c4 --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0001.html @@ -0,0 +1,19 @@ + + +

API Version Information

+
+
+ + +
+
Parent topic: Native OpenStack Neutron APIs V2.0
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0002.html b/docs/eip/api-ref/eip_openstackapi_0002.html new file mode 100644 index 000000000..cf9cf67b8 --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0002.html @@ -0,0 +1,119 @@ + + +

Querying API Versions

+

Function

This API is used to query all available versions of a native OpenStack API.

+
+

URI

GET /

+
+

Request Message

Request parameter

+

None

+

Example request

+
GET https://{Endpoint}/
+
+

Response Message

Response parameter

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

Parameter

+

Type

+

Description

+

versions

+

Array of version objects

+

Specifies the API version list. For details, see Table 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 2 version objects

Parameter

+

Type

+

Description

+

status

+

String

+

Specifies the API version status. Possible values are as follows:

+
  • CURRENT
  • STABLE
  • DEPRECATED
+

id

+

String

+

Specifies the API version.

+

links

+

Array of link objects

+

Specifies the link list. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 link objects

Parameter

+

Type

+

Description

+

href

+

String

+

Specifies the API link.

+

rel

+

String

+

Specifies the relationship between the API link and the API version.

+
+
+

Example response

+
{
+    "versions": [
+        {
+            "status": "CURRENT", 
+            "id": "v2.0", 
+            "links": [
+                {
+                    "href": "https://None/v2.0", 
+                    "rel": "self"
+                }
+            ]
+        }
+    ]
+}
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: API Version Information
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0003.html b/docs/eip/api-ref/eip_openstackapi_0003.html new file mode 100644 index 000000000..311b59b6f --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0003.html @@ -0,0 +1,157 @@ + + +

Querying a Specified API Version

+

Function

This API is used to query the version of a specified API.

+
+

URI

GET /{api_version}

+

Table 1 describes the parameters.

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

Parameter

+

Type

+

Description

+

api_version

+

String

+

Specifies the version number, for example v2.0.

+
+
+
+

Request Message

  • Request parameter

    None

    +
+
  • Example request
    GET https://{Endpoint}/v2.0
    +
+
+

Response Message

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

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    Array of resource objects

    +

    Specifies the resource object list.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 3 resource object

    Parameter

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    Specifies the resource name.

    +

    collection

    +

    String

    +

    Specifies the resource collection name.

    +

    links

    +

    Array of link objects

    +

    Specifies the link list. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 4 link objects

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the API link.

    +

    rel

    +

    String

    +

    Specifies the relationship between the API link and the API version.

    +
    +
    +
  • Example response
    {
+    "resources": [
+        {
+            "links": [
+                {
+                    "href": "https://vpc.systems.com/v2.0/subnets",
+                    "rel": "self"
+                }
+            ],
+            "name": "subnet",
+            "collection": "subnets"
+        },
+        {
+            "links": [
+                {
+                    "href": "https://vpc.systems.com/v2.0/networks",
+                    "rel": "self"
+                }
+            ],
+            "name": "network",
+            "collection": "networks"
+        },
+        {
+            "links": [
+                {
+                    "href": "https://vpc.systems.com/v2.0/ports",
+                    "rel": "self"
+                }
+            ],
+            "name": "port",
+            "collection": "ports"
+        }
+    ]
+}
    +
+
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: API Version Information
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0004.html b/docs/eip/api-ref/eip_openstackapi_0004.html new file mode 100644 index 000000000..ca0d736e4 --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0004.html @@ -0,0 +1,143 @@ + + +

Pagination

+

Function

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 items are displayed in the ascending order of ID.

+
  • To access the next page of the request, perform the following configurations:
    • Replace the value of marker in the original access request URL. Replace the value of marker to the value of marker in the value of herf if the value of rel in the response is next.
    • Set the value of page_reverse to False.
    +
  • To access the previous page of the request, perform the following configurations:
    • Replace the value of marker in the original access request URL. Replace the value of marker to the value of marker in the value of herf if the value of rel in the response is previous.
    • Set the value of page_reverse to True.
    +
+
+

Request Message

Request parameter

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

Parameter

+

Type

+

Mandatory

+

Description

+

limit

+

Integer

+

No

+

Specifies the number of items displayed per page.

+

marker

+

String

+

No

+

Specifies the ID of the last item in the previous list. If the marker value is invalid, error code 400 will be returned.

+

page_reverse

+

Boolean

+

No

+

Specifies the page direction. The value can be True or False.

+
+
+

Example request 1

+
GET https://{Endpoint}/v2.0/networks?limit=2&marker=3d42a0d4-a980-4613-ae76-a2cddecff054&page_reverse=False
+
+

Example request 2

+
GET https://{Endpoint}/v2.0/vpc/peerings?limit=2&marker=e5a0c88e-228e-4e62-a8b0-90825b1b7958&page_reverse=True
+

Response Message

Response parameter

+

None

+

Example response 1

+
{
+    "networks": [
+        {
+            "status": "ACTIVE",
+            "subnets": [],
+            "name": "liudongtest ",
+            "admin_state_up": false,
+            "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
+            "id": "60c809cb-6731-45d0-ace8-3bf5626421a9"
+        },
+        {
+            "status": "ACTIVE",
+            "subnets": [
+                "132dc12d-c02a-4c90-9cd5-c31669aace04"
+            ],
+            "name": "publicnet",
+            "admin_state_up": true,
+            "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
+            "id": "9daeac7c-a98f-430f-8e38-67f9c044e299"
+        }
+    ],
+    "networks_links": [
+        {
+            "href": "http://192.168.82.231:9696/v2.0/networks?limit=2&marker=9daeac7c-a98f-430f-8e38-67f9c044e299",
+            "rel": "next"
+        },
+        {
+            "href": "http://192.168.82.231:9696/v2.0/networks?limit=2&marker=60c809cb-6731-45d0-ace8-3bf5626421a9&page_reverse=True",
+            "rel": "previous"
+        }
+    ]
+}
+
+

Example response 2

+
{
+    "peerings_links": [
+        {
+            "marker": "dd442819-5638-401c-bd48-a82703cf0464",
+            "rel": "next"
+        },
+        {
+            "marker": "1e13cbaf-3ce4-413d-941f-66d855dbfa7f",
+            "rel": "previous"
+        }
+    ],
+    "peerings": [
+        {
+            "status": "ACTIVE",
+            "accept_vpc_info": {
+                "vpc_id": "83a48834-b9bc-4f70-aa46-074568594650",
+                "tenant_id": "e41a43bf06e249678413c6d61536eff9"
+            },
+            "request_vpc_info": {
+                "vpc_id": "db8e7687-e43b-4fc1-94cf-16f69f484d6d",
+                "tenant_id": "e41a43bf06e249678413c6d61536eff9"
+            },
+            "name": "peering1",
+            "id": "1e13cbaf-3ce4-413d-941f-66d855dbfa7f"
+        },
+        {
+            "status": "ACTIVE",
+            "accept_vpc_info": {
+                "vpc_id": "83a48834-b9bc-4f70-aa46-074568594650",
+                "tenant_id": "e41a43bf06e249678413c6d61536eff9"
+            },
+            "request_vpc_info": {
+                "vpc_id": "bd63cc9e-e7b8-4d4e-a0e9-055031470ffc",
+                "tenant_id": "e41a43bf06e249678413c6d61536eff9"
+            },
+            "name": "peering2",
+            "id": "dd442819-5638-401c-bd48-a82703cf0464"
+        }
+    ]
+}
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: API Version Information
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0005.html b/docs/eip/api-ref/eip_openstackapi_0005.html new file mode 100644 index 000000000..aa77c57f6 --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0005.html @@ -0,0 +1,23 @@ + + +

Floating IP Address

+
+
+ + +
+
Parent topic: Native OpenStack Neutron APIs V2.0
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0006.html b/docs/eip/api-ref/eip_openstackapi_0006.html new file mode 100644 index 000000000..e8d09acbf --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0006.html @@ -0,0 +1,288 @@ + + +

Querying Floating IP Addresses

+

Function

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 address using the API for Querying a Floating IP Address.

+
+

URI

GET /v2.0/floatingips

+

Table 1 describes the parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Specifies the floating IP address ID.

+

floating_ip_address

+

No

+

String

+

Specifies the floating IPv4 address.

+

floating_network_id

+

No

+

String

+

Specifies the external network ID.

+

You can only use fixed external network.

+

You can use GET /v2.0/networks?router:external=True or

+

GET /v2.0/networks?name={floating_network} or run the neutron net-external-list command to obtain information about the external network.

+

router_id

+

No

+

String

+

Specifies the ID of the belonged router.

+

port_id

+

No

+

String

+

Specifies the port ID.

+

fixed_ip_address

+

No

+

String

+

Specifies the private IP address of the associated port.

+

tenant_id

+

No

+

String

+

Specifies the project ID.

+

limit

+

Integer

+

No

+

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

+

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

+

marker

+

String

+

No

+

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, all resource records 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.
+

page_reverse

+

Boolean

+

No

+

Specifies the page direction. The value can be True or False.

+
+
+

Example:

+
GET https://{Endpoint}/v2.0/floatingips?id={fip_id}&router_id={router_id}&floating_network_id={net_id}&floating_ip_address={floating_ip}&port_id={port_id}&fixed_ip_address={fixed_ip}&tenant_id={tenant_id}
+
+

Request Message

None

+
+

Response Message

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

Parameter

+

Type

+

Description

+

floatingips

+

Array of floatingip objects

+

Specifies the floating IP address list. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 floatingip objects

Parameter

+

Type

+

Description

+

status

+

String

+

Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

+
  • DOWN indicates that the floating IP address has not been bound.
  • ACTIVE indicates that the floating IP address has been bound.
  • ERROR indicates that the floating IP address is abnormal.
+

id

+

String

+

Specifies the floating IP address ID.

+

project_id

+

String

+

Specifies the project ID.

+

floating_ip_address

+

String

+

Specifies the floating IP address.

+

floating_network_id

+

String

+

Specifies the external network ID.

+

router_id

+

String

+

Specifies the ID of the belonged router.

+

port_id

+

String

+

Specifies the port ID.

+
NOTE:

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

+
+

fixed_ip_address

+

String

+

Specifies the private IP address of the associated port.

+

tenant_id

+

String

+

Specifies the project ID.

+

+

dns_name

+

String

+

Specifies the DNS name.

+

dns_domain

+

String

+

Specifies the DNS domain.

+

created_at

+

String

+

Specifies the time when the floating IP address was created.

+

UTC time is used.

+

Format: yyyy-MM-ddTHH:mm:ss

+

updated_at

+

String

+

Specifies the time when the floating IP address was updated.

+

UTC time is used.

+

Format: yyyy-MM-ddTHH:mm:ss

+
+
+
+

Example:

Example request

+
GET https://{Endpoint}/v2.0/floatingips?limit=1
+
+

Example response

+
{
+    "floatingips": [
+        {
+            "id": "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd",
+            "status": "DOWN",
+            "router_id": null,
+            "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+            "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+            "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
+            "fixed_ip_address": null,
+            "floating_ip_address": "99.99.99.84",
+            "port_id": null,
+            "dns_name": "ecs-80-158-78-239",
+            "dns_domain": "reverse.domain-name.com",
+            "created_at": "2017-10-19T12:21:28",
+            "updated_at": "2018-07-30T12:52:13"
+        }
+    ]
+}
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0007.html b/docs/eip/api-ref/eip_openstackapi_0007.html new file mode 100644 index 000000000..9d6593b9c --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0007.html @@ -0,0 +1,173 @@ + + +

Querying a Floating IP Address

+

Function

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 belongs, and external network ID of the floating IP address.

+
+

URI

GET /v2.0/floatingips/{floatingip_id}

+
+

Request Message

None

+
+

Response Message

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

Parameter

+

Type

+

Description

+

floatingip

+

floatingip object

+

Specifies the floating IP address list. For details, see Table 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 floatingip objects

Attribute

+

Type

+

Description

+

status

+

String

+

Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

+
  • DOWN indicates that the floating IP address has not been bound.
  • ACTIVE indicates that the floating IP address has been bound.
  • ERROR indicates that the floating IP address is abnormal.
+

id

+

String

+

Specifies the floating IP address ID.

+

project_id

+

String

+

Specifies the project ID.

+

floating_ip_address

+

String

+

Specifies the floating IP address.

+

floating_network_id

+

String

+

Specifies the external network ID.

+

router_id

+

String

+

Specifies the ID of the belonged router.

+

port_id

+

String

+

Specifies the port ID.

+
NOTE:

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

+
+

fixed_ip_address

+

String

+

Specifies the private IP address of the associated port.

+

tenant_id

+

String

+

Specifies the project ID.

+

+

dns_name

+

String

+

Specifies the DNS name.

+

dns_domain

+

String

+

Specifies the DNS domain.

+

created_at

+

String

+

Specifies the time when the floating IP address was created.

+

UTC time is used.

+

Format: yyyy-MM-ddTHH:mm:ss

+

updated_at

+

String

+

Specifies the time when the floating IP address was updated.

+

UTC time is used.

+

Format: yyyy-MM-ddTHH:mm:ss

+
+
+
+

Example:

Example request

+
GET https://{Endpoint}/v2.0/floatingips/1a3a2818-d9b4-4a9c-8a19-5252c499d1cd
+
+

Example response

+
{
+    "floatingip": {
+        "id": "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd",
+        "status": "DOWN",
+        "router_id": null,
+        "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+        "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+        "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
+        "fixed_ip_address": null,
+        "floating_ip_address": "99.99.99.84",
+        "port_id": null,
+        "dns_name": "ecs-80-158-78-239",
+        "dns_domain": "reverse.domain-name.com",
+        "created_at": "2017-10-19T12:21:28",
+        "updated_at": "2018-07-30T12:52:13"
+    }
+}
+

+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0008.html b/docs/eip/api-ref/eip_openstackapi_0008.html new file mode 100644 index 000000000..ba4ff613c --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0008.html @@ -0,0 +1,228 @@ + + +

Assigning a Floating IP Address

+

Function

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:external=True or run the neutron net-external-list command to obtain the UUID of the external network required for assigning a floating IP address.

+
+

URI

POST /v2.0/floatingips

+
+

Request Message

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

Parameter

+

Type

+

Mandatory

+

Description

+

floatingip

+

floatingip object

+

Yes

+

Specifies the floating IP address list. For details, see Table 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 floatingip objects

Parameter

+

Mandatory

+

Type

+

Description

+

floating_ip_address

+

No

+

String

+

Specifies the floating IP address.

+

floating_network_id

+

Yes

+

String

+

Specifies the external network ID.

+

You can only use fixed external network.

+

You can use GET /v2.0/networks?router:external=True or

+

GET /v2.0/networks?name={floating_network} or

+

run the neutron net-external-list mode command to obtain information about the external network.

+

port_id

+

No

+

String

+

Specifies the port ID.

+

fixed_ip_address

+

No

+

String

+

Specifies the private IP address of the associated port.

+
+
+
+

Response Message

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

Parameter

+

Type

+

Description

+

floatingip

+

floatingip object

+

Specifies the floating IP address list. For details, see Table 4.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 floatingip objects

Attribute

+

Type

+

Description

+

status

+

String

+

Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

+
  • DOWN indicates that the floating IP address has not been bound.
  • ACTIVE indicates that the floating IP address has been bound.
  • ERROR indicates that the floating IP address is abnormal.
+

id

+

String

+

Specifies the floating IP address ID.

+

floating_ip_address

+

String

+

Specifies the floating IP address.

+

floating_network_id

+

String

+

Specifies the external network ID.

+

router_id

+

String

+

Specifies the ID of the belonged router.

+

port_id

+

String

+

Specifies the port ID.

+

fixed_ip_address

+

String

+

Specifies the private IP address of the associated port.

+

tenant_id

+

String

+

Specifies the project ID.

+

+

dns_name

+

String

+

Specifies the DNS name.

+

dns_domain

+

String

+

Specifies the DNS domain.

+
+
+
+

Example:

Example request

+
POST https://{Endpoint}/v2.0/floatingips 
+
+{
+    "floatingip": {
+           "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975"
+    }
+}
+
+

Example response

+
{
+    "floatingip": {
+        "id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2",
+        "status": "DOWN",
+        "router_id": null,
+        "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+        "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+        "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
+        "fixed_ip_address": null,
+        "floating_ip_address": "88.88.215.205",
+        "port_id": null,
+        "dns_name": "ecs-80-158-78-239",
+        "dns_domain": "reverse.domain-name.com",
+        "created_at": "2018-09-20T02:10:02",
+        "updated_at": "2018-09-20T02:10:02"
+    }
+}
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0009.html b/docs/eip/api-ref/eip_openstackapi_0009.html new file mode 100644 index 000000000..4953ce4c4 --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0009.html @@ -0,0 +1,253 @@ + + +

Updating a Floating IP Address

+

Function

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 IP address has been unbound from the port.

+
This API has the following constraints:
  • If you want to bind a floating IP address in the error state, unbind the IP address first.
  • Do not associate a port that has a floating IP address associated to another floating IP address. You must first disassociate the port from the IP address and then associate it with another IP address.
  • This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer.
+
+
+
+

URI

PUT /v2.0/floatingips/{floatingip_id}

+

Table 1 describes the parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

floatingip_id

+

Yes

+

String

+

Specifies the floating IP address ID.

+

This parameter is not required when you assign a floating IP address. This parameter is mandatory when you query, update, or delete a floating IP address.

+
+
+
+

Request Message

+
+ + + + + + + + + + + +
Table 2 Request parameter

Parameter

+

Type

+

Mandatory

+

Description

+

floatingip

+

floatingip object

+

Yes

+

Specifies the floating IP address list. For details, see Table 3.

+
+
+ +
+ + + + + + + + + + + +
Table 3 floatingip objects

Parameter

+

Mandatory

+

Type

+

Description

+

port_id

+

No

+

String

+

Specifies the port ID.

+

Leaving this parameter blank does not unbind the EIP from the dedicated load balancer.

+
+
+
+

Response Message

+
+ + + + + + + + + +
Table 4 Response parameter

Parameter

+

Type

+

Description

+

floatingip

+

floatingip object

+

Specifies the floating IP address list. For details, see Table 5.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 floatingip objects

Attribute

+

Type

+

Description

+

status

+

String

+

Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.

+
  • DOWN indicates that the floating IP address has not been bound.
  • ACTIVE indicates that the floating IP address has been bound.
  • ERROR indicates that the floating IP address is abnormal.
+

id

+

String

+

Specifies the floating IP address ID.

+

floating_ip_address

+

String

+

Specifies the floating IP address.

+

floating_network_id

+

String

+

Specifies the external network ID.

+

router_id

+

String

+

Specifies the ID of the belonged router.

+

port_id

+

String

+

Specifies the port ID.

+

fixed_ip_address

+

String

+

Specifies the private IP address of the associated port.

+

tenant_id

+

String

+

Specifies the project ID.

+

+

dns_name

+

String

+

Specifies the DNS name.

+

dns_domain

+

String

+

Specifies the DNS domain.

+
+
+
+

Example:

Example request 1 (Binding a floating IP address to a port)

+
PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 
+ 
+{
+    "floatingip": {
+           "port_id": "f91f5763-c5a2-4458-979d-61e48b3c3fac"
+    }
+}
+
+

Example response 1 (Binding a floating IP address to a port)

+
{
+    "floatingip": {
+        "id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2",
+        "status": "DOWN",
+        "router_id": null,
+        "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+        "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+        "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
+        "fixed_ip_address": "192.168.10.3",
+        "floating_ip_address": "88.88.215.205",
+        "port_id": 00587256-27e3-489b-96bf-ea80c1da4aeb,
+        "dns_name": "ecs-80-158-78-239",
+        "dns_domain": "reverse.domain-name.com",
+        "created_at": "2018-09-20T02:10:02",
+        "updated_at": "2018-09-20T02:10:07"
+    }
+}
+

Example request 2 (Unbinding a floating IP address from a port)

+
PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2
+
+{
+    "floatingip": {
+        "port_id": null
+    }
+}
+

Example response 2 (Unbinding a floating IP address from a port)

+
{
+    "floatingip": {
+        "id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2",
+        "status": "DOWN",
+        "router_id": null,
+        "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+        "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
+        "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
+        "fixed_ip_address": null,
+        "floating_ip_address": "88.88.215.205",
+        "port_id": null,
+        "dns_name": "ecs-80-158-78-239",
+        "dns_domain": "reverse.domain-name.com",
+        "created_at": "2018-09-20T02:10:02",
+        "updated_at": "2018-09-20T02:10:07"
+    }
+}
+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address
+
+
+ diff --git a/docs/eip/api-ref/eip_openstackapi_0010.html b/docs/eip/api-ref/eip_openstackapi_0010.html new file mode 100644 index 000000000..1e98022ef --- /dev/null +++ b/docs/eip/api-ref/eip_openstackapi_0010.html @@ -0,0 +1,51 @@ + + +

Deleting a Floating IP Address

+

Function

This API is used to delete a floating IP address.

+
+

URI

DELETE /v2.0/floatingips/{floatingip_id}

+

Table 1 describes the parameters.

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

Parameter

+

Mandatory

+

Type

+

Description

+

floatingip_id

+

Yes

+

String

+

Specifies the floating IP address ID.

+
+
+
+

Request Message

None

+
+

Response Message

None

+
+

Example:

Example request

+
DELETE https://{Endpoint}/v2.0/floatingips/a95ec431-8473-463b-aede-34fb048ee3a7
+
+

Example response

+

None

+

Status Code

See Status Codes.

+
+

Error Code

See Error Codes.

+
+
+
+
+
Parent topic: Floating IP Address
+
+
+ diff --git a/docs/eip/api-ref/public_sys-resources/ExpandCollapse.js b/docs/eip/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 000000000..3f1b7db00 --- /dev/null +++ b/docs/eip/api-ref/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";var href="";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(href.substring(href.lastIndexOf("#")+1))}}catch(a){}}; \ No newline at end of file diff --git a/docs/eip/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/eip/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..60f60762138fe7d98fa081415cf26a4943897779 GIT binary patch literal 2752 zcmV;x3P1IUP)pPa!Eu%RCwC$n`u~-F-BFk{0Y@>jH&Wt02T)4n7aXBssVicB` zOX`JaF2{q_2~&#?rkP8$id|Xfs23G(+0lTGT0tnFxgZFMIx;xG$R>Lr2ng2sFhB=q zSd{Td_5QEx{V+WDJooe7@Bg{)|8u`XpV~`~ZvvYTAfN{@5<(zAAd&!qNCE^R2@oI< zNq|5k0e^NPrRGdyW8`F%MH7XH|3P8=s2${2dg49z003YAM?%tm1!4=85P2aZJs3WS zG6CT8kCv0C(eT;v!9vu9jP&3oZEw^8HmnQ6+clMCL4mv(zK?)Ob8&M#`$%sr@v0v& z@zoUHs-n619H>uFER~Aj==ntk06q~XtAWrX`-(7l=)GLjQP?!@q z{@ZTZw0`amLgo~4vvd&0Pxryp)QHy>ob2%4P9)V*SX4zr!(BuoQ>IK9!d&k>z1cqI z{8L;})njUE#LIJj>h%6Q^ZVF{wB;i;Qi+5h9}NJn%x@raKm6;fW+Fl#T`67idLh|4 zu~b$4-1hhHTVfMtV@>p)0G=3ns@?Zq+;oGKv z*YE#+n>`1!`TpdYF4yhs&w)&meoVo}#+v$ur`WVKNyq<%YnFsZMC$eXSc!Bf$)AMeNOrxm z98up?0IbZ4d1uoLyuSG}0{xcY?H+G%68SDpqp0{6ZmtR(?ChBNKk$ZxK&chd%Fub9B!C3$z*oSdfKP$^R+Au*=jW--Q5@}8T8wOFz(A> z+jPJi0CSN!@M}8~J+m~H+qJd0$mL8L?}^W38D?fiTvJtZ_QG{CGOx1j!^2co2eNIY zE_th}e&*28WCEs4)4Ngh`F*TJs&5jrEg}J*$>Ry|NTs@Q5S4XS*jiLGYupV!l}OmJ zCkyWg!}|T(8zmGK-@ggmTpXX4Lzd^H6d8Ibpk8+o_km$bMW>TS}&FY)P96F+{d%+84 z0FbR#^Wj0eUL$0WrHtk7-A3#N4!~oiv))WDwoq|!rza!b-MC#_%g6i5bZq+f?}v+A z&dvOM*6oz`?o(Suoq{*R_pvM}5O;^mT)Ww?Z7fftAwAED0FP9BCXZ)ZL<03qVuSdN zP8xtRONCq}V{LHL13e@F7rC5Q7nL%1)>HuEPG%TvZ9T=8(JF40lp-DCMCkm>9oo4$ zp2gbI0)X_(**fDB#*QLr-bCyM4&cnWE2QR3>%BzUvd0>L#Q|n|$1Tk60kC$33wat1 zyP`b|;`hpR?G6;%TDEA7?qPdG5~XG3DCEwFEmXV^*atUP1r?Q*Z6tf#C@HG~z|7R7 z%W^bSHmKdEz8|Y+XCNKoj5;@$;5Eqx+bjkplCo$bd!u65ur3Iht+xK#S>J1CGr+PQ z0C$JWZS8>kO3xnquB&Tk(E(-;v|eN5zDOk!LKaKgc6D>}Jxa^U*&dP9D~M#(l4Wdd zEW5NF>oE`jQ&SV}G+O8_@4Ge+!`aD+oB8?teVaq?BU0GA1xO_l=1nQrAx&+WdOB8S#d?X;+5%{W zL%$q0tP5gqR7{WS^|&#ETLM_$tqfODr{F@Wvh7$L9&xbkIv%IZL`G<~%z?=et2Z8l(~lTRu|vXblrbH{CQq;M*jC6P7 zAFJjO7P_e26);09x-VYJYSS8{M>uNB=$!_=`UBu*VJQICR{ab{qy@7TIM~}!cc+es zuSRv+yK8E024LzW_fF?DH>qIv7JK9}8Okgb+deq(_=yx1KZZPwhLE7)i2By(j4ulc zZ0X+G=!}W_*0i+)j$M5C6#K-`Q^PI#NC$_uZf2|)Q-QCDmtJxjn1b~m%uQ)q7k*!v<@zee~^S^yy8n;SIv9h!z@F~L` zuV;E)#MIP`TP3BWq~-E)te=ie;#EKP>`x<4qruHp!K;f(yPS8hZ8~d0reR}ajZ`A( z(HeW)kgTXvuy(`eEDH)`tWfsw@ySLcm z71)pX#Is~7?MOOfjY2*gfad0Vq-SPfE=p#UyBs4UBW!G}*%&$+h}RorbCI@}bUZGD z(D`DX7<2A;EnO+wSMkI5S3ZiysJKOPz zXHjNr`1+U~!-i@z2TQevhO_F+9anqo4qDp6*s z{^#^#iMhy}=wm-XjcU;ayd~S zjKa+^{((2(%#||Kxw$%iyNf&$A}5<97d+PwF{vJcqF5t}K17 zWA47SPe$ba7&NE7d;EGLztWTQN_%qi?{fFvpbejgc;mTn%wk=QtX`o_PVsJli{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/eip/api-ref/public_sys-resources/commonltr_print.css b/docs/eip/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 000000000..a59823141 --- /dev/null +++ b/docs/eip/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/eip/api-ref/public_sys-resources/commonrtl.css b/docs/eip/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 000000000..f261da752 --- /dev/null +++ b/docs/eip/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/eip/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/eip/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..47a9c723532a0ac410285e5152684262127922bf GIT binary patch literal 2771 zcmV;^3M}=BP)pPg-Jv~RCwC$oO@7HS02Ydnp$REOA{(Mow8*Mm>A3h9MeO=6 zYU>mmT}9emv9DQm*RJeXc5T5Q!v0 zB$5b`NFqdtL=w?OklwC|&JB*_kR*g*P1STeQY~6uB+{*;B2i1mw!HxCh>m7?uX_kB zZW668hPGS7cBvYGjjLu-T2{ta(MHkoqDQ**khXqXE?M&}B*qkwZb{|!wVV0PLl1U( zh|@k2Pt@e8KI2W7%cc| zO7%;oh!GEaKI?~$MKHY5t{0Ps=^60OI`;KR@k?HRh+XkChOueL!}QpzFXL=(zz|LUxf|B{Fmxd{EXn6tyV1mZmG!*PMf2b20p#%- z`o8%ZVfQ~su(20?SHHrs3D0@S-1|flxSZIlFT0HsqCq!dAXirJ4@lTnmkYTz0`t-t zoL%_-P1mIvW2W1<$B}7tG*?~Z^s+@a=y&VTO-%?Gh7Jy#@{?>}D?H+5hs1sBQ0R>W z$rPxPB0JS9by>2#BO!*;vNGmn#B$c!n|>2>7?JiN4?lg9=9Ul^WTvn;zkmZNJ#I@f zXfLYayW|WUHCNr9F<}t$c#W4#+=3U8s&%wF9keEQnyx}+}N<*(D-{;R$ zaL&lM{`n*i9mMK`CvfP6+g4qiUbYCAy$P8{NBGDGJ>#mRNP+|zE_)NFmo4(hwYIv@ zj4}Jw)#_@YXz^U^wkl+5Ed$yU@(x$pVxcJ-ZmXBjPZHcyBPNTQ@jT3znFTMzB|S?h0gxfpz6m)AA4I1f{{Z$&2y zk3ciVjBaWI{dcTHs?p)HH*sm#raQmUz>fucJ<0Wt1$&7Yo{Gv8hdf^6w-o?Tw&YWcsTM+dBoLi8 zm#bgrQM3K5ud%~av^tvIiFi|^-&R4OlHQ{uGz@8In6F1rD1F94&As{c8*2bi=#8{A z)KIlQhtnC$?tCJxvO0({nRs+qm1oR!Z=IKnF2v^f{N$t{)~t1Vv2?ngNK$nuGEKO< zzf@ihKvc#!1ci#0h8lzrHSz1+9!LmL<7})$rq&Yk)GWTA^F~0u-~E0TNjvu-Q)}t} z)&}+s8s@*>B2&1%Q%tPac=st8NJG2{;%siGF;7#NJH;& zhtmrs6i)v0ou4BeO^#u2egO+IQwUR3_$5wT3!n{#&@*Jsx3K<;Tq+W^T~4H!KR$~@ zu5|Zlat{Mw&iD(0QiW8dAv|#;hS6ylMyC;;I1(Y)o!@mEZ@FnQU-ZJ$IBKhr$d&Y3 z@~n?c&GxedN!C@{=B92P%iuKA4P5P zF?T5M7UQl=?_?r5^a9HdpCWnaAVwy9ACNdxCO+iz-A9L25o0p3%IfG+5=G4$jjDT3 z_rX_P#9mZ`W{jEERu|5u25kR1=sC=`>*|qQT57FGWQv;}!j;wgsVgZ&P^ySbnS#<_ z@{wsQcZWQgM(3rkuisR2@ddhKm zm>y`QU}}cvFx#%9zncRR0f}5m+=3T>`k`rb(CYH78vp)0Ee*BEwGqTVll7BY1|4qD zR@y0eaw?7*EAlWsiJLyTGjpW6UP@ltw4HQIDv2=#er2YNQnNeHL|TgfF7e2O?@1my zh~&SD2{!g(;QB4N?2Xi&J%utn0;xtv zkRbctK7@An=2gu(9Ra)bZS!9G@?)aLPe-neAnxr2otkuaibwkB-UtAuk5dGci8mbQ zpHD?%2tDKXzEY@Rj-@xHWo6{`Gk44bDS}ZNOehT|CG6gP2Ggpt~a%lW$PyZ(R zi8N$tEzX8o&aMocNSD04oR)@K6nZ1(%xk%iRHX^nOsp#j+)(^s?wgdX$fl*dQ#vN{kQBLN_&` z(}>jJm$ns&TBh$jOxAo08KVLl?;k50S@-!F7S4`i=H$SR@bCXNvu5pPHYX!BHAMhH=PbZLgf2GrXYPBlYfJrz}; z)`4zn0@|b`lo3(5nj87CARk+Pp-;mw(B7`!W7{6u*6MHG>-993S9MlnGP}b>T0X$Q z*4=p=+dA4SslE}Gg;&WhtYpG)6U!Ea29!H%?ahd^54+^o0V28#9s2{xQ^UKnb$1>s zUY^}9i2&9v4QJu(xOPbdVAh?wt?d92zi^J^&vgoySb1+qmmi0B}` Z`Y-il7nw201!5QImN;7^FeRDuvlieQm$nqSgH2#ST^0cx)=Dn zcnY!FJo_HPt-fVW+YdiB+UT#;6V;vF(d}+cR@IeV(d8~pF{?8>qtl(5 z-l&f3hz@sXMqTY}N84?I)T&mtqU9C|*g%8DFx{Fx6Im5iuF|X}%dCt_S87;LjI4+X zS7=Dl>numvWx_9&xPzYqFMxz!h@dKJnV+WiNj6zrg25Bat1rHX34YcM&(@mM25EsKp^s$!A zn#VD|u6s{$op5YkSDD^r^tisfo6%**9APOOq(ypevUm*eg627JCCoz;t2Wm=9wHzA zIZpn)d?D?0K6~e%(5n+Y{``IW_383vZ~ype`|Z!iyVvi|9^OBm{E(}2>Xh(M9J1dY2CIYT07X)PL*D{uoU3SWSe zM5)Z@cZj(9E!*Rn@%yj8UtL_@?zGcisVAyCyQACPnyjiTyQ0fonqpRGc1EW=HN8j060m^=i($GodnU3fs$8X6OO{y~m9EsVpcq*Z6|T^b zqSslDvde-aqopiG$tAYJ8Zb!15?a()3^veUF{}|ZIT4x8)aYX^Swx02G;(1<(UEpq zsD~82sYp46Jp6zr)7XK2NT3kbfI%9Tw8DeMU;_=7#;04Wd;7XW>CRXi!yzvnE_|I|r wZ*w5M>1_7SKcT}DJ@4vn|M>OS_UPly>%-H_{r>p;)5Xs}-+pgDf7s~DJ6{D>Q~&?~ literal 0 HcmV?d00001 diff --git a/docs/eip/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/eip/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 0000000000000000000000000000000000000000..84eec9be2f2ce458e888f8a9b803f9387247726a GIT binary patch literal 68 zcmZ?wbhEHbzkByxQ$u Mo$o?7J5~m305MV#!~g&Q literal 0 HcmV?d00001 diff --git a/docs/eip/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/eip/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 0000000000000000000000000000000000000000..39583d168d6db303b366b5b8c1780698a6bb6017 GIT binary patch literal 70 zcmZ?wbhEHbEMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 diff --git a/docs/eip/api-ref/public_sys-resources/icon-danger.gif b/docs/eip/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..079c79b263f4b48089f3b3256154c73e7699593f GIT binary patch literal 1086 zcmW+#YfRQ<6hA3LZMyP?V}KhnEtF{Q4vGxS52AozEVM85nq$#%tv8gRF!3GhgM?_) zd5Luv3SKrXFTGCpn$y>EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 diff --git a/docs/eip/api-ref/public_sys-resources/icon-huawei.gif b/docs/eip/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 0000000000000000000000000000000000000000..a31d60f895af919d33855217ca02daf4093136d7 GIT binary patch literal 2767 zcmV;=3NZCYNk%w1VaEV40Oo%H*MEWRpQG)+!RUX6`tR@RDKg4%aM+KK_}}3B+S#H2 z0rt<*_Nl4!k%7|y4fwgY^uNNg00pZ61NzIz@q2NyEiLIHE%S?g^NEbfKt%9!YU?yQ z^qh&+U}WbD8{q&E?Mq9<013DN2H5})@N8$u01CkX3Fs9f^{bWHKuGLFOZ1kS)=*aD z01@p=RQ9r(>pemK^YiUeQPU6`>94W!hk53YleQ2Q>_SB7aCr2fj@; z@a|n&?qX^0W?<$J9`9pa@`8Bj9VzWnT-qQk!yqQl01W6ECF?mp=LHtlFgo|Iv-PHs z+HiFBprpVM7yReuz5od5zrUyu5$;)5@{gDATVup9HOgRO=U{2(0u;*t3-Hg-^OuGE z;N9vkH}7a--=Co1Fg#jPP{_r^k&B8kCM0%mZLFxL@$v9KH8SJk;?~sDy0^BTnwV%{ zUQ9zlgnfM9U}wHiP~xwz{`dCrZ*%7e7{X9d^{Afom69VE761SLA^8LW004ggEC2ui z0LK6@000O7fPaF6goTEOh>41ejE#|lU+C8$A-c{-jb1$W_sAqMbtN`+RZ#DGFR(dnrcRE3N%f+!F;*y7(oOv#1FPiAwy#YP$z^Q7U<_8BLs** zMSr>_(L`oBgxA?;z>x3<218xJ;14v)$l4!yG&Wrk_I1$$0*;vB$B=#`at4uppizkb zkVG1Zq>_oSkp_`a7SaZiZXiMjk!m2q29j+I!X%PpB5B5wO%5V}2qJRl1%NsHfxr&G z=|x^!dAKu_41Dql0y7LOA)N(0dcZ^rABfh-m_;ITB$a5UdB~$fR(S{-NTzYfmPE#Z z$dyBCddM0`(jjJQ3^=Hu0tmpW@WUTds1O^W zCv4aPqTVsWsFRSgiX^m^Dgr8zYZ&qdl5-rgEs}5?A_tOhoSJHxtD4)WAg_+-CV)r$ z0l^3=PP3O0e*huI221P;!@n>Lqi=>hZs_9&J75vyw2nR*>5$YWnFy(5hH1$EwSHt- z2&Y^c@+FZL3&QBRsy<8z0uiv;-+usJMIdJZ34w1G1pu?}1~|L$M-&7rk*ppEBV3oW z3{UE?w2~S^sl>(pGc6ETQUgwH}48uSiAJo0SA(QX~FrGzYvq#TC0!EGVmk{K=`YG64w z*^4Iq2N`U_YT26(@Ww;iA6V3a3V*n8!U;+!QN-&o;K;WJKrdVR4kI*6wC0H)Z8+gt z8&Y|wjA~4X(?lBohtwStGUbrnULHxSg=BE{y8s3-FXI^_2KJ7l* zPUi?^WVSHxgDj2s;6@ith~r!?-DM$hAerqT7$efv{s0FgQSEnvBN74j@P$DTKnvHC zONlTuy0+nk2Y*mO7rMX%Cg?#AOZY{0)h5f{2_S7&W;+3~xxv`varUz{DmpF%e^`f&wJ41t9(5fhwzv1mBc| z0U*EuBM2j%FvtTFnh*k5Fk|UZh`TZf2my8Qf){uKMUtgzel#qE{5o z`T+owlz=pEZ~#HrKnm`Pm2OzzgBhrem4EOJodD;_ahfxf-U+}Ak|4_v=x&*|EE67c z`G;K+;#whFp8pE*u^;}yhknQwAj5S;KNQlDsB)$xqbbb@AmI*w_<|O)xy2+vAOLDp z8yCVE${l#|oS_`S5dZ^$BP4;HUf`rVX&Fy4%@bn4W7;49dBA^~$q>dQOL?8kgXdnQvsYOnDfj24t0FVQ&GJsH);SXF0X(+eq z0|aFCq_QkQ2uwgnL@)|$U)!lnaS7A<-BO9Aav~Zq1~shtZ;*=2X&Qw1zoAY~flO_x zQ=i%a0w5p*o16;-5U|cJ{sE(En`{^}sx}@hzy~=vDN0qkRui}|sdcU4U8UAnL&&wT ze-NTA73oVe_41G0LefE{2Z>hMA+geI=u@QtfIkQT2`1nUZwBxt8^}v-apD4J9dHDm z*r2j$RqI-*fP_WBP>(V+WFp;)q}Cd-rO7KqPBT@AJ}!>D^n`Dbmde!NE;eOIpur!e zT2+HIfiCh&!V$`4~D_J+6+9nP?X4+~QQR3Nd6O>yUni+~O!R{(#Yf%|x3 zV=w6V57*_SoPYe_5lO*{ETyMCXS!kI{qmTJC@5?}tYs@Z`Gp%cnIOCjX8WdC#YjMN znOSg%0i?hn3uwZe>0DG@D8{!L9NVviU!0?6(AlZm;xWpa)Zb-c0Yf<`I615cvC$3@R|NPo+jf8PRu)%BB zhMd<%u5!4#ylXATHvtr$a54bk<~ZL%26n#lMX-S98Gr)LaZUq?L;OQXHv|E!0Ok|h zR|}ywHv~IJbrC%JsW+&2(zpJHJ2XAlm3#yMI(PL)OS76>Px~OC`E{mNAnK0zLI%qI z)ZlJG?RXaiuD@;tv`>NzH;90J?Vk56!rvj>leB^Xjy?$j0N@7pwE`ImPx(Jo;pSvu Vyd?-=a{xfJ@}LjB=qC{f06U7uGEOJ7jGVWt0R$WZ8s=je-u*DOe&kq9}!i z4KyN^y7WUtlMt&*F%bljtRbDEJamX6>@vOi{twMwE+=kqtJr%yLc-a1j}Z>-)`f9GBO%WDhy=L0>5=eLzUZCI?G``P_| zXl3c^-NL}=_M!Zh=FG7pU)shB58htr9~}O0uVbq2_rt-Fxv_(zmmdB7)lfOReyZ>D zrqum6#Z#+~moGM-oS4Ziby(A(@4L&ZrWcR4wV&_mTide#$G4kXKF-|cGp}2pJe$2t GE&l)<3Z_>8 literal 0 HcmV?d00001 diff --git a/docs/eip/api-ref/public_sys-resources/icon-notice.gif b/docs/eip/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..409070650a49518feb1624c624d814c3bfa63d2e GIT binary patch literal 962 zcmb7D&r8&C5S<{wSd_qn6)U)w5LOaRh!N}_*49lD)S!dZp@M<3gPIX|@UR9-fz+X3 zAaT9)OY{xZtO-;RC85Vab;JEUNIMS5f^r$7-e%-XK`j{0+N$CsgpRd6B1wp z8dw-cH^rU^H4`&7qgabf)l^K`l!66{q9$U(CKRO5%W5pfY)s&YQ6n`HBR0ZTum%`N zgC%I8hQ+`JG_WvCAt-W$sIn@BKCDG1qQWW^a=`*c7G+i@s0S(ZDv1&+K_2`7O-#cM z=m!ZX1Z#kSG+3e)Jg^wpfCd(Yb5TZ)U=a!DwsG z)Z`|1ejMK4ap%CHj;%+>T6=D++5I=uBbQ$fZ48cf{hV1}9&Njl-I}i7e0#6Hdug@s zsr-57_=gLr&9Ros$k}}M>tJ77=hEJ}iPaZ%8|P+gUbS|Oj}5I{|5nZZc)C1$e*Rj` d`09hYXJ4M@PhCx)dHK8WZo1*|*q+^V@*ncduk8Q; literal 0 HcmV?d00001 diff --git a/docs/eip/api-ref/public_sys-resources/icon-tip.gif b/docs/eip/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..c47bae05c9fd17c02a851d96cfac67bf194498d8 GIT binary patch literal 879 zcmchWKWmj?48@OdDOZPr)a61!OE4yGD)salg#|^Ix$qIEF#uk)V>D{95e^!2r`i+9t# zTMu5YtUcd+@#gp0tDE;9ug>oLIzL$6dOx4-t#2PKExu1KulwoYeD?Os#mVO%AMWih HO|EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 diff --git a/docs/eip/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/eip/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..57a0e1f53377b28fd80ceb393b035f8d9b8b392a GIT binary patch literal 1080 zcmV-81jqY{P)pI>PbXFRA}Dqnq7z+RTRg6r`*v5D@IBmL~4s5$SN3-f`YICkrqS^ z3O*?4J{4psT?>Nv;P$DA4|YKmeJd1v=!+{-P(e)MT23E4 zfpM5g?!;YNyXOywggfWv-aG#}pA%7499KRz`7Lmw98Q!I<#3`LPLvbnaH1TQ5UMEG zlVk_b1{y%CK&5Na8Kh~iV1CQyHSIUD=$Ui|Y1(mW{t2nlnW!hpqTT3)%#9tQ2@Hwc z4!jG@4brq%Pm%+`OlEvYXy4{GY5awd{We?gCpulWuT{Z9`oN)jk~9ZtI#ba@Tm#IC$eXI#i?GB7 z@C|Siuxi7{ffK+jzyrW_z5t&id2Xi{7fGOZ7RUNhF z=`q(YYu4B2zr}fA1-My6UW~A&C(H`Z0J{sqLLYb>ST?)$UTJH~j4 z)U5D`kx~@HyTBjADBwh`9UcOHGnaO3gx+o=^sFTdqcDs&7cD!S1Y1R9DJQENmMBXi zUX68u7SqPL=oS0?tDydiCJNY=lMCxo@cxg;Iw&H0tZv&cB5#jSkGc8v45{4-xAi@+ zH#c^6Llb3aTk2cp0#8`%*2*ZSb3DivIwje71|rV*JnwHI2e{V0 z?L}VtT_k|}D>qFKHz^_)cUMxtxkDBWXzz2D1oirfKkqs5Z>m~O`i+$JJR1>-NN>fsG-Q5hHbmeou}1??2@ zp;^{uvz{qy3k557pH|h^|K(Paf~;?wS^K(J)S`9Ki+p;|vZBS3*BostG+QG&8PgN& z=@C2h$ubuxBJTs&=XH#%UFPZrh=oAMNN{DPG_uReuDWcPESRPGOKD;{Otwcu3X@*QY`k0+@}-e yxT4{IZgHXpLI!Q!9RCwC$n{8}UWfaGMW8J;IUE8&LY1fUhGLTVa3!QBW+ZA*L=y*M3rfr5il?z?dJZieJ#47>M$@*mD4$1ecadv1qsU1#wR$;qu4Bmh4yS`Hi)ReG=4*#e zajgEV5YlLPaKTMvrW)|6L6Y@JtlU|tX}9u@d<^;|8a!TJ`kRn8mKIZX-z)%<^+`jn z738I}>P{CwooQ#@mc8ItdHsQ6rsk%O$iLY)*x7Zcj%}lwEK@`-=;otzSyX+&p9{kzQYbgSF@Q=2Qy+?#VW0=Vy|cYT&lQ@%;A2YQ{hH z9%ov+34{hBa~SnWOw39F;7p5`9$z4G?cJ)An*I*rb~&khdI=d8h1SkK)If-j5C2TB z8p4%r<<^31tR|Tw4Xs1QHMjMk20}yD8f4p%dXd_$me9Z-SWPlj8%nUOe;>LpUUAI& z1+$nxI~Q3>q`9q!{1-nPlEMa4o@e_SGSdvCrzn))J%_ut?ipfIn4e4CD=Pq4zT@D? zqk$|@wV{L*qfBG7mtFghv-Lntl$pcnz~kwNI)BUSUuvgmQEXp5=UThz?DmmjlsW$V z@)3#dyh6UbBYa%QD%n4gom-Glu20@0My{Xs3VRpaU9=0QxbJP-J)Pz^`?kOW30Tn z@ufYqb@gL4$<)8N0%S?kG%v#(IqvH7UvcW1v+a@N8!}9Baks0-uUUYP1beE1+)Q)S zUobczB2ql)J>S90pM1~e2X4k70q-59;@Rj(Ixc6Ok_Z$V@dbE+GNTrV;HlFQ=lRMeN%CX^J*|inqrfX$fdWuECU& zYE~#M%8xCgqI||*N`--7Xw)BgEZ#bB0-qYhW>q--LhLmBU*r0E*5+4PP+l2n2}rtV z_qXh+#jl32SrvAyo2R)OD=o_BoyYIMW>x6y_Tety7r)3^eF8`TK$3KP{`eA2F}YpN zxa|~0YP$+*PB&3e-M~W&UFbFHknL5q%yVT?GB=Ox3?p^VEh7*N@$03nevU0%RA*Qe zy8Bd~e78Ejsl=~x+vYF$e)B!#In3BC3Kw>)rNi4F>6}lnndnzTghB(1f9&nZP({}9 z<_Y#X?@5R5*rUdbm zZ9zPQB)-@t_#f`t1VTsxAtZr72uUD>BoIOp2q6gsLP&yt3mvdY+y=oIIs7M?<}pwN SX0_=60000=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!==null&&typeof document.body!=="undefined"){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(e){if(document.body===null||typeof document.body==="undefined"){return}if(i==0){return}clickFlag=true;var f=Json.parse("jsonData."+e);var a=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var b=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){b=0}var c=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=f;dhtmlgoodies_tooltip.style.left=c+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+b+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=c+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+b+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var d=dhtmlgoodies_tooltip.offsetWidth;if(da){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if((dhtmlgoodies_tooltip!==null&&typeof dhtmlgoodies_tooltip!=="undefined")&&+(dhtmlgoodies_tooltip.style!==null&&typeof dhtmlgoodies_tooltip.style!=="undefined")){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/eip/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/eip/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..def5c3565da51684d78479f45904c0360844c243 GIT binary patch literal 3164 zcmV-i45RajP)pR4oO5oRCwC$oPSW0cb>;zfj~mSuLKN~5E4Ot2?$cVg1bfW*MgmP zwXW?r{^)GC>z&@*cI;fk*-bA_)*65J|u{1o1b~sY9&bgB!&FtPHC|>aqwkEf8t)sIV8a zy`l<$fv1-750WZjrUfER4&AbBw(qRs>9xxN*j}-pMOzA)VQ&y-TOiWJv9nVR=-IGB zL`2wi-rWtmJCwYrnwtLq8d^@54N{_E#qc2?d98FYUt9|#UM6CV$k!5{lNa$(kHW9K zOnWgQF}`S;)25`yKPRE0?;CL9SWtgolNa zrBRX}cY`9==aUXcrj$ru%8RMoU&9MOUrS=-S8j{+s~_?FOYc$kFAFFdtPOe${ncT1 z{rLzf8V%)-DtvDE-wqmRZ8xCPYAJtA<5`q3{Ob`bjZO9Fv|84D-@EVUj$Eg)=@6=E z@#L*7W|qCq*W!xRyz%}azq+NTrIL{{k5{wx9=$&5QFz+d73A@UdA>TE#nbrfC(X3B z8(6fZ$fI-Rsms(id`VH^EXwBij$f6Q%6pGy`z7a}PPWn1d>+=6lPmX*Un}gz{Ox!v z`WEl|IDGSOT%3|O*G+D{rZj7N?NbLjt(LV5jh=HqnA?U z8mrYxV|c!gMHxe<(a3REu1^wRwhaLAc*#s3m+W-80O+~e%iEuijH}D~<%`(7rkqDg z=TTZb2dmA-!DFZR&9(3NZQo)rQeiLlD~pmzCp{Of?FN2YE1pz;Th3*$^KYlnx3rR& zpyJ_&X0!Fj%Xs-G%lKj0eA3fW0mv9`|G!E9Ya~lJ`Po^X-Lx2KsErPD79Hj+q@gxm z{Mlkoes-3_qjQ5Er(oy{Vq#*j+H8D$A>2z=-J3vbyTSAQk0(04Sglr))oM!O z`@CekFQuSwX(c8)8igX37UN~i63tz8`Qdaso8^aiGyN2A&2A@2H4T81Uv&6wZ?)Oj zTifJC_?WSn~TqB!^hRw*Ad4e7J~3dFR=6G>_8NdnsMLm)G}au^{sd3m-1x^#e`g zF3xz6x-4W*PjVBduE|UGaf6#U1-aQM6tVOT40?@sz!ZhmW+Or>@p4-Zv4VXye+OW7 zc`+d&A#@sz?CP00DZSLHz!o=IttMHmrqgKTxg*zuw$4$Jkz99N$7-|j*1@mnmSvB7 zO=WExR-28GkWk(!3-#*~r7p`oB}P+1qz`Ts(`7QTajn||ZQHTiBYWfRy#Q?8q@~Mb zVxKK9=<$~3C;^C&N<0(TEz8Di8z5P&W>aZ0G0`z}8jaMCZ=XmZMWeykeJP-en=p}N zQr=uQi}bWqx=f~kF79@>Z|%3c-P>cc{E{db1WhEfM8nqKxzqiJbY}y$o33o;>9xz* zUQson-E%k07oQ_VqoK9kz%l!D08Tq~beT*pkf^ z4(PF1`pDEKqI8;gLeoonS}MI}GariryW_5*SlZ-;)XNs|tUjBo*UTssvHYZ9)NlJ) z_By_sKLd-UZ%SNTyvWApvWyA2xbs6QE?m4wVctygq*taq{STT*zcFP3uVFUm(>{fsnY2byQucdN-4PVNGGwlltbpW(qxPn=t@v%0g@(xlo8u|zNX$;Tj zL~B0)v5_*bKys%(iq>`m{r&x%z8c|~$V_b_07FC0fQu6zCMG;gOl!LV)wFmvmglg* zQ8R8V_1h;>NK8;+wORT1?%)IOmvT)cCaCB#nI=Te-qC2U(nDqS8QysRkk_a3)aCm} zq?bP(MW@xWs-)NJe1QW+nJCD~rsrxeyN)(b$ZgNE*Rg8RgYE+A=jS;+kQlUu{`Kmaq-Zo)ZC1bW*X)SP zB&*dleDyW$_FJ1<>AK4LvN>#CQ_ki!<><89`&-$rmo4DrXSKYw{l~;e&UndGvBREY zdBhz%GStSin-=p=&;OneA1vbs!`1gR{w#YP5zt^s>sevrzAfWX_)uEYBrfUeBv}`^qrW~HGWfKsmsDE zOQ*BGS9P4Wl`RF-yksh zy60FsZNNwVNWragKrk^ve!4rg7mMBdVO@#NOI{X#h4i#kMn*=saPcD79Zs)o<((?G z^^%CiJRf_Q&GJKDpRI*9vNO}^G#dG@zTAL%%&<4GWyKs~qN8as7&HHba-?wT_zK+{<0Kls4ZZI zwt3@|Ua`~d_}Me*beT*+rNNJ9iBKqFak*TiXf(`~bowmtSfv`EtT@NZqPks+{a z5!JMKPh8~>&n-znE|bw}==6Ccb0>biz(smmDwnVHu}ZPEji zzW45)-n*6<0^#-C^K4pKLR_4Zk&zJ&pEynB{*O3#>=aGS=dlkuD9FiX!}lillwCC0 z-?hEgU&dQ|syVhNu(h$+M6CR&JD%9FMMGhZ|GG+tIg8TOds)AHF)ylW?m2UG5RP)x z8t}<_w^)soA(EXPo(HDmU3a@1zaW|JX{#K%Oq;}A@|fXl@p%B-Ez8C%ib2W{N|$?g zkBuLwVmzkfoqdk=b-RuZv4S>9rqBJ{sq>hQNv?~2V>^dfL1TD6U)yB#J4cCkVw)_#|7FHwSFj&?I903+@}Q+?E}XNC3Nz=CN(ZZjK1= zEPb1Cd{SB4f1Go_kMMN4^{(v-b4ID$mhCyd8&;L{vU{JFmp>h)qCi-YZ!0DoBh||m zu>a`Eo9X_gaoZQ>jE+kpfEdXop55erJD^6gL|Bn;DJE=@t~lNAw+sx9aIkUClqxYW z=nj}aF^#ZTB`nJSYa&gTT1nApc>bmLzAo-6E0000