From 79a69012633620c6999ea9f83e2150ccd5be911e Mon Sep 17 00:00:00 2001 From: zhoumeng Date: Thu, 4 Dec 2025 21:11:56 +0000 Subject: [PATCH] ELB_API_20251118_Version MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reviewed-by: Hajba, László Antal Co-authored-by: zhoumeng Co-committed-by: zhoumeng --- docs/elb/api-ref/ALL_META.TXT.json | 1014 +++++++---------- docs/elb/api-ref/CLASS.TXT.json | 176 +-- docs/elb/api-ref/CreateCertificate.html | 11 +- docs/elb/api-ref/CreateHealthMonitor.html | 148 ++- docs/elb/api-ref/CreateIpGroup.html | 1 + docs/elb/api-ref/CreateL7Policy.html | 6 +- docs/elb/api-ref/CreateL7Rule.html | 2 +- docs/elb/api-ref/CreateListener.html | 997 +++++++++++++++- docs/elb/api-ref/CreateLoadBalancer.html | 24 +- docs/elb/api-ref/CreateMember.html | 10 +- docs/elb/api-ref/CreatePool.html | 16 +- docs/elb/api-ref/DeleteListenerForce.html | 82 +- docs/elb/api-ref/DeleteLoadBalancerForce.html | 98 +- docs/elb/api-ref/ListAllMembers.html | 4 +- docs/elb/api-ref/ListApiVersions.html | 2 +- docs/elb/api-ref/ListCertificates.html | 2 +- docs/elb/api-ref/ListHealthMonitors.html | 114 +- docs/elb/api-ref/ListListeners.html | 499 +++++++- docs/elb/api-ref/ListLoadBalancers.html | 14 +- docs/elb/api-ref/ListMembers.html | 6 +- docs/elb/api-ref/ListPools.html | 10 +- docs/elb/api-ref/ShowCertificate.html | 2 +- docs/elb/api-ref/ShowHealthMonitor.html | 72 +- docs/elb/api-ref/ShowListener.html | 497 +++++++- docs/elb/api-ref/ShowLoadBalancer.html | 12 +- docs/elb/api-ref/ShowMember.html | 2 +- docs/elb/api-ref/ShowPool.html | 8 +- docs/elb/api-ref/UpdateCertificate.html | 13 +- docs/elb/api-ref/UpdateHealthMonitor.html | 151 ++- docs/elb/api-ref/UpdateListener.html | 988 +++++++++++++++- docs/elb/api-ref/UpdateLoadBalancer.html | 20 +- docs/elb/api-ref/UpdateMember.html | 2 +- docs/elb/api-ref/UpdatePool.html | 10 +- docs/elb/api-ref/elb_xd_0000.html | 16 +- 34 files changed, 4066 insertions(+), 963 deletions(-) diff --git a/docs/elb/api-ref/ALL_META.TXT.json b/docs/elb/api-ref/ALL_META.TXT.json index adb6fdc19..6e6a1cd25 100644 --- a/docs/elb/api-ref/ALL_META.TXT.json +++ b/docs/elb/api-ref/ALL_META.TXT.json @@ -13,9 +13,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"API Usage Guidelines", @@ -32,9 +31,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"APIs (V2.0)", @@ -51,9 +49,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"API Call Precaution", @@ -70,9 +67,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Load Balancer", @@ -89,9 +85,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Creating a Load Balancer", @@ -108,9 +103,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Load Balancers", @@ -127,9 +121,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Details of a Load Balancer", @@ -146,9 +139,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying the Status Tree of a Load Balancer", @@ -165,9 +157,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Updating a Load Balancer", @@ -184,9 +175,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Load Balancer", @@ -203,9 +193,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Listener", @@ -222,9 +211,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Adding a Listener", @@ -241,9 +229,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Listeners", @@ -260,9 +247,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Details of a Listener", @@ -279,9 +265,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Updating a Listener", @@ -298,9 +283,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Listener", @@ -317,9 +301,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Backend Server Group", @@ -336,9 +319,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Adding a Backend Server Group", @@ -355,9 +337,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Backend Server Groups", @@ -374,9 +355,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Details of a Backend Server Group", @@ -393,9 +373,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Updating a Backend Server Group", @@ -412,9 +391,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Backend Server Group", @@ -431,9 +409,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Backend Server", @@ -450,9 +427,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Adding a Backend Server", @@ -469,9 +445,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Backend Servers", @@ -488,9 +463,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Details of a Backend Server", @@ -507,9 +481,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Updating a Backend Server", @@ -526,9 +499,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Removing a Backend Server", @@ -545,9 +517,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying All Backend Servers (Extension API)", @@ -564,9 +535,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Batch Updating Backend Servers", @@ -583,9 +553,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Quota", @@ -602,9 +571,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Default Resource Quotas", @@ -621,9 +589,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Current Resource Quotas", @@ -640,9 +607,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Health Check", @@ -659,9 +625,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Configuring a Health Check", @@ -678,9 +643,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Health Checks", @@ -697,9 +661,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Details of a Health Check", @@ -716,9 +679,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Updating a Health Check", @@ -735,9 +697,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Health Check", @@ -754,9 +715,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Forwarding Policy", @@ -773,9 +733,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Adding a Forwarding Policy", @@ -792,9 +751,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Forwarding Policies", @@ -811,9 +769,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Details of a Forwarding Policy", @@ -830,9 +787,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Updating a Forwarding Policy", @@ -849,9 +805,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Forwarding Policy", @@ -868,9 +823,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Forwarding Rule", @@ -887,9 +841,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Adding a Forwarding Rule", @@ -906,9 +859,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Forwarding Rules", @@ -925,9 +877,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Details of a Forwarding Rule", @@ -944,9 +895,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Updating a Forwarding Rule", @@ -963,9 +913,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Forwarding Rule", @@ -982,9 +931,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Whitelist", @@ -1001,9 +949,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Adding a Whitelist", @@ -1020,9 +967,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Whitelists", @@ -1039,9 +985,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Details of a Whitelist", @@ -1058,9 +1003,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Updating a Whitelist", @@ -1077,9 +1021,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Whitelist", @@ -1096,9 +1039,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Certificate", @@ -1115,9 +1057,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Creating a Certificate", @@ -1134,9 +1075,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Certificates", @@ -1153,9 +1093,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Details of a Certificate", @@ -1172,9 +1111,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Updating a Certificate", @@ -1191,9 +1129,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Certificate", @@ -1210,9 +1147,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Tag", @@ -1229,9 +1165,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Adding a Tag to a Load Balancer", @@ -1248,9 +1183,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Batch Adding Load Balancer Tags", @@ -1267,9 +1201,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying All Tags of a Load Balancer", @@ -1286,9 +1219,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying the Tags of All Load Balancers", @@ -1305,9 +1237,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Load Balancers by Tag", @@ -1324,9 +1255,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Tag from a Load Balancer", @@ -1343,9 +1273,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Adding a Tag to a Listener", @@ -1362,9 +1291,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Batch Adding Tags to a Listener", @@ -1381,9 +1309,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying All Tags of a Listener", @@ -1400,9 +1327,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying the Tags of All Listeners", @@ -1419,9 +1345,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Listeners by Tag", @@ -1438,9 +1363,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Tag from a Listener", @@ -1457,9 +1381,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Status Codes", @@ -1476,9 +1399,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"APIs (V3)", @@ -1495,9 +1417,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"API Call Precaution", @@ -1506,7 +1427,7 @@ { "uri":"module_versions.html", "node_id":"module_versions.xml", - "product_code":"", + "product_code":"elb", "code":"80", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -1514,7 +1435,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"API Version", @@ -1523,7 +1445,7 @@ { "uri":"ListApiVersions.html", "node_id":"listapiversions.xml", - "product_code":"", + "product_code":"elb", "code":"81", "des":"This API is used to query all available ELB API versions.GET /versionsNoneStatus code: 200Querying API versionsStatus code: 200Successful request.See Error Codes.", "doc_type":"api", @@ -1531,9 +1453,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListApiVersions" + "prodname":"elb" } ], "title":"Querying API Versions", @@ -1542,7 +1463,7 @@ { "uri":"module_quotas.html", "node_id":"module_quotas.xml", - "product_code":"", + "product_code":"elb", "code":"82", "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", @@ -1550,7 +1471,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Quota", @@ -1559,7 +1481,7 @@ { "uri":"ShowQuota.html", "node_id":"showquota.xml", - "product_code":"", + "product_code":"elb", "code":"83", "des":"This API is used to query the quotas of load balancers and related resources in a specific project.GET /v3/{project_id}/elb/quotasStatus code: 200Obtaining the resource q", "doc_type":"api", @@ -1567,9 +1489,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowQuota" + "prodname":"elb" } ], "title":"Querying Quotas", @@ -1578,7 +1499,7 @@ { "uri":"ListQuotaDetails.html", "node_id":"listquotadetails.xml", - "product_code":"", + "product_code":"elb", "code":"84", "des":"This API is used to query the current quotas and used quotas of resources related to a dedicated load balancer in a specific project.GET /v3/{project_id}/elb/quotas/detai", "doc_type":"api", @@ -1586,9 +1507,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListQuotaDetails" + "prodname":"elb" } ], "title":"Querying Quota Usage", @@ -1597,7 +1517,7 @@ { "uri":"module_azs.html", "node_id":"module_azs.xml", - "product_code":"", + "product_code":"elb", "code":"85", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", @@ -1605,7 +1525,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"AZ", @@ -1614,7 +1535,7 @@ { "uri":"ListAvailabilityZones.html", "node_id":"listavailabilityzones.xml", - "product_code":"", + "product_code":"elb", "code":"86", "des":"This API is used to query all available AZs when you create a dedicated load balancer.One set of AZs is returned by default. When you create a dedicated load balancer, yo", "doc_type":"api", @@ -1622,9 +1543,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListAvailabilityZones" + "prodname":"elb" } ], "title":"Querying AZs", @@ -1633,7 +1553,7 @@ { "uri":"module_flavors.html", "node_id":"module_flavors.xml", - "product_code":"", + "product_code":"elb", "code":"87", "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", @@ -1641,7 +1561,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Load Balancer Flavor", @@ -1650,7 +1571,7 @@ { "uri":"ListFlavors.html", "node_id":"listflavors.xml", - "product_code":"", + "product_code":"elb", "code":"88", "des":"This API is used to query all load balancer flavors that are available to a specific user in a specific region.This API has the following constraints:Parameters marker, l", "doc_type":"api", @@ -1658,9 +1579,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListFlavors" + "prodname":"elb" } ], "title":"Querying Flavors", @@ -1669,7 +1589,7 @@ { "uri":"ShowFlavor.html", "node_id":"showflavor.xml", - "product_code":"", + "product_code":"elb", "code":"89", "des":"This API is used to view details of a flavor.GET /v3/{project_id}/elb/flavors/{flavor_id}Status code: 200Status code: 200Successful request.See Error Codes.", "doc_type":"api", @@ -1677,9 +1597,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowFlavor" + "prodname":"elb" } ], "title":"Viewing Details of a Flavor", @@ -1688,7 +1607,7 @@ { "uri":"module_loadbalancers.html", "node_id":"module_loadbalancers.xml", - "product_code":"", + "product_code":"elb", "code":"90", "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", @@ -1696,7 +1615,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Load Balancer", @@ -1705,7 +1625,7 @@ { "uri":"CreateLoadBalancer.html", "node_id":"createloadbalancer.xml", - "product_code":"", + "product_code":"elb", "code":"91", "des":"This API is used to create a dedicated load balancer. When you create a load balancer, note the following:Specify vip_subnet_cidr_id if you want to bind a private IPv4 ad", "doc_type":"api", @@ -1713,9 +1633,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateLoadBalancer" + "prodname":"elb" } ], "title":"Creating a Load Balancer", @@ -1724,7 +1643,7 @@ { "uri":"ListLoadBalancers.html", "node_id":"listloadbalancers.xml", - "product_code":"", + "product_code":"elb", "code":"92", "des":"This API is used to query all load balancers.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters ma", "doc_type":"api", @@ -1732,9 +1651,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListLoadBalancers" + "prodname":"elb" } ], "title":"Querying Load Balancers", @@ -1743,7 +1661,7 @@ { "uri":"ShowLoadBalancer.html", "node_id":"showloadbalancer.xml", - "product_code":"", + "product_code":"elb", "code":"93", "des":"This API is used to view details of a load balancer.GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}Status code: 200Viewing details of a load balancerStatus code:", "doc_type":"api", @@ -1751,9 +1669,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowLoadBalancer" + "prodname":"elb" } ], "title":"Viewing Details of a Load Balancer", @@ -1762,7 +1679,7 @@ { "uri":"UpdateLoadBalancer.html", "node_id":"updateloadbalancer.xml", - "product_code":"", + "product_code":"elb", "code":"94", "des":"This API is used to update a load balancer.PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}Status code: 200Updating a load balancerStatus code: 200Successful requ", "doc_type":"api", @@ -1770,9 +1687,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateLoadBalancer" + "prodname":"elb" } ], "title":"Updating a Load Balancer", @@ -1781,7 +1697,7 @@ { "uri":"DeleteLoadBalancer.html", "node_id":"deleteloadbalancer.xml", - "product_code":"", + "product_code":"elb", "code":"95", "des":"This API is used to delete a load balancer.All listeners added to the load balancer must be deleted before the load balancer is deleted.DELETE /v3/{project_id}/elb/loadba", "doc_type":"api", @@ -1789,9 +1705,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteLoadBalancer" + "prodname":"elb" } ], "title":"Deleting a Load Balancer", @@ -1800,7 +1715,7 @@ { "uri":"DeleteLoadBalancerForce.html", "node_id":"deleteloadbalancerforce.xml", - "product_code":"", + "product_code":"elb", "code":"96", "des":"This API is used to delete a load balancer and its associated resources, including the listeners, backend server groups, and backend servers.Note:If a load balancer has E", "doc_type":"api", @@ -1808,9 +1723,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteLoadBalancerForce" + "prodname":"elb" } ], "title":"Deleting a Load Balancer and Its Associated Resources", @@ -1819,7 +1733,7 @@ { "uri":"ShowLoadBalancerStatus.html", "node_id":"showloadbalancerstatus.xml", - "product_code":"", + "product_code":"elb", "code":"97", "des":"This API is used to query the status tree of a load balancer and to show information about all resources associated with the load balancer.When admin_state_up is set to f", "doc_type":"api", @@ -1827,9 +1741,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowLoadBalancerStatus" + "prodname":"elb" } ], "title":"Querying the Status Tree of a Load Balancer", @@ -1838,7 +1751,7 @@ { "uri":"module_certificates.html", "node_id":"module_certificates.xml", - "product_code":"", + "product_code":"elb", "code":"98", "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", @@ -1846,7 +1759,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Certificate", @@ -1855,7 +1769,7 @@ { "uri":"CreateCertificate.html", "node_id":"createcertificate.xml", - "product_code":"", + "product_code":"elb", "code":"99", "des":"This API is used to create an SSL certificate for HTTPS listeners.POST /v3/{project_id}/elb/certificatesStatus code: 201Creating a server certificateStatus code: 201Norma", "doc_type":"api", @@ -1863,9 +1777,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateCertificate" + "prodname":"elb" } ], "title":"Creating a Certificate", @@ -1874,7 +1787,7 @@ { "uri":"ListCertificates.html", "node_id":"listcertificates.xml", - "product_code":"", + "product_code":"elb", "code":"100", "des":"This API is used to query all SSL certificates.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters ", "doc_type":"api", @@ -1882,9 +1795,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListCertificates" + "prodname":"elb" } ], "title":"Querying Certificates", @@ -1893,7 +1805,7 @@ { "uri":"ShowCertificate.html", "node_id":"showcertificate.xml", - "product_code":"", + "product_code":"elb", "code":"101", "des":"This API is used to view details of an SSL certificate.GET /v3/{project_id}/elb/certificates/{certificate_id}Status code: 200Status code: 200Successful request.See Error ", "doc_type":"api", @@ -1901,9 +1813,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowCertificate" + "prodname":"elb" } ], "title":"Viewing Details of a Certificate", @@ -1912,7 +1823,7 @@ { "uri":"UpdateCertificate.html", "node_id":"updatecertificate.xml", - "product_code":"", + "product_code":"elb", "code":"102", "des":"This API is used to update an SSL certificate.If a certificate with a domain name is used by a listener, the domain name cannot be updated to an empty string (\"\"), and th", "doc_type":"api", @@ -1920,9 +1831,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateCertificate" + "prodname":"elb" } ], "title":"Updating a Certificate", @@ -1931,7 +1841,7 @@ { "uri":"DeleteCertificate.html", "node_id":"deletecertificate.xml", - "product_code":"", + "product_code":"elb", "code":"103", "des":"This API is used to delete an SSL certificate.If the certificate is used by a listener, the certificate cannot be deleted, and the 409 Conflict error code will be display", "doc_type":"api", @@ -1939,9 +1849,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteCertificate" + "prodname":"elb" } ], "title":"Deleting a Certificate", @@ -1950,7 +1859,7 @@ { "uri":"module_security_policies.html", "node_id":"module_security_policies.xml", - "product_code":"", + "product_code":"elb", "code":"104", "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", @@ -1958,7 +1867,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Security Policy", @@ -1967,7 +1877,7 @@ { "uri":"CreateSecurityPolicy.html", "node_id":"createsecuritypolicy.xml", - "product_code":"", + "product_code":"elb", "code":"105", "des":"This API is used to create a custom security policy. If you need a custom security policy, you need to specify security_policy_id when you add an HTTPS listener to your l", "doc_type":"api", @@ -1975,9 +1885,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateSecurityPolicy" + "prodname":"elb" } ], "title":"Creating a Custom Security Policy", @@ -1986,7 +1895,7 @@ { "uri":"ListSecurityPolicies.html", "node_id":"listsecuritypolicies.xml", - "product_code":"", + "product_code":"elb", "code":"106", "des":"This API is used to query custom security policies.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Paramet", "doc_type":"api", @@ -1994,9 +1903,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListSecurityPolicies" + "prodname":"elb" } ], "title":"Querying Custom Security Policies", @@ -2005,7 +1913,7 @@ { "uri":"ShowSecurityPolicy.html", "node_id":"showsecuritypolicy.xml", - "product_code":"", + "product_code":"elb", "code":"107", "des":"This API is used to query details of a custom security policy.GET /v3/{project_id}/elb/security-policies/{security_policy_id}Status code: 200Querying details of a custom ", "doc_type":"api", @@ -2013,9 +1921,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowSecurityPolicy" + "prodname":"elb" } ], "title":"Querying Details of a Custom Security Policy", @@ -2024,7 +1931,7 @@ { "uri":"UpdateSecurityPolicy.html", "node_id":"updatesecuritypolicy.xml", - "product_code":"", + "product_code":"elb", "code":"108", "des":"This API is used to update a custom security policy.If protocols or ciphers is updated, the modification takes effect immediately on all listeners that use the custom sec", "doc_type":"api", @@ -2032,9 +1939,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateSecurityPolicy" + "prodname":"elb" } ], "title":"Updating a Custom Security Policy", @@ -2043,7 +1949,7 @@ { "uri":"DeleteSecurityPolicy.html", "node_id":"deletesecuritypolicy.xml", - "product_code":"", + "product_code":"elb", "code":"109", "des":"This API is used to delete a custom security policy.A custom security policy that has been used by a listener cannot be deleted.DELETE /v3/{project_id}/elb/security-polic", "doc_type":"api", @@ -2051,9 +1957,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteSecurityPolicy" + "prodname":"elb" } ], "title":"Deleting a Custom Security Policy", @@ -2062,7 +1967,7 @@ { "uri":"ListSystemSecurityPolicies.html", "node_id":"listsystemsecuritypolicies.xml", - "product_code":"", + "product_code":"elb", "code":"110", "des":"This API is used to query system security policies.System security policies are available to all users and cannot be created or modified.GET /v3/{project_id}/elb/system-s", "doc_type":"api", @@ -2070,9 +1975,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListSystemSecurityPolicies" + "prodname":"elb" } ], "title":"Querying System Security Policies", @@ -2081,7 +1985,7 @@ { "uri":"module_ipgroups.html", "node_id":"module_ipgroups.xml", - "product_code":"", + "product_code":"elb", "code":"111", "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", @@ -2089,7 +1993,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"IP Address Group", @@ -2098,7 +2003,7 @@ { "uri":"CreateIpGroup.html", "node_id":"createipgroup.xml", - "product_code":"", + "product_code":"elb", "code":"112", "des":"This API is used to create an IP address group. The IP address can contain IP addresses or CIDR blocks. 0.0.0.0 will be considered the same as 0.0.0.0/32. If you enter bo", "doc_type":"api", @@ -2106,9 +2011,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateIpGroup" + "prodname":"elb" } ], "title":"Creating an IP Address Group", @@ -2117,7 +2021,7 @@ { "uri":"ListIpGroups.html", "node_id":"listipgroups.xml", - "product_code":"", + "product_code":"elb", "code":"113", "des":"This API is used to query IP address groups.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters mar", "doc_type":"api", @@ -2125,9 +2029,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListIpGroups" + "prodname":"elb" } ], "title":"Querying IP Address Groups", @@ -2136,7 +2039,7 @@ { "uri":"ShowIpGroup.html", "node_id":"showipgroup.xml", - "product_code":"", + "product_code":"elb", "code":"114", "des":"This API is used to view details of an IP address group.GET /v3/{project_id}/elb/ipgroups/{ipgroup_id}Status code: 200Viewing details of an IP address groupStatus code: 2", "doc_type":"api", @@ -2144,9 +2047,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowIpGroup" + "prodname":"elb" } ], "title":"Viewing Details of an IP Address Group", @@ -2155,7 +2057,7 @@ { "uri":"UpdateIpGroup.html", "node_id":"updateipgroup.xml", - "product_code":"", + "product_code":"elb", "code":"115", "des":"This API is used to update an IP address group. All IP addresses in the IP address group will be overwritten, and the IP addresses that are not included in the ip_list pa", "doc_type":"api", @@ -2163,9 +2065,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateIpGroup" + "prodname":"elb" } ], "title":"Updating an IP Address Group", @@ -2174,7 +2075,7 @@ { "uri":"DeleteIpGroup.html", "node_id":"deleteipgroup.xml", - "product_code":"", + "product_code":"elb", "code":"116", "des":"This API is used to delete an IP address group.DELETE /v3/{project_id}/elb/ipgroups/{ipgroup_id}Status code: 204Successful request.NoneDeleting an IP address groupNoneSee", "doc_type":"api", @@ -2182,9 +2083,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteIpGroup" + "prodname":"elb" } ], "title":"Deleting an IP Address Group", @@ -2193,7 +2093,7 @@ { "uri":"UpdateIpList.html", "node_id":"updateiplist.xml", - "product_code":"", + "product_code":"elb", "code":"117", "des":"This API is used to update the IP addresses in an IP address group.POST /v3/{project_id}/elb/ipgroups/{ipgroup_id}/iplist/create-or-updateStatus code: 200Updating IP addr", "doc_type":"api", @@ -2201,9 +2101,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateIpList" + "prodname":"elb" } ], "title":"Updating IP Addresses in an IP Address Group", @@ -2212,7 +2111,7 @@ { "uri":"BatchDeleteIpList.html", "node_id":"batchdeleteiplist.xml", - "product_code":"", + "product_code":"elb", "code":"118", "des":"This API is used to delete IP addresses from an IP address group.POST /v3/{project_id}/elb/ipgroups/{ipgroup_id}/iplist/batch-deleteStatus code: 200Deleting IP addresses ", "doc_type":"api", @@ -2220,9 +2119,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"BatchDeleteIpList" + "prodname":"elb" } ], "title":"Deleting IP Addresses from an IP Address Group", @@ -2231,7 +2129,7 @@ { "uri":"module_listeners.html", "node_id":"module_listeners.xml", - "product_code":"", + "product_code":"elb", "code":"119", "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", @@ -2239,7 +2137,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Listener", @@ -2248,17 +2147,16 @@ { "uri":"CreateListener.html", "node_id":"createlistener.xml", - "product_code":"", + "product_code":"elb", "code":"120", - "des":"This API is used to add a listener to a load balancer.The protocol used by the listener can be TCP, UDP, HTTP, or HTTPS.For load balancing at Layer 4, the protocol can on", + "des":"This API is used to add a listener to a load balancer.For load balancing at Layer 4, the protocol can only be TCP or UDP.For load balancing at Layer 4, the protocol can o", "doc_type":"api", "kw":"Adding a Listener,Listener,API Reference", "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateListener" + "prodname":"elb" } ], "title":"Adding a Listener", @@ -2267,7 +2165,7 @@ { "uri":"ListListeners.html", "node_id":"listlisteners.xml", - "product_code":"", + "product_code":"elb", "code":"121", "des":"This API is used to query listeners.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker, lim", "doc_type":"api", @@ -2275,9 +2173,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListListeners" + "prodname":"elb" } ], "title":"Querying Listeners", @@ -2286,7 +2183,7 @@ { "uri":"ShowListener.html", "node_id":"showlistener.xml", - "product_code":"", + "product_code":"elb", "code":"122", "des":"This API is used to view details of a listener.GET /v3/{project_id}/elb/listeners/{listener_id}Status code: 200Viewing details of a listenerStatus code: 200Successful req", "doc_type":"api", @@ -2294,9 +2191,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowListener" + "prodname":"elb" } ], "title":"Viewing Details of a Listener", @@ -2305,7 +2201,7 @@ { "uri":"UpdateListener.html", "node_id":"updatelistener.xml", - "product_code":"", + "product_code":"elb", "code":"123", "des":"This API is used to update a listener.If the provisioning status of the load balancer that the listener is added to is not ACTIVE, the listener cannot be updated.PUT /v3/", "doc_type":"api", @@ -2313,9 +2209,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateListener" + "prodname":"elb" } ], "title":"Updating a Listener", @@ -2324,7 +2219,7 @@ { "uri":"DeleteListener.html", "node_id":"deletelistener.xml", - "product_code":"", + "product_code":"elb", "code":"124", "des":"This API is used to delete a listener.Before you delete a listener, delete associated backend server groups or remove all backend servers in the default backend server gr", "doc_type":"api", @@ -2332,9 +2227,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteListener" + "prodname":"elb" } ], "title":"Deleting a Listener", @@ -2343,7 +2237,7 @@ { "uri":"DeleteListenerForce.html", "node_id":"deletelistenerforce.xml", - "product_code":"", + "product_code":"elb", "code":"125", "des":"This API is used to delete a listener and its associated resources, including the forwarding policies and backend server groups.DELETE /v3/{project_id}/elb/listeners/{lis", "doc_type":"api", @@ -2351,9 +2245,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteListenerForce" + "prodname":"elb" } ], "title":"Deleting a Listener and Its Associated Resources", @@ -2362,7 +2255,7 @@ { "uri":"module_pools.html", "node_id":"module_pools.xml", - "product_code":"", + "product_code":"elb", "code":"126", "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", @@ -2370,7 +2263,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Backend Server Group", @@ -2379,17 +2273,16 @@ { "uri":"CreatePool.html", "node_id":"createpool.xml", - "product_code":"", + "product_code":"elb", "code":"127", - "des":"This API is used to create a backend server group.If session-persistence is specified, cookie_name is available only when type is set to APP_COOKIE.If listener_id is spec", + "des":"This API is used to create a backend server group.If session_persistence is specified, cookie_name is available only when type is set to APP_COOKIE.If listener_id is spec", "doc_type":"api", "kw":"Creating a Backend Server Group,Backend Server Group,API Reference", "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreatePool" + "prodname":"elb" } ], "title":"Creating a Backend Server Group", @@ -2398,7 +2291,7 @@ { "uri":"ListPools.html", "node_id":"listpools.xml", - "product_code":"", + "product_code":"elb", "code":"128", "des":"This API is used to query all backend server groups.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parame", "doc_type":"api", @@ -2406,9 +2299,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListPools" + "prodname":"elb" } ], "title":"Querying Backend Server Groups", @@ -2417,7 +2309,7 @@ { "uri":"ShowPool.html", "node_id":"showpool.xml", - "product_code":"", + "product_code":"elb", "code":"129", "des":"This API is used to view details of a backend server group.GET /v3/{project_id}/elb/pools/{pool_id}Status code: 200Status code: 200Successful request.See Error Codes.", "doc_type":"api", @@ -2425,9 +2317,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowPool" + "prodname":"elb" } ], "title":"Viewing Details of a Backend Server Group", @@ -2436,7 +2327,7 @@ { "uri":"UpdatePool.html", "node_id":"updatepool.xml", - "product_code":"", + "product_code":"elb", "code":"130", "des":"This API is used to update a backend server group.The backend server group can be updated only when the provisioning status of the associated load balancer is ACTIVE.PUT ", "doc_type":"api", @@ -2444,9 +2335,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdatePool" + "prodname":"elb" } ], "title":"Updating a Backend Server Group", @@ -2455,7 +2345,7 @@ { "uri":"DeletePool.html", "node_id":"deletepool.xml", - "product_code":"", + "product_code":"elb", "code":"131", "des":"This API is used to delete a backend server group.A backend server group can be deleted only after all servers are removed from the group, the health check configured for", "doc_type":"api", @@ -2463,9 +2353,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeletePool" + "prodname":"elb" } ], "title":"Deleting a Backend Server Group", @@ -2474,7 +2363,7 @@ { "uri":"module_members.html", "node_id":"module_members.xml", - "product_code":"", + "product_code":"elb", "code":"132", "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", @@ -2482,7 +2371,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Backend Server", @@ -2491,7 +2381,7 @@ { "uri":"CreateMember.html", "node_id":"createmember.xml", - "product_code":"", + "product_code":"elb", "code":"133", "des":"This API is used to add a backend server.When you add backend servers, note the following:Two backend servers in the same backend server group must have different IP addr", "doc_type":"api", @@ -2499,9 +2389,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateMember" + "prodname":"elb" } ], "title":"Adding a Backend Server", @@ -2510,7 +2399,7 @@ { "uri":"ListMembers.html", "node_id":"listmembers.xml", - "product_code":"", + "product_code":"elb", "code":"134", "des":"This API is used to query all backend servers in a given backend server group.This API has the following constraints:Parameters marker, limit, and page_reverse are used f", "doc_type":"api", @@ -2518,9 +2407,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListMembers" + "prodname":"elb" } ], "title":"Querying Backend Servers in a Backend Server Group", @@ -2529,7 +2417,7 @@ { "uri":"ShowMember.html", "node_id":"showmember.xml", - "product_code":"", + "product_code":"elb", "code":"135", "des":"This API is used to view details of a backend server.GET /v3/{project_id}/elb/pools/{pool_id}/members/{member_id}Status code: 200Status code: 200Successful request.See Er", "doc_type":"api", @@ -2537,9 +2425,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowMember" + "prodname":"elb" } ], "title":"Viewing Details of a Backend Server", @@ -2548,7 +2435,7 @@ { "uri":"UpdateMember.html", "node_id":"updatemember.xml", - "product_code":"", + "product_code":"elb", "code":"136", "des":"This API is used to update a backend server.If the provisioning status of the associated load balancer is not ACTIVE, the backend server cannot be updated.PUT /v3/{projec", "doc_type":"api", @@ -2556,9 +2443,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateMember" + "prodname":"elb" } ], "title":"Updating a Backend Server", @@ -2567,7 +2453,7 @@ { "uri":"DeleteMember.html", "node_id":"deletemember.xml", - "product_code":"", + "product_code":"elb", "code":"137", "des":"This API is used to remove a backend server.After you remove a backend server, new connections to this server will not be established. However, persistent connections tha", "doc_type":"api", @@ -2575,9 +2461,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteMember" + "prodname":"elb" } ], "title":"Removing a Backend Server", @@ -2586,7 +2471,7 @@ { "uri":"ListAllMembers.html", "node_id":"listallmembers.xml", - "product_code":"", + "product_code":"elb", "code":"138", "des":"This API is used to query the backend servers under the current project.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pag", "doc_type":"api", @@ -2594,9 +2479,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListAllMembers" + "prodname":"elb" } ], "title":"Querying Backend Servers in a Project", @@ -2605,7 +2489,7 @@ { "uri":"module_health_monitors.html", "node_id":"module_health_monitors.xml", - "product_code":"", + "product_code":"elb", "code":"139", "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", @@ -2613,7 +2497,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Health Check", @@ -2622,7 +2507,7 @@ { "uri":"CreateHealthMonitor.html", "node_id":"createhealthmonitor.xml", - "product_code":"", + "product_code":"elb", "code":"140", "des":"This API is used to configure a health check.The security groups must have rules that allow traffic to 100.125.0.0/16.If you want to use UDP for health checks, ensure tha", "doc_type":"api", @@ -2630,9 +2515,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateHealthMonitor" + "prodname":"elb" } ], "title":"Configuring a Health Check", @@ -2641,7 +2525,7 @@ { "uri":"ListHealthMonitors.html", "node_id":"listhealthmonitors.xml", - "product_code":"", + "product_code":"elb", "code":"141", "des":"This API is used to query all health checks.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters mar", "doc_type":"api", @@ -2649,9 +2533,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListHealthMonitors" + "prodname":"elb" } ], "title":"Querying Health Checks", @@ -2660,7 +2543,7 @@ { "uri":"ShowHealthMonitor.html", "node_id":"showhealthmonitor.xml", - "product_code":"", + "product_code":"elb", "code":"142", "des":"This API is used to view details of a health check.GET /v3/{project_id}/elb/healthmonitors/{healthmonitor_id}Status code: 200Status code: 200Successful request.See Error ", "doc_type":"api", @@ -2668,9 +2551,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowHealthMonitor" + "prodname":"elb" } ], "title":"Viewing Details of a Health Check", @@ -2679,7 +2561,7 @@ { "uri":"UpdateHealthMonitor.html", "node_id":"updatehealthmonitor.xml", - "product_code":"", + "product_code":"elb", "code":"143", "des":"This API is used to update a health check.The health check can be updated only when the provisioning status of the associated load balancer is ACTIVE.PUT /v3/{project_id}", "doc_type":"api", @@ -2687,9 +2569,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateHealthMonitor" + "prodname":"elb" } ], "title":"Updating a Health Check", @@ -2698,7 +2579,7 @@ { "uri":"DeleteHealthMonitor.html", "node_id":"deletehealthmonitor.xml", - "product_code":"", + "product_code":"elb", "code":"144", "des":"This API is used to delete a health check.The health check can be deleted only when the provisioning status of the associated load balancer is ACTIVE.DELETE /v3/{project_", "doc_type":"api", @@ -2706,9 +2587,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteHealthMonitor" + "prodname":"elb" } ], "title":"Deleting a Health Check", @@ -2717,7 +2597,7 @@ { "uri":"module_policies.html", "node_id":"module_policies.xml", - "product_code":"", + "product_code":"elb", "code":"145", "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", @@ -2725,7 +2605,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Forwarding Policy", @@ -2734,17 +2615,16 @@ { "uri":"CreateL7Policy.html", "node_id":"createl7policy.xml", - "product_code":"", + "product_code":"elb", "code":"146", - "des":"This API is used to add a forwarding policy to a listener.Forwarding policies can be added to only to HTTP or HTTPS listeners.POST /v3/{project_id}/elb/l7policiesStatus c", + "des":"This API is used to add a forwarding policy to a listener.Forwarding policies can be added only to HTTP or HTTPS listeners.POST /v3/{project_id}/elb/l7policiesStatus code", "doc_type":"api", "kw":"Adding a Forwarding Policy,Forwarding Policy,API Reference", "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateL7Policy" + "prodname":"elb" } ], "title":"Adding a Forwarding Policy", @@ -2753,7 +2633,7 @@ { "uri":"ListL7Policies.html", "node_id":"listl7policies.xml", - "product_code":"", + "product_code":"elb", "code":"147", "des":"This API is used to query all forwarding policies.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Paramete", "doc_type":"api", @@ -2761,9 +2641,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListL7Policies" + "prodname":"elb" } ], "title":"Querying Forwarding Policies", @@ -2772,7 +2651,7 @@ { "uri":"ShowL7Policy.html", "node_id":"showl7policy.xml", - "product_code":"", + "product_code":"elb", "code":"148", "des":"This API is used to view details of a forwarding policy.GET /v3/{project_id}/elb/l7policies/{l7policy_id}Status code: 200Status code: 200Successful request.See Error Code", "doc_type":"api", @@ -2780,9 +2659,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowL7Policy" + "prodname":"elb" } ], "title":"Viewing Details of a Forwarding Policy", @@ -2791,7 +2669,7 @@ { "uri":"UpdateL7Policy.html", "node_id":"updatel7policy.xml", - "product_code":"", + "product_code":"elb", "code":"149", "des":"This API is used to update a forwarding policy.PUT /v3/{project_id}/elb/l7policies/{l7policy_id}Status code: 200Status code: 200Successful request.See Error Codes.", "doc_type":"api", @@ -2799,9 +2677,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateL7Policy" + "prodname":"elb" } ], "title":"Updating a Forwarding Policy", @@ -2810,7 +2687,7 @@ { "uri":"DeleteL7Policy.html", "node_id":"deletel7policy.xml", - "product_code":"", + "product_code":"elb", "code":"150", "des":"This API is used to delete a forwarding policy.DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}Status code: 204Successful request.NoneNoneSee Error Codes.", "doc_type":"api", @@ -2818,9 +2695,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteL7Policy" + "prodname":"elb" } ], "title":"Deleting a Forwarding Policy", @@ -2829,7 +2705,7 @@ { "uri":"BatchUpdatePoliciesPriority.html", "node_id":"batchupdatepoliciespriority.xml", - "product_code":"", + "product_code":"elb", "code":"151", "des":"This API is used to batch update the priorities of forwarding policies.This API is only used to update the priorities of forwarding policies added to a listener of a dedi", "doc_type":"api", @@ -2837,9 +2713,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"BatchUpdatePoliciesPriority" + "prodname":"elb" } ], "title":"Batch Updating Forwarding Policy Priorities", @@ -2848,7 +2723,7 @@ { "uri":"module_rules.html", "node_id":"module_rules.xml", - "product_code":"", + "product_code":"elb", "code":"152", "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", @@ -2856,7 +2731,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Forwarding Rule", @@ -2865,17 +2741,16 @@ { "uri":"CreateL7Rule.html", "node_id":"createl7rule.xml", - "product_code":"", + "product_code":"elb", "code":"153", - "des":"This API is used to add a forwarding rule.If the action of l7policy is set to Redirect to another listener, 17rule cannot be created.POST /v3/{project_id}/elb/l7policies/", + "des":"This API is used to add a forwarding rule.The forwarding rule cannot be created when action is set to REDIRECT_TO_LISTENER.POST /v3/{project_id}/elb/l7policies/{l7policy_", "doc_type":"api", "kw":"Adding a Forwarding Rule,Forwarding Rule,API Reference", "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateL7Rule" + "prodname":"elb" } ], "title":"Adding a Forwarding Rule", @@ -2884,7 +2759,7 @@ { "uri":"ListL7Rules.html", "node_id":"listl7rules.xml", - "product_code":"", + "product_code":"elb", "code":"154", "des":"This API is used to query all forwarding rules.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters ", "doc_type":"api", @@ -2892,9 +2767,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListL7Rules" + "prodname":"elb" } ], "title":"Querying Forwarding Rules", @@ -2903,7 +2777,7 @@ { "uri":"ShowL7Rule.html", "node_id":"showl7rule.xml", - "product_code":"", + "product_code":"elb", "code":"155", "des":"This API is used to view details of a forwarding rule.GET /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}Status code: 200Status code: 200OKSee Error Codes", "doc_type":"api", @@ -2911,9 +2785,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowL7Rule" + "prodname":"elb" } ], "title":"Viewing Details of a Forwarding Rule", @@ -2922,7 +2795,7 @@ { "uri":"UpdateL7Rule.html", "node_id":"updatel7rule.xml", - "product_code":"", + "product_code":"elb", "code":"156", "des":"This API is used to update a forwarding rule.PUT /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}Status code: 200Status code: 200Successful request.See Err", "doc_type":"api", @@ -2930,9 +2803,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateL7Rule" + "prodname":"elb" } ], "title":"Updating a Forwarding Rule", @@ -2941,7 +2813,7 @@ { "uri":"DeleteL7Rule.html", "node_id":"deletel7rule.xml", - "product_code":"", + "product_code":"elb", "code":"157", "des":"This API is used to delete a forwarding rule.DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}Status code: 204Successful request.NoneNoneSee Error Co", "doc_type":"api", @@ -2949,9 +2821,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteL7Rule" + "prodname":"elb" } ], "title":"Deleting a Forwarding Rule", @@ -2960,7 +2831,7 @@ { "uri":"module_logtank.html", "node_id":"module_logtank.xml", - "product_code":"", + "product_code":"elb", "code":"158", "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", @@ -2968,7 +2839,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"elb" } ], "title":"Log", @@ -2977,7 +2849,7 @@ { "uri":"CreateLogtank.html", "node_id":"createlogtank.xml", - "product_code":"", + "product_code":"elb", "code":"159", "des":"This API is used to create a log.POST /v3/{project_id}/elb/logtanksStatus code: 201Creating a log for a load balancerStatus code: 201CreatedSee Error Codes.", "doc_type":"api", @@ -2985,9 +2857,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"CreateLogtank" + "prodname":"elb" } ], "title":"Creating a Log", @@ -2996,7 +2867,7 @@ { "uri":"ListLogtanks.html", "node_id":"listlogtanks.xml", - "product_code":"", + "product_code":"elb", "code":"160", "des":"This API is used to query logs.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker, limit, a", "doc_type":"api", @@ -3004,9 +2875,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ListLogtanks" + "prodname":"elb" } ], "title":"Querying Logs", @@ -3015,7 +2885,7 @@ { "uri":"ShowLogtank.html", "node_id":"showlogtank.xml", - "product_code":"", + "product_code":"elb", "code":"161", "des":"This API is used to view details of a log.GET /v3/{project_id}/elb/logtanks/{logtank_id}Status code: 200Viewing details of a logStatus code: 200OKSee Error Codes.", "doc_type":"api", @@ -3023,9 +2893,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"ShowLogtank" + "prodname":"elb" } ], "title":"Viewing Details of a Log", @@ -3034,7 +2903,7 @@ { "uri":"UpdateLogtank.html", "node_id":"updatelogtank.xml", - "product_code":"", + "product_code":"elb", "code":"162", "des":"This API is used to update a log.PUT /v3/{project_id}/elb/logtanks/{logtank_id}Status code: 200Updating a logStatus code: 200OKSee Error Codes.", "doc_type":"api", @@ -3042,9 +2911,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"UpdateLogtank" + "prodname":"elb" } ], "title":"Updating a Log", @@ -3053,7 +2921,7 @@ { "uri":"DeleteLogtank.html", "node_id":"deletelogtank.xml", - "product_code":"", + "product_code":"elb", "code":"163", "des":"This API is used to delete a log.DELETE /v3/{project_id}/elb/logtanks/{logtank_id}Status code: 204No ContentNoneDeleting a logNoneSee Error Codes.", "doc_type":"api", @@ -3061,9 +2929,8 @@ "search_title":"", "metedata":[ { - "opensource":"true", "documenttype":"api", - "operation_id":"DeleteLogtank" + "prodname":"elb" } ], "title":"Deleting a Log", @@ -3080,9 +2947,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Versions", @@ -3099,9 +2965,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Examples", @@ -3118,9 +2983,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Creating a Dedicated Load Balancer and Binding a New EIP to It", @@ -3137,9 +3001,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Adding a Listener to a Dedicated Load Balancer", @@ -3156,9 +3019,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Deleting a Dedicated Load Balancer", @@ -3175,9 +3037,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Common Parameters", @@ -3194,9 +3055,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"HTTP Status Codes of Shared Load Balancers", @@ -3213,9 +3073,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"HTTP Status Codes for Dedicated Load Balancers", @@ -3232,9 +3091,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Permissions and Supported Actions", @@ -3251,9 +3109,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Introduction", @@ -3271,8 +3128,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"API Actions (V2)", @@ -3290,8 +3146,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Load Balancer", @@ -3309,8 +3164,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Listener", @@ -3328,8 +3182,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Backend Server Group", @@ -3347,8 +3200,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Backend Server", @@ -3366,8 +3218,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Health Check", @@ -3385,8 +3236,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Forwarding Policy", @@ -3404,8 +3254,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Forwarding Rule", @@ -3423,8 +3272,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Whitelist", @@ -3442,8 +3290,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"SSL Certificate", @@ -3461,8 +3308,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Tag", @@ -3480,8 +3326,7 @@ "metedata":[ { "documenttype":"api;devg", - "prodname":"elb", - "opensource":"false;true" + "prodname":"elb" } ], "title":"Precautions for Supported Actions", @@ -3498,9 +3343,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"API Actions (V3)", @@ -3517,9 +3361,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Load Balancer", @@ -3536,9 +3379,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Listener", @@ -3555,9 +3397,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Backend Server Group", @@ -3574,9 +3415,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Backend Server", @@ -3593,9 +3433,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Health Check", @@ -3612,9 +3451,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Forwarding Policy", @@ -3631,9 +3469,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Forwarding Rule", @@ -3650,9 +3487,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"SSL Certificate", @@ -3669,7 +3505,7 @@ "search_title":"", "metedata":[ { - "documenttype":"api", + "documenttype":"api;devg", "prodname":"elb" } ], @@ -3687,7 +3523,7 @@ "search_title":"", "metedata":[ { - "documenttype":"api", + "documenttype":"api;devg", "prodname":"elb" } ], @@ -3705,9 +3541,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Quota Management", @@ -3724,7 +3559,7 @@ "search_title":"", "metedata":[ { - "documenttype":"api", + "documenttype":"api;devg", "prodname":"elb" } ], @@ -3742,7 +3577,7 @@ "search_title":"", "metedata":[ { - "documenttype":"api", + "documenttype":"api;devg", "prodname":"elb" } ], @@ -3760,7 +3595,7 @@ "search_title":"", "metedata":[ { - "documenttype":"api", + "documenttype":"api;devg", "prodname":"elb" } ], @@ -3778,9 +3613,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Precautions for Supported Actions", @@ -3797,9 +3631,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Appendix", @@ -3834,9 +3667,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Status Codes", @@ -3853,9 +3685,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"ELB Metrics", @@ -3872,9 +3703,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"General Information About Shared Load Balancers", @@ -3891,9 +3721,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Querying Data in Pages", @@ -3910,9 +3739,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Sequencing Query Results", @@ -3929,9 +3757,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Basic Workflow", @@ -3948,9 +3775,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"false;true" + "documenttype":"api;devg", + "prodname":"elb" } ], "title":"Change History", diff --git a/docs/elb/api-ref/CLASS.TXT.json b/docs/elb/api-ref/CLASS.TXT.json index dac7c50f1..c665b1d3d 100644 --- a/docs/elb/api-ref/CLASS.TXT.json +++ b/docs/elb/api-ref/CLASS.TXT.json @@ -712,7 +712,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"API Version", "uri":"module_versions.html", "doc_type":"api", @@ -721,7 +721,7 @@ }, { "desc":"This API is used to query all available ELB API versions.GET /versionsNoneStatus code: 200Querying API versionsStatus code: 200Successful request.See Error Codes.", - "product_code":"", + "product_code":"elb", "title":"Querying API Versions", "uri":"ListApiVersions.html", "doc_type":"api", @@ -730,7 +730,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Quota", "uri":"module_quotas.html", "doc_type":"api", @@ -739,7 +739,7 @@ }, { "desc":"This API is used to query the quotas of load balancers and related resources in a specific project.GET /v3/{project_id}/elb/quotasStatus code: 200Obtaining the resource q", - "product_code":"", + "product_code":"elb", "title":"Querying Quotas", "uri":"ShowQuota.html", "doc_type":"api", @@ -748,7 +748,7 @@ }, { "desc":"This API is used to query the current quotas and used quotas of resources related to a dedicated load balancer in a specific project.GET /v3/{project_id}/elb/quotas/detai", - "product_code":"", + "product_code":"elb", "title":"Querying Quota Usage", "uri":"ListQuotaDetails.html", "doc_type":"api", @@ -757,7 +757,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"AZ", "uri":"module_azs.html", "doc_type":"api", @@ -766,7 +766,7 @@ }, { "desc":"This API is used to query all available AZs when you create a dedicated load balancer.One set of AZs is returned by default. When you create a dedicated load balancer, yo", - "product_code":"", + "product_code":"elb", "title":"Querying AZs", "uri":"ListAvailabilityZones.html", "doc_type":"api", @@ -775,7 +775,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Load Balancer Flavor", "uri":"module_flavors.html", "doc_type":"api", @@ -784,7 +784,7 @@ }, { "desc":"This API is used to query all load balancer flavors that are available to a specific user in a specific region.This API has the following constraints:Parameters marker, l", - "product_code":"", + "product_code":"elb", "title":"Querying Flavors", "uri":"ListFlavors.html", "doc_type":"api", @@ -793,7 +793,7 @@ }, { "desc":"This API is used to view details of a flavor.GET /v3/{project_id}/elb/flavors/{flavor_id}Status code: 200Status code: 200Successful request.See Error Codes.", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Flavor", "uri":"ShowFlavor.html", "doc_type":"api", @@ -802,7 +802,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Load Balancer", "uri":"module_loadbalancers.html", "doc_type":"api", @@ -811,7 +811,7 @@ }, { "desc":"This API is used to create a dedicated load balancer. When you create a load balancer, note the following:Specify vip_subnet_cidr_id if you want to bind a private IPv4 ad", - "product_code":"", + "product_code":"elb", "title":"Creating a Load Balancer", "uri":"CreateLoadBalancer.html", "doc_type":"api", @@ -820,7 +820,7 @@ }, { "desc":"This API is used to query all load balancers.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters ma", - "product_code":"", + "product_code":"elb", "title":"Querying Load Balancers", "uri":"ListLoadBalancers.html", "doc_type":"api", @@ -829,7 +829,7 @@ }, { "desc":"This API is used to view details of a load balancer.GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}Status code: 200Viewing details of a load balancerStatus code:", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Load Balancer", "uri":"ShowLoadBalancer.html", "doc_type":"api", @@ -838,7 +838,7 @@ }, { "desc":"This API is used to update a load balancer.PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}Status code: 200Updating a load balancerStatus code: 200Successful requ", - "product_code":"", + "product_code":"elb", "title":"Updating a Load Balancer", "uri":"UpdateLoadBalancer.html", "doc_type":"api", @@ -847,7 +847,7 @@ }, { "desc":"This API is used to delete a load balancer.All listeners added to the load balancer must be deleted before the load balancer is deleted.DELETE /v3/{project_id}/elb/loadba", - "product_code":"", + "product_code":"elb", "title":"Deleting a Load Balancer", "uri":"DeleteLoadBalancer.html", "doc_type":"api", @@ -856,7 +856,7 @@ }, { "desc":"This API is used to delete a load balancer and its associated resources, including the listeners, backend server groups, and backend servers.Note:If a load balancer has E", - "product_code":"", + "product_code":"elb", "title":"Deleting a Load Balancer and Its Associated Resources", "uri":"DeleteLoadBalancerForce.html", "doc_type":"api", @@ -865,7 +865,7 @@ }, { "desc":"This API is used to query the status tree of a load balancer and to show information about all resources associated with the load balancer.When admin_state_up is set to f", - "product_code":"", + "product_code":"elb", "title":"Querying the Status Tree of a Load Balancer", "uri":"ShowLoadBalancerStatus.html", "doc_type":"api", @@ -874,7 +874,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Certificate", "uri":"module_certificates.html", "doc_type":"api", @@ -883,7 +883,7 @@ }, { "desc":"This API is used to create an SSL certificate for HTTPS listeners.POST /v3/{project_id}/elb/certificatesStatus code: 201Creating a server certificateStatus code: 201Norma", - "product_code":"", + "product_code":"elb", "title":"Creating a Certificate", "uri":"CreateCertificate.html", "doc_type":"api", @@ -892,7 +892,7 @@ }, { "desc":"This API is used to query all SSL certificates.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters ", - "product_code":"", + "product_code":"elb", "title":"Querying Certificates", "uri":"ListCertificates.html", "doc_type":"api", @@ -901,7 +901,7 @@ }, { "desc":"This API is used to view details of an SSL certificate.GET /v3/{project_id}/elb/certificates/{certificate_id}Status code: 200Status code: 200Successful request.See Error ", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Certificate", "uri":"ShowCertificate.html", "doc_type":"api", @@ -910,7 +910,7 @@ }, { "desc":"This API is used to update an SSL certificate.If a certificate with a domain name is used by a listener, the domain name cannot be updated to an empty string (\"\"), and th", - "product_code":"", + "product_code":"elb", "title":"Updating a Certificate", "uri":"UpdateCertificate.html", "doc_type":"api", @@ -919,7 +919,7 @@ }, { "desc":"This API is used to delete an SSL certificate.If the certificate is used by a listener, the certificate cannot be deleted, and the 409 Conflict error code will be display", - "product_code":"", + "product_code":"elb", "title":"Deleting a Certificate", "uri":"DeleteCertificate.html", "doc_type":"api", @@ -928,7 +928,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Security Policy", "uri":"module_security_policies.html", "doc_type":"api", @@ -937,7 +937,7 @@ }, { "desc":"This API is used to create a custom security policy. If you need a custom security policy, you need to specify security_policy_id when you add an HTTPS listener to your l", - "product_code":"", + "product_code":"elb", "title":"Creating a Custom Security Policy", "uri":"CreateSecurityPolicy.html", "doc_type":"api", @@ -946,7 +946,7 @@ }, { "desc":"This API is used to query custom security policies.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Paramet", - "product_code":"", + "product_code":"elb", "title":"Querying Custom Security Policies", "uri":"ListSecurityPolicies.html", "doc_type":"api", @@ -955,7 +955,7 @@ }, { "desc":"This API is used to query details of a custom security policy.GET /v3/{project_id}/elb/security-policies/{security_policy_id}Status code: 200Querying details of a custom ", - "product_code":"", + "product_code":"elb", "title":"Querying Details of a Custom Security Policy", "uri":"ShowSecurityPolicy.html", "doc_type":"api", @@ -964,7 +964,7 @@ }, { "desc":"This API is used to update a custom security policy.If protocols or ciphers is updated, the modification takes effect immediately on all listeners that use the custom sec", - "product_code":"", + "product_code":"elb", "title":"Updating a Custom Security Policy", "uri":"UpdateSecurityPolicy.html", "doc_type":"api", @@ -973,7 +973,7 @@ }, { "desc":"This API is used to delete a custom security policy.A custom security policy that has been used by a listener cannot be deleted.DELETE /v3/{project_id}/elb/security-polic", - "product_code":"", + "product_code":"elb", "title":"Deleting a Custom Security Policy", "uri":"DeleteSecurityPolicy.html", "doc_type":"api", @@ -982,7 +982,7 @@ }, { "desc":"This API is used to query system security policies.System security policies are available to all users and cannot be created or modified.GET /v3/{project_id}/elb/system-s", - "product_code":"", + "product_code":"elb", "title":"Querying System Security Policies", "uri":"ListSystemSecurityPolicies.html", "doc_type":"api", @@ -991,7 +991,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"IP Address Group", "uri":"module_ipgroups.html", "doc_type":"api", @@ -1000,7 +1000,7 @@ }, { "desc":"This API is used to create an IP address group. The IP address can contain IP addresses or CIDR blocks. 0.0.0.0 will be considered the same as 0.0.0.0/32. If you enter bo", - "product_code":"", + "product_code":"elb", "title":"Creating an IP Address Group", "uri":"CreateIpGroup.html", "doc_type":"api", @@ -1009,7 +1009,7 @@ }, { "desc":"This API is used to query IP address groups.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters mar", - "product_code":"", + "product_code":"elb", "title":"Querying IP Address Groups", "uri":"ListIpGroups.html", "doc_type":"api", @@ -1018,7 +1018,7 @@ }, { "desc":"This API is used to view details of an IP address group.GET /v3/{project_id}/elb/ipgroups/{ipgroup_id}Status code: 200Viewing details of an IP address groupStatus code: 2", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of an IP Address Group", "uri":"ShowIpGroup.html", "doc_type":"api", @@ -1027,7 +1027,7 @@ }, { "desc":"This API is used to update an IP address group. All IP addresses in the IP address group will be overwritten, and the IP addresses that are not included in the ip_list pa", - "product_code":"", + "product_code":"elb", "title":"Updating an IP Address Group", "uri":"UpdateIpGroup.html", "doc_type":"api", @@ -1036,7 +1036,7 @@ }, { "desc":"This API is used to delete an IP address group.DELETE /v3/{project_id}/elb/ipgroups/{ipgroup_id}Status code: 204Successful request.NoneDeleting an IP address groupNoneSee", - "product_code":"", + "product_code":"elb", "title":"Deleting an IP Address Group", "uri":"DeleteIpGroup.html", "doc_type":"api", @@ -1045,7 +1045,7 @@ }, { "desc":"This API is used to update the IP addresses in an IP address group.POST /v3/{project_id}/elb/ipgroups/{ipgroup_id}/iplist/create-or-updateStatus code: 200Updating IP addr", - "product_code":"", + "product_code":"elb", "title":"Updating IP Addresses in an IP Address Group", "uri":"UpdateIpList.html", "doc_type":"api", @@ -1054,7 +1054,7 @@ }, { "desc":"This API is used to delete IP addresses from an IP address group.POST /v3/{project_id}/elb/ipgroups/{ipgroup_id}/iplist/batch-deleteStatus code: 200Deleting IP addresses ", - "product_code":"", + "product_code":"elb", "title":"Deleting IP Addresses from an IP Address Group", "uri":"BatchDeleteIpList.html", "doc_type":"api", @@ -1063,7 +1063,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Listener", "uri":"module_listeners.html", "doc_type":"api", @@ -1071,8 +1071,8 @@ "code":"119" }, { - "desc":"This API is used to add a listener to a load balancer.The protocol used by the listener can be TCP, UDP, HTTP, or HTTPS.For load balancing at Layer 4, the protocol can on", - "product_code":"", + "desc":"This API is used to add a listener to a load balancer.For load balancing at Layer 4, the protocol can only be TCP or UDP.For load balancing at Layer 4, the protocol can o", + "product_code":"elb", "title":"Adding a Listener", "uri":"CreateListener.html", "doc_type":"api", @@ -1081,7 +1081,7 @@ }, { "desc":"This API is used to query listeners.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker, lim", - "product_code":"", + "product_code":"elb", "title":"Querying Listeners", "uri":"ListListeners.html", "doc_type":"api", @@ -1090,7 +1090,7 @@ }, { "desc":"This API is used to view details of a listener.GET /v3/{project_id}/elb/listeners/{listener_id}Status code: 200Viewing details of a listenerStatus code: 200Successful req", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Listener", "uri":"ShowListener.html", "doc_type":"api", @@ -1099,7 +1099,7 @@ }, { "desc":"This API is used to update a listener.If the provisioning status of the load balancer that the listener is added to is not ACTIVE, the listener cannot be updated.PUT /v3/", - "product_code":"", + "product_code":"elb", "title":"Updating a Listener", "uri":"UpdateListener.html", "doc_type":"api", @@ -1108,7 +1108,7 @@ }, { "desc":"This API is used to delete a listener.Before you delete a listener, delete associated backend server groups or remove all backend servers in the default backend server gr", - "product_code":"", + "product_code":"elb", "title":"Deleting a Listener", "uri":"DeleteListener.html", "doc_type":"api", @@ -1117,7 +1117,7 @@ }, { "desc":"This API is used to delete a listener and its associated resources, including the forwarding policies and backend server groups.DELETE /v3/{project_id}/elb/listeners/{lis", - "product_code":"", + "product_code":"elb", "title":"Deleting a Listener and Its Associated Resources", "uri":"DeleteListenerForce.html", "doc_type":"api", @@ -1126,7 +1126,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Backend Server Group", "uri":"module_pools.html", "doc_type":"api", @@ -1134,8 +1134,8 @@ "code":"126" }, { - "desc":"This API is used to create a backend server group.If session-persistence is specified, cookie_name is available only when type is set to APP_COOKIE.If listener_id is spec", - "product_code":"", + "desc":"This API is used to create a backend server group.If session_persistence is specified, cookie_name is available only when type is set to APP_COOKIE.If listener_id is spec", + "product_code":"elb", "title":"Creating a Backend Server Group", "uri":"CreatePool.html", "doc_type":"api", @@ -1144,7 +1144,7 @@ }, { "desc":"This API is used to query all backend server groups.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parame", - "product_code":"", + "product_code":"elb", "title":"Querying Backend Server Groups", "uri":"ListPools.html", "doc_type":"api", @@ -1153,7 +1153,7 @@ }, { "desc":"This API is used to view details of a backend server group.GET /v3/{project_id}/elb/pools/{pool_id}Status code: 200Status code: 200Successful request.See Error Codes.", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Backend Server Group", "uri":"ShowPool.html", "doc_type":"api", @@ -1162,7 +1162,7 @@ }, { "desc":"This API is used to update a backend server group.The backend server group can be updated only when the provisioning status of the associated load balancer is ACTIVE.PUT ", - "product_code":"", + "product_code":"elb", "title":"Updating a Backend Server Group", "uri":"UpdatePool.html", "doc_type":"api", @@ -1171,7 +1171,7 @@ }, { "desc":"This API is used to delete a backend server group.A backend server group can be deleted only after all servers are removed from the group, the health check configured for", - "product_code":"", + "product_code":"elb", "title":"Deleting a Backend Server Group", "uri":"DeletePool.html", "doc_type":"api", @@ -1180,7 +1180,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Backend Server", "uri":"module_members.html", "doc_type":"api", @@ -1189,7 +1189,7 @@ }, { "desc":"This API is used to add a backend server.When you add backend servers, note the following:Two backend servers in the same backend server group must have different IP addr", - "product_code":"", + "product_code":"elb", "title":"Adding a Backend Server", "uri":"CreateMember.html", "doc_type":"api", @@ -1198,7 +1198,7 @@ }, { "desc":"This API is used to query all backend servers in a given backend server group.This API has the following constraints:Parameters marker, limit, and page_reverse are used f", - "product_code":"", + "product_code":"elb", "title":"Querying Backend Servers in a Backend Server Group", "uri":"ListMembers.html", "doc_type":"api", @@ -1207,7 +1207,7 @@ }, { "desc":"This API is used to view details of a backend server.GET /v3/{project_id}/elb/pools/{pool_id}/members/{member_id}Status code: 200Status code: 200Successful request.See Er", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Backend Server", "uri":"ShowMember.html", "doc_type":"api", @@ -1216,7 +1216,7 @@ }, { "desc":"This API is used to update a backend server.If the provisioning status of the associated load balancer is not ACTIVE, the backend server cannot be updated.PUT /v3/{projec", - "product_code":"", + "product_code":"elb", "title":"Updating a Backend Server", "uri":"UpdateMember.html", "doc_type":"api", @@ -1225,7 +1225,7 @@ }, { "desc":"This API is used to remove a backend server.After you remove a backend server, new connections to this server will not be established. However, persistent connections tha", - "product_code":"", + "product_code":"elb", "title":"Removing a Backend Server", "uri":"DeleteMember.html", "doc_type":"api", @@ -1234,7 +1234,7 @@ }, { "desc":"This API is used to query the backend servers under the current project.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pag", - "product_code":"", + "product_code":"elb", "title":"Querying Backend Servers in a Project", "uri":"ListAllMembers.html", "doc_type":"api", @@ -1243,7 +1243,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Health Check", "uri":"module_health_monitors.html", "doc_type":"api", @@ -1252,7 +1252,7 @@ }, { "desc":"This API is used to configure a health check.The security groups must have rules that allow traffic to 100.125.0.0/16.If you want to use UDP for health checks, ensure tha", - "product_code":"", + "product_code":"elb", "title":"Configuring a Health Check", "uri":"CreateHealthMonitor.html", "doc_type":"api", @@ -1261,7 +1261,7 @@ }, { "desc":"This API is used to query all health checks.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters mar", - "product_code":"", + "product_code":"elb", "title":"Querying Health Checks", "uri":"ListHealthMonitors.html", "doc_type":"api", @@ -1270,7 +1270,7 @@ }, { "desc":"This API is used to view details of a health check.GET /v3/{project_id}/elb/healthmonitors/{healthmonitor_id}Status code: 200Status code: 200Successful request.See Error ", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Health Check", "uri":"ShowHealthMonitor.html", "doc_type":"api", @@ -1279,7 +1279,7 @@ }, { "desc":"This API is used to update a health check.The health check can be updated only when the provisioning status of the associated load balancer is ACTIVE.PUT /v3/{project_id}", - "product_code":"", + "product_code":"elb", "title":"Updating a Health Check", "uri":"UpdateHealthMonitor.html", "doc_type":"api", @@ -1288,7 +1288,7 @@ }, { "desc":"This API is used to delete a health check.The health check can be deleted only when the provisioning status of the associated load balancer is ACTIVE.DELETE /v3/{project_", - "product_code":"", + "product_code":"elb", "title":"Deleting a Health Check", "uri":"DeleteHealthMonitor.html", "doc_type":"api", @@ -1297,7 +1297,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Forwarding Policy", "uri":"module_policies.html", "doc_type":"api", @@ -1305,8 +1305,8 @@ "code":"145" }, { - "desc":"This API is used to add a forwarding policy to a listener.Forwarding policies can be added to only to HTTP or HTTPS listeners.POST /v3/{project_id}/elb/l7policiesStatus c", - "product_code":"", + "desc":"This API is used to add a forwarding policy to a listener.Forwarding policies can be added only to HTTP or HTTPS listeners.POST /v3/{project_id}/elb/l7policiesStatus code", + "product_code":"elb", "title":"Adding a Forwarding Policy", "uri":"CreateL7Policy.html", "doc_type":"api", @@ -1315,7 +1315,7 @@ }, { "desc":"This API is used to query all forwarding policies.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Paramete", - "product_code":"", + "product_code":"elb", "title":"Querying Forwarding Policies", "uri":"ListL7Policies.html", "doc_type":"api", @@ -1324,7 +1324,7 @@ }, { "desc":"This API is used to view details of a forwarding policy.GET /v3/{project_id}/elb/l7policies/{l7policy_id}Status code: 200Status code: 200Successful request.See Error Code", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Forwarding Policy", "uri":"ShowL7Policy.html", "doc_type":"api", @@ -1333,7 +1333,7 @@ }, { "desc":"This API is used to update a forwarding policy.PUT /v3/{project_id}/elb/l7policies/{l7policy_id}Status code: 200Status code: 200Successful request.See Error Codes.", - "product_code":"", + "product_code":"elb", "title":"Updating a Forwarding Policy", "uri":"UpdateL7Policy.html", "doc_type":"api", @@ -1342,7 +1342,7 @@ }, { "desc":"This API is used to delete a forwarding policy.DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}Status code: 204Successful request.NoneNoneSee Error Codes.", - "product_code":"", + "product_code":"elb", "title":"Deleting a Forwarding Policy", "uri":"DeleteL7Policy.html", "doc_type":"api", @@ -1351,7 +1351,7 @@ }, { "desc":"This API is used to batch update the priorities of forwarding policies.This API is only used to update the priorities of forwarding policies added to a listener of a dedi", - "product_code":"", + "product_code":"elb", "title":"Batch Updating Forwarding Policy Priorities", "uri":"BatchUpdatePoliciesPriority.html", "doc_type":"api", @@ -1360,7 +1360,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Forwarding Rule", "uri":"module_rules.html", "doc_type":"api", @@ -1368,8 +1368,8 @@ "code":"152" }, { - "desc":"This API is used to add a forwarding rule.If the action of l7policy is set to Redirect to another listener, 17rule cannot be created.POST /v3/{project_id}/elb/l7policies/", - "product_code":"", + "desc":"This API is used to add a forwarding rule.The forwarding rule cannot be created when action is set to REDIRECT_TO_LISTENER.POST /v3/{project_id}/elb/l7policies/{l7policy_", + "product_code":"elb", "title":"Adding a Forwarding Rule", "uri":"CreateL7Rule.html", "doc_type":"api", @@ -1378,7 +1378,7 @@ }, { "desc":"This API is used to query all forwarding rules.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters ", - "product_code":"", + "product_code":"elb", "title":"Querying Forwarding Rules", "uri":"ListL7Rules.html", "doc_type":"api", @@ -1387,7 +1387,7 @@ }, { "desc":"This API is used to view details of a forwarding rule.GET /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}Status code: 200Status code: 200OKSee Error Codes", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Forwarding Rule", "uri":"ShowL7Rule.html", "doc_type":"api", @@ -1396,7 +1396,7 @@ }, { "desc":"This API is used to update a forwarding rule.PUT /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}Status code: 200Status code: 200Successful request.See Err", - "product_code":"", + "product_code":"elb", "title":"Updating a Forwarding Rule", "uri":"UpdateL7Rule.html", "doc_type":"api", @@ -1405,7 +1405,7 @@ }, { "desc":"This API is used to delete a forwarding rule.DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}Status code: 204Successful request.NoneNoneSee Error Co", - "product_code":"", + "product_code":"elb", "title":"Deleting a Forwarding Rule", "uri":"DeleteL7Rule.html", "doc_type":"api", @@ -1414,7 +1414,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"", + "product_code":"elb", "title":"Log", "uri":"module_logtank.html", "doc_type":"api", @@ -1423,7 +1423,7 @@ }, { "desc":"This API is used to create a log.POST /v3/{project_id}/elb/logtanksStatus code: 201Creating a log for a load balancerStatus code: 201CreatedSee Error Codes.", - "product_code":"", + "product_code":"elb", "title":"Creating a Log", "uri":"CreateLogtank.html", "doc_type":"api", @@ -1432,7 +1432,7 @@ }, { "desc":"This API is used to query logs.This API has the following constraints:Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker, limit, a", - "product_code":"", + "product_code":"elb", "title":"Querying Logs", "uri":"ListLogtanks.html", "doc_type":"api", @@ -1441,7 +1441,7 @@ }, { "desc":"This API is used to view details of a log.GET /v3/{project_id}/elb/logtanks/{logtank_id}Status code: 200Viewing details of a logStatus code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"elb", "title":"Viewing Details of a Log", "uri":"ShowLogtank.html", "doc_type":"api", @@ -1450,7 +1450,7 @@ }, { "desc":"This API is used to update a log.PUT /v3/{project_id}/elb/logtanks/{logtank_id}Status code: 200Updating a logStatus code: 200OKSee Error Codes.", - "product_code":"", + "product_code":"elb", "title":"Updating a Log", "uri":"UpdateLogtank.html", "doc_type":"api", @@ -1459,7 +1459,7 @@ }, { "desc":"This API is used to delete a log.DELETE /v3/{project_id}/elb/logtanks/{logtank_id}Status code: 204No ContentNoneDeleting a logNoneSee Error Codes.", - "product_code":"", + "product_code":"elb", "title":"Deleting a Log", "uri":"DeleteLogtank.html", "doc_type":"api", diff --git a/docs/elb/api-ref/CreateCertificate.html b/docs/elb/api-ref/CreateCertificate.html index 08a6b06f0..b241da7a7 100644 --- a/docs/elb/api-ref/CreateCertificate.html +++ b/docs/elb/api-ref/CreateCertificate.html @@ -101,8 +101,9 @@

String

-

Specifies the body of the certificate required by HTTPS listeners. The value must be PEM encoded.

-

Maximum 65,536 character length is allowed, supports certificate chains with a maximum of 11 layers (including certificates and certificate chains).

+

Specifies the body of the certificate required by HTTPS listeners.

+

The value must be PEM encoded, and can contain a maximum of 65,536 characters.

+

It supports certificate chains with a maximum of 11 layers (including certificates and certificate chains).

description

@@ -126,7 +127,7 @@

Note the following when using domain names:

  • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.

  • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com

    -

  • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com

    +

  • A wildcard domain name is a domain name starting with an asterisk (*). Example: *.test.com

  • This parameter will take effect only when type is set to server.

  • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.

  • SNI certificates of a shared load balancer's listener can have up to 30 domain names.

    @@ -263,7 +264,7 @@

    Note the following when using domain names:

    • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.

    • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com

      -

    • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com

      +

    • A wildcard domain name is a domain name starting with an asterisk (*). Example: *.test.com

    • This parameter will take effect only when type is set to server.

    • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.

    • SNI certificates of a shared load balancer's listener can have up to 30 domain names.

      @@ -338,7 +339,7 @@

      Example Requests

      Creating a server certificate

      -
      POST https://{elb_endponit}/v3/{project_id}/elb/certificates
+
      POST https://{ELB_Endpoint}/v3/{project_id}/elb/certificates
 
 {
   "certificate" : {
diff --git a/docs/elb/api-ref/CreateHealthMonitor.html b/docs/elb/api-ref/CreateHealthMonitor.html
index 252ca376d..5298e2c75 100644
--- a/docs/elb/api-ref/CreateHealthMonitor.html
+++ b/docs/elb/api-ref/CreateHealthMonitor.html
@@ -118,7 +118,7 @@
 
      Specifies the domain name that HTTP requests are sent to during the health check.
      
 
      The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.
      
 
      The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.
      
-
      This parameter is available only when type is set to HTTP.
      
+
      This parameter is available only when type is set to HTTP or HTTPS.
      
 
      Minimum: 1
      
 
      Maximum: 100
      
 
@@ -256,12 +256,83 @@
 
      String
      
 
 
      Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.
      
-
      Note: This parameter is available only when type is set to HTTP.
      
+
      Note: This parameter is available when type is set to HTTP or HTTPS.
      
 
      Default: /
      
 
      Minimum: 1
      
 
      Maximum: 80
      
 
 
+
      http_version
      
+
+
      No
      
+
+
      String
      
+
+
      Specifies the HTTP version used for health checks.
      
+
      The value can be HTTP/1.0 or HTTP/1.1. By default, this parameter is left blank, indicating that no HTTP version is specified.
      
+
      Note: This parameter is available only when type is set to HTTP or HTTPS.
      
+
      This parameter is unsupported. Please do not use it.
      
+
+
+
      content_check_enable
      
+
+
      No
      
+
+
      Boolean
      
+
+
      Specifies whether to enable health check content verification.
      
+
      The value can be:
      
+
      • true: Health check content verification will be enabled.
        
+
      • false (default): Health check content verification will be disabled.
        
+
      
+
      Note: This parameter can be enabled only when type is set to TCP or UDP_CONNECT.
      
+
      This parameter is unsupported. Please do not use it.
      
+
+
+
      send_content
      
+
+
      No
      
+
+
      String
      
+
+
      Specifies the health check content to be sent. ELB sends the configured content and waits for a response from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.
      
+
      The value can contain:
      
+
      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: !"#$%&'()*+,/:;<=>?@[]^-_`{|}~.
        
+
      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).
        
+
      
+
      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.
      
+
      This parameter is unsupported. Please do not use it.
      
+
+
+
      receive_content
      
+
+
      No
      
+
+
      String
      
+
+
      Specifies the health check response content you expect from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.
      
+
      The value can contain:
      
+
      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: !"#$%&'()*+,/:;<=>?@[]^-_`{|}~.
        
+
      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).
        
+
      
+
      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.
      
+
      This parameter is unsupported. Please do not use it.
      
+
+
+
      content_format
      
+
+
      No
      
+
+
      String
      
+
+
      Specifies the health check content format.
      
+
      The value can be:
      
+
      • TEXT: The content can contain only letters, digits, and the following special characters: !"#$%&'()*+,/:;<=>?@[]^-_`{|}~.
        
+
      • HEX: The content can contain only hexadecimal characters (0–9 and A–F).
        
+
      
+
      This parameter is unsupported. Please do not use it.
      
+
+
      @@ -328,7 +399,7 @@

      Specifies the domain name that HTTP requests are sent to during the health check.

      The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

      The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

      -

      This parameter is available only when type is set to HTTP.

      +

      This parameter is available when type is set to HTTP or HTTPS.

      expected_codes

      @@ -459,6 +530,67 @@

      This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

      +

      http_version

      + +

      String

      + +

      Specifies the HTTP version used for health checks.

      +

      The value can be HTTP/1.0 or HTTP/1.1. By default, this parameter is left blank, indicating that no HTTP version is specified.

      +

      Note: This parameter is available only when type is set to HTTP or HTTPS.

      +

      This parameter is unsupported. Please do not use it.

      + + +

      content_check_enable

      + +

      Boolean

      + +

      Specifies whether to enable health check content verification.

      +

      The value can be:

      +

      • true: Health check content verification will be enabled.

        +

      • false (default): Health check content verification will be disabled.

        +
      +

      Note: This parameter can be enabled only when type is set to TCP or UDP_CONNECT.

      +

      This parameter is unsupported. Please do not use it.

      + + +

      send_content

      + +

      String

      + +

      Specifies the health check content to be sent. ELB sends the configured content and waits for a response from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

      +

      The value can contain:

      +

      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

      +

      This parameter is unsupported. Please do not use it.

      + + +

      receive_content

      + +

      String

      + +

      Specifies the health check response content you expect from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

      +

      The value can contain:

      +

      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

      +

      This parameter is unsupported. Please do not use it.

      + + +

      content_format

      + +

      String

      + +

      Specifies the health check content format.

      +

      The value can be:

      +

      • TEXT: The content can contain only letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • HEX: The content can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      This parameter is unsupported. Please do not use it.

      + + @@ -515,7 +647,15 @@ "type" : "HTTP", "expected_codes" : "200", "url_path" : "/", - "http_method" : "GET" + "http_method" : "GET", + "http_version" : null, + "content_check_enable" : false, + "sni_enable" : false, + "send_content" : null, + "receive_content" : null, + "content_format" : "TEXT", + "created_at" : "2024-08-08T09:00:34Z", + "updated_at" : "2024-08-08T09:00:34Z" } } diff --git a/docs/elb/api-ref/CreateIpGroup.html b/docs/elb/api-ref/CreateIpGroup.html index 7a53162f9..db562a8b5 100644 --- a/docs/elb/api-ref/CreateIpGroup.html +++ b/docs/elb/api-ref/CreateIpGroup.html @@ -135,6 +135,7 @@

      String

      Specifies the ID of the enterprise project that the IP address group belongs to.

      +

      This parameter is unsupported. Please do not use it.

      diff --git a/docs/elb/api-ref/CreateL7Policy.html b/docs/elb/api-ref/CreateL7Policy.html index 8580f4a7e..d9b4dacc4 100644 --- a/docs/elb/api-ref/CreateL7Policy.html +++ b/docs/elb/api-ref/CreateL7Policy.html @@ -3,7 +3,7 @@

      Adding a Forwarding Policy

      Function

      This API is used to add a forwarding policy to a listener.

      -

      Constraints

      Forwarding policies can be added to only to HTTP or HTTPS listeners.

      +

      Constraints

      Forwarding policies can be added only to HTTP or HTTPS listeners.

      URI

      POST /v3/{project_id}/elb/l7policies

      @@ -99,9 +99,9 @@

    • REDIRECT_TO_URL: Requests will be redirected to another URL.

    • FIXED_RESPONSE: A fixed response body will be returned.

    -

    REDIRECT_TO_LISTENER has the highest priority. If requests are to be redirected to an HTTPS listener, other forwarding policies of the listener will become invalid.

    Note:

    -

    • If action is set to REDIRECT_TO_POOL, the listener's protocol must be HTTP or HTTPS.

      +

      • REDIRECT_TO_LISTENER has the highest priority. If requests are to be redirected to an HTTPS listener, other forwarding policies of the listener will become invalid.

        +

      • If action is set to REDIRECT_TO_POOL, the listener's protocol must be HTTP or HTTPS.

      • If action is set to REDIRECT_TO_LISTENER, the listener's protocol must be HTTP.

      Minimum: 1

      diff --git a/docs/elb/api-ref/CreateL7Rule.html b/docs/elb/api-ref/CreateL7Rule.html index a80bf04f8..0e3fd1b09 100644 --- a/docs/elb/api-ref/CreateL7Rule.html +++ b/docs/elb/api-ref/CreateL7Rule.html @@ -3,7 +3,7 @@

      Adding a Forwarding Rule

      Function

      This API is used to add a forwarding rule.

      -

      Constraints

      If the action of l7policy is set to Redirect to another listener, 17rule cannot be created.

      +

      Constraints

      The forwarding rule cannot be created when action is set to REDIRECT_TO_LISTENER.

      URI

      POST /v3/{project_id}/elb/l7policies/{l7policy_id}/rules

      diff --git a/docs/elb/api-ref/CreateListener.html b/docs/elb/api-ref/CreateListener.html index c22f6c0ed..cd781cbfe 100644 --- a/docs/elb/api-ref/CreateListener.html +++ b/docs/elb/api-ref/CreateListener.html @@ -3,8 +3,7 @@

      Adding a Listener

      Function

      This API is used to add a listener to a load balancer.

      -

      Constraints

      The protocol used by the listener can be TCP, UDP, HTTP, or HTTPS.

      -

      • For load balancing at Layer 4, the protocol can only be TCP or UDP.

        +

        Constraints

        • For load balancing at Layer 4, the protocol can only be TCP or UDP.

        • For load balancing at Layer 7, the protocol can only be HTTP or HTTPS.

        • For load balancing both at Layer 4 and Layer 7, TCP, UDP, HTTP, and HTTPS are supported.

        @@ -185,6 +184,7 @@

        String

        Specifies the listener name.

        +

        Note: If you leave the listener name empty, you cannot locate it on the listener list and view its details.

        Minimum: 0

        Maximum: 255

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

        Integer

        -

        Specifies the protocol used by the listener.

        +

        Specifies the port used by the listener to receive requests from clients.

        Minimum: 1

        Maximum: 65535

        @@ -353,7 +353,7 @@

        CreateListenerIpGroupOption object

        -

        Specifies the IP address group associated with the listener.

        +

        Specifies the IP address group associated with the listener. The value can be null or an empty JSON structure, indicating that no IP address group is associated with the listener. ipgroup_id is also required if you want to associate an IP address group with the listener.

        transparent_client_ip_enable

        @@ -382,7 +382,7 @@

        Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

        The following scenarios are supported:

        -

        • action can be set to REDIRECT_TO_URL (requests will be redirected to another URL) or Fixed_RESPONSE (a fixed response body will be returned to clients).

          +

          • action can be set to REDIRECT_TO_URL (requests will be redirected to another URL) or FIXED_RESPONSE (a fixed response body will be returned to clients).

          • Parameters priority, redirect_url_config, and fixed_response_config can be specified in a forwarding policy.

          • Parameter type can be set to METHOD, HEADER, QUERY_STRING, or SOURCE_IP for a forwarding rule.

          • If type is set to HOST_NAME for a forwarding rule, the value parameter of the forwarding rule supports wildcard asterisks (*).

            @@ -416,6 +416,22 @@

            Maximum: 255

            +

            access_log_customized_headers_config

            + +

            No

            + +

            CreateAccessLogCustomizedHeadersConfigOption object

            + +

            Definition:

            +

            Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.

            +

            Constraints:

            +

            This parameter is available only for HTTP, HTTPS, and QUIC listeners.

            +

            Range:

            +

            N/A

            +

            Default value:

            +

            N/A

            + +
        @@ -436,8 +452,7 @@

        Boolean

        -

        Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

        -

        Default: false

        +

        Definition: If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

        X-Forwarded-Port

        @@ -446,8 +461,7 @@

        Boolean

        -

        Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

        -

        Default: false

        +

        Definition: If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

        X-Forwarded-For-Port

        @@ -456,8 +470,7 @@

        Boolean

        -

        Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

        -

        Default: false

        +

        Definition: If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

        X-Forwarded-Host

        @@ -466,8 +479,389 @@

        Boolean

        -

        Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

        -

        Default: true

        +

        Definition: If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

        + + +

        X-Forwarded-Proto

        + +

        No

        + +

        Boolean

        + +

        Definition: If X-Forwarded-Proto is set to true, the listener protocol of the load balancer can be stored in the X-Forwarded-Proto header and passed to backend servers.

        + + +

        X-Real-IP

        + +

        No

        + +

        Boolean

        + +

        Definition: If X-Real-IP is set to true, the client IP address can be stored in the X-Real-IP header and passed to backend servers.

        + + +

        X-Forwarded-ELB-ID

        + +

        No

        + +

        Boolean

        + +

        Definition: If X-Forwarded-ELB-ID is set to true, the load balancer ID can be stored in the X-Forwarded-ELB-ID header and passed to backend servers.

        + + +

        X-Forwarded-TLS-Certificate-ID

        + +

        No

        + +

        Boolean

        + +

        Definition: If X-Forwarded-TLS-Certificate-ID is set to true, the certificate ID of the load balancer can be stored in the X-Forwarded-TLS-Certificate-ID header and passed to backend servers.

        + + +

        X-Forwarded-TLS-Protocol

        + +

        No

        + +

        Boolean

        + +

        Definition: If X-Forwarded-TLS-Protocol is set to true, the algorithm protocol of the load balancer can be stored in the X-Forwarded-TLS-Protocol header and passed to backend servers.

        + + +

        X-Forwarded-TLS-Cipher

        + +

        No

        + +

        Boolean

        + +

        Definition: If X-Forwarded-TLS-Cipher is set to true, the algorithm suite of the load balancer can be stored in the X-Forwarded-TLS-Cipher header and passed to backend servers.

        + + +

        X-Forwarded-TLS-Protocol-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-TLS-Protocol header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-TLS-Protocol is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-TLS-Cipher-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-TLS-Cipher header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-TLS-Cipher is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-For-Processing-Mode

        + +

        No

        + +

        String

        + +

        Definition: Specifies how the X-Forwarded-For header will be handled.

        +

        • append: The IP address of the last hop will be included in the X-Forwarded-For header and sent to the backend server.

          +

        • remove: The X-Forwarded-For header will be deleted before the request is sent to the backend server, regardless of whether the request carries the X-Forwarded-For header.

          +

        • preserve: The existing X-Forwarded-For header will be retained in the request.

          +
        +

        Constraints: This parameter is available only for HTTP, HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: append, remove, or preserve

        +

        Default value: append

        + + +

        X-Forwarded-Clientcert-subjectdn-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the owner information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-subjectdn header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Clientcert-subjectdn-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Clientcert-subjectdn header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Clientcert-subjectdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Clientcert-issuerdn-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the issuer information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-issuerdn header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Clientcert-issuerdn-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Clientcert-issuerdn header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Clientcert-issuerdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Clientcert-fingerprint-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the fingerprint of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-fingerprint header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Clientcert-fingerprint-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Clientcert-fingerprint header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Clientcert-fingerprint-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Clientcert-clientverify-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the verification result of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-clientverify header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Clientcert-clientverify-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Clientcert-clientverify header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Clientcert-clientverify-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Clientcert-serialnumber-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the client certificate serial number through the X-Forwarded-Clientcert-serialnumber header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Clientcert-serialnumber-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Clientcert-serialnumber header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Clientcert-serialnumber-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Clientcert-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the client certificate content through the X-Forwarded-Clientcert header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Clientcert-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Clientcert header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Clientcert-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Clientcert-ciphers-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the TLS cipher suite supported by the client through the X-Forwarded-Clientcert-ciphers header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Clientcert-ciphers-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Clientcert-ciphers header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Clientcert-ciphers-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Clientcert-end-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the client certificate expiration date through the X-Forwarded-Clientcert-end header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Clientcert-end-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Clientcert-end header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Clientcert-end-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Tls-Alpn-Protocol-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to use the X-Forwarded-Tls-Alpn-Protocol header to transfer the application protocol that the client and the load balancer negotiate to use during SSL handshakes.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Tls-Alpn-Protocol-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Tls-Alpn-Protocol header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Tls-Alpn-Protocol-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Tls-Sni-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the domain name of the SNI certificate accessed by the client through the X-Forwarded-Tls-Sni header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Tls-Sni-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Tls-Sni header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Tls-Sni-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Tls-Ja3-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the Ja3 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja3 header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Tls-Ja3-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Tls-Ja3 header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja3-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        + + +

        X-Forwarded-Tls-Ja4-enable

        + +

        No

        + +

        Boolean

        + +

        Definition: Specifies whether to transfer the Ja4 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja4 header.

        +

        Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: true or false

        +

        Default value: false

        + + +

        X-Forwarded-Tls-Ja4-alias

        + +

        No

        + +

        String

        + +

        Definition: Specifies the name of the X-Forwarded-Tls-Ja4 header.

        +

        Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja4-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

        +

        Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

        +

        Default value: N/A

        @@ -561,10 +955,76 @@
      + +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 8 CreateAccessLogCustomizedHeadersConfigOption

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to record custom headers in access logs.

      +

      Constraints:

      +

      This parameter can be set to true only when the access logging function is enabled for the load balancer that the listener is added to.

      +

      If this parameter is set to true and the access logging function of the load balancer is disabled later, this parameter will not be automatically changed to false. If the access logging function of the load balancer is enabled again, the custom headers are still recorded.

      +

      Range:

      +

      • true: Custom headers will be recorded in access logs.

        +

      • false: Custom headers will not be recorded in access logs.

        +
      +

      Default value:

      +

      false

      +

      include_headers

      +

      No

      +

      Array of strings

      +

      Definition: Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.

      +

      Constraints:

      +

      A maximum of five custom headers can be configured.

      +

      Range:

      +

      Each header supports only letters, digits, underscores (_), and hyphens (-).

      +

      Each header can contain 1 to 40 characters.

      +

      The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

      +

      Default value:

      +

      N/A

      +

      exclude_headers

      +

      No

      +

      Array of strings

      +

      Definition: Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.

      +

      Constraints:

      +

      A maximum of five custom headers can be configured.

      +

      Range:

      +

      Each header supports only letters, digits, underscores (_), and hyphens (-).

      +

      Each header can contain 1 to 40 characters.

      +

      The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

      +

      Default value:

      +

      N/A

      +
      +

      Response Parameters

      Status code: 201

      -
      - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -460,10 +855,76 @@
      Table 8 Response body parameters

      Parameter

      +
      @@ -590,7 +1050,7 @@
      Table 9 Response body parameters

      Parameter

      Type

      -
      @@ -351,6 +352,22 @@

      Maximum: 255

      + + + + +
      Table 9 Listener

      Parameter

      +
      @@ -617,7 +1077,7 @@ - @@ -625,7 +1085,7 @@ - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 10 Listener

      Parameter

      Type

      Integer

      Specifies the maximum number of connections that the load balancer can establish with backend servers. The value -1 indicates that the number of connections is not limited.

      +

      Specifies the maximum number of connections that the listener can establish with backend servers. The value -1 indicates that the number of connections is not limited.

      This parameter is unsupported. Please do not use it.

      String

      Specifies the time when the listener was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

      +

      Specifies the time when the listener was created, in the format of yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2021-07-30T12:03:44Z.

      default_pool_id

      @@ -684,6 +1144,7 @@

      String

      Specifies the listener name.

      +

      Note: If you leave the listener name empty, you cannot locate it on the listener list and view its details.

      project_id

      @@ -745,7 +1206,7 @@

      String

      Specifies the time when the listener was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

      +

      Specifies the time when the listener was updated, in the format of yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2021-07-30T12:03:44Z.

      tls_ciphers_policy

      @@ -887,11 +1348,69 @@

      Maximum: 255

      gzip_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable gzip_enable for a load balancer.

      +

      Range: The value can be true (enable this option) or false (disable this option).

      +

      cps

      +

      Integer

      +

      Definition: Specifies the maximum number of new connections that a listener can handle per second.

      +

      Range: 0 to 1000000

      +

      connection

      +

      Integer

      +

      Definition: Specifies the maximum number of concurrent connections that a listener can handle per second.

      +

      Range: 0 to 1000000

      +

      nat64_enable

      +

      Boolean

      +

      Definition: Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.

      +

      Range:

      +

      • true: Enable nat64_enable.

        +

      • false: Disable nat64_enable.

        +
      +

      Default: false

      +

      proxy_protocol_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable ProxyProtocol to pass the source IP addresses of the clients to backend servers.

      +

      Range: The value can be true (enable this option) or false (disable this option).

      +

      tracing_config

      +

      TracingConfig object

      +

      Definition: Specifies the open tracing configuration.

      +

      access_log_customized_headers_config

      +

      AccessLogCustomizedHeadersConfig object

      +

      Definition: Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.

      +
      -
      + + + + + + + + + + + + + + + + + + + +
      Table 10 ListenerInsertHeaders

      Parameter

      +
      @@ -903,39 +1422,351 @@ - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 11 ListenerInsertHeaders

      Parameter

      Type

      Boolean

      Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Port

      Boolean

      Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-For-Port

      Boolean

      Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Host

      Boolean

      Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      -

      Default: true

      +

      Definition: If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      +

      X-Forwarded-Proto

      +

      Boolean

      +

      Definition: If X-Forwarded-Proto is set to true, the listener protocol of the load balancer can be stored in the X-Forwarded-Proto header and passed to backend servers.

      +

      X-Real-IP

      +

      Boolean

      +

      Definition: If X-Real-IP is set to true, the client IP address can be stored in the X-Real-IP header and passed to backend servers.

      +

      X-Forwarded-ELB-ID

      +

      Boolean

      +

      Definition: If X-Forwarded-ELB-ID is set to true, the load balancer ID can be stored in the X-Forwarded-ELB-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Certificate-ID

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Certificate-ID is set to true, the certificate ID of the load balancer can be stored in the X-Forwarded-TLS-Certificate-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Protocol is set to true, the algorithm protocol of the load balancer can be stored in the X-Forwarded-TLS-Protocol header and passed to backend servers.

      +

      X-Forwarded-TLS-Cipher

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Cipher is set to true, the algorithm suite of the load balancer can be stored in the X-Forwarded-TLS-Cipher header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Protocol is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-TLS-Cipher-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Cipher header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Cipher is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-For-Processing-Mode

      +

      String

      +

      Definition: Specifies how the X-Forwarded-For header will be handled.

      +

      • append: The IP address of the last hop will be included in the X-Forwarded-For header and sent to the backend server.

        +

      • remove: The X-Forwarded-For header will be deleted before the request is sent to the backend server, regardless of whether the request carries the X-Forwarded-For header.

        +

      • preserve: The existing X-Forwarded-For header will be retained in the request.

        +
      +

      Constraints: This parameter is available only for HTTP, HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: append, remove, or preserve

      +

      Default value: append

      +

      X-Forwarded-Clientcert-subjectdn-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the owner information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-subjectdn-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-subjectdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-issuerdn-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the issuer information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-issuerdn-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-issuerdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-fingerprint-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the fingerprint of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-fingerprint-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-fingerprint-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-clientverify-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the verification result of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-clientverify-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-clientverify-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-serialnumber-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate serial number through the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-serialnumber-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-serialnumber-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate content through the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-ciphers-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the TLS cipher suite supported by the client through the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-ciphers-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-ciphers-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-end-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate expiration date through the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-end-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-end-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Alpn-Protocol-enable

      +

      Boolean

      +

      Definition: Specifies whether to use the X-Forwarded-Tls-Alpn-Protocol header to transfer the application protocol that the client and the load balancer negotiate to use during SSL handshakes.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Alpn-Protocol-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Alpn-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Alpn-Protocol-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Sni-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the domain name of the SNI certificate accessed by the client through the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Sni-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Sni-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja3-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja3 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja3-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja3-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja4-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja4 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja4-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja4-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A
      -
      - @@ -128,7 +128,7 @@ @@ -159,7 +159,7 @@ @@ -250,6 +250,77 @@ + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 11 LoadBalancerRef

      Parameter

      +
      @@ -954,7 +1785,7 @@
      Table 12 LoadBalancerRef

      Parameter

      Type

      -
      - - - diff --git a/docs/elb/api-ref/ShowMember.html b/docs/elb/api-ref/ShowMember.html index 4f89365b7..dd2e4bd94 100644 --- a/docs/elb/api-ref/ShowMember.html +++ b/docs/elb/api-ref/ShowMember.html @@ -181,7 +181,7 @@ diff --git a/docs/elb/api-ref/ShowPool.html b/docs/elb/api-ref/ShowPool.html index e2c55fd34..aac21dc39 100644 --- a/docs/elb/api-ref/ShowPool.html +++ b/docs/elb/api-ref/ShowPool.html @@ -183,7 +183,7 @@ diff --git a/docs/elb/api-ref/UpdateCertificate.html b/docs/elb/api-ref/UpdateCertificate.html index fefd1872e..651b1f0ec 100644 --- a/docs/elb/api-ref/UpdateCertificate.html +++ b/docs/elb/api-ref/UpdateCertificate.html @@ -102,8 +102,9 @@ - -
      Table 12 Tag

      Parameter

      +
      @@ -984,7 +1815,7 @@
      Table 13 Tag

      Parameter

      Type

      -
      - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -548,8 +919,9 @@ @@ -557,6 +929,105 @@
      Table 13 ListenerIpGroup

      Parameter

      +
      @@ -1026,7 +1857,7 @@
      Table 14 ListenerIpGroup

      Parameter

      Type

      -
      - - - - @@ -1523,7 +1523,7 @@

      Example Requests

      • Example 1: Creating a load balancer with a private IPv4 address

        -
        POST https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
+
        POST https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
 
 {
   "loadbalancer" : {
@@ -1535,7 +1535,7 @@
   }
 }

      • Example 2: Creating a load balancer with an IPv4 EIP

        -
        POST https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
+
        POST https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
 
 {
   "loadbalancer" : {
diff --git a/docs/elb/api-ref/CreateMember.html b/docs/elb/api-ref/CreateMember.html
index 6266e693d..36b6be5e6 100644
--- a/docs/elb/api-ref/CreateMember.html
+++ b/docs/elb/api-ref/CreateMember.html
@@ -5,7 +5,7 @@

      Constraints

      When you add backend servers, note the following:

      • Two backend servers in the same backend server group must have different IP addresses and ports.

        -

      • If no subnets are specified during cloud server creation, IP as Backend servers can be added. In this case, address must be set to an IPv4 address, the protocol of the backend server group must be TCP, HTTP, or HTTPS, and IP as a Backend Server must have been enabled for the load balancer.

        +

      • If no subnets are specified during cloud server creation, IP as backend servers can be added. In this case, address must be set to an IPv4 address, the protocol of the backend server group must be TCP, HTTP, or HTTPS, and IP as a Backend must have been enabled for the load balancer.

      • If a subnet is specified during cloud server creation, the subnet must be in the same VPC where the load balancer resides.

      • If the backend server group supports IPv4/IPv6 dual stack, address can be an IPv4 address or an IPv6 address. If the backend server group supports only IPv4, address can only be an IPv4 address.

      @@ -108,7 +108,7 @@
      @@ -496,7 +496,7 @@ "address" : "120.10.10.16" } } -

    • Example 2: Adding a server of IP as a Backend Server

      +

    • Example 2: Adding an IP as a backend server

      POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members
 
 {
diff --git a/docs/elb/api-ref/CreatePool.html b/docs/elb/api-ref/CreatePool.html
index f58840645..3043f1463 100644
--- a/docs/elb/api-ref/CreatePool.html
+++ b/docs/elb/api-ref/CreatePool.html
@@ -3,7 +3,7 @@
 
      Creating a Backend Server Group
      
 
      Function
      This API is used to create a backend server group.
      
 
      
-
      Constraints
      If session-persistence is specified, cookie_name is available only when type is set to APP_COOKIE.
      
+
      Constraints
      If session_persistence is specified, cookie_name is available only when type is set to APP_COOKIE.
      
 
      If listener_id is specified, the listener must have no backend server group associated.
      
 
      
 
      URI
      POST /v3/{project_id}/elb/pools
      
@@ -233,7 +233,7 @@
      • diff --git a/docs/elb/api-ref/DeleteListenerForce.html b/docs/elb/api-ref/DeleteListenerForce.html index f1d2c46a8..91e8e2d5a 100644 --- a/docs/elb/api-ref/DeleteListenerForce.html +++ b/docs/elb/api-ref/DeleteListenerForce.html @@ -1,98 +1,98 @@

      Deleting a Listener and Its Associated Resources

      -

      Function

      This API is used to delete a listener and its associated resources, including the forwarding policies and backend server groups.

      +

      Function

      This API is used to delete a listener and its associated resources, including the forwarding policies and backend server groups.

      -

      URI

      DELETE /v3/{project_id}/elb/listeners/{listener_id}/force

      +

      URI

      DELETE /v3/{project_id}/elb/listeners/{listener_id}/force

      -
      Table 14 ListenerQuicConfig

      Parameter

      +
      @@ -1049,8 +1880,9 @@ @@ -1058,6 +1890,105 @@
      Table 15 ListenerQuicConfig

      Parameter

      Type

      Boolean

      Specifies whether to enable QUIC upgrade.

      -

      True: QUIC upgrade is enabled.

      -

      False: QUIC upgrade is disabled.

      +

      • true: QUIC upgrade is enabled.

        +

      • false: QUIC upgrade is disabled.

        +

      HTTPS listeners can be upgraded to QUIC listeners.

      QUIC protocol is not supported.
      + +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 16 TracingConfig

      Parameter

      +

      Type

      +

      Description

      +

      tracing_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable open tracing.

      +

      Range:

      +

      • true: Enable this option.

        +

      • false: Disable this option.

        +
      +

      tracing_strategy

      +

      String

      +

      Definition: Specifies the sampling mode.

      +

      Range:

      +

      • full: full sampling

        +

      • ratio: sampling by ratio

        +
      +

      tracing_sample

      +

      Integer

      +

      Definition: Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01/ %to 100%. For example, if tracing_sample is set to 3000, the sampling rate is 30%.

      +

      Range:

      +

      1 to 10000

      +

      tracing_type

      +

      String

      +

      Definition:

      +

      Specifies the tracing type.

      +

      Range: W3CTraceContext

      +
      +
      + +
      + + + + + + + + + + + + + + + + + +
      Table 17 AccessLogCustomizedHeadersConfig

      Parameter

      +

      Type

      +

      Description

      +

      enable

      +

      Boolean

      +

      Definition: Specifies whether to record custom headers in access logs.

      +

      Range:

      +

      • true: Custom headers will be recorded in access logs.

        +

      • false: Custom headers will not be recorded in access logs.

        +
      +

      include_headers

      +

      Array of strings

      +

      Definition: Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.

      +

      Range:

      +

      • Each header supports only letters, digits, underscores (_), and hyphens (-).

        +

      • Each header can contain 1 to 40 characters.

        +

      • The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

        +
      +

      exclude_headers

      +

      Array of strings

      +

      Definition: Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.

      +

      Range:

      +

      • Each header supports only letters, digits, underscores (_), and hyphens (-).

        +

      • Each header can contain 1 to 40 characters.

        +

      • The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

        +
      +
      +

      Example Requests

      • Example 1: Adding a TCP listener

        POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners
diff --git a/docs/elb/api-ref/CreateLoadBalancer.html b/docs/elb/api-ref/CreateLoadBalancer.html
index 219802d16..f7cfeabc2 100644
--- a/docs/elb/api-ref/CreateLoadBalancer.html
+++ b/docs/elb/api-ref/CreateLoadBalancer.html
@@ -14,7 +14,7 @@

      Constraints

      There are some constraints when you create a dedicated load balancer:

      • vpc_id, vip_subnet_cidr_id, and ipv6_vip_virsubnet_id cannot be left blank at the same time.

        -

      • ip_target_enable specifies whether to enable IP as a Backend Server. If you enable this function for a dedicated load balancer, you can associate servers in a VPC connected through a VPC peering connection, in a VPC connected through a cloud connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using server IP addresses.

        +

      • ip_target_enable specifies whether to enable IP as a Backend. If you enable this function for a dedicated load balancer, you can associate servers in a VPC connected through a VPC peering connection, in a VPC connected through a cloud connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using server IP addresses.

      • admin_state_up must be set to true.

      • provider must be set to vlb.

      • elb_virsubnet_ids indicates the subnets that support IPv4/IPv6 dual stack or only IPv4 subnets. If only IPv4 subnets are supported, ipv6_vip_virsubnet_id must be left blank.

        @@ -337,11 +337,11 @@

      Boolean

      Specifies whether to enable IP as a Backend Server.

      +

      Specifies whether to enable IP as a Backend.

      If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

      This function is supported only by dedicated load balancers.

      -

      The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

      -

      The value can only be update to true.

      +

      The value can be true (enable IP as a Backend) or false (disable IP as a Backend).

      +

      The value can only be updated to true.

      deletion_protection_enable

      @@ -801,14 +801,14 @@

      String

      Specifies the time when the load balancer was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

      +

      Specifies the time when the load balancer was created, in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

      updated_at

      String

      Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

      +

      Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

      guaranteed

      @@ -959,11 +959,11 @@

      Boolean

      Specifies whether to enable IP as a Backend Server.

      +

      Specifies whether to enable IP as a Backend.

      If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

      This function is supported only by dedicated load balancers.

      -

      The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

      -

      The value can only be update to true.

      +

      The value can be true (enable IP as a Backend) or false (disable IP as a Backend).

      +

      The value can only be updated to true.

      frozen_scene

      @@ -1000,7 +1000,7 @@

      Specifies the information about elastic scaling. If elastic scaling is enabled, the load balancer specifications can be automatically adjusted based on incoming traffic.

      Note:

      • This parameter is only available for users on the whitelist.

        -

      • If elastic scaling is enabled, l4_flavor_id indicates the ID of the maximmum elastic flavor at Layer 4. l7_flavor_id indicates the ID of the maximmum elastic flavor at Layer 7.

        +

      • If elastic scaling is enabled, l4_flavor_id indicates the ID of the maximum elastic flavor at Layer 4. l7_flavor_id indicates the ID of the maximum elastic flavor at Layer 7.

      String

      Specifies the private IP address bound to the backend server.

      -

      • If subnet_cidr_id is left blank, IP as a Backend Server is enabled. In this case, the IP address must be an IPv4 address.

        +

        • If subnet_cidr_id is left blank, IP as a Backend is enabled. In this case, the IP address must be an IPv4 address.

        • If subnet_cidr_id is not left blank, the IP address can be IPv4 or IPv6. It must be in the subnet specified by subnet_cidr_id and can only be bound to the primary NIC of the backend server.

        Minimum: 1

        @@ -167,7 +167,7 @@

      Specifies the ID of the IPv4 or IPv6 subnet where the backend server resides.

      Note:

      • The IPv4 or IPv6 subnet must be in the same VPC as the subnet of the load balancer.

        -

      • If this parameter is not passed, IP as a Backend Server has been enabled for the load balancer. In this case, IP as Backend servers must use private IPv4 addresses, and the protocol of the backend server group must be TCP, HTTP, or HTTPS.

        +

      • If this parameter is not passed, IP as a Backend has been enabled for the load balancer. In this case, IP as backend servers must use private IPv4 addresses, and the protocol of the backend server group must be TCP, HTTP, or HTTPS.

      Minimum: 1

      Maximum: 36

      @@ -311,7 +311,7 @@

      String

      Specifies the private IP address bound to the backend server.

      -

      • If subnet_cidr_id is left blank, IP as a Backend Server is enabled. In this case, the IP address must be an IPv4 address.

        +

        • If subnet_cidr_id is left blank, IP as a Backend is enabled. In this case, the IP address must be an IPv4 address.

        • If subnet_cidr_id is not left blank, the IP address can be IPv4 or IPv6. It must be in the subnet specified by subnet_cidr_id and can only be bound to the primary NIC of the backend server.

      Specifies the ID of the VPC where the backend server group works.

      Note:

      • The backend server group must be associated with the VPC.

        -

      • Only backend servers in the VPC or IP as Backend servers can be added.

        +

      • Only backend servers in the VPC or IP as backend servers can be added.

      • type must be set to instance.

      If vpc_id is not specified:

      @@ -251,12 +251,12 @@

      Specifies the type of the backend server group.

      Values:

      • instance: Any type of backend servers can be added. vpc_id is mandatory.

        -

      • ip: Only IP as Backend servers can be added. vpc_id cannot be specified.

        +

      • ip: Only IP as backend servers can be added. vpc_id cannot be specified.

      • "": Any type of backend servers can be added.

      Note:

      • If this parameter is not passed, any type of backend servers can be added. type will be returned as an empty string.

        -

      • Specify one of listener_id, loadbalancer_id, or type. Shared load balancers can only can added to the backend server group with loadbalancer_id or listener_id specified.

        +

      • Specify one of listener_id, loadbalancer_id, or type. Shared load balancers can only be associated with backend server groups with loadbalancer_id or listener_id specified.

      Minimum: 0

      Maximum: 36

      @@ -505,7 +505,7 @@

      String

      Specifies the protocol used by the backend server group to receive requests. The value can be TCP, UDP, HTTP, HTTPS, or QUIC.

      -

      • If the listener's protocol is UDP, the protocol of the backend server group must be UDP.

        +

        • If the listener's protocol is UDP, the protocol of the backend server group must be UDP or QUIC.

        • If the listener's protocol is TCP, the protocol of the backend server group must be TCP.

        • If the listener's protocol is HTTP, the protocol of the backend server group must be HTTP.

        • If the listener's protocol is HTTPS, the protocol of the backend server group can be HTTP or HTTPS.

          @@ -526,7 +526,9 @@

      String

      Specifies the IP address version supported by the backend server group.

      -

      IPv6 is unsupported. Only v4 will be returned.

      +

      • Shared load balancers: The value is fixed at v4.

        +

      • Dedicated load balancers: The value can be dualstack or v4. If the protocol of the backend server group is TCP or UDP, the value is dualstack. If the protocol of the backend server group is HTTP or HTTPS, the value is v4.

        +

      slow_start

      @@ -578,7 +580,7 @@

      Specifies the type of the backend server group.

      Values:

      • instance: Any type of backend servers can be added. vpc_id is mandatory.

        -

      • ip: Only IP as Backend servers can be added. vpc_id cannot be specified.

        +

      • ip: Only IP as backend servers can be added. vpc_id cannot be specified.

      • "": Any type of backend servers can be added.
      - @@ -124,7 +124,7 @@ - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 1 Path Parameters

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Definition: Specifies the project ID.

      -

      Constraints: N/A

      -

      Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

      -

      Default value: N/A

      +

      Definition: Specifies the project ID.

      +

      Constraints: N/A

      +

      Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

      +

      Default value: N/A

      listener_id

      +

      listener_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the listener ID.

      +

      Specifies the listener ID.
      -

      Request Parameters

      -
      - @@ -592,14 +592,14 @@ - - - diff --git a/docs/elb/api-ref/ListMembers.html b/docs/elb/api-ref/ListMembers.html index 70761706b..12c631eae 100644 --- a/docs/elb/api-ref/ListMembers.html +++ b/docs/elb/api-ref/ListMembers.html @@ -209,7 +209,7 @@ diff --git a/docs/elb/api-ref/ListPools.html b/docs/elb/api-ref/ListPools.html index 156b77925..10f5450d7 100644 --- a/docs/elb/api-ref/ListPools.html +++ b/docs/elb/api-ref/ListPools.html @@ -266,7 +266,7 @@ @@ -474,7 +474,7 @@ diff --git a/docs/elb/api-ref/ShowCertificate.html b/docs/elb/api-ref/ShowCertificate.html index 038a57573..e2d96c104 100644 --- a/docs/elb/api-ref/ShowCertificate.html +++ b/docs/elb/api-ref/ShowCertificate.html @@ -129,7 +129,7 @@

      Note the following when using domain names:

      • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.

      • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com

        -

      • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com

        +

      • A wildcard domain name is a domain name starting with an asterisk (*). Example: *.test.com

      • This parameter will take effect only when type is set to server.

      • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.

      • SNI certificates of a shared load balancer's listener can have up to 30 domain names.

        diff --git a/docs/elb/api-ref/ShowHealthMonitor.html b/docs/elb/api-ref/ShowHealthMonitor.html index d9b6e2397..a27d84023 100644 --- a/docs/elb/api-ref/ShowHealthMonitor.html +++ b/docs/elb/api-ref/ShowHealthMonitor.html @@ -123,7 +123,7 @@
      + + + + + + + + + + + + + + + + + + + +
      Table 2 Request header parameters

      Parameter

      +

      Request Parameters

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      Definition: Specifies the token used for IAM authentication.

      -

      Constraints: N/A

      -

      Range: N/A

      -

      Default value: N/A

      +

      Definition: Specifies the token used for IAM authentication.

      +

      Constraints: N/A

      +

      Range: N/A

      +

      Default value: N/A
      -

      Response Parameters

      Status code: 204

      -

      Successful request.

      -

      None

      +

      Response Parameters

      Status code: 204

      +

      Successful request.

      +

      None

      -

      Example Requests

      Deleting a listener and its associated resources

      -
      DELETE https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners/0b11747a-b139-492f-9692-2df0b1c87193/force
      +

      Example Requests

      Deleting a listener and its associated resources

      +
      DELETE https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners/0b11747a-b139-492f-9692-2df0b1c87193/force
      -

      Example Responses

      None

      +

      Example Responses

      None

      -

      Status Codes

      -
      - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -905,8 +1276,9 @@ @@ -914,6 +1286,105 @@

      Status Code

      +

      Status Codes

      +
      - - -

      Status Code

      Description

      +

      Description

      204

      +

      204

      Successful request.

      +

      Successful request.
      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/elb/api-ref/DeleteLoadBalancerForce.html b/docs/elb/api-ref/DeleteLoadBalancerForce.html index 75862dccc..34e33747d 100644 --- a/docs/elb/api-ref/DeleteLoadBalancerForce.html +++ b/docs/elb/api-ref/DeleteLoadBalancerForce.html @@ -1,107 +1,107 @@

      Deleting a Load Balancer and Its Associated Resources

      -

      Function

      This API is used to delete a load balancer and its associated resources, including the listeners, backend server groups, and backend servers.

      -

      Note:

      -

      • If a load balancer has EIPs bound to it, the EIPs will be unbound from the load balancer.

        -

      • If Deletion protection feature is enabled for ELB, it won’t be possible to delete the ELB and it’s resources.

        -

      • If Removal protection feature is enabled for a Backend Server Group used by the ELB, it won’t be possible to delete the ELB and it’s resources.

        -

      • If only Modification protection feature is enabled it won’t protect it from force-deletion.

        +

        Function

        This API is used to delete a load balancer and its associated resources, including the listeners, backend server groups, and backend servers.

        +

        Note:

        +

        • If a load balancer has EIPs bound to it, the EIPs will be unbound from the load balancer.

          +

        • If deletion protection is enabled for the load balancer, the load balancer and its associated resources cannot be deleted.

          +

        • If deletion protection is enabled for any backend server group of the load balancer, the load balancer and its associated resources cannot be deleted.

          +

        • If modification protection is enabled for the load balancer, the load balancer and its associated resources can be deleted.

        -

        URI

        DELETE /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/force-elb

        +

        URI

        DELETE /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/force-elb

        -
        - @@ -473,7 +473,7 @@ - @@ -481,7 +481,7 @@ - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Table 1 Path Parameters

        Parameter

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

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        project_id

        +

        project_id

        Yes

        +

        Yes

        String

        +

        String

        Definition: Specifies the project ID.

        -

        Constraints: N/A

        -

        Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

        -

        Default value: N/A

        +

        Definition: Specifies the project ID.

        +

        Constraints: N/A

        +

        Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

        +

        Default value: N/A

        loadbalancer_id

        +

        loadbalancer_id

        Yes

        +

        Yes

        String

        +

        String

        Definition: Specifies the load balancer ID.

        -

        Constraints: N/A

        -

        Range: N/A

        -

        Default value: N/A

        +

        Definition: Specifies the load balancer ID.

        +

        Constraints: N/A

        +

        Range: N/A

        +

        Default value: N/A
        -

        Request Parameters

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

        Parameter

        +

        Request Parameters

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

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        X-Auth-Token

        +

        X-Auth-Token

        Yes

        +

        Yes

        String

        +

        String

        Definition: Specifies the token used for IAM authentication.

        -

        Constraints: N/A

        -

        Range: N/A

        -

        Default value: N/A

        +

        Definition: Specifies the token used for IAM authentication.

        +

        Constraints: N/A

        +

        Range: N/A

        +

        Default value: N/A
        -

        Response Parameters

        Status code: 204

        -

        Successful request.

        -

        None

        +

        Response Parameters

        Status code: 204

        +

        Successful request.

        +

        None

        -

        Example Requests

        Deleting a load balancer and resources associated with it

        -
        DELETE https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/32c1057f-74a1-42d6-9b20-d55b80ab89c4/force-elb
        +

        Example Requests

        Deleting a load balancer and resources associated with it

        +
        DELETE https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/32c1057f-74a1-42d6-9b20-d55b80ab89c4/force-elb
        -

        Example Responses

        None

        +

        Example Responses

        None

        -

        Status Codes

        -
        - @@ -396,7 +396,7 @@ diff --git a/docs/elb/api-ref/ListApiVersions.html b/docs/elb/api-ref/ListApiVersions.html index c302211b2..75eb623d6 100644 --- a/docs/elb/api-ref/ListApiVersions.html +++ b/docs/elb/api-ref/ListApiVersions.html @@ -54,7 +54,7 @@

      • STABLE: stable version

      • DEPRECATED: discarded version

        • -

        Note: CURRENT indicates the latest version.

        +

        Note: CURRENT indicates the latest version.

        diff --git a/docs/elb/api-ref/ListCertificates.html b/docs/elb/api-ref/ListCertificates.html index 5ce62429a..00b4c95e1 100644 --- a/docs/elb/api-ref/ListCertificates.html +++ b/docs/elb/api-ref/ListCertificates.html @@ -282,7 +282,7 @@

        Note the following when using domain names:

        • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.

        • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com

          -

        • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com

          +

        • A wildcard domain name is a domain name starting with an asterisk (*). Example: *.test.com

        • This parameter will take effect only when type is set to server.

        • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.

        • SNI certificates of a shared load balancer's listener can have up to 30 domain names.

          diff --git a/docs/elb/api-ref/ListHealthMonitors.html b/docs/elb/api-ref/ListHealthMonitors.html index 2154e5a81..10c8dbfa8 100644 --- a/docs/elb/api-ref/ListHealthMonitors.html +++ b/docs/elb/api-ref/ListHealthMonitors.html @@ -237,6 +237,38 @@

          This parameter is unsupported. Please do not use it.

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

        Status Code

        +

        Status Codes

        +
        - - -

        Status Code

        Description

        +

        Description

        204

        +

        204

        Successful request.

        +

        Successful request.
        -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/elb/api-ref/ListAllMembers.html b/docs/elb/api-ref/ListAllMembers.html index 04a387f89..04b674699 100644 --- a/docs/elb/api-ref/ListAllMembers.html +++ b/docs/elb/api-ref/ListAllMembers.html @@ -198,7 +198,7 @@

        Array of strings

        Specifies the ID of the backend server group to which the backend sever belongs.

        +

        Specifies the ID of the backend server group to which the backend server belongs.

        Multiple IDs can be queried in the format of pool_id=xxx&pool_id=xxx.

        String

        Specifies the private IP address bound to the backend server.

        -

        • If subnet_cidr_id is left blank, IP as a Backend Server is enabled. In this case, the IP address must be an IPv4 address.

          +

          • If subnet_cidr_id is left blank, IP as a Backend is enabled. In this case, the IP address must be an IPv4 address.

          • If subnet_cidr_id is not left blank, the IP address can be IPv4 or IPv6. It must be in the subnet specified by subnet_cidr_id and can only be bound to the primary NIC of the backend server.

        http_version

        +

        No

        +

        Array of strings

        +

        Specifies the HTTP version used for health checks.

        +

        The value can be HTTP/1.0 or HTTP/1.1.

        +

        Multiple values can be used for query in the format of http_version=xxx&http_version=xxx.

        +

        content_check_enable

        +

        No

        +

        Boolean

        +

        Specifies whether to enable health check content verification.

        +

        The value can be true or false.

        +

        content_format

        +

        No

        +

        Array of strings

        +

        Specifies the health check content format.

        +

        The value can be TEXT or HEX.

        +

        Multiple values can be used for query in the format of content_format=xxx&content_format=xxx.

        +
        @@ -367,7 +399,7 @@

        Specifies the domain name that HTTP requests are sent to during the health check.

        The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

        The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

        -

        This parameter is available only when type is set to HTTP.

        +

        This parameter is available when type is set to HTTP or HTTPS.

        expected_codes

        @@ -498,6 +530,67 @@

        This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

        http_version

        +

        String

        +

        Specifies the HTTP version used for health checks.

        +

        The value can be HTTP/1.0 or HTTP/1.1. By default, this parameter is left blank, indicating that no HTTP version is specified.

        +

        Note: This parameter is available only when type is set to HTTP or HTTPS.

        +

        This parameter is unsupported. Please do not use it.

        +

        content_check_enable

        +

        Boolean

        +

        Specifies whether to enable health check content verification.

        +

        The value can be:

        +

        • true: Health check content verification will be enabled.

          +

        • false (default): Health check content verification will be disabled.

          +
        +

        Note: This parameter can be enabled only when type is set to TCP or UDP_CONNECT.

        +

        This parameter is unsupported. Please do not use it.

        +

        send_content

        +

        String

        +

        Specifies the health check content to be sent. ELB sends the configured content and waits for a response from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

        +

        The value can contain:

        +

        • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

          +

        • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

          +
        +

        Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

        +

        This parameter is unsupported. Please do not use it.

        +

        receive_content

        +

        String

        +

        Specifies the health check response content you expect from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

        +

        The value can contain:

        +

        • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

          +

        • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

          +
        +

        Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

        +

        This parameter is unsupported. Please do not use it.

        +

        content_format

        +

        String

        +

        Specifies the health check content format.

        +

        The value can be:

        +

        • TEXT: The content can contain only letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

          +

        • HEX: The content can contain only hexadecimal characters (0–9 and A–F).

          +
        +

        This parameter is unsupported. Please do not use it.

        +
        @@ -542,7 +635,15 @@ "type" : "HTTP", "expected_codes" : "200", "url_path" : "/", - "http_method" : "GET" + "http_method" : "GET", + "http_version" : null, + "content_check_enable" : false, + "sni_enable" : false, + "send_content" : null, + "receive_content" : null, + "content_format" : "TEXT", + "created_at" : "2024-08-08T09:00:34Z", + "updated_at" : "2024-08-08T09:00:34Z" }, { "monitor_port" : null, "id" : "cda1af03-0660-4fd2-8edf-e38c79846e08", @@ -559,7 +660,14 @@ "type" : "UDP_CONNECT", "expected_codes" : null, "url_path" : "/world", - "http_method" : null + "http_method" : null, + "content_check_enable" : false, + "sni_enable" : false, + "send_content" : null, + "receive_content" : null, + "content_format" : "TEXT", + "created_at" : "2024-08-08T09:00:34Z", + "updated_at" : "2024-08-08T09:00:34Z" } ], "page_info" : { "next_marker" : "cda1af03-0660-4fd2-8edf-e38c79846e08", diff --git a/docs/elb/api-ref/ListListeners.html b/docs/elb/api-ref/ListListeners.html index e0e243308..72df8e6a9 100644 --- a/docs/elb/api-ref/ListListeners.html +++ b/docs/elb/api-ref/ListListeners.html @@ -153,7 +153,7 @@

        Array of integers

        Specifies the maximum number of connections that the load balancer can establish with backend servers. The value -1 indicates that the number of connections is not limited.

        +

        Specifies the maximum number of connections that the listener can establish with backend servers. The value -1 indicates that the number of connections is not limited.

        Multiple values can be queried in the format of connection_limit=xxx&connection_limit=xxx.

        This parameter is unsupported. Please do not use it.

        Integer

        Specifies the maximum number of connections that the load balancer can establish with backend servers. The value -1 indicates that the number of connections is not limited.

        +

        Specifies the maximum number of connections that the listener can establish with backend servers. The value -1 indicates that the number of connections is not limited.

        This parameter is unsupported. Please do not use it.

        String

        Specifies the time when the listener was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

        +

        Specifies the time when the listener was created, in the format of yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2021-07-30T12:03:44Z.

        default_pool_id

        @@ -540,6 +540,7 @@

        String

        Specifies the listener name.

        +

        Note: If you leave the listener name empty, you cannot locate it on the listener list and view its details.

        project_id

        @@ -601,7 +602,7 @@

        String

        Specifies the time when the listener was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

        +

        Specifies the time when the listener was updated, in the format of yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2021-07-30T12:03:44Z.

        tls_ciphers_policy

        @@ -743,6 +744,64 @@

        Maximum: 255

        gzip_enable

        +

        Boolean

        +

        Definition: Specifies whether to enable gzip_enable for a load balancer.

        +

        Range: The value can be true (enable this option) or false (disable this option).

        +

        cps

        +

        Integer

        +

        Definition: Specifies the maximum number of new connections that a listener can handle per second.

        +

        Range: 0 to 1000000

        +

        connection

        +

        Integer

        +

        Definition: Specifies the maximum number of concurrent connections that a listener can handle per second.

        +

        Range: 0 to 1000000

        +

        nat64_enable

        +

        Boolean

        +

        Definition: Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.

        +

        Range:

        +

        • true: Enable nat64_enable.

          +

        • false: Disable nat64_enable.

          +
        +

        Default: false

        +

        proxy_protocol_enable

        +

        Boolean

        +

        Definition: Specifies whether to enable ProxyProtocol to pass the source IP addresses of the clients to backend servers.

        +

        Range: The value can be true (enable this option) or false (disable this option).

        +

        tracing_config

        +

        TracingConfig object

        +

        Definition: Specifies the open tracing configuration.

        +

        access_log_customized_headers_config

        +

        AccessLogCustomizedHeadersConfig object

        +

        Definition: Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.

        +
        @@ -759,32 +818,344 @@

      Boolean

      Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Port

      Boolean

      Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-For-Port

      Boolean

      Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Host

      Boolean

      Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      -

      Default: true

      +

      Definition: If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      +

      X-Forwarded-Proto

      +

      Boolean

      +

      Definition: If X-Forwarded-Proto is set to true, the listener protocol of the load balancer can be stored in the X-Forwarded-Proto header and passed to backend servers.

      +

      X-Real-IP

      +

      Boolean

      +

      Definition: If X-Real-IP is set to true, the client IP address can be stored in the X-Real-IP header and passed to backend servers.

      +

      X-Forwarded-ELB-ID

      +

      Boolean

      +

      Definition: If X-Forwarded-ELB-ID is set to true, the load balancer ID can be stored in the X-Forwarded-ELB-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Certificate-ID

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Certificate-ID is set to true, the certificate ID of the load balancer can be stored in the X-Forwarded-TLS-Certificate-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Protocol is set to true, the algorithm protocol of the load balancer can be stored in the X-Forwarded-TLS-Protocol header and passed to backend servers.

      +

      X-Forwarded-TLS-Cipher

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Cipher is set to true, the algorithm suite of the load balancer can be stored in the X-Forwarded-TLS-Cipher header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Protocol is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-TLS-Cipher-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Cipher header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Cipher is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-For-Processing-Mode

      +

      String

      +

      Definition: Specifies how the X-Forwarded-For header will be handled.

      +

      • append: The IP address of the last hop will be included in the X-Forwarded-For header and sent to the backend server.

        +

      • remove: The X-Forwarded-For header will be deleted before the request is sent to the backend server, regardless of whether the request carries the X-Forwarded-For header.

        +

      • preserve: The existing X-Forwarded-For header will be retained in the request.

        +
      +

      Constraints: This parameter is available only for HTTP, HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: append, remove, or preserve

      +

      Default value: append

      +

      X-Forwarded-Clientcert-subjectdn-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the owner information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-subjectdn-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-subjectdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-issuerdn-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the issuer information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-issuerdn-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-issuerdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-fingerprint-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the fingerprint of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-fingerprint-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-fingerprint-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-clientverify-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the verification result of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-clientverify-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-clientverify-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-serialnumber-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate serial number through the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-serialnumber-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-serialnumber-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate content through the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-ciphers-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the TLS cipher suite supported by the client through the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-ciphers-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-ciphers-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-end-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate expiration date through the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-end-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-end-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Alpn-Protocol-enable

      +

      Boolean

      +

      Definition: Specifies whether to use the X-Forwarded-Tls-Alpn-Protocol header to transfer the application protocol that the client and the load balancer negotiate to use during SSL handshakes.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Alpn-Protocol-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Alpn-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Alpn-Protocol-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Sni-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the domain name of the SNI certificate accessed by the client through the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Sni-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Sni-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja3-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja3 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja3-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja3-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja4-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja4 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja4-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja4-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      Boolean

      Specifies whether to enable QUIC upgrade.

      -

      True: QUIC upgrade is enabled.

      -

      False: QUIC upgrade is disabled.

      +

      • true: QUIC upgrade is enabled.

        +

      • false: QUIC upgrade is disabled.

        +

      HTTPS listeners can be upgraded to QUIC listeners.

      QUIC protocol is not supported.
      + +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 12 TracingConfig

      Parameter

      +

      Type

      +

      Description

      +

      tracing_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable open tracing.

      +

      Range:

      +

      • true: Enable this option.

        +

      • false: Disable this option.

        +
      +

      tracing_strategy

      +

      String

      +

      Definition: Specifies the sampling mode.

      +

      Range:

      +

      • full: full sampling

        +

      • ratio: sampling by ratio

        +
      +

      tracing_sample

      +

      Integer

      +

      Definition: Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01/ %to 100%. For example, if tracing_sample is set to 3000, the sampling rate is 30%.

      +

      Range:

      +

      1 to 10000

      +

      tracing_type

      +

      String

      +

      Definition:

      +

      Specifies the tracing type.

      +

      Range: W3CTraceContext

      +
      +
      + +
      + + + + + + + + + + + + + + + + + +
      Table 13 AccessLogCustomizedHeadersConfig

      Parameter

      +

      Type

      +

      Description

      +

      enable

      +

      Boolean

      +

      Definition: Specifies whether to record custom headers in access logs.

      +

      Range:

      +

      • true: Custom headers will be recorded in access logs.

        +

      • false: Custom headers will not be recorded in access logs.

        +
      +

      include_headers

      +

      Array of strings

      +

      Definition: Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.

      +

      Range:

      +

      • Each header supports only letters, digits, underscores (_), and hyphens (-).

        +

      • Each header can contain 1 to 40 characters.

        +

      • The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

        +
      +

      exclude_headers

      +

      Array of strings

      +

      Definition: Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.

      +

      Range:

      +

      • Each header supports only letters, digits, underscores (_), and hyphens (-).

        +

      • Each header can contain 1 to 40 characters.

        +

      • The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

        +
      +
      +

      Example Requests

      Queries the listeners on each page

      GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners?limit=2&marker=0r31747a-b139-492f-2749-2df0b1c87193
      diff --git a/docs/elb/api-ref/ListLoadBalancers.html b/docs/elb/api-ref/ListLoadBalancers.html index 16d4feed2..22fbb1d35 100644 --- a/docs/elb/api-ref/ListLoadBalancers.html +++ b/docs/elb/api-ref/ListLoadBalancers.html @@ -26,7 +26,7 @@

      String

      This parameter has the same meaning as eips.

      +

      Specifies the ID of the project where the load balancer is used.

      Minimum: 1

      Maximum: 255

      String

      Specifies the time when the load balancer was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

      +

      Specifies the time when the load balancer was created, in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

      updated_at

      String

      Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

      +

      Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

      guaranteed

      @@ -750,11 +750,11 @@

      Boolean

      Specifies whether to enable IP as a Backend Server.

      +

      Specifies whether to enable IP as a Backend.

      If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

      This function is supported only by dedicated load balancers.

      -

      The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

      -

      The value can only be update to true.

      +

      The value can be true (enable IP as a Backend) or false (disable IP as a Backend).

      +

      The value can only be updated to true.

      frozen_scene

      @@ -791,7 +791,7 @@

      Specifies the information about elastic scaling. If elastic scaling is enabled, the load balancer specifications can be automatically adjusted based on incoming traffic.

      Note:

      • This parameter is only available for users on the whitelist.

        -

      • If elastic scaling is enabled, l4_flavor_id indicates the ID of the maximmum elastic flavor at Layer 4. l7_flavor_id indicates the ID of the maximmum elastic flavor at Layer 7.

        +

      • If elastic scaling is enabled, l4_flavor_id indicates the ID of the maximum elastic flavor at Layer 4. l7_flavor_id indicates the ID of the maximum elastic flavor at Layer 7.

      Array of strings

      Specifies the type of the backend server. Values:

      -

      • ip: IP as Backend servers

        +

        • ip: IP as backend servers

        • instance: ECSs used as backend servers

        Multiple values can be queried in the format of member_type=xxx&member_type=xxx.

        @@ -222,7 +222,7 @@

      Array of strings

      Specifies the ID of the instance associated with the backend server. If this parameter is left blank, the backend server is not an ECS. It may be an IP address.

      -

      Multiple instance id can be queried in the format of instance_id=xxx&instance_id=xxx.

      +

      Multiple instance IDs can be queried in the format of instance_id=xxx&instance_id=xxx.

      availability_zone

      @@ -415,7 +415,7 @@

      String

      Specifies the private IP address bound to the backend server.

      -

      • If subnet_cidr_id is left blank, IP as a Backend Server is enabled. In this case, the IP address must be an IPv4 address.

        +

        • If subnet_cidr_id is left blank, IP as a Backend is enabled. In this case, the IP address must be an IPv4 address.

        • If subnet_cidr_id is not left blank, the IP address can be IPv4 or IPv6. It must be in the subnet specified by subnet_cidr_id and can only be bound to the primary NIC of the backend server.

      Specifies the type of the backend server group.

      Values:

      • instance: Any type of backend servers can be added. vpc_id is mandatory.

        -

      • ip: Only IP as Backend servers can be added. vpc_id cannot be specified.

        +

      • ip: Only IP as backend servers can be added. vpc_id cannot be specified.

      • "": Any type of backend servers can be added.

      String

      Specifies the protocol used by the backend server group to receive requests. The value can be TCP, UDP, HTTP, HTTPS, or QUIC.

      -

      • If the listener's protocol is UDP, the protocol of the backend server group must be UDP.

        +

        • If the listener's protocol is UDP, the protocol of the backend server group must be UDP or QUIC.

        • If the listener's protocol is TCP, the protocol of the backend server group must be TCP.

        • If the listener's protocol is HTTP, the protocol of the backend server group must be HTTP.

        • If the listener's protocol is HTTPS, the protocol of the backend server group can be HTTP or HTTPS.

          @@ -495,7 +495,9 @@

      String

      Specifies the IP address version supported by the backend server group.

      -

      IPv6 is unsupported. Only v4 will be returned.

      +

      • Shared load balancers: The value is fixed at v4.

        +

      • Dedicated load balancers: The value can be dualstack or v4. If the protocol of the backend server group is TCP or UDP, the value is dualstack. If the protocol of the backend server group is HTTP or HTTPS, the value is v4.

        +

      slow_start

      @@ -547,7 +549,7 @@

      Specifies the type of the backend server group.

      Values:

      • instance: Any type of backend servers can be added. vpc_id is mandatory.

        -

      • ip: Only IP as Backend servers can be added. vpc_id cannot be specified.

        +

      • ip: Only IP as backend servers can be added. vpc_id cannot be specified.

      • "": Any type of backend servers can be added.

      Specifies the domain name that HTTP requests are sent to during the health check.

      The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

      The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

      -

      This parameter is available only when type is set to HTTP.

      +

      This parameter is available when type is set to HTTP or HTTPS.

      expected_codes

      @@ -254,6 +254,67 @@

      This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

      http_version

      +

      String

      +

      Specifies the HTTP version used for health checks.

      +

      The value can be HTTP/1.0 or HTTP/1.1. By default, this parameter is left blank, indicating that no HTTP version is specified.

      +

      Note: This parameter is available only when type is set to HTTP or HTTPS.

      +

      This parameter is unsupported. Please do not use it.

      +

      content_check_enable

      +

      Boolean

      +

      Specifies whether to enable health check content verification.

      +

      The value can be:

      +

      • true: Health check content verification will be enabled.

        +

      • false (default): Health check content verification will be disabled.

        +
      +

      Note: This parameter can be enabled only when type is set to TCP or UDP_CONNECT.

      +

      This parameter is unsupported. Please do not use it.

      +

      send_content

      +

      String

      +

      Specifies the health check content to be sent. ELB sends the configured content and waits for a response from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

      +

      The value can contain:

      +

      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

      +

      This parameter is unsupported. Please do not use it.

      +

      receive_content

      +

      String

      +

      Specifies the health check response content you expect from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

      +

      The value can contain:

      +

      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

      +

      This parameter is unsupported. Please do not use it.

      +

      content_format

      +

      String

      +

      Specifies the health check content format.

      +

      The value can be:

      +

      • TEXT: The content can contain only letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • HEX: The content can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      This parameter is unsupported. Please do not use it.

      +
      @@ -298,7 +359,14 @@ "type" : "HTTP", "expected_codes" : "200", "url_path" : "/", - "http_method" : "GET" + "http_method" : "GET", + "content_check_enable" : false, + "http_version" : null, + "send_content" : null, + "receive_content" : null, + "content_format" : "TEXT", + "created_at" : "2024-08-08T09:00:34Z", + "updated_at" : "2024-08-08T09:00:34Z" }, "request_id" : "3702e8f0-f5f0-4d35-9097-fc7160005fae" } diff --git a/docs/elb/api-ref/ShowListener.html b/docs/elb/api-ref/ShowListener.html index f65c018b2..1013f058a 100644 --- a/docs/elb/api-ref/ShowListener.html +++ b/docs/elb/api-ref/ShowListener.html @@ -116,7 +116,7 @@

      Integer

      Specifies the maximum number of connections that the load balancer can establish with backend servers. The value -1 indicates that the number of connections is not limited.

      +

      Specifies the maximum number of connections that the listener can establish with backend servers. The value -1 indicates that the number of connections is not limited.

      This parameter is unsupported. Please do not use it.

      String

      Specifies the time when the listener was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

      +

      Specifies the time when the listener was created, in the format of yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2021-07-30T12:03:44Z.

      default_pool_id

      @@ -183,6 +183,7 @@

      String

      Specifies the listener name.

      +

      Note: If you leave the listener name empty, you cannot locate it on the listener list and view its details.

      project_id

      @@ -244,7 +245,7 @@

      String

      Specifies the time when the listener was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

      +

      Specifies the time when the listener was updated, in the format of yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2021-07-30T12:03:44Z.

      tls_ciphers_policy

      @@ -386,6 +387,64 @@

      Maximum: 255

      gzip_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable gzip_enable for a load balancer.

      +

      Range: The value can be true (enable this option) or false (disable this option).

      +

      cps

      +

      Integer

      +

      Definition: Specifies the maximum number of new connections that a listener can handle per second.

      +

      Range: 0 to 1000000

      +

      connection

      +

      Integer

      +

      Definition: Specifies the maximum number of concurrent connections that a listener can handle per second.

      +

      Range: 0 to 1000000

      +

      nat64_enable

      +

      Boolean

      +

      Definition: Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.

      +

      Range:

      +

      • true: Enable nat64_enable.

        +

      • false: Disable nat64_enable.

        +
      +

      Default: false

      +

      proxy_protocol_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable ProxyProtocol to pass the source IP addresses of the clients to backend servers.

      +

      Range: The value can be true (enable this option) or false (disable this option).

      +

      tracing_config

      +

      TracingConfig object

      +

      Definition: Specifies the open tracing configuration.

      +

      access_log_customized_headers_config

      +

      AccessLogCustomizedHeadersConfig object

      +

      Definition: Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.

      +
      @@ -402,32 +461,344 @@

      Boolean

      Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Port

      Boolean

      Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-For-Port

      Boolean

      Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Host

      Boolean

      Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      -

      Default: true

      +

      Definition: If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      +

      X-Forwarded-Proto

      +

      Boolean

      +

      Definition: If X-Forwarded-Proto is set to true, the listener protocol of the load balancer can be stored in the X-Forwarded-Proto header and passed to backend servers.

      +

      X-Real-IP

      +

      Boolean

      +

      Definition: If X-Real-IP is set to true, the client IP address can be stored in the X-Real-IP header and passed to backend servers.

      +

      X-Forwarded-ELB-ID

      +

      Boolean

      +

      Definition: If X-Forwarded-ELB-ID is set to true, the load balancer ID can be stored in the X-Forwarded-ELB-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Certificate-ID

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Certificate-ID is set to true, the certificate ID of the load balancer can be stored in the X-Forwarded-TLS-Certificate-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Protocol is set to true, the algorithm protocol of the load balancer can be stored in the X-Forwarded-TLS-Protocol header and passed to backend servers.

      +

      X-Forwarded-TLS-Cipher

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Cipher is set to true, the algorithm suite of the load balancer can be stored in the X-Forwarded-TLS-Cipher header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Protocol is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-TLS-Cipher-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Cipher header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Cipher is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-For-Processing-Mode

      +

      String

      +

      Definition: Specifies how the X-Forwarded-For header will be handled.

      +

      • append: The IP address of the last hop will be included in the X-Forwarded-For header and sent to the backend server.

        +

      • remove: The X-Forwarded-For header will be deleted before the request is sent to the backend server, regardless of whether the request carries the X-Forwarded-For header.

        +

      • preserve: The existing X-Forwarded-For header will be retained in the request.

        +
      +

      Constraints: This parameter is available only for HTTP, HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: append, remove, or preserve

      +

      Default value: append

      +

      X-Forwarded-Clientcert-subjectdn-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the owner information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-subjectdn-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-subjectdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-issuerdn-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the issuer information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-issuerdn-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-issuerdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-fingerprint-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the fingerprint of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-fingerprint-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-fingerprint-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-clientverify-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the verification result of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-clientverify-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-clientverify-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-serialnumber-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate serial number through the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-serialnumber-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-serialnumber-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate content through the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-ciphers-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the TLS cipher suite supported by the client through the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-ciphers-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-ciphers-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-end-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate expiration date through the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-end-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-end-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Alpn-Protocol-enable

      +

      Boolean

      +

      Definition: Specifies whether to use the X-Forwarded-Tls-Alpn-Protocol header to transfer the application protocol that the client and the load balancer negotiate to use during SSL handshakes.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Alpn-Protocol-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Alpn-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Alpn-Protocol-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Sni-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the domain name of the SNI certificate accessed by the client through the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Sni-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Sni-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja3-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja3 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja3-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja3-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja4-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja4 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja4-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja4-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      Boolean

      Specifies whether to enable QUIC upgrade.

      -

      True: QUIC upgrade is enabled.

      -

      False: QUIC upgrade is disabled.

      +

      • true: QUIC upgrade is enabled.

        +

      • false: QUIC upgrade is disabled.

        +

      HTTPS listeners can be upgraded to QUIC listeners.

      QUIC protocol is not supported.
      + +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 10 TracingConfig

      Parameter

      +

      Type

      +

      Description

      +

      tracing_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable open tracing.

      +

      Range:

      +

      • true: Enable this option.

        +

      • false: Disable this option.

        +
      +

      tracing_strategy

      +

      String

      +

      Definition: Specifies the sampling mode.

      +

      Range:

      +

      • full: full sampling

        +

      • ratio: sampling by ratio

        +
      +

      tracing_sample

      +

      Integer

      +

      Definition: Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01/ %to 100%. For example, if tracing_sample is set to 3000, the sampling rate is 30%.

      +

      Range:

      +

      1 to 10000

      +

      tracing_type

      +

      String

      +

      Definition:

      +

      Specifies the tracing type.

      +

      Range: W3CTraceContext

      +
      +
      + +
      + + + + + + + + + + + + + + + + + +
      Table 11 AccessLogCustomizedHeadersConfig

      Parameter

      +

      Type

      +

      Description

      +

      enable

      +

      Boolean

      +

      Definition: Specifies whether to record custom headers in access logs.

      +

      Range:

      +

      • true: Custom headers will be recorded in access logs.

        +

      • false: Custom headers will not be recorded in access logs.

        +
      +

      include_headers

      +

      Array of strings

      +

      Definition: Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.

      +

      Range:

      +

      • Each header supports only letters, digits, underscores (_), and hyphens (-).

        +

      • Each header can contain 1 to 40 characters.

        +

      • The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

        +
      +

      exclude_headers

      +

      Array of strings

      +

      Definition: Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.

      +

      Range:

      +

      • Each header supports only letters, digits, underscores (_), and hyphens (-).

        +

      • Each header can contain 1 to 40 characters.

        +

      • The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

        +
      +
      +

      Example Requests

      Viewing details of a listener

      GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners/0b11747a-b139-492f-9692-2df0b1c87193
      diff --git a/docs/elb/api-ref/ShowLoadBalancer.html b/docs/elb/api-ref/ShowLoadBalancer.html index d784395bf..d0283e6c1 100644 --- a/docs/elb/api-ref/ShowLoadBalancer.html +++ b/docs/elb/api-ref/ShowLoadBalancer.html @@ -205,14 +205,14 @@

      String

      Specifies the time when the load balancer was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

      +

      Specifies the time when the load balancer was created, in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

      updated_at

      String

      Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

      +

      Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

      guaranteed

      @@ -363,11 +363,11 @@

      Boolean

      Specifies whether to enable IP as a Backend Server.

      +

      Specifies whether to enable IP as a Backend.

      If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

      This function is supported only by dedicated load balancers.

      -

      The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

      -

      The value can only be update to true.

      +

      The value can be true (enable IP as a Backend) or false (disable IP as a Backend).

      +

      The value can only be updated to true.

      frozen_scene

      @@ -404,7 +404,7 @@

      Specifies the information about elastic scaling. If elastic scaling is enabled, the load balancer specifications can be automatically adjusted based on incoming traffic.

      Note:

      • This parameter is only available for users on the whitelist.

        -

      • If elastic scaling is enabled, l4_flavor_id indicates the ID of the maximmum elastic flavor at Layer 4. l7_flavor_id indicates the ID of the maximmum elastic flavor at Layer 7.

        +

      • If elastic scaling is enabled, l4_flavor_id indicates the ID of the maximum elastic flavor at Layer 4. l7_flavor_id indicates the ID of the maximum elastic flavor at Layer 7.

      String

      Specifies the private IP address bound to the backend server.

      -

      • If subnet_cidr_id is left blank, IP as a Backend Server is enabled. In this case, the IP address must be an IPv4 address.

        +

        • If subnet_cidr_id is left blank, IP as a Backend is enabled. In this case, the IP address must be an IPv4 address.

        • If subnet_cidr_id is not left blank, the IP address can be IPv4 or IPv6. It must be in the subnet specified by subnet_cidr_id and can only be bound to the primary NIC of the backend server.

      String

      Specifies the protocol used by the backend server group to receive requests. The value can be TCP, UDP, HTTP, HTTPS, or QUIC.

      -

      • If the listener's protocol is UDP, the protocol of the backend server group must be UDP.

        +

        • If the listener's protocol is UDP, the protocol of the backend server group must be UDP or QUIC.

        • If the listener's protocol is TCP, the protocol of the backend server group must be TCP.

        • If the listener's protocol is HTTP, the protocol of the backend server group must be HTTP.

        • If the listener's protocol is HTTPS, the protocol of the backend server group can be HTTP or HTTPS.

          @@ -204,7 +204,9 @@

      String

      Specifies the IP address version supported by the backend server group.

      -

      IPv6 is unsupported. Only v4 will be returned.

      +

      • Shared load balancers: The value is fixed at v4.

        +

      • Dedicated load balancers: The value can be dualstack or v4. If the protocol of the backend server group is TCP or UDP, the value is dualstack. If the protocol of the backend server group is HTTP or HTTPS, the value is v4.

        +

      slow_start

      @@ -256,7 +258,7 @@

      Specifies the type of the backend server group.

      Values:

      • instance: Any type of backend servers can be added. vpc_id is mandatory.

        -

      • ip: Only IP as Backend servers can be added. vpc_id cannot be specified.

        +

      • ip: Only IP as backend servers can be added. vpc_id cannot be specified.

      • "": Any type of backend servers can be added.

      String

      Specifies the private key of the certificate. The value must be PEM encoded.

      -

      Maximum 65,536 character length is allowed, supports certificate chains with a maximum of 11 layers (including certificates and certificate chains).

      +

      Specifies the body of the certificate.

      +

      The value must be PEM encoded, and can contain a maximum of 65,536 characters.

      +

      It supports certificate chains with a maximum of 11 layers (including certificates and certificate chains).

      description

      @@ -134,7 +135,7 @@

      String

      Specifies the private key of the server certificate. The value must be PEM encoded. Maximum 8,192 character length is allowed.

      +

      Specifies the private key of the server certificate. The value must be PEM encoded. A maximum of 8,192 characters is allowed.

      • This parameter is valid and mandatory only when type is set to server.

      • This parameter will not take effect and an error will be returned if type is set to client.

      @@ -150,7 +151,7 @@

      Note the following when using domain names:

      • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.

      • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com

        -

      • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com

        +

      • A wildcard domain name is a domain name starting with an asterisk (*). Example: *.test.com

      • This parameter will take effect only when type is set to server.

      • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.

      • SNI certificates of a shared load balancer's listener can have up to 30 domain names.

        @@ -231,7 +232,7 @@

        Note the following when using domain names:

        • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.

        • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com

          -

        • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com

          +

        • A wildcard domain name is a domain name starting with an asterisk (*). Example: *.test.com

        • This parameter will take effect only when type is set to server.

        • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.

        • SNI certificates of a shared load balancer's listener can have up to 30 domain names.

          @@ -305,7 +306,7 @@
      -

      Example Requests

      PUT https://{ELB_Endponit}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/certificates/233a325e5e3e4ce8beeb320aa714cc12
+
      Example Requests
      PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/certificates/233a325e5e3e4ce8beeb320aa714cc12
 
 {
   "certificate" : {
diff --git a/docs/elb/api-ref/UpdateHealthMonitor.html b/docs/elb/api-ref/UpdateHealthMonitor.html
index 905aefa0b..1a61d0af3 100644
--- a/docs/elb/api-ref/UpdateHealthMonitor.html
+++ b/docs/elb/api-ref/UpdateHealthMonitor.html
@@ -79,7 +79,7 @@

      UpdateHealthMonitorOption object

      Specifies the health check.

      +

      Specifies the request body for updating a health check.

      Specifies the domain name that HTTP requests are sent to during the health check.

      The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

      The value cannot be left blank, but can be specified as null or cannot be passed, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

      -

      This parameter is available only when type is set to HTTP.

      +

      This parameter is available when type is set to HTTP or HTTPS.

      Minimum: 1

      Maximum: 100

      Specifies the HTTP method.

      The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

      -

      This parameter will take effect only when type is set to HTTP.

      +

      This parameter is available when type is set to HTTP or HTTPS.

      This parameter is unsupported. Please do not use it.

      Minimum: 1

      Maximum: 16

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

      String

      Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.

      -

      Note: This parameter is available only when type is set to HTTP.

      +

      Note: This parameter is available when type is set to HTTP or HTTPS.

      Minimum: 1

      Maximum: 80

      content_check_enable

      +

      No

      +

      Boolean

      +

      Specifies whether to enable health check content verification.

      +

      The value can be:

      +

      • true: Health check content verification will be enabled.

        +

      • false (default): Health check content verification will be disabled.

        +
      +

      Note: This parameter can be enabled only when type is set to TCP or UDP_CONNECT.

      +

      This parameter is unsupported. Please do not use it.

      +

      send_content

      +

      No

      +

      String

      +

      Specifies the health check content to be sent. ELB sends the configured content and waits for a response from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

      +

      The value can contain:

      +

      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

      +

      This parameter is unsupported. Please do not use it.

      +

      receive_content

      +

      No

      +

      String

      +

      Specifies the health check response content you expect from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

      +

      The value can contain:

      +

      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

      +

      This parameter is unsupported. Please do not use it.

      +

      content_format

      +

      No

      +

      String

      +

      Specifies the health check content format.

      +

      The value can be:

      +

      • TEXT: The content can contain only letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • HEX: The content can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      This parameter is unsupported. Please do not use it.

      +

      http_version

      +

      No

      +

      String

      +

      Specifies the HTTP version used for health checks.

      +

      The value can be HTTP/1.0 or HTTP/1.1. By default, this parameter is left blank, indicating that no HTTP version is specified.

      +

      Note: This parameter is available only when type is set to HTTP or HTTPS.

      +

      This parameter is unsupported. Please do not use it.

      +
      @@ -316,7 +387,7 @@

      Specifies the domain name that HTTP requests are sent to during the health check.

      The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

      The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

      -

      This parameter is available only when type is set to HTTP.

      +

      This parameter is available when type is set to HTTP or HTTPS.

      expected_codes

      @@ -447,6 +518,67 @@

      This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

      http_version

      +

      String

      +

      Specifies the HTTP version used for health checks.

      +

      The value can be HTTP/1.0 or HTTP/1.1. By default, this parameter is left blank, indicating that no HTTP version is specified.

      +

      Note: This parameter is available only when type is set to HTTP or HTTPS.

      +

      This parameter is unsupported. Please do not use it.

      +

      content_check_enable

      +

      Boolean

      +

      Specifies whether to enable health check content verification.

      +

      The value can be:

      +

      • true: Health check content verification will be enabled.

        +

      • false (default): Health check content verification will be disabled.

        +
      +

      Note: This parameter can be enabled only when type is set to TCP or UDP_CONNECT.

      +

      This parameter is unsupported. Please do not use it.

      +

      send_content

      +

      String

      +

      Specifies the health check content to be sent. ELB sends the configured content and waits for a response from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

      +

      The value can contain:

      +

      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

      +

      This parameter is unsupported. Please do not use it.

      +

      receive_content

      +

      String

      +

      Specifies the health check response content you expect from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.

      +

      The value can contain:

      +

      • 1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • 2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.

      +

      This parameter is unsupported. Please do not use it.

      +

      content_format

      +

      String

      +

      Specifies the health check content format.

      +

      The value can be:

      +

      • TEXT: The content can contain only letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.

        +

      • HEX: The content can contain only hexadecimal characters (0–9 and A–F).

        +
      +

      This parameter is unsupported. Please do not use it.

      +
      @@ -500,7 +632,14 @@ "type" : "HTTP", "expected_codes" : "200", "url_path" : "/", - "http_method" : "GET" + "http_method" : "GET", + "content_check_enable" : false, + "http_version" : null, + "send_content" : null, + "receive_content" : null, + "content_format" : "TEXT", + "created_at" : "2024-08-08T09:00:34Z", + "updated_at" : "2024-08-08T09:00:34Z" } } diff --git a/docs/elb/api-ref/UpdateListener.html b/docs/elb/api-ref/UpdateListener.html index 7edc00de0..bf4723d2c 100644 --- a/docs/elb/api-ref/UpdateListener.html +++ b/docs/elb/api-ref/UpdateListener.html @@ -173,6 +173,7 @@

      String

      Specifies the listener name.

      +

      Note: If you leave the listener name empty, you cannot locate it on the listener list and view its details.

      Minimum: 0

      Maximum: 255

      access_log_customized_headers_config

      +

      No

      +

      UpdateAccessLogCustomizedHeadersConfigOption object

      +

      Definition:

      +

      Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.

      +

      Constraints:

      +

      This parameter is available only for HTTP, HTTPS, and QUIC listeners.

      +

      Range:

      +

      N/A

      +

      Default value:

      +

      N/A

      +
      @@ -371,8 +388,7 @@

      Boolean

      Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Port

      @@ -381,8 +397,7 @@

      Boolean

      Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-For-Port

      @@ -391,8 +406,7 @@

      Boolean

      Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Host

      @@ -401,8 +415,389 @@

      Boolean

      Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      -

      Default: true

      +

      Definition: If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      +

      X-Forwarded-Proto

      +

      No

      +

      Boolean

      +

      Definition: If X-Forwarded-Proto is set to true, the listener protocol of the load balancer can be stored in the X-Forwarded-Proto header and passed to backend servers.

      +

      X-Real-IP

      +

      No

      +

      Boolean

      +

      Definition: If X-Real-IP is set to true, the client IP address can be stored in the X-Real-IP header and passed to backend servers.

      +

      X-Forwarded-ELB-ID

      +

      No

      +

      Boolean

      +

      Definition: If X-Forwarded-ELB-ID is set to true, the load balancer ID can be stored in the X-Forwarded-ELB-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Certificate-ID

      +

      No

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Certificate-ID is set to true, the certificate ID of the load balancer can be stored in the X-Forwarded-TLS-Certificate-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol

      +

      No

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Protocol is set to true, the algorithm protocol of the load balancer can be stored in the X-Forwarded-TLS-Protocol header and passed to backend servers.

      +

      X-Forwarded-TLS-Cipher

      +

      No

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Cipher is set to true, the algorithm suite of the load balancer can be stored in the X-Forwarded-TLS-Cipher header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Protocol is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-TLS-Cipher-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Cipher header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Cipher is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-For-Processing-Mode

      +

      No

      +

      String

      +

      Definition: Specifies how the X-Forwarded-For header will be handled.

      +

      • append: The IP address of the last hop will be included in the X-Forwarded-For header and sent to the backend server.

        +

      • remove: The X-Forwarded-For header will be deleted before the request is sent to the backend server, regardless of whether the request carries the X-Forwarded-For header.

        +

      • preserve: The existing X-Forwarded-For header will be retained in the request.

        +
      +

      Constraints: This parameter is available only for HTTP, HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: append, remove, or preserve

      +

      Default value: append

      +

      X-Forwarded-Clientcert-subjectdn-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the owner information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-subjectdn-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-subjectdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-issuerdn-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the issuer information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-issuerdn-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-issuerdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-fingerprint-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the fingerprint of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-fingerprint-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-fingerprint-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-clientverify-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the verification result of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-clientverify-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-clientverify-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-serialnumber-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate serial number through the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-serialnumber-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-serialnumber-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate content through the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-ciphers-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the TLS cipher suite supported by the client through the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-ciphers-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-ciphers-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-end-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate expiration date through the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-end-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-end-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Alpn-Protocol-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to use the X-Forwarded-Tls-Alpn-Protocol header to transfer the application protocol that the client and the load balancer negotiate to use during SSL handshakes.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Alpn-Protocol-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Alpn-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Alpn-Protocol-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Sni-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the domain name of the SNI certificate accessed by the client through the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Sni-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Sni-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja3-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja3 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja3-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja3-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja4-enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja4 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja4-alias

      +

      No

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja4-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A
      + +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 7 UpdateAccessLogCustomizedHeadersConfigOption

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      enable

      +

      No

      +

      Boolean

      +

      Definition: Specifies whether to record custom headers in access logs.

      +

      Constraints:

      +

      This parameter can be set to true only when the access logging function is enabled for the load balancer that the listener is added to.

      +

      If this parameter is set to true and the access logging function of the load balancer is disabled later, this parameter will not be automatically changed to false. If the access logging function of the load balancer is enabled again, the custom headers are still recorded.

      +

      Range:

      +

      • true: Custom headers will be recorded in access logs.

        +

      • false: Custom headers will not be recorded in access logs.

        +
      +

      Default value:

      +

      false

      +

      include_headers

      +

      No

      +

      Array of strings

      +

      Definition: Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.

      +

      Constraints:

      +

      A maximum of five custom headers can be configured.

      +

      Range:

      +

      Each header supports only letters, digits, underscores (_), and hyphens (-).

      +

      Each header can contain 1 to 40 characters.

      +

      The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

      +

      Default value:

      +

      N/A

      +

      exclude_headers

      +

      No

      +

      Array of strings

      +

      Definition: Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.

      +

      Constraints:

      +

      A maximum of five custom headers can be configured.

      +

      Range:

      +

      Each header supports only letters, digits, underscores (_), and hyphens (-).

      +

      Each header can contain 1 to 40 characters.

      +

      The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

      +

      Default value:

      +

      N/A

      +
      +

      Response Parameters

      Status code: 200

      -
      Table 7 Response body parameters

      Parameter

      +
      @@ -489,7 +950,7 @@
      Table 8 Response body parameters

      Parameter

      Type

      -
      Table 8 Listener

      Parameter

      +
      @@ -516,7 +977,7 @@ - @@ -524,7 +985,7 @@ - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 9 Listener

      Parameter

      Type

      Integer

      Specifies the maximum number of connections that the load balancer can establish with backend servers. The value -1 indicates that the number of connections is not limited.

      +

      Specifies the maximum number of connections that the listener can establish with backend servers. The value -1 indicates that the number of connections is not limited.

      This parameter is unsupported. Please do not use it.

      String

      Specifies the time when the listener was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

      +

      Specifies the time when the listener was created, in the format of yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2021-07-30T12:03:44Z.

      default_pool_id

      @@ -583,6 +1044,7 @@

      String

      Specifies the listener name.

      +

      Note: If you leave the listener name empty, you cannot locate it on the listener list and view its details.

      project_id

      @@ -644,7 +1106,7 @@

      String

      Specifies the time when the listener was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

      +

      Specifies the time when the listener was updated, in the format of yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2021-07-30T12:03:44Z.

      tls_ciphers_policy

      @@ -786,11 +1248,69 @@

      Maximum: 255

      gzip_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable gzip_enable for a load balancer.

      +

      Range: The value can be true (enable this option) or false (disable this option).

      +

      cps

      +

      Integer

      +

      Definition: Specifies the maximum number of new connections that a listener can handle per second.

      +

      Range: 0 to 1000000

      +

      connection

      +

      Integer

      +

      Definition: Specifies the maximum number of concurrent connections that a listener can handle per second.

      +

      Range: 0 to 1000000

      +

      nat64_enable

      +

      Boolean

      +

      Definition: Specifies whether to translate between IPv4 and IPv6 addresses. This option allows a client to access IPv4 or IPv6 backend servers by accessing the IPv4 or IPv6 address of a load balancer.

      +

      Range:

      +

      • true: Enable nat64_enable.

        +

      • false: Disable nat64_enable.

        +
      +

      Default: false

      +

      proxy_protocol_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable ProxyProtocol to pass the source IP addresses of the clients to backend servers.

      +

      Range: The value can be true (enable this option) or false (disable this option).

      +

      tracing_config

      +

      TracingConfig object

      +

      Definition: Specifies the open tracing configuration.

      +

      access_log_customized_headers_config

      +

      AccessLogCustomizedHeadersConfig object

      +

      Definition: Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.

      +
      -
      Table 9 ListenerInsertHeaders

      Parameter

      +
      @@ -802,39 +1322,351 @@ - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 10 ListenerInsertHeaders

      Parameter

      Type

      Boolean

      Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Port

      Boolean

      Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-For-Port

      Boolean

      Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      -

      Default: false

      +

      Definition: If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.

      X-Forwarded-Host

      Boolean

      Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      -

      Default: true

      +

      Definition: If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.

      +

      X-Forwarded-Proto

      +

      Boolean

      +

      Definition: If X-Forwarded-Proto is set to true, the listener protocol of the load balancer can be stored in the X-Forwarded-Proto header and passed to backend servers.

      +

      X-Real-IP

      +

      Boolean

      +

      Definition: If X-Real-IP is set to true, the client IP address can be stored in the X-Real-IP header and passed to backend servers.

      +

      X-Forwarded-ELB-ID

      +

      Boolean

      +

      Definition: If X-Forwarded-ELB-ID is set to true, the load balancer ID can be stored in the X-Forwarded-ELB-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Certificate-ID

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Certificate-ID is set to true, the certificate ID of the load balancer can be stored in the X-Forwarded-TLS-Certificate-ID header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Protocol is set to true, the algorithm protocol of the load balancer can be stored in the X-Forwarded-TLS-Protocol header and passed to backend servers.

      +

      X-Forwarded-TLS-Cipher

      +

      Boolean

      +

      Definition: If X-Forwarded-TLS-Cipher is set to true, the algorithm suite of the load balancer can be stored in the X-Forwarded-TLS-Cipher header and passed to backend servers.

      +

      X-Forwarded-TLS-Protocol-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Protocol is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-TLS-Cipher-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-TLS-Cipher header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-TLS-Cipher is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-For-Processing-Mode

      +

      String

      +

      Definition: Specifies how the X-Forwarded-For header will be handled.

      +

      • append: The IP address of the last hop will be included in the X-Forwarded-For header and sent to the backend server.

        +

      • remove: The X-Forwarded-For header will be deleted before the request is sent to the backend server, regardless of whether the request carries the X-Forwarded-For header.

        +

      • preserve: The existing X-Forwarded-For header will be retained in the request.

        +
      +

      Constraints: This parameter is available only for HTTP, HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: append, remove, or preserve

      +

      Default value: append

      +

      X-Forwarded-Clientcert-subjectdn-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the owner information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-subjectdn-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-subjectdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-subjectdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-issuerdn-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the issuer information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-issuerdn-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-issuerdn header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-issuerdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-fingerprint-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the fingerprint of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-fingerprint-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-fingerprint header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-fingerprint-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-clientverify-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the verification result of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-clientverify-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-clientverify header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-clientverify-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-serialnumber-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate serial number through the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-serialnumber-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-serialnumber header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-serialnumber-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate content through the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-ciphers-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the TLS cipher suite supported by the client through the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-ciphers-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-ciphers header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-ciphers-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Clientcert-end-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the client certificate expiration date through the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Clientcert-end-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Clientcert-end header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Clientcert-end-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Alpn-Protocol-enable

      +

      Boolean

      +

      Definition: Specifies whether to use the X-Forwarded-Tls-Alpn-Protocol header to transfer the application protocol that the client and the load balancer negotiate to use during SSL handshakes.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Alpn-Protocol-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Alpn-Protocol header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Alpn-Protocol-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Sni-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the domain name of the SNI certificate accessed by the client through the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Sni-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Sni header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Sni-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja3-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja3 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja3-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja3 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja3-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A

      +

      X-Forwarded-Tls-Ja4-enable

      +

      Boolean

      +

      Definition: Specifies whether to transfer the Ja4 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: true or false

      +

      Default value: false

      +

      X-Forwarded-Tls-Ja4-alias

      +

      String

      +

      Definition: Specifies the name of the X-Forwarded-Tls-Ja4 header.

      +

      Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja4-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.

      +

      Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.

      +

      Default value: N/A
      -
      Table 10 LoadBalancerRef

      Parameter

      +
      @@ -853,7 +1685,7 @@
      Table 11 LoadBalancerRef

      Parameter

      Type

      -
      Table 11 Tag

      Parameter

      +
      @@ -883,7 +1715,7 @@
      Table 12 Tag

      Parameter

      Type

      -
      Table 12 ListenerIpGroup

      Parameter

      +
      @@ -925,7 +1757,7 @@
      Table 13 ListenerIpGroup

      Parameter

      Type

      -
      - - - - diff --git a/docs/elb/api-ref/UpdateMember.html b/docs/elb/api-ref/UpdateMember.html index 3976a6922..97e5dd646 100644 --- a/docs/elb/api-ref/UpdateMember.html +++ b/docs/elb/api-ref/UpdateMember.html @@ -269,7 +269,7 @@ diff --git a/docs/elb/api-ref/UpdatePool.html b/docs/elb/api-ref/UpdatePool.html index 61383a498..7127c5789 100644 --- a/docs/elb/api-ref/UpdatePool.html +++ b/docs/elb/api-ref/UpdatePool.html @@ -200,7 +200,7 @@ diff --git a/docs/elb/api-ref/elb_xd_0000.html b/docs/elb/api-ref/elb_xd_0000.html index 8bf9d2b4b..63d811af3 100644 --- a/docs/elb/api-ref/elb_xd_0000.html +++ b/docs/elb/api-ref/elb_xd_0000.html @@ -8,20 +8,26 @@ - - + + + - - @@ -39,7 +45,7 @@ -
      Table 13 ListenerQuicConfig

      Parameter

      +
      @@ -948,8 +1780,9 @@ @@ -957,6 +1790,105 @@
      Table 14 ListenerQuicConfig

      Parameter

      Type

      Boolean

      Specifies whether to enable QUIC upgrade.

      -

      True: QUIC upgrade is enabled.

      -

      False: QUIC upgrade is disabled.

      +

      • true: QUIC upgrade is enabled.

        +

      • false: QUIC upgrade is disabled.

        +

      HTTPS listeners can be upgraded to QUIC listeners.

      QUIC protocol is not supported.
      + +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 15 TracingConfig

      Parameter

      +

      Type

      +

      Description

      +

      tracing_enable

      +

      Boolean

      +

      Definition: Specifies whether to enable open tracing.

      +

      Range:

      +

      • true: Enable this option.

        +

      • false: Disable this option.

        +
      +

      tracing_strategy

      +

      String

      +

      Definition: Specifies the sampling mode.

      +

      Range:

      +

      • full: full sampling

        +

      • ratio: sampling by ratio

        +
      +

      tracing_sample

      +

      Integer

      +

      Definition: Specifies the sampling rate. Values between 1 and 10000 represent sampling rates ranging from 0.01/ %to 100%. For example, if tracing_sample is set to 3000, the sampling rate is 30%.

      +

      Range:

      +

      1 to 10000

      +

      tracing_type

      +

      String

      +

      Definition:

      +

      Specifies the tracing type.

      +

      Range: W3CTraceContext

      +
      +
      + +
      + + + + + + + + + + + + + + + + + +
      Table 16 AccessLogCustomizedHeadersConfig

      Parameter

      +

      Type

      +

      Description

      +

      enable

      +

      Boolean

      +

      Definition: Specifies whether to record custom headers in access logs.

      +

      Range:

      +

      • true: Custom headers will be recorded in access logs.

        +

      • false: Custom headers will not be recorded in access logs.

        +
      +

      include_headers

      +

      Array of strings

      +

      Definition: Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs.

      +

      Range:

      +

      • Each header supports only letters, digits, underscores (_), and hyphens (-).

        +

      • Each header can contain 1 to 40 characters.

        +

      • The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

        +
      +

      exclude_headers

      +

      Array of strings

      +

      Definition: Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs.

      +

      Range:

      +

      • Each header supports only letters, digits, underscores (_), and hyphens (-).

        +

      • Each header can contain 1 to 40 characters.

        +

      • The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent.

        +
      +
      +

      Example Requests

      PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners/0b11747a-b139-492f-9692-2df0b1c87193
 
diff --git a/docs/elb/api-ref/UpdateLoadBalancer.html b/docs/elb/api-ref/UpdateLoadBalancer.html
index 363a03e95..6f7e4e4b7 100644
--- a/docs/elb/api-ref/UpdateLoadBalancer.html
+++ b/docs/elb/api-ref/UpdateLoadBalancer.html
@@ -228,11 +228,11 @@

      Boolean

      Specifies whether to enable IP as a Backend Server.

      +

      Specifies whether to enable IP as a Backend.

      If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

      This function is supported only by dedicated load balancers.

      -

      The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

      -

      The value can only be update to true.

      +

      The value can be true (enable IP as a Backend) or false (disable IP as a Backend).

      +

      The value can only be updated to true.

      elb_virsubnet_ids

      @@ -243,7 +243,7 @@

      Specifies the IDs of subnets on the downstream plane. You can query parameter neutron_network_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

      • If the IDs of the subnets required by the load balancer are specified in elb_virsubnet_ids, the subnets will still be bound to the load balancer.

        -

      • If the IDs of the subnets required by the load balancer are not specified in elb_virsubnet_ids, the subnets will be unbound from the load balancers. Do not unbound the subnets that have been used by the load balancer. Otherwise, an error will be returned.

        +

      • If the IDs of the subnets required by the load balancer are not specified in elb_virsubnet_ids, the subnets will be unbound from the load balancers. Do not unbind the subnets that have been used by the load balancer. Otherwise, an error will be returned.

      • If the IDs of the subnets are specified in elb_virsubnet_ids, but not on the downstream plane, a new load balancer will be bound to the downstream plane.

      Note:

      @@ -482,14 +482,14 @@

      String

      Specifies the time when the load balancer was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

      +

      Specifies the time when the load balancer was created, in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

      updated_at

      String

      Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

      +

      Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd'T'HH:mm:ss'Z'.

      guaranteed

      @@ -640,11 +640,11 @@

      Boolean

      Specifies whether to enable IP as a Backend Server.

      +

      Specifies whether to enable IP as a Backend.

      If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

      This function is supported only by dedicated load balancers.

      -

      The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

      -

      The value can only be update to true.

      +

      The value can be true (enable IP as a Backend) or false (disable IP as a Backend).

      +

      The value can only be updated to true.

      frozen_scene

      @@ -681,7 +681,7 @@

      Specifies the information about elastic scaling. If elastic scaling is enabled, the load balancer specifications can be automatically adjusted based on incoming traffic.

      Note:

      • This parameter is only available for users on the whitelist.

        -

      • If elastic scaling is enabled, l4_flavor_id indicates the ID of the maximmum elastic flavor at Layer 4. l7_flavor_id indicates the ID of the maximmum elastic flavor at Layer 7.

        +

      • If elastic scaling is enabled, l4_flavor_id indicates the ID of the maximum elastic flavor at Layer 4. l7_flavor_id indicates the ID of the maximum elastic flavor at Layer 7.

      String

      Specifies the private IP address bound to the backend server.

      -

      • If subnet_cidr_id is left blank, IP as a Backend Server is enabled. In this case, the IP address must be an IPv4 address.

        +

        • If subnet_cidr_id is left blank, IP as a Backend is enabled. In this case, the IP address must be an IPv4 address.

        • If subnet_cidr_id is not left blank, the IP address can be IPv4 or IPv6. It must be in the subnet specified by subnet_cidr_id and can only be bound to the primary NIC of the backend server.

      Specifies the type of the backend server group.

      Values:

      • instance: Any type of backend servers can be added. vpc_id is mandatory.

        -

      • ip: Only IP as Backend servers can be added. vpc_id cannot be specified.

        +

      • ip: Only IP as backend servers can be added. vpc_id cannot be specified.

      Note:

      This parameter can be updated only when type is left blank. And it cannot be updated from a non-empty value to empty value.

      @@ -433,7 +433,7 @@

      String

      Specifies the protocol used by the backend server group to receive requests. The value can be TCP, UDP, HTTP, HTTPS, or QUIC.

      -

      • If the listener's protocol is UDP, the protocol of the backend server group must be UDP.

        +

        • If the listener's protocol is UDP, the protocol of the backend server group must be UDP or QUIC.

        • If the listener's protocol is TCP, the protocol of the backend server group must be TCP.

        • If the listener's protocol is HTTP, the protocol of the backend server group must be HTTP.

        • If the listener's protocol is HTTPS, the protocol of the backend server group can be HTTP or HTTPS.

          @@ -454,7 +454,9 @@

      String

      Specifies the IP address version supported by the backend server group.

      -

      IPv6 is unsupported. Only v4 will be returned.

      +

      • Shared load balancers: The value is fixed at v4.

        +

      • Dedicated load balancers: The value can be dualstack or v4. If the protocol of the backend server group is TCP or UDP, the value is dualstack. If the protocol of the backend server group is HTTP or HTTPS, the value is v4.

        +

      slow_start

      @@ -506,7 +508,7 @@

      Specifies the type of the backend server group.

      Values:

      • instance: Any type of backend servers can be added. vpc_id is mandatory.

        -

      • ip: Only IP as Backend servers can be added. vpc_id cannot be specified.

        +

      • ip: Only IP as backend servers can be added. vpc_id cannot be specified.

      • "": Any type of backend servers can be added.

      2025-09-28

      +

      2025-11-18

      Added the API for deleting a listeners and its associated resources.

      +

      Added the following content:

      +
      • Added parameter http_version.
      • Added the parameters send_content and receive_content.
      • Added the support for you to specify the headers to be or not to be recorded in access logs.
      +

      2025-09-28

      +

      Added the API for deleting a listener and its associated resources.

      2025-09-28

      Modified the following content:

      +

      Added the following content:

      Added the quota management API.

      2025-09-12

      Modified the following content:

      +

      Added the following content:

      Added the APIs for cascading deletion.

      2024-06-07

      Modified the following content:

      +

      Added the following content:

      Added the APIs for creating, querying, viewing, updating, and deleting logs.