diff --git a/docs/elb/api-ref/.placeholder b/docs/elb/api-ref/.placeholder new file mode 100644 index 000000000..e69de29bb diff --git a/docs/elb/api-ref/ALL_META.TXT.json b/docs/elb/api-ref/ALL_META.TXT.json index 7c98f3bdc..d11ad8fa0 100644 --- a/docs/elb/api-ref/ALL_META.TXT.json +++ b/docs/elb/api-ref/ALL_META.TXT.json @@ -1,1852 +1,12 @@ [ - { - "uri":"en-us_topic_0022480177.html", - "product_code":"elb", - "code":"1", - "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", - "doc_type":"api", - "kw":"API Usage Guidelines,API Reference", - "title":"API Usage Guidelines", - "githuburl":"" - }, - { - "uri":"elb_jd_0000.html", - "product_code":"elb", - "code":"2", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Classic Load Balancer APIs", - "title":"Classic Load Balancer APIs", - "githuburl":"" - }, - { - "uri":"en-us_topic_0000001124568811.html", - "product_code":"elb", - "code":"3", - "des":"Classic load balancers are not supported in the eu-nl region.", - "doc_type":"api", - "kw":"API Call Precaution,Classic Load Balancer APIs,API Reference", - "title":"API Call Precaution", - "githuburl":"" - }, - { - "uri":"elb_jd_fz_0000.html", - "product_code":"elb", - "code":"4", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Load Balancer", - "title":"Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_jd_fz_0001.html", - "product_code":"elb", - "code":"5", - "des":"This API is used to create a load balancer.POST /v1.0/{project_id}/elbaas/loadbalancersRequest parametersParameter descriptionParameterMandatoryTypeDescriptionnameYesStri", - "doc_type":"api", - "kw":"Creating a Load Balancer,Load Balancer,API Reference", - "title":"Creating a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_jd_fz_0002.html", - "product_code":"elb", - "code":"6", - "des":"This API is used to delete a load balancer. If the load balancer is a public network load balancer, this API deletes the EIP bound to the load balancer.For a public netwo", - "doc_type":"api", - "kw":"Deleting a Load Balancer,Load Balancer,API Reference", - "title":"Deleting a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_jd_fz_0003.html", - "product_code":"elb", - "code":"7", - "des":"This API is used to delete a public network load balancer. The EIP bound to the load balancer will not be deleted. If you need to delete this IP address, refer to Deletin", - "doc_type":"api", - "kw":"Deleting a Public Network Load Balancer,Load Balancer,API Reference", - "title":"Deleting a Public Network Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_jd_fz_0004.html", - "product_code":"elb", - "code":"8", - "des":"This API is used to modify the name, description, bandwidth, and administrative status of a load balancer.PUT /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}Req", - "doc_type":"api", - "kw":"Modifying a Load Balancer,Load Balancer,API Reference", - "title":"Modifying a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_jd_fz_0005.html", - "product_code":"elb", - "code":"9", - "des":"This API is used to query details about a load balancer.GET /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}Request parametersNoneNoneExample requestNoneNoneResp", - "doc_type":"api", - "kw":"Querying Details of a Load Balancer,Load Balancer,API Reference", - "title":"Querying Details of a Load Balancer", - "githuburl":"" - }, - { - "uri":"en-us_topic_0096561504.html", - "product_code":"elb", - "code":"10", - "des":"This API is used to query load balancers and display them in a list.GET /v1.0/{project_id}/elbaas/loadbalancersRequest parametersNoneNoneExample requestNoneNoneResponse p", - "doc_type":"api", - "kw":"Querying Load Balancers,Load Balancer,API Reference", - "title":"Querying Load Balancers", - "githuburl":"" - }, - { - "uri":"elb_jd_jt_0000.html", - "product_code":"elb", - "code":"11", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Listener", - "title":"Listener", - "githuburl":"" - }, - { - "uri":"elb_jd_jt_0001.html", - "product_code":"elb", - "code":"12", - "des":"This API is used to add a listener to a load balancer.POST /v1.0/{project_id}/elbaas/listenersRequest parametersNoneNoneExample request{\n \"name\": \"listener1\",\n \"des", - "doc_type":"api", - "kw":"Adding a Listener,Listener,API Reference", - "title":"Adding a Listener", - "githuburl":"" - }, - { - "uri":"elb_jd_jt_0002.html", - "product_code":"elb", - "code":"13", - "des":"This API is used to delete a listener.DELETE /v1.0/{project_id}/elbaas/listeners/{listener_id}Request parametersNoneNoneExample requestNoneNoneResponse parametersNoneNone", - "doc_type":"api", - "kw":"Deleting a Listener,Listener,API Reference", - "title":"Deleting a Listener", - "githuburl":"" - }, - { - "uri":"elb_jd_jt_0003.html", - "product_code":"elb", - "code":"14", - "des":"This API is used to modify the listener information, including the listener name, description, and status.PUT /v1.0/{project_id}/elbaas/listeners/{listener_id}Request par", - "doc_type":"api", - "kw":"Modifying a Listener,Listener,API Reference", - "title":"Modifying a Listener", - "githuburl":"" - }, - { - "uri":"elb_jd_jt_0004.html", - "product_code":"elb", - "code":"15", - "des":"This API is used to query details about a listener.GET /v1.0/{project_id}/elbaas/listeners/{listener_id}Request parametersNoneNoneExample requestNoneNoneResponse paramete", - "doc_type":"api", - "kw":"Querying Details of a Listener,Listener,API Reference", - "title":"Querying Details of a Listener", - "githuburl":"" - }, - { - "uri":"elb_jd_jt_0005.html", - "product_code":"elb", - "code":"16", - "des":"This API is used to query listeners using search criteria and display them in a list.GET /v1.0/{project_id}/elbaas/listeners?loadbalancer_id={loadbalancer_id}Enter a ques", - "doc_type":"api", - "kw":"Querying Listeners,Listener,API Reference", - "title":"Querying Listeners", - "githuburl":"" - }, - { - "uri":"elb_jd_jk_0000.html", - "product_code":"elb", - "code":"17", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Health Check", - "title":"Health Check", - "githuburl":"" - }, - { - "uri":"elb_jd_jk_0001.html", - "product_code":"elb", - "code":"18", - "des":"This API is used to configure a health check for backend ECSs.POST /v1.0/{project_id}/elbaas/healthcheckRequest parametersNoneNoneExample request 1: Configuring an HTTP h", - "doc_type":"api", - "kw":"Configuring a Health Check,Health Check,API Reference", - "title":"Configuring a Health Check", - "githuburl":"" - }, - { - "uri":"elb_jd_jk_0002.html", - "product_code":"elb", - "code":"19", - "des":"This API is used to delete a health check.DELETE /v1.0/{project_id}/elbaas/healthcheck/{healthcheck_id}Request parametersNoneNoneExample requestNoneNoneResponse parameter", - "doc_type":"api", - "kw":"Deleting a Health Check,Health Check,API Reference", - "title":"Deleting a Health Check", - "githuburl":"" - }, - { - "uri":"elb_jd_jk_0003.html", - "product_code":"elb", - "code":"20", - "des":"This API is used to modify information about a health check.PUT /v1.0/{project_id}/elbaas/healthcheck/{healthcheck_id}Request parametersNoneNoneExample request{\n \"heal", - "doc_type":"api", - "kw":"Modifying a Health Check,Health Check,API Reference", - "title":"Modifying a Health Check", - "githuburl":"" - }, - { - "uri":"elb_jd_jk_0004.html", - "product_code":"elb", - "code":"21", - "des":"This API is used to query details about a health check.GET /v1.0/{project_id}/elbaas/healthcheck/{healthcheck_id}Request parametersNoneNoneExample requestNoneNoneResponse", - "doc_type":"api", - "kw":"Querying Details of a Health Check,Health Check,API Reference", - "title":"Querying Details of a Health Check", - "githuburl":"" - }, - { - "uri":"elb_jd_hd_0000.html", - "product_code":"elb", - "code":"22", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Backend ECS", - "title":"Backend ECS", - "githuburl":"" - }, - { - "uri":"elb_jd_hd_0001.html", - "product_code":"elb", - "code":"23", - "des":"This API is used to add backend ECSs to a listener for monitoring.To add backend ECSs to a UDP listener, IP addresses can be pinged and UDP services must be enabled.POST ", - "doc_type":"api", - "kw":"Adding Backend ECSs,Backend ECS,API Reference", - "title":"Adding Backend ECSs", - "githuburl":"" - }, - { - "uri":"elb_jd_hd_0002.html", - "product_code":"elb", - "code":"24", - "des":"This API is used to remove backend ECSs from a listener. Multiple backend ECSs can be removed concurrently.POST /v1.0/{project_id}/elbaas/listeners/{listener_id}/members/", - "doc_type":"api", - "kw":"Removing Backend ECSs,Backend ECS,API Reference", - "title":"Removing Backend ECSs", - "githuburl":"" - }, - { - "uri":"elb_jd_hd_0003.html", - "product_code":"elb", - "code":"25", - "des":"This API is used to query backend ECSs added to a listener. If you are the administrator, the backend ECS list will be empty.GET /v1.0/{project_id}/elbaas/listeners/{list", - "doc_type":"api", - "kw":"Querying Backend ECSs,Backend ECS,API Reference", - "title":"Querying Backend ECSs", - "githuburl":"" - }, - { - "uri":"elb_jd_pe_0000.html", - "product_code":"elb", - "code":"26", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Quota", - "title":"Quota", - "githuburl":"" - }, - { - "uri":"elb_jd_pe_0001.html", - "product_code":"elb", - "code":"27", - "des":"This API is used to query the load balancer or listener quotas.GET /v1.0/{project_id}/elbaas/quotasRequest parametersNoneNoneExample requestNoneNoneResponse parametersPar", - "doc_type":"api", - "kw":"Querying Load Balancer or Listener Quotas,Quota,API Reference", - "title":"Querying Load Balancer or Listener Quotas", - "githuburl":"" - }, - { - "uri":"elb_jd_zs_0000.html", - "product_code":"elb", - "code":"28", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Certificate", - "title":"Certificate", - "githuburl":"" - }, - { - "uri":"elb_jd_zs_0001.html", - "product_code":"elb", - "code":"29", - "des":"This API is used to create a certificate for an HTTPS listener.POST /v1.0/{project_id}/elbaas/certificateRequest parametersNoneNoneExample request{\n \"name\": \"cert-bky\"", - "doc_type":"api", - "kw":"Creating a Certificate,Certificate,API Reference", - "title":"Creating a Certificate", - "githuburl":"" - }, - { - "uri":"elb_jd_zs_0002.html", - "product_code":"elb", - "code":"30", - "des":"This API is used to delete a certificate.DELETE /v1.0/{project_id}/elbaas/certificate/{certificate_id}Request parametersNoneNoneExample requestNoneNoneResponse parameters", - "doc_type":"api", - "kw":"Deleting a Certificate,Certificate,API Reference", - "title":"Deleting a Certificate", - "githuburl":"" - }, - { - "uri":"elb_jd_zs_0003.html", - "product_code":"elb", - "code":"31", - "des":"This API is used to modify the name and description of a certificate.PUT /v1.0/{project_id}/elbaas/certificate/{certificate_id}Request parametersNoneNoneExample request{\n", - "doc_type":"api", - "kw":"Modifying a Certificate,Certificate,API Reference", - "title":"Modifying a Certificate", - "githuburl":"" - }, - { - "uri":"elb_jd_zs_0004.html", - "product_code":"elb", - "code":"32", - "des":"This API is used to query all the certificates.GET /v1.0/{project_id}/elbaas/certificateRequest parametersNoneNoneExample requestNoneNoneResponse parametersResponse param", - "doc_type":"api", - "kw":"Querying Certificates,Certificate,API Reference", - "title":"Querying Certificates", - "githuburl":"" - }, - { - "uri":"elb_jd_job_0000.html", - "product_code":"elb", - "code":"33", - "des":"This API is used to query the job status, such as the execution status of creating or deleting a load balancer.GET /v1.0/{project_id}/jobs/{job_id}Request parametersNoneN", - "doc_type":"api", - "kw":"Querying the Job Status,Classic Load Balancer APIs,API Reference", - "title":"Querying the Job Status", - "githuburl":"" - }, - { - "uri":"elb_jd_cj_0000.html", - "product_code":"elb", - "code":"34", - "des":"This API is used to query all metrics at Layer 4 and Layer 7.Only users can query these metrics.GET /v1.0/{project_id}/elbaas/monitorRequest parametersNoneNoneExample req", - "doc_type":"api", - "kw":"Querying Monitoring Metrics,Classic Load Balancer APIs,API Reference", - "title":"Querying Monitoring Metrics", - "githuburl":"" - }, - { - "uri":"elb_jd_bg_0000.html", - "product_code":"elb", - "code":"35", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"API Version", - "title":"API Version", - "githuburl":"" - }, - { - "uri":"elb_jd_bg_0001.html", - "product_code":"elb", - "code":"36", - "des":"This API is used to query all API versions of ELB.GET /Request parametersNoneNoneExample requestNoneNoneResponse parametersParameter descriptionParameterTypeDescriptionve", - "doc_type":"api", - "kw":"Querying All API Versions,API Version,API Reference", - "title":"Querying All API Versions", - "githuburl":"" - }, - { - "uri":"elb_jd_bg_0002.html", - "product_code":"elb", - "code":"37", - "des":"This API is used to query a specific ELB API version.GET /{api_version}Example/v1.0/v1.0Request parametersNoneNoneExample requestNoneNoneResponse parametersResponse param", - "doc_type":"api", - "kw":"Querying a Specific API Version,API Version,API Reference", - "title":"Querying a Specific API Version", - "githuburl":"" - }, - { - "uri":"elb_zq_0000.html", - "product_code":"elb", - "code":"38", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Shared Load Balancer APIs", - "title":"Shared Load Balancer APIs", - "githuburl":"" - }, - { - "uri":"en-us_topic_0000001088335195.html", - "product_code":"elb", - "code":"39", - "des":"By default, load balancers created in the eu-de region are shared load balancers. APIs for shared load balancers are only available in this region. Shared load balancers ", - "doc_type":"api", - "kw":"API Call Precaution,Shared Load Balancer APIs,API Reference", - "title":"API Call Precaution", - "githuburl":"" - }, - { - "uri":"elb_zq_fz_0000.html", - "product_code":"elb", - "code":"40", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Load Balancer", - "title":"Load Balancer", - "githuburl":"" - }, - { - "uri":"en-us_topic_0096561535.html", - "product_code":"elb", - "code":"41", - "des":"This API is used to create a private network load balancer. After the load balancer is created, its details, such as load balancer ID, IP address, and subnet ID, are retu", - "doc_type":"api", - "kw":"Creating a Load Balancer,Load Balancer,API Reference", - "title":"Creating a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_zq_fz_0002.html", - "product_code":"elb", - "code":"42", - "des":"This API is used to query load balancers and display them in a list. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.P", - "doc_type":"api", - "kw":"Querying Load Balancers,Load Balancer,API Reference", - "title":"Querying Load Balancers", - "githuburl":"" - }, - { - "uri":"en-us_topic_0141008271.html", - "product_code":"elb", - "code":"43", - "des":"See HTTP Status Codes of Shared Load Balancers.", - "doc_type":"api", - "kw":"Querying Details of a Load Balancer,Load Balancer,API Reference", - "title":"Querying Details of a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_zq_fz_0004.html", - "product_code":"elb", - "code":"44", - "des":"This API is used to query the status tree of a load balancer. You can use this API to query details about the associated listeners, backend server groups, backend servers", - "doc_type":"api", - "kw":"Querying the Status Tree of a Load Balancer,Load Balancer,API Reference", - "title":"Querying the Status Tree of a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_zq_fz_0005.html", - "product_code":"elb", - "code":"45", - "des":"This API is used to update the name or description of a load balancer.PUT /v2.0/lbaas/loadbalancers/{loadbalancer_id}Example request: Modifying the load balancer name and", - "doc_type":"api", - "kw":"Updating a Load Balancer,Load Balancer,API Reference", - "title":"Updating a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_zq_fz_0006.html", - "product_code":"elb", - "code":"46", - "des":"This API is used to delete a specific load balancer.All listeners added to the load balancer must be deleted before the load balancer is deleted.DELETE /v2.0/lbaas/loadba", - "doc_type":"api", - "kw":"Deleting a Load Balancer,Load Balancer,API Reference", - "title":"Deleting a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_zq_jt_0000.html", - "product_code":"elb", - "code":"47", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Listener", - "title":"Listener", - "githuburl":"" - }, - { - "uri":"elb_zq_jt_0001.html", - "product_code":"elb", - "code":"48", - "des":"This API is used to add a listener to a load balancer.When protocol is set to TCP and protocol_port to 0, the listener works in IP mode (DR mode).POST /v2.0/lbaas/listene", - "doc_type":"api", - "kw":"Adding a Listener,Listener,API Reference", - "title":"Adding a Listener", - "githuburl":"" - }, - { - "uri":"elb_zq_jt_0002.html", - "product_code":"elb", - "code":"49", - "des":"This API is used to query the listeners and display them in a list. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Yo", - "doc_type":"api", - "kw":"Querying Listeners,Listener,API Reference", - "title":"Querying Listeners", - "githuburl":"" - }, - { - "uri":"elb_zq_jt_0003.html", - "product_code":"elb", - "code":"50", - "des":"This API is used to query details about a listener using its ID.GET /v2.0/lbaas/listeners/{listener_id}NoneExample request: Viewing details of a listenerGET https://{Endp", - "doc_type":"api", - "kw":"Querying Details of a Listener,Listener,API Reference", - "title":"Querying Details of a Listener", - "githuburl":"" - }, - { - "uri":"elb_zq_jt_0004.html", - "product_code":"elb", - "code":"51", - "des":"This API is used to update a listener, such as listener name, description, associated backend server groups, and server certificates.If the provisioning status of the ass", - "doc_type":"api", - "kw":"Updating a Listener,Listener,API Reference", - "title":"Updating a Listener", - "githuburl":"" - }, - { - "uri":"elb_zq_jt_0005.html", - "product_code":"elb", - "code":"52", - "des":"This API is used to delete a listener by ID.All backend server groups associated with the listener must be deleted before the listener is deleted.DELETE /v2.0/lbaas/liste", - "doc_type":"api", - "kw":"Deleting a Listener,Listener,API Reference", - "title":"Deleting a Listener", - "githuburl":"" - }, - { - "uri":"elb_zq_hz_0000.html", - "product_code":"elb", - "code":"53", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Backend Server Group", - "title":"Backend Server Group", - "githuburl":"" - }, - { - "uri":"elb_zq_hz_0001.html", - "product_code":"elb", - "code":"54", - "des":"This API is used to add a backend server group. After multiple backend servers are added to a backend server group, requests are distributed among backend servers based o", - "doc_type":"api", - "kw":"Adding a Backend Server Group,Backend Server Group,API Reference", - "title":"Adding a Backend Server Group", - "githuburl":"" - }, - { - "uri":"en-us_topic_0096561547.html", - "product_code":"elb", - "code":"55", - "des":"Example request 1: Adding a backend server group with the sticky session feature disabledPOST https://{Endpoint}/v2.0/lbaas/pools \n\n{\n \"pool\": {\n \"lb_algorithm\"", - "doc_type":"api", - "kw":"Querying Backend Server Groups,Backend Server Group,API Reference", - "title":"Querying Backend Server Groups", - "githuburl":"" - }, - { - "uri":"elb_zq_hz_0003.html", - "product_code":"elb", - "code":"56", - "des":"This API is used to query details about a backend server group using its ID.GET /v2.0/lbaas/pools/{pool_id}NoneExample request: Querying details of a backend server group", - "doc_type":"api", - "kw":"Querying Details of a Backend Server Group,Backend Server Group,API Reference", - "title":"Querying Details of a Backend Server Group", - "githuburl":"" - }, - { - "uri":"elb_zq_hz_0004.html", - "product_code":"elb", - "code":"57", - "des":"This API is used to update a backend server group.If the provisioning status of the load balancer associated with a backend server group is not ACTIVE, the backend server", - "doc_type":"api", - "kw":"Updating a Backend Server Group,Backend Server Group,API Reference", - "title":"Updating a Backend Server Group", - "githuburl":"" - }, - { - "uri":"elb_zq_hz_0005.html", - "product_code":"elb", - "code":"58", - "des":"This API is used to delete a backend server group.Before deleting a backend server group, remove all backend servers, delete the health check, and disassociate forwarding", - "doc_type":"api", - "kw":"Deleting a Backend Server Group,Backend Server Group,API Reference", - "title":"Deleting a Backend Server Group", - "githuburl":"" - }, - { - "uri":"elb_zq_hd_0000.html", - "product_code":"elb", - "code":"59", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Backend Server", - "title":"Backend Server", - "githuburl":"" - }, - { - "uri":"elb_zq_hd_0001.html", - "product_code":"elb", - "code":"60", - "des":"This API is used to add a backend server to a specific backend server group. After a backend server group is added to a listener, traffic is distributed to backend server", - "doc_type":"api", - "kw":"Adding a Backend Server,Backend Server,API Reference", - "title":"Adding a Backend Server", - "githuburl":"" - }, - { - "uri":"elb_zq_hd_0002.html", - "product_code":"elb", - "code":"61", - "des":"This API is used to query backend servers in a specific backend server group. Filter query and pagination query are supported. Unless otherwise specified, exact match is ", - "doc_type":"api", - "kw":"Querying Backend Servers,Backend Server,API Reference", - "title":"Querying Backend Servers", - "githuburl":"" - }, - { - "uri":"elb_zq_hd_0003.html", - "product_code":"elb", - "code":"62", - "des":"This API is used to query details about a backend server.GET /v2.0/lbaas/pools/{pool_id}/members/{member_id}NoneExample request: Querying details of a backend serverGET h", - "doc_type":"api", - "kw":"Querying Details of a Backend Server,Backend Server,API Reference", - "title":"Querying Details of a Backend Server", - "githuburl":"" - }, - { - "uri":"elb_zq_hd_0004.html", - "product_code":"elb", - "code":"63", - "des":"This API is used to update a backend server. You can modify its name and weight. You can set a larger weight for backend servers that can receive more traffic.If the prov", - "doc_type":"api", - "kw":"Updating a Backend Server,Backend Server,API Reference", - "title":"Updating a Backend Server", - "githuburl":"" - }, - { - "uri":"elb_zq_hd_0005.html", - "product_code":"elb", - "code":"64", - "des":"This API is used to remove a backend server by its ID.After you remove a backend server, new connections to this server will not be established. However, long connections", - "doc_type":"api", - "kw":"Removing a Backend Server,Backend Server,API Reference", - "title":"Removing a Backend Server", - "githuburl":"" - }, - { - "uri":"elb_zq_hd_0006.html", - "product_code":"elb", - "code":"65", - "des":"This API is used to query all backend servers. Filter query and pagination query are supported.Parameters marker, limit, and page_reverse are used for pagination query. P", - "doc_type":"api", - "kw":"Querying All Backend Servers (Extension API),Backend Server,API Reference", - "title":"Querying All Backend Servers (Extension API)", - "githuburl":"" - }, - { - "uri":"elb_zq_hd_0007.html", - "product_code":"elb", - "code":"66", - "des":"This API is used to update backend servers in batches.A maximum of 200 backend servers can be modified at a time.Two backend servers a backend server group cannot have th", - "doc_type":"api", - "kw":"Batch Updating Backend Servers,Backend Server,API Reference", - "title":"Batch Updating Backend Servers", - "githuburl":"" - }, - { - "uri":"elb_zq_jk_0000.html", - "product_code":"elb", - "code":"67", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Health Check", - "title":"Health Check", - "githuburl":"" - }, - { - "uri":"elb_zq_jk_0001.html", - "product_code":"elb", - "code":"68", - "des":"This API is used to configure a health check for a backend server group to check the status of backend servers. If the health check result is OFFLINE, backend servers are", - "doc_type":"api", - "kw":"Configuring a Health Check,Health Check,API Reference", - "title":"Configuring a Health Check", - "githuburl":"" - }, - { - "uri":"elb_zq_jk_0002.html", - "product_code":"elb", - "code":"69", - "des":"This API is used to query the health checks. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.GET /v2.0/lbaas/healthmon", - "doc_type":"api", - "kw":"Querying Health Checks,Health Check,API Reference", - "title":"Querying Health Checks", - "githuburl":"" - }, - { - "uri":"elb_zq_jk_0003.html", - "product_code":"elb", - "code":"70", - "des":"This API is used to query details about a health check using its iD.GET /v2.0/lbaas/healthmonitors/{healthmonitor_id}NoneExample request: Querying details of a health che", - "doc_type":"api", - "kw":"Querying Details of a Health Check,Health Check,API Reference", - "title":"Querying Details of a Health Check", - "githuburl":"" - }, - { - "uri":"elb_zq_jk_0004.html", - "product_code":"elb", - "code":"71", - "des":"This API is used to update a health check.If provisioning_status of the load balancer for which the health check is configured is not ACTIVE, the health check cannot be u", - "doc_type":"api", - "kw":"Updating a Health Check,Health Check,API Reference", - "title":"Updating a Health Check", - "githuburl":"" - }, - { - "uri":"elb_zq_jk_0005.html", - "product_code":"elb", - "code":"72", - "des":"This API is used to delete a health check.If provisioning_status of the load balancer for which the health check is configured is not ACTIVE, the health check cannot be d", - "doc_type":"api", - "kw":"Deleting a Health Check,Health Check,API Reference", - "title":"Deleting a Health Check", - "githuburl":"" - }, - { - "uri":"elb_zq_zf_0000.html", - "product_code":"elb", - "code":"73", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Forwarding Policy", - "title":"Forwarding Policy", - "githuburl":"" - }, - { - "uri":"elb_zq_zf_0001.html", - "product_code":"elb", - "code":"74", - "des":"This API is used to add a forwarding policy. The listener and forwarding policy determine how traffic is forwarded to backend servers.By matching the URL or domain name s", - "doc_type":"api", - "kw":"Adding a Forwarding Policy,Forwarding Policy,API Reference", - "title":"Adding a Forwarding Policy", - "githuburl":"" - }, - { - "uri":"elb_zq_zf_0002.html", - "product_code":"elb", - "code":"75", - "des":"This API is used to query the forwarding policies. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Parameters marker, ", - "doc_type":"api", - "kw":"Querying Forwarding Policies,Forwarding Policy,API Reference", - "title":"Querying Forwarding Policies", - "githuburl":"" - }, - { - "uri":"elb_zq_zf_0003.html", - "product_code":"elb", - "code":"76", - "des":"This API is used to query details about a forwarding policy.GET /v2.0/lbaas/l7policies/{l7policy_id}NoneExample request: Querying details of a forwarding policyGET https:", - "doc_type":"api", - "kw":"Querying Details of a Forwarding Policy,Forwarding Policy,API Reference", - "title":"Querying Details of a Forwarding Policy", - "githuburl":"" - }, - { - "uri":"elb_zq_zf_0004.html", - "product_code":"elb", - "code":"77", - "des":"This API is used to update a forwarding policy. You can select another backend server group or redirect to another HTTPS listener.PUT /v2.0/lbaas/l7policies/{l7policy_id}", - "doc_type":"api", - "kw":"Updating a Forwarding Policy,Forwarding Policy,API Reference", - "title":"Updating a Forwarding Policy", - "githuburl":"" - }, - { - "uri":"elb_zq_zf_0005.html", - "product_code":"elb", - "code":"78", - "des":"This API is used to delete a specific forwarding policy.DELETE /v2.0/lbaas/l7policies/{l7policy_id}NoneNoneExample request: Deleting a forwarding policyDELETE https://{En", - "doc_type":"api", - "kw":"Deleting a Forwarding Policy,Forwarding Policy,API Reference", - "title":"Deleting a Forwarding Policy", - "githuburl":"" - }, - { - "uri":"elb_zq_zg_0000.html", - "product_code":"elb", - "code":"79", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Forwarding Rule", - "title":"Forwarding Rule", - "githuburl":"" - }, - { - "uri":"elb_zq_zg_0001.html", - "product_code":"elb", - "code":"80", - "des":"This API is used to add a forwarding rule. After you add a forwarding rule, the load balancer matches the domain name and path in the request and distributes the traffic ", - "doc_type":"api", - "kw":"Adding a Forwarding Rule,Forwarding Rule,API Reference", - "title":"Adding a Forwarding Rule", - "githuburl":"" - }, - { - "uri":"elb_zq_zg_0002.html", - "product_code":"elb", - "code":"81", - "des":"This API is used to query forwarding rules. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Parameters marker, limit, ", - "doc_type":"api", - "kw":"Querying Forwarding Rules,Forwarding Rule,API Reference", - "title":"Querying Forwarding Rules", - "githuburl":"" - }, - { - "uri":"elb_zq_zg_0003.html", - "product_code":"elb", - "code":"82", - "des":"This API is used to query details about a forwarding rule using its ID.GET /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}NoneExample request: Querying details of ", - "doc_type":"api", - "kw":"Querying Details of a Forwarding Rule,Forwarding Rule,API Reference", - "title":"Querying Details of a Forwarding Rule", - "githuburl":"" - }, - { - "uri":"elb_zq_zg_0004.html", - "product_code":"elb", - "code":"83", - "des":"This API is used to update a forwarding rule. You can change the mode that how traffic is distributed by updating the forwarding rule.PUT /v2.0/lbaas/l7policies/{l7policy", - "doc_type":"api", - "kw":"Updating a Forwarding Rule,Forwarding Rule,API Reference", - "title":"Updating a Forwarding Rule", - "githuburl":"" - }, - { - "uri":"elb_zq_zg_0005.html", - "product_code":"elb", - "code":"84", - "des":"This API is used to delete a specific forwarding rule.DELETE /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}NoneNoneExample request: Deleting a forwarding ruleDELE", - "doc_type":"api", - "kw":"Deleting a Forwarding Rule,Forwarding Rule,API Reference", - "title":"Deleting a Forwarding Rule", - "githuburl":"" - }, - { - "uri":"elb_zq_bm_0000.html", - "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", - "kw":"Whitelist", - "title":"Whitelist", - "githuburl":"" - }, - { - "uri":"elb_zq_bm_0001.html", - "product_code":"elb", - "code":"86", - "des":"This API is used to add a whitelist to control access to a specific listener. After a whitelist is added, only IP addresses in the whitelist can access the listener.POST ", - "doc_type":"api", - "kw":"Adding a Whitelist,Whitelist,API Reference", - "title":"Adding a Whitelist", - "githuburl":"" - }, - { - "uri":"elb_zq_bm_0002.html", - "product_code":"elb", - "code":"87", - "des":"This API is used to query the whitelists. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Parameters marker, limit, an", - "doc_type":"api", - "kw":"Querying Whitelists,Whitelist,API Reference", - "title":"Querying Whitelists", - "githuburl":"" - }, - { - "uri":"elb_zq_bm_0003.html", - "product_code":"elb", - "code":"88", - "des":"This API is used to query details about a whitelist using its ID.GET /v2.0/lbaas/whitelists/{whitelist_id}NoneExample request: Querying details of a whitelistGET https://", - "doc_type":"api", - "kw":"Querying Details of a Whitelist,Whitelist,API Reference", - "title":"Querying Details of a Whitelist", - "githuburl":"" - }, - { - "uri":"elb_zq_bm_0004.html", - "product_code":"elb", - "code":"89", - "des":"This API is used to update a whitelist. You can enable or disable the whitelist function or change IP addresses in the whitelist. If you change IP addresses in the whitel", - "doc_type":"api", - "kw":"Updating a Whitelist,Whitelist,API Reference", - "title":"Updating a Whitelist", - "githuburl":"" - }, - { - "uri":"elb_zq_bm_0005.html", - "product_code":"elb", - "code":"90", - "des":"This API is used to delete a specific whitelist.DELETE /v2.0/lbaas/whitelists/{whitelist_id}NoneNoneExample request: Deleting a whitelistDELETE https://{Endpoint}/v2.0/lb", - "doc_type":"api", - "kw":"Deleting a Whitelist,Whitelist,API Reference", - "title":"Deleting a Whitelist", - "githuburl":"" - }, - { - "uri":"elb_zq_zs_0000.html", - "product_code":"elb", - "code":"91", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Certificate", - "title":"Certificate", - "githuburl":"" - }, - { - "uri":"elb_zq_zs_0001.html", - "product_code":"elb", - "code":"92", - "des":"This API is used to create a certificate. After a certificate is bound to a listener, the load balancer authenticates the client using this certificate, and backend serve", - "doc_type":"api", - "kw":"Creating a Certificate,Certificate,API Reference", - "title":"Creating a Certificate", - "githuburl":"" - }, - { - "uri":"elb_zq_zs_0002.html", - "product_code":"elb", - "code":"93", - "des":"This API is used to query all the certificates. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Parameters marker, lim", - "doc_type":"api", - "kw":"Querying Certificates,Certificate,API Reference", - "title":"Querying Certificates", - "githuburl":"" - }, - { - "uri":"elb_zq_zs_0003.html", - "product_code":"elb", - "code":"94", - "des":"This API is used to query details about a certificate.GET /v2.0/lbaas/certificates/{certificate_id}NoneExample request: Querying details of a certificateGET https://{Endp", - "doc_type":"api", - "kw":"Querying Details of a Certificate,Certificate,API Reference", - "title":"Querying Details of a Certificate", - "githuburl":"" - }, - { - "uri":"elb_zq_zs_0004.html", - "product_code":"elb", - "code":"95", - "des":"This API is used to update a certificate.PUT /v2.0/lbaas/certificates/{certificate_id}Example request: Updating a certificatePUT https://{Endpoint}/v2.0/lbaas/certificate", - "doc_type":"api", - "kw":"Updating a Certificate,Certificate,API Reference", - "title":"Updating a Certificate", - "githuburl":"" - }, - { - "uri":"elb_zq_zs_0005.html", - "product_code":"elb", - "code":"96", - "des":"This API is used to delete a specific certificate.If the target certificate is used by a listener, the certificate cannot be deleted, and 409 code will be displayed.DELET", - "doc_type":"api", - "kw":"Deleting a Certificate,Certificate,API Reference", - "title":"Deleting a Certificate", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0000.html", - "product_code":"elb", - "code":"97", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Tag", - "title":"Tag", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0001.html", - "product_code":"elb", - "code":"98", - "des":"This API is used to add a tag to a specific load balancer for easier management.You can also use this API for dedicated load balancers.A maximum of 20 tags can be added t", - "doc_type":"api", - "kw":"Adding a Tag to a Load Balancer,Tag,API Reference", - "title":"Adding a Tag to a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0002.html", - "product_code":"elb", - "code":"99", - "des":"This API is used to batch add tags to or delete tags from a load balancer.You can also use this API for dedicated load balancers.A maximum of 20 tags can be added to a lo", - "doc_type":"api", - "kw":"Batch Adding or Deleting Load Balancer Tags,Tag,API Reference", - "title":"Batch Adding or Deleting Load Balancer Tags", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0003.html", - "product_code":"elb", - "code":"100", - "des":"This API is used to query all the tags of one load balancer.You can also use this API for dedicated load balancers.GET /v2.0/{project_id}/loadbalancers/{loadbalancer_id}/", - "doc_type":"api", - "kw":"Querying All Tags of a Load Balancer,Tag,API Reference", - "title":"Querying All Tags of a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0004.html", - "product_code":"elb", - "code":"101", - "des":"This API is used to query the tags of all the load balancers.You can also use this API for dedicated load balancers.GET /v2.0/{project_id}/loadbalancers/tagsNoneExample r", - "doc_type":"api", - "kw":"Querying the Tags of All Load Balancers,Tag,API Reference", - "title":"Querying the Tags of All Load Balancers", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0005.html", - "product_code":"elb", - "code":"102", - "des":"This API is used to query load balancers using tags.You can also use this API for dedicated load balancers.NonePOST /v2.0/{project_id}/loadbalancers/resource_instances/ac", - "doc_type":"api", - "kw":"Querying Load Balancers by Tag,Tag,API Reference", - "title":"Querying Load Balancers by Tag", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0006.html", - "product_code":"elb", - "code":"103", - "des":"This API is used to delete a tag with a specific key from a load balancer.You can also use this API for dedicated load balancers.NoneDELETE /v2.0/{project_id}/loadbalance", - "doc_type":"api", - "kw":"Deleting a Tag from a Load Balancer,Tag,API Reference", - "title":"Deleting a Tag from a Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0007.html", - "product_code":"elb", - "code":"104", - "des":"This API is used to add a tag to a specific listener.You can also use this API for dedicated load balancers.A maximum of 20 tags can be added to a listener.Note the follo", - "doc_type":"api", - "kw":"Adding a Tag to a Listener,Tag,API Reference", - "title":"Adding a Tag to a Listener", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0008.html", - "product_code":"elb", - "code":"105", - "des":"This API is used to batch add tags to or delete tags from a listener.You can also use this API for dedicated load balancers.A maximum of 20 tags can be added to a listene", - "doc_type":"api", - "kw":"Batch Adding or Deleting Listener Tags,Tag,API Reference", - "title":"Batch Adding or Deleting Listener Tags", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0009.html", - "product_code":"elb", - "code":"106", - "des":"This API is used to query all tags of one listener.You can also use this API for dedicated load balancers.NoneGET /v2.0/{project_id}/listeners/{listener_id}/tagsNoneExamp", - "doc_type":"api", - "kw":"Querying All Tags of a Listener,Tag,API Reference", - "title":"Querying All Tags of a Listener", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0010.html", - "product_code":"elb", - "code":"107", - "des":"This API is used to query the tags of all listeners.You can also use this API for dedicated load balancers.NoneGET /v2.0/{project_id}/listeners/tagsNoneExample requestGET", - "doc_type":"api", - "kw":"Querying the Tags of All Listeners,Tag,API Reference", - "title":"Querying the Tags of All Listeners", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0011.html", - "product_code":"elb", - "code":"108", - "des":"This API is used to query listeners by tag.You can also use this API for dedicated load balancers.NonePOST /v2.0/{project_id}/listeners/resource_instances/actionExample r", - "doc_type":"api", - "kw":"Querying Listeners by Tag,Tag,API Reference", - "title":"Querying Listeners by Tag", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0012.html", - "product_code":"elb", - "code":"109", - "des":"This API is used to delete a tag with a specific key from a listener.You can also use this API for dedicated load balancers.NoneDELETE /v2.0/{project_id}/listeners/{liste", - "doc_type":"api", - "kw":"Deleting a Tag from a Listener,Tag,API Reference", - "title":"Deleting a Tag from a Listener", - "githuburl":"" - }, - { - "uri":"elb_zq_bq_0013.html", - "product_code":"elb", - "code":"110", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Status Codes,Tag,API Reference", - "title":"Status Codes", - "githuburl":"" - }, - { - "uri":"elb_dx_0000.html", - "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", - "kw":"Dedicated Load Balancer APIs", - "title":"Dedicated Load Balancer APIs", - "githuburl":"" - }, - { - "uri":"en-us_topic_0000001088310753.html", - "product_code":"elb", - "code":"112", - "des":"By default, load balancers created in the eu-nl region are dedicated load balancers. APIs for dedicated load balancers are only available in this region. Shared load bala", - "doc_type":"api", - "kw":"API Call Precaution,Dedicated Load Balancer APIs,API Reference", - "title":"API Call Precaution", - "githuburl":"" - }, - { - "uri":"topic_300000000.html", - "product_code":"elb", - "code":"113", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Quota", - "title":"Quota", - "githuburl":"" - }, - { - "uri":"ShowQuota.html", - "product_code":"elb", - "code":"114", - "des":"This API is used to query resource quotas of a specific user.GET /v3/{project_id}/elb/quotasStatus code: 200Status code: 200Successful request.See Error Codes.", - "doc_type":"api", - "kw":"Querying Quotas,Quota,API Reference", - "title":"Querying Quotas", - "githuburl":"" - }, - { - "uri":"topic_300000001.html", - "product_code":"elb", - "code":"115", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"AZ", - "title":"AZ", - "githuburl":"" - }, - { - "uri":"ListAvailabilityZones.html", - "product_code":"elb", - "code":"116", - "des":"This API is used to query all available AZs when you create a dedicated load balancer.One set of AZs is returned. When you create a dedicated load balancer, you can selec", - "doc_type":"api", - "kw":"Querying AZs,AZ,API Reference", - "title":"Querying AZs", - "githuburl":"" - }, - { - "uri":"topic_300000002.html", - "product_code":"elb", - "code":"117", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Load Balancer Flavor", - "title":"Load Balancer Flavor", - "githuburl":"" - }, - { - "uri":"ListFlavors.html", - "product_code":"elb", - "code":"118", - "des":"This API is used to query all load balancer flavors that are available to a specific user in a specific region.Parameters marker, limit, and page_reverse are used for pag", - "doc_type":"api", - "kw":"Querying Flavors,Load Balancer Flavor,API Reference", - "title":"Querying Flavors", - "githuburl":"" - }, - { - "uri":"ShowFlavor.html", - "product_code":"elb", - "code":"119", - "des":"This API is used to view details of a flavor.This API can only be used to view the details of a flavor.GET /v3/{project_id}/elb/flavors/{flavor_id}Status code: 200Status ", - "doc_type":"api", - "kw":"Viewing Details of a Flavor,Load Balancer Flavor,API Reference", - "title":"Viewing Details of a Flavor", - "githuburl":"" - }, - { - "uri":"topic_300000003.html", - "product_code":"elb", - "code":"120", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Load Balancer", - "title":"Load Balancer", - "githuburl":"" - }, - { - "uri":"CreateLoadBalancer.html", - "product_code":"elb", - "code":"121", - "des":"This API is used to create a dedicated load balancer. When you create the load balancer, note the following:Specify both vip_subnet_cidr_id and vip_address if you want to", - "doc_type":"api", - "kw":"Creating a Load Balancer,Load Balancer,API Reference", - "title":"Creating a Load Balancer", - "githuburl":"" - }, - { - "uri":"ListLoadBalancers.html", - "product_code":"elb", - "code":"122", - "des":"This API is used to query all load balancers. Both filtered query and pagination query are supported.Parameters marker, limit, and page_reverse are used for pagination qu", - "doc_type":"api", - "kw":"Querying Load Balancers,Load Balancer,API Reference", - "title":"Querying Load Balancers", - "githuburl":"" - }, - { - "uri":"ShowLoadBalancer.html", - "product_code":"elb", - "code":"123", - "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", - "kw":"Viewing Details of a Load Balancer,Load Balancer,API Reference", - "title":"Viewing Details of a Load Balancer", - "githuburl":"" - }, - { - "uri":"UpdateLoadBalancer.html", - "product_code":"elb", - "code":"124", - "des":"This API is used to update a load balancer.PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}Status code: 200Status code: 200Successful request.See Error Codes.", - "doc_type":"api", - "kw":"Updating a Load Balancer,Load Balancer,API Reference", - "title":"Updating a Load Balancer", - "githuburl":"" - }, - { - "uri":"DeleteLoadBalancer.html", - "product_code":"elb", - "code":"125", - "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", - "kw":"Deleting a Load Balancer,Load Balancer,API Reference", - "title":"Deleting a Load Balancer", - "githuburl":"" - }, - { - "uri":"ShowLoadBalancerStatus.html", - "product_code":"elb", - "code":"126", - "des":"This API is used to query the status tree of a load balancer and show information about all resources associated with the load balancer.When admin_state_up is set to fals", - "doc_type":"api", - "kw":"Querying the Status Tree of a Load Balancer,Load Balancer,API Reference", - "title":"Querying the Status Tree of a Load Balancer", - "githuburl":"" - }, - { - "uri":"topic_300000004.html", - "product_code":"elb", - "code":"127", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Certificate", - "title":"Certificate", - "githuburl":"" - }, - { - "uri":"CreateCertificate.html", - "product_code":"elb", - "code":"128", - "des":"This API is used to create an SSL certificate.POST /v3/{project_id}/elb/certificatesStatus code: 201Status code: 201Successful request.See Error Codes.", - "doc_type":"api", - "kw":"Creating a Certificate,Certificate,API Reference", - "title":"Creating a Certificate", - "githuburl":"" - }, - { - "uri":"ListCertificates.html", - "product_code":"elb", - "code":"129", - "des":"This API is used to query all SSL certificates.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect onl", - "doc_type":"api", - "kw":"Querying Certificates,Certificate,API Reference", - "title":"Querying Certificates", - "githuburl":"" - }, - { - "uri":"ShowCertificate.html", - "product_code":"elb", - "code":"130", - "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", - "kw":"Viewing Details of a Certificate,Certificate,API Reference", - "title":"Viewing Details of a Certificate", - "githuburl":"" - }, - { - "uri":"UpdateCertificate.html", - "product_code":"elb", - "code":"131", - "des":"This API is used to update an SSL certificate.PUT /v3/{project_id}/elb/certificates/{certificate_id}Status code: 200Status code: 200Successful request.See Error Codes.", - "doc_type":"api", - "kw":"Updating a Certificate,Certificate,API Reference", - "title":"Updating a Certificate", - "githuburl":"" - }, - { - "uri":"DeleteCertificate.html", - "product_code":"elb", - "code":"132", - "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", - "kw":"Deleting a Certificate,Certificate,API Reference", - "title":"Deleting a Certificate", - "githuburl":"" - }, - { - "uri":"topic_300000005.html", - "product_code":"elb", - "code":"133", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Listener", - "title":"Listener", - "githuburl":"" - }, - { - "uri":"CreateListener.html", - "product_code":"elb", - "code":"134", - "des":"This API is used to add a listener to a load balancer.Only the administrator can specify connection_limit.The listener protocol can be TCP, HTTP, UDP, or HTTPS.The listen", - "doc_type":"api", - "kw":"Adding a Listener,Listener,API Reference", - "title":"Adding a Listener", - "githuburl":"" - }, - { - "uri":"ListListeners.html", - "product_code":"elb", - "code":"135", - "des":"This API is used to query listeners.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect only when they", - "doc_type":"api", - "kw":"Querying Listeners,Listener,API Reference", - "title":"Querying Listeners", - "githuburl":"" - }, - { - "uri":"ShowListener.html", - "product_code":"elb", - "code":"136", - "des":"This API is used to view details of a listener.GET /v3/{project_id}/elb/listeners/{listener_id}Status code: 200Status code: 200Successful request.See Error Codes.", - "doc_type":"api", - "kw":"Viewing Details of a Listener,Listener,API Reference", - "title":"Viewing Details of a Listener", - "githuburl":"" - }, - { - "uri":"UpdateListener.html", - "product_code":"elb", - "code":"137", - "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. Only th", - "doc_type":"api", - "kw":"Updating a Listener,Listener,API Reference", - "title":"Updating a Listener", - "githuburl":"" - }, - { - "uri":"DeleteListener.html", - "product_code":"elb", - "code":"138", - "des":"This API is used to delete a listener.Before you delete a listener, delete the associated backend server group or disassociate the backend server group from the listener,", - "doc_type":"api", - "kw":"Deleting a Listener,Listener,API Reference", - "title":"Deleting a Listener", - "githuburl":"" - }, - { - "uri":"topic_300000006.html", - "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", - "kw":"Backend Server Group", - "title":"Backend Server Group", - "githuburl":"" - }, - { - "uri":"CreatePool.html", - "product_code":"elb", - "code":"140", - "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", - "title":"Creating a Backend Server Group", - "githuburl":"" - }, - { - "uri":"ListPools.html", - "product_code":"elb", - "code":"141", - "des":"This API is used to query all backend server groups.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effec", - "doc_type":"api", - "kw":"Querying Backend Server Groups,Backend Server Group,API Reference", - "title":"Querying Backend Server Groups", - "githuburl":"" - }, - { - "uri":"ShowPool.html", - "product_code":"elb", - "code":"142", - "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", - "kw":"Viewing Details of a Backend Server Group,Backend Server Group,API Reference", - "title":"Viewing Details of a Backend Server Group", - "githuburl":"" - }, - { - "uri":"UpdatePool.html", - "product_code":"elb", - "code":"143", - "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", - "kw":"Updating a Backend Server Group,Backend Server Group,API Reference", - "title":"Updating a Backend Server Group", - "githuburl":"" - }, - { - "uri":"DeletePool.html", - "product_code":"elb", - "code":"144", - "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", - "kw":"Deleting a Backend Server Group,Backend Server Group,API Reference", - "title":"Deleting a Backend Server Group", - "githuburl":"" - }, - { - "uri":"topic_300000007.html", - "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", - "kw":"Backend Server", - "title":"Backend Server", - "githuburl":"" - }, - { - "uri":"CreateMember.html", - "product_code":"elb", - "code":"146", - "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", - "kw":"Adding a Backend Server,Backend Server,API Reference", - "title":"Adding a Backend Server", - "githuburl":"" - }, - { - "uri":"ListMembers.html", - "product_code":"elb", - "code":"147", - "des":"This API is used to query all backend servers.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect only", - "doc_type":"api", - "kw":"Querying Backend Servers,Backend Server,API Reference", - "title":"Querying Backend Servers", - "githuburl":"" - }, - { - "uri":"ShowMember.html", - "product_code":"elb", - "code":"148", - "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", - "kw":"Viewing Details of a Backend Server,Backend Server,API Reference", - "title":"Viewing Details of a Backend Server", - "githuburl":"" - }, - { - "uri":"UpdateMember.html", - "product_code":"elb", - "code":"149", - "des":"The backend server can be updated only when the provisioning status of the associated load balancer is ACTIVE.PUT /v3/{project_id}/elb/pools/{pool_id}/members/{member_id}", - "doc_type":"api", - "kw":"Updating a Backend Server,Backend Server,API Reference", - "title":"Updating a Backend Server", - "githuburl":"" - }, - { - "uri":"DeleteMember.html", - "product_code":"elb", - "code":"150", - "des":"This API is used to remove a backend server.When you remove backend servers, note the following:After you remove a backend server, new connections to this server will not", - "doc_type":"api", - "kw":"Removing a Backend Server,Backend Server,API Reference", - "title":"Removing a Backend Server", - "githuburl":"" - }, - { - "uri":"topic_300000008.html", - "product_code":"elb", - "code":"151", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Health Check", - "title":"Health Check", - "githuburl":"" - }, - { - "uri":"CreateHealthMonitor.html", - "product_code":"elb", - "code":"152", - "des":"This API is used to configure a health check.The security groups must have rules that allow access from 100.125.0.0/16. If you want to use UDP for health checks, ensure t", - "doc_type":"api", - "kw":"Configuring a Health Check,Health Check,API Reference", - "title":"Configuring a Health Check", - "githuburl":"" - }, - { - "uri":"ListHealthMonitors.html", - "product_code":"elb", - "code":"153", - "des":"This API is used to query all health checks.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect only w", - "doc_type":"api", - "kw":"Querying Health Checks,Health Check,API Reference", - "title":"Querying Health Checks", - "githuburl":"" - }, - { - "uri":"ShowHealthMonitor.html", - "product_code":"elb", - "code":"154", - "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", - "kw":"Viewing Details of a Health Check,Health Check,API Reference", - "title":"Viewing Details of a Health Check", - "githuburl":"" - }, - { - "uri":"UpdateHealthMonitor.html", - "product_code":"elb", - "code":"155", - "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", - "kw":"Updating a Health Check,Health Check,API Reference", - "title":"Updating a Health Check", - "githuburl":"" - }, - { - "uri":"DeleteHealthMonitor.html", - "product_code":"elb", - "code":"156", - "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", - "kw":"Deleting a Health Check,Health Check,API Reference", - "title":"Deleting a Health Check", - "githuburl":"" - }, - { - "uri":"topic_300000009.html", - "product_code":"elb", - "code":"157", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Forwarding Policy", - "title":"Forwarding Policy", - "githuburl":"" - }, - { - "uri":"CreateL7Policy.html", - "product_code":"elb", - "code":"158", - "des":"This API is used to add a forwarding policy.The protocol of the listener to which requests are redirected can only be HTTPS.The listener associated with the forwarding po", - "doc_type":"api", - "kw":"Adding a Forwarding Policy,Forwarding Policy,API Reference", - "title":"Adding a Forwarding Policy", - "githuburl":"" - }, - { - "uri":"ListL7Policies.html", - "product_code":"elb", - "code":"159", - "des":"This API is used to query all forwarding policies.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect ", - "doc_type":"api", - "kw":"Querying Forwarding Policies,Forwarding Policy,API Reference", - "title":"Querying Forwarding Policies", - "githuburl":"" - }, - { - "uri":"ShowL7Policy.html", - "product_code":"elb", - "code":"160", - "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", - "kw":"Viewing Details of a Forwarding Policy,Forwarding Policy,API Reference", - "title":"Viewing Details of a Forwarding Policy", - "githuburl":"" - }, - { - "uri":"UpdateL7Policy.html", - "product_code":"elb", - "code":"161", - "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", - "kw":"Updating a Forwarding Policy,Forwarding Policy,API Reference", - "title":"Updating a Forwarding Policy", - "githuburl":"" - }, - { - "uri":"DeleteL7Policy.html", - "product_code":"elb", - "code":"162", - "des":"This API is used to delete a forwarding policy.DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}NoneNoneSee Error Codes.", - "doc_type":"api", - "kw":"Deleting a Forwarding Policy,Forwarding Policy,API Reference", - "title":"Deleting a Forwarding Policy", - "githuburl":"" - }, - { - "uri":"topic_300000010.html", - "product_code":"elb", - "code":"163", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Forwarding Rule", - "title":"Forwarding Rule", - "githuburl":"" - }, - { - "uri":"CreateL7Rule.html", - "product_code":"elb", - "code":"164", - "des":"This API is used to add a forwarding rule.POST /v3/{project_id}/elb/l7policies/{l7policy_id}/rulesStatus code: 201Status code: 201Successful request.See Error Codes.", - "doc_type":"api", - "kw":"Adding a Forwarding Rule,Forwarding Rule,API Reference", - "title":"Adding a Forwarding Rule", - "githuburl":"" - }, - { - "uri":"ListL7Rules.html", - "product_code":"elb", - "code":"165", - "des":"This API is used to query all forwarding rules.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect onl", - "doc_type":"api", - "kw":"Querying Forwarding Rules,Forwarding Rule,API Reference", - "title":"Querying Forwarding Rules", - "githuburl":"" - }, - { - "uri":"ShowL7Rule.html", - "product_code":"elb", - "code":"166", - "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: 200Successful reques", - "doc_type":"api", - "kw":"Viewing Details of a Forwarding Rule,Forwarding Rule,API Reference", - "title":"Viewing Details of a Forwarding Rule", - "githuburl":"" - }, - { - "uri":"UpdateL7Rule.html", - "product_code":"elb", - "code":"167", - "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", - "kw":"Updating a Forwarding Rule,Forwarding Rule,API Reference", - "title":"Updating a Forwarding Rule", - "githuburl":"" - }, - { - "uri":"DeleteL7Rule.html", - "product_code":"elb", - "code":"168", - "des":"This API is used to delete a forwarding rule.DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}NoneNoneSee Error Codes.", - "doc_type":"api", - "kw":"Deleting a Forwarding Rule,Forwarding Rule,API Reference", - "title":"Deleting a Forwarding Rule", - "githuburl":"" - }, - { - "uri":"elb_fl_0006.html", - "product_code":"elb", - "code":"169", - "des":"Queries all available versions.If there is no version added to the URL, all available versions are returned.GET /NoneNoneExample requestGET /Example response{\n \"version", - "doc_type":"api", - "kw":"Querying Versions,API Reference", - "title":"Querying Versions", - "githuburl":"" - }, - { - "uri":"elb_eg_v3_0000.html", - "product_code":"elb", - "code":"170", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Examples", - "title":"Examples", - "githuburl":"" - }, - { - "uri":"en-us_topic_0000001127879251.html", - "product_code":"elb", - "code":"171", - "des":"Call APIs to create a dedicated load balancer and bind a new EIP to it.You have created a VPC and a subnet.Query the subnet you have created.Send GET https://{vpc_endpoin", - "doc_type":"api", - "kw":"Creating a Dedicated Load Balancer and Binding a New EIP to It,Examples,API Reference", - "title":"Creating a Dedicated Load Balancer and Binding a New EIP to It", - "githuburl":"" - }, - { - "uri":"elb_eg_v3_0002.html", - "product_code":"elb", - "code":"172", - "des":"Call the API to add a listener to a dedicated load balancer.You have created a dedicated load balancer.You have obtained the ID of the dedicated load balancer.Add a liste", - "doc_type":"api", - "kw":"Adding a Listener to a Dedicated Load Balancer,Examples,API Reference", - "title":"Adding a Listener to a Dedicated Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_eg_v3_0003.html", - "product_code":"elb", - "code":"173", - "des":"Call APIs to delete a dedicated load balancer.Before you delete a dedicated load balancer, delete all resources associated with it. Figure 1 shows the associated resource", - "doc_type":"api", - "kw":"Deleting a Dedicated Load Balancer,Examples,API Reference", - "title":"Deleting a Dedicated Load Balancer", - "githuburl":"" - }, - { - "uri":"elb_gc_0000.html", - "product_code":"elb", - "code":"174", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Common Parameters", - "title":"Common Parameters", - "githuburl":"" - }, - { - "uri":"elb_gc_0001.html", - "product_code":"elb", - "code":"175", - "des":"The following error code descriptions are only suitable for classic load balancers.If an error occurs when using an API, an error response will be returned, which contain", - "doc_type":"api", - "kw":"Error Codes,Common Parameters,API Reference", - "title":"Error Codes", - "githuburl":"" - }, - { - "uri":"elb_gc_0002.html", - "product_code":"elb", - "code":"176", - "des":"The following code descriptions are only suitable for shared load balancers.", - "doc_type":"api", - "kw":"HTTP Status Codes of Shared Load Balancers,Common Parameters,API Reference", - "title":"HTTP Status Codes of Shared Load Balancers", - "githuburl":"" - }, - { - "uri":"errorcode.html", - "product_code":"elb", - "code":"177", - "des":"The following code descriptions are only suitable for dedicated load balancers.", - "doc_type":"api", - "kw":"HTTP Status Codes for Dedicated Load Balancers,Common Parameters,API Reference", - "title":"HTTP Status Codes for Dedicated Load Balancers", - "githuburl":"" - }, - { - "uri":"elb_fl_0000.html", - "product_code":"elb", - "code":"178", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Appendix", - "title":"Appendix", - "githuburl":"" - }, - { - "uri":"elb_gc_1102.html", - "product_code":"elb", - "code":"179", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Status Codes,Appendix,API Reference", - "title":"Status Codes", - "githuburl":"" - }, - { - "uri":"elb_fl_0002.html", - "product_code":"elb", - "code":"180", - "des":"This section describes the metrics that can be monitored by Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the metr", - "doc_type":"api", - "kw":"ELB Metrics,Appendix,API Reference", - "title":"ELB Metrics", - "githuburl":"" - }, - { - "uri":"elb_fl_0003.html", - "product_code":"elb", - "code":"181", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"General Information About Shared Load Balancers", - "title":"General Information About Shared Load Balancers", - "githuburl":"" - }, - { - "uri":"elb_fl_0004.html", - "product_code":"elb", - "code":"182", - "des":"APIs v2.0 allow users to query data in pages by adding the limit and marker parameters to the URL of the list request. The query results are displayed in the ascending or", - "doc_type":"api", - "kw":"Querying Data in Pages,General Information About Shared Load Balancers,API Reference", - "title":"Querying Data in Pages", - "githuburl":"" - }, - { - "uri":"elb_fl_0005.html", - "product_code":"elb", - "code":"183", - "des":"APIs v2.0 enable the system to sort queried results based on customized keys by adding the sort_key and sort_dir parameters to the URL of the list request. sort_key speci", - "doc_type":"api", - "kw":"Sequencing Query Results,General Information About Shared Load Balancers,API Reference", - "title":"Sequencing Query Results", - "githuburl":"" - }, - { - "uri":"elb_fl_0007.html", - "product_code":"elb", - "code":"184", - "des":"The basic workflow of elastic load balancers contains the following: creating a load balancer, adding a listener to a specified load balancer, adding a backend server gro", - "doc_type":"api", - "kw":"Basic Workflow,General Information About Shared Load Balancers,API Reference", - "title":"Basic Workflow", - "githuburl":"" - }, - { - "uri":"elb_xd_0000.html", - "product_code":"elb", - "code":"185", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Change History,API Reference", - "title":"Change History", - "githuburl":"" - } + { + "uri":"elb_pro_0000.html", + "product_code":"elb", + "code":"1", + "des":"dummy desc", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", + "githuburl":"" + } ] diff --git a/docs/elb/api-ref/CLASS.TXT.json b/docs/elb/api-ref/CLASS.TXT.json index b20406813..1698f231f 100644 --- a/docs/elb/api-ref/CLASS.TXT.json +++ b/docs/elb/api-ref/CLASS.TXT.json @@ -1,1667 +1,11 @@ [ - { - "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", - "product_code":"elb", - "title":"API Usage Guidelines", - "uri":"en-us_topic_0022480177.html", - "doc_type":"api", - "p_code":"", - "code":"1" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Classic Load Balancer APIs", - "uri":"elb_jd_0000.html", - "doc_type":"api", - "p_code":"", - "code":"2" - }, - { - "desc":"Classic load balancers are not supported in the eu-nl region.", - "product_code":"elb", - "title":"API Call Precaution", - "uri":"en-us_topic_0000001124568811.html", - "doc_type":"api", - "p_code":"2", - "code":"3" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Load Balancer", - "uri":"elb_jd_fz_0000.html", - "doc_type":"api", - "p_code":"2", - "code":"4" - }, - { - "desc":"This API is used to create a load balancer.POST /v1.0/{project_id}/elbaas/loadbalancersRequest parametersParameter descriptionParameterMandatoryTypeDescriptionnameYesStri", - "product_code":"elb", - "title":"Creating a Load Balancer", - "uri":"elb_jd_fz_0001.html", - "doc_type":"api", - "p_code":"4", - "code":"5" - }, - { - "desc":"This API is used to delete a load balancer. If the load balancer is a public network load balancer, this API deletes the EIP bound to the load balancer.For a public netwo", - "product_code":"elb", - "title":"Deleting a Load Balancer", - "uri":"elb_jd_fz_0002.html", - "doc_type":"api", - "p_code":"4", - "code":"6" - }, - { - "desc":"This API is used to delete a public network load balancer. The EIP bound to the load balancer will not be deleted. If you need to delete this IP address, refer to Deletin", - "product_code":"elb", - "title":"Deleting a Public Network Load Balancer", - "uri":"elb_jd_fz_0003.html", - "doc_type":"api", - "p_code":"4", - "code":"7" - }, - { - "desc":"This API is used to modify the name, description, bandwidth, and administrative status of a load balancer.PUT /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}Req", - "product_code":"elb", - "title":"Modifying a Load Balancer", - "uri":"elb_jd_fz_0004.html", - "doc_type":"api", - "p_code":"4", - "code":"8" - }, - { - "desc":"This API is used to query details about a load balancer.GET /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}Request parametersNoneNoneExample requestNoneNoneResp", - "product_code":"elb", - "title":"Querying Details of a Load Balancer", - "uri":"elb_jd_fz_0005.html", - "doc_type":"api", - "p_code":"4", - "code":"9" - }, - { - "desc":"This API is used to query load balancers and display them in a list.GET /v1.0/{project_id}/elbaas/loadbalancersRequest parametersNoneNoneExample requestNoneNoneResponse p", - "product_code":"elb", - "title":"Querying Load Balancers", - "uri":"en-us_topic_0096561504.html", - "doc_type":"api", - "p_code":"4", - "code":"10" - }, - { - "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":"elb", - "title":"Listener", - "uri":"elb_jd_jt_0000.html", - "doc_type":"api", - "p_code":"2", - "code":"11" - }, - { - "desc":"This API is used to add a listener to a load balancer.POST /v1.0/{project_id}/elbaas/listenersRequest parametersNoneNoneExample request{\n \"name\": \"listener1\",\n \"des", - "product_code":"elb", - "title":"Adding a Listener", - "uri":"elb_jd_jt_0001.html", - "doc_type":"api", - "p_code":"11", - "code":"12" - }, - { - "desc":"This API is used to delete a listener.DELETE /v1.0/{project_id}/elbaas/listeners/{listener_id}Request parametersNoneNoneExample requestNoneNoneResponse parametersNoneNone", - "product_code":"elb", - "title":"Deleting a Listener", - "uri":"elb_jd_jt_0002.html", - "doc_type":"api", - "p_code":"11", - "code":"13" - }, - { - "desc":"This API is used to modify the listener information, including the listener name, description, and status.PUT /v1.0/{project_id}/elbaas/listeners/{listener_id}Request par", - "product_code":"elb", - "title":"Modifying a Listener", - "uri":"elb_jd_jt_0003.html", - "doc_type":"api", - "p_code":"11", - "code":"14" - }, - { - "desc":"This API is used to query details about a listener.GET /v1.0/{project_id}/elbaas/listeners/{listener_id}Request parametersNoneNoneExample requestNoneNoneResponse paramete", - "product_code":"elb", - "title":"Querying Details of a Listener", - "uri":"elb_jd_jt_0004.html", - "doc_type":"api", - "p_code":"11", - "code":"15" - }, - { - "desc":"This API is used to query listeners using search criteria and display them in a list.GET /v1.0/{project_id}/elbaas/listeners?loadbalancer_id={loadbalancer_id}Enter a ques", - "product_code":"elb", - "title":"Querying Listeners", - "uri":"elb_jd_jt_0005.html", - "doc_type":"api", - "p_code":"11", - "code":"16" - }, - { - "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":"elb", - "title":"Health Check", - "uri":"elb_jd_jk_0000.html", - "doc_type":"api", - "p_code":"2", - "code":"17" - }, - { - "desc":"This API is used to configure a health check for backend ECSs.POST /v1.0/{project_id}/elbaas/healthcheckRequest parametersNoneNoneExample request 1: Configuring an HTTP h", - "product_code":"elb", - "title":"Configuring a Health Check", - "uri":"elb_jd_jk_0001.html", - "doc_type":"api", - "p_code":"17", - "code":"18" - }, - { - "desc":"This API is used to delete a health check.DELETE /v1.0/{project_id}/elbaas/healthcheck/{healthcheck_id}Request parametersNoneNoneExample requestNoneNoneResponse parameter", - "product_code":"elb", - "title":"Deleting a Health Check", - "uri":"elb_jd_jk_0002.html", - "doc_type":"api", - "p_code":"17", - "code":"19" - }, - { - "desc":"This API is used to modify information about a health check.PUT /v1.0/{project_id}/elbaas/healthcheck/{healthcheck_id}Request parametersNoneNoneExample request{\n \"heal", - "product_code":"elb", - "title":"Modifying a Health Check", - "uri":"elb_jd_jk_0003.html", - "doc_type":"api", - "p_code":"17", - "code":"20" - }, - { - "desc":"This API is used to query details about a health check.GET /v1.0/{project_id}/elbaas/healthcheck/{healthcheck_id}Request parametersNoneNoneExample requestNoneNoneResponse", - "product_code":"elb", - "title":"Querying Details of a Health Check", - "uri":"elb_jd_jk_0004.html", - "doc_type":"api", - "p_code":"17", - "code":"21" - }, - { - "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":"elb", - "title":"Backend ECS", - "uri":"elb_jd_hd_0000.html", - "doc_type":"api", - "p_code":"2", - "code":"22" - }, - { - "desc":"This API is used to add backend ECSs to a listener for monitoring.To add backend ECSs to a UDP listener, IP addresses can be pinged and UDP services must be enabled.POST ", - "product_code":"elb", - "title":"Adding Backend ECSs", - "uri":"elb_jd_hd_0001.html", - "doc_type":"api", - "p_code":"22", - "code":"23" - }, - { - "desc":"This API is used to remove backend ECSs from a listener. Multiple backend ECSs can be removed concurrently.POST /v1.0/{project_id}/elbaas/listeners/{listener_id}/members/", - "product_code":"elb", - "title":"Removing Backend ECSs", - "uri":"elb_jd_hd_0002.html", - "doc_type":"api", - "p_code":"22", - "code":"24" - }, - { - "desc":"This API is used to query backend ECSs added to a listener. If you are the administrator, the backend ECS list will be empty.GET /v1.0/{project_id}/elbaas/listeners/{list", - "product_code":"elb", - "title":"Querying Backend ECSs", - "uri":"elb_jd_hd_0003.html", - "doc_type":"api", - "p_code":"22", - "code":"25" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Quota", - "uri":"elb_jd_pe_0000.html", - "doc_type":"api", - "p_code":"2", - "code":"26" - }, - { - "desc":"This API is used to query the load balancer or listener quotas.GET /v1.0/{project_id}/elbaas/quotasRequest parametersNoneNoneExample requestNoneNoneResponse parametersPar", - "product_code":"elb", - "title":"Querying Load Balancer or Listener Quotas", - "uri":"elb_jd_pe_0001.html", - "doc_type":"api", - "p_code":"26", - "code":"27" - }, - { - "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":"elb", - "title":"Certificate", - "uri":"elb_jd_zs_0000.html", - "doc_type":"api", - "p_code":"2", - "code":"28" - }, - { - "desc":"This API is used to create a certificate for an HTTPS listener.POST /v1.0/{project_id}/elbaas/certificateRequest parametersNoneNoneExample request{\n \"name\": \"cert-bky\"", - "product_code":"elb", - "title":"Creating a Certificate", - "uri":"elb_jd_zs_0001.html", - "doc_type":"api", - "p_code":"28", - "code":"29" - }, - { - "desc":"This API is used to delete a certificate.DELETE /v1.0/{project_id}/elbaas/certificate/{certificate_id}Request parametersNoneNoneExample requestNoneNoneResponse parameters", - "product_code":"elb", - "title":"Deleting a Certificate", - "uri":"elb_jd_zs_0002.html", - "doc_type":"api", - "p_code":"28", - "code":"30" - }, - { - "desc":"This API is used to modify the name and description of a certificate.PUT /v1.0/{project_id}/elbaas/certificate/{certificate_id}Request parametersNoneNoneExample request{\n", - "product_code":"elb", - "title":"Modifying a Certificate", - "uri":"elb_jd_zs_0003.html", - "doc_type":"api", - "p_code":"28", - "code":"31" - }, - { - "desc":"This API is used to query all the certificates.GET /v1.0/{project_id}/elbaas/certificateRequest parametersNoneNoneExample requestNoneNoneResponse parametersResponse param", - "product_code":"elb", - "title":"Querying Certificates", - "uri":"elb_jd_zs_0004.html", - "doc_type":"api", - "p_code":"28", - "code":"32" - }, - { - "desc":"This API is used to query the job status, such as the execution status of creating or deleting a load balancer.GET /v1.0/{project_id}/jobs/{job_id}Request parametersNoneN", - "product_code":"elb", - "title":"Querying the Job Status", - "uri":"elb_jd_job_0000.html", - "doc_type":"api", - "p_code":"2", - "code":"33" - }, - { - "desc":"This API is used to query all metrics at Layer 4 and Layer 7.Only users can query these metrics.GET /v1.0/{project_id}/elbaas/monitorRequest parametersNoneNoneExample req", - "product_code":"elb", - "title":"Querying Monitoring Metrics", - "uri":"elb_jd_cj_0000.html", - "doc_type":"api", - "p_code":"2", - "code":"34" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"API Version", - "uri":"elb_jd_bg_0000.html", - "doc_type":"api", - "p_code":"2", - "code":"35" - }, - { - "desc":"This API is used to query all API versions of ELB.GET /Request parametersNoneNoneExample requestNoneNoneResponse parametersParameter descriptionParameterTypeDescriptionve", - "product_code":"elb", - "title":"Querying All API Versions", - "uri":"elb_jd_bg_0001.html", - "doc_type":"api", - "p_code":"35", - "code":"36" - }, - { - "desc":"This API is used to query a specific ELB API version.GET /{api_version}Example/v1.0/v1.0Request parametersNoneNoneExample requestNoneNoneResponse parametersResponse param", - "product_code":"elb", - "title":"Querying a Specific API Version", - "uri":"elb_jd_bg_0002.html", - "doc_type":"api", - "p_code":"35", - "code":"37" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Shared Load Balancer APIs", - "uri":"elb_zq_0000.html", - "doc_type":"api", - "p_code":"", - "code":"38" - }, - { - "desc":"By default, load balancers created in the eu-de region are shared load balancers. APIs for shared load balancers are only available in this region. Shared load balancers ", - "product_code":"elb", - "title":"API Call Precaution", - "uri":"en-us_topic_0000001088335195.html", - "doc_type":"api", - "p_code":"38", - "code":"39" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Load Balancer", - "uri":"elb_zq_fz_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"40" - }, - { - "desc":"This API is used to create a private network load balancer. After the load balancer is created, its details, such as load balancer ID, IP address, and subnet ID, are retu", - "product_code":"elb", - "title":"Creating a Load Balancer", - "uri":"en-us_topic_0096561535.html", - "doc_type":"api", - "p_code":"40", - "code":"41" - }, - { - "desc":"This API is used to query load balancers and display them in a list. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.P", - "product_code":"elb", - "title":"Querying Load Balancers", - "uri":"elb_zq_fz_0002.html", - "doc_type":"api", - "p_code":"40", - "code":"42" - }, - { - "desc":"See HTTP Status Codes of Shared Load Balancers.", - "product_code":"elb", - "title":"Querying Details of a Load Balancer", - "uri":"en-us_topic_0141008271.html", - "doc_type":"api", - "p_code":"40", - "code":"43" - }, - { - "desc":"This API is used to query the status tree of a load balancer. You can use this API to query details about the associated listeners, backend server groups, backend servers", - "product_code":"elb", - "title":"Querying the Status Tree of a Load Balancer", - "uri":"elb_zq_fz_0004.html", - "doc_type":"api", - "p_code":"40", - "code":"44" - }, - { - "desc":"This API is used to update the name or description of a load balancer.PUT /v2.0/lbaas/loadbalancers/{loadbalancer_id}Example request: Modifying the load balancer name and", - "product_code":"elb", - "title":"Updating a Load Balancer", - "uri":"elb_zq_fz_0005.html", - "doc_type":"api", - "p_code":"40", - "code":"45" - }, - { - "desc":"This API is used to delete a specific load balancer.All listeners added to the load balancer must be deleted before the load balancer is deleted.DELETE /v2.0/lbaas/loadba", - "product_code":"elb", - "title":"Deleting a Load Balancer", - "uri":"elb_zq_fz_0006.html", - "doc_type":"api", - "p_code":"40", - "code":"46" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Listener", - "uri":"elb_zq_jt_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"47" - }, - { - "desc":"This API is used to add a listener to a load balancer.When protocol is set to TCP and protocol_port to 0, the listener works in IP mode (DR mode).POST /v2.0/lbaas/listene", - "product_code":"elb", - "title":"Adding a Listener", - "uri":"elb_zq_jt_0001.html", - "doc_type":"api", - "p_code":"47", - "code":"48" - }, - { - "desc":"This API is used to query the listeners and display them in a list. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Yo", - "product_code":"elb", - "title":"Querying Listeners", - "uri":"elb_zq_jt_0002.html", - "doc_type":"api", - "p_code":"47", - "code":"49" - }, - { - "desc":"This API is used to query details about a listener using its ID.GET /v2.0/lbaas/listeners/{listener_id}NoneExample request: Viewing details of a listenerGET https://{Endp", - "product_code":"elb", - "title":"Querying Details of a Listener", - "uri":"elb_zq_jt_0003.html", - "doc_type":"api", - "p_code":"47", - "code":"50" - }, - { - "desc":"This API is used to update a listener, such as listener name, description, associated backend server groups, and server certificates.If the provisioning status of the ass", - "product_code":"elb", - "title":"Updating a Listener", - "uri":"elb_zq_jt_0004.html", - "doc_type":"api", - "p_code":"47", - "code":"51" - }, - { - "desc":"This API is used to delete a listener by ID.All backend server groups associated with the listener must be deleted before the listener is deleted.DELETE /v2.0/lbaas/liste", - "product_code":"elb", - "title":"Deleting a Listener", - "uri":"elb_zq_jt_0005.html", - "doc_type":"api", - "p_code":"47", - "code":"52" - }, - { - "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":"elb", - "title":"Backend Server Group", - "uri":"elb_zq_hz_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"53" - }, - { - "desc":"This API is used to add a backend server group. After multiple backend servers are added to a backend server group, requests are distributed among backend servers based o", - "product_code":"elb", - "title":"Adding a Backend Server Group", - "uri":"elb_zq_hz_0001.html", - "doc_type":"api", - "p_code":"53", - "code":"54" - }, - { - "desc":"Example request 1: Adding a backend server group with the sticky session feature disabledPOST https://{Endpoint}/v2.0/lbaas/pools \n\n{\n \"pool\": {\n \"lb_algorithm\"", - "product_code":"elb", - "title":"Querying Backend Server Groups", - "uri":"en-us_topic_0096561547.html", - "doc_type":"api", - "p_code":"53", - "code":"55" - }, - { - "desc":"This API is used to query details about a backend server group using its ID.GET /v2.0/lbaas/pools/{pool_id}NoneExample request: Querying details of a backend server group", - "product_code":"elb", - "title":"Querying Details of a Backend Server Group", - "uri":"elb_zq_hz_0003.html", - "doc_type":"api", - "p_code":"53", - "code":"56" - }, - { - "desc":"This API is used to update a backend server group.If the provisioning status of the load balancer associated with a backend server group is not ACTIVE, the backend server", - "product_code":"elb", - "title":"Updating a Backend Server Group", - "uri":"elb_zq_hz_0004.html", - "doc_type":"api", - "p_code":"53", - "code":"57" - }, - { - "desc":"This API is used to delete a backend server group.Before deleting a backend server group, remove all backend servers, delete the health check, and disassociate forwarding", - "product_code":"elb", - "title":"Deleting a Backend Server Group", - "uri":"elb_zq_hz_0005.html", - "doc_type":"api", - "p_code":"53", - "code":"58" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Backend Server", - "uri":"elb_zq_hd_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"59" - }, - { - "desc":"This API is used to add a backend server to a specific backend server group. After a backend server group is added to a listener, traffic is distributed to backend server", - "product_code":"elb", - "title":"Adding a Backend Server", - "uri":"elb_zq_hd_0001.html", - "doc_type":"api", - "p_code":"59", - "code":"60" - }, - { - "desc":"This API is used to query backend servers in a specific backend server group. Filter query and pagination query are supported. Unless otherwise specified, exact match is ", - "product_code":"elb", - "title":"Querying Backend Servers", - "uri":"elb_zq_hd_0002.html", - "doc_type":"api", - "p_code":"59", - "code":"61" - }, - { - "desc":"This API is used to query details about a backend server.GET /v2.0/lbaas/pools/{pool_id}/members/{member_id}NoneExample request: Querying details of a backend serverGET h", - "product_code":"elb", - "title":"Querying Details of a Backend Server", - "uri":"elb_zq_hd_0003.html", - "doc_type":"api", - "p_code":"59", - "code":"62" - }, - { - "desc":"This API is used to update a backend server. You can modify its name and weight. You can set a larger weight for backend servers that can receive more traffic.If the prov", - "product_code":"elb", - "title":"Updating a Backend Server", - "uri":"elb_zq_hd_0004.html", - "doc_type":"api", - "p_code":"59", - "code":"63" - }, - { - "desc":"This API is used to remove a backend server by its ID.After you remove a backend server, new connections to this server will not be established. However, long connections", - "product_code":"elb", - "title":"Removing a Backend Server", - "uri":"elb_zq_hd_0005.html", - "doc_type":"api", - "p_code":"59", - "code":"64" - }, - { - "desc":"This API is used to query all backend servers. Filter query and pagination query are supported.Parameters marker, limit, and page_reverse are used for pagination query. P", - "product_code":"elb", - "title":"Querying All Backend Servers (Extension API)", - "uri":"elb_zq_hd_0006.html", - "doc_type":"api", - "p_code":"59", - "code":"65" - }, - { - "desc":"This API is used to update backend servers in batches.A maximum of 200 backend servers can be modified at a time.Two backend servers a backend server group cannot have th", - "product_code":"elb", - "title":"Batch Updating Backend Servers", - "uri":"elb_zq_hd_0007.html", - "doc_type":"api", - "p_code":"59", - "code":"66" - }, - { - "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":"elb", - "title":"Health Check", - "uri":"elb_zq_jk_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"67" - }, - { - "desc":"This API is used to configure a health check for a backend server group to check the status of backend servers. If the health check result is OFFLINE, backend servers are", - "product_code":"elb", - "title":"Configuring a Health Check", - "uri":"elb_zq_jk_0001.html", - "doc_type":"api", - "p_code":"67", - "code":"68" - }, - { - "desc":"This API is used to query the health checks. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.GET /v2.0/lbaas/healthmon", - "product_code":"elb", - "title":"Querying Health Checks", - "uri":"elb_zq_jk_0002.html", - "doc_type":"api", - "p_code":"67", - "code":"69" - }, - { - "desc":"This API is used to query details about a health check using its iD.GET /v2.0/lbaas/healthmonitors/{healthmonitor_id}NoneExample request: Querying details of a health che", - "product_code":"elb", - "title":"Querying Details of a Health Check", - "uri":"elb_zq_jk_0003.html", - "doc_type":"api", - "p_code":"67", - "code":"70" - }, - { - "desc":"This API is used to update a health check.If provisioning_status of the load balancer for which the health check is configured is not ACTIVE, the health check cannot be u", - "product_code":"elb", - "title":"Updating a Health Check", - "uri":"elb_zq_jk_0004.html", - "doc_type":"api", - "p_code":"67", - "code":"71" - }, - { - "desc":"This API is used to delete a health check.If provisioning_status of the load balancer for which the health check is configured is not ACTIVE, the health check cannot be d", - "product_code":"elb", - "title":"Deleting a Health Check", - "uri":"elb_zq_jk_0005.html", - "doc_type":"api", - "p_code":"67", - "code":"72" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Forwarding Policy", - "uri":"elb_zq_zf_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"73" - }, - { - "desc":"This API is used to add a forwarding policy. The listener and forwarding policy determine how traffic is forwarded to backend servers.By matching the URL or domain name s", - "product_code":"elb", - "title":"Adding a Forwarding Policy", - "uri":"elb_zq_zf_0001.html", - "doc_type":"api", - "p_code":"73", - "code":"74" - }, - { - "desc":"This API is used to query the forwarding policies. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Parameters marker, ", - "product_code":"elb", - "title":"Querying Forwarding Policies", - "uri":"elb_zq_zf_0002.html", - "doc_type":"api", - "p_code":"73", - "code":"75" - }, - { - "desc":"This API is used to query details about a forwarding policy.GET /v2.0/lbaas/l7policies/{l7policy_id}NoneExample request: Querying details of a forwarding policyGET https:", - "product_code":"elb", - "title":"Querying Details of a Forwarding Policy", - "uri":"elb_zq_zf_0003.html", - "doc_type":"api", - "p_code":"73", - "code":"76" - }, - { - "desc":"This API is used to update a forwarding policy. You can select another backend server group or redirect to another HTTPS listener.PUT /v2.0/lbaas/l7policies/{l7policy_id}", - "product_code":"elb", - "title":"Updating a Forwarding Policy", - "uri":"elb_zq_zf_0004.html", - "doc_type":"api", - "p_code":"73", - "code":"77" - }, - { - "desc":"This API is used to delete a specific forwarding policy.DELETE /v2.0/lbaas/l7policies/{l7policy_id}NoneNoneExample request: Deleting a forwarding policyDELETE https://{En", - "product_code":"elb", - "title":"Deleting a Forwarding Policy", - "uri":"elb_zq_zf_0005.html", - "doc_type":"api", - "p_code":"73", - "code":"78" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Forwarding Rule", - "uri":"elb_zq_zg_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"79" - }, - { - "desc":"This API is used to add a forwarding rule. After you add a forwarding rule, the load balancer matches the domain name and path in the request and distributes the traffic ", - "product_code":"elb", - "title":"Adding a Forwarding Rule", - "uri":"elb_zq_zg_0001.html", - "doc_type":"api", - "p_code":"79", - "code":"80" - }, - { - "desc":"This API is used to query forwarding rules. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Parameters marker, limit, ", - "product_code":"elb", - "title":"Querying Forwarding Rules", - "uri":"elb_zq_zg_0002.html", - "doc_type":"api", - "p_code":"79", - "code":"81" - }, - { - "desc":"This API is used to query details about a forwarding rule using its ID.GET /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}NoneExample request: Querying details of ", - "product_code":"elb", - "title":"Querying Details of a Forwarding Rule", - "uri":"elb_zq_zg_0003.html", - "doc_type":"api", - "p_code":"79", - "code":"82" - }, - { - "desc":"This API is used to update a forwarding rule. You can change the mode that how traffic is distributed by updating the forwarding rule.PUT /v2.0/lbaas/l7policies/{l7policy", - "product_code":"elb", - "title":"Updating a Forwarding Rule", - "uri":"elb_zq_zg_0004.html", - "doc_type":"api", - "p_code":"79", - "code":"83" - }, - { - "desc":"This API is used to delete a specific forwarding rule.DELETE /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}NoneNoneExample request: Deleting a forwarding ruleDELE", - "product_code":"elb", - "title":"Deleting a Forwarding Rule", - "uri":"elb_zq_zg_0005.html", - "doc_type":"api", - "p_code":"79", - "code":"84" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", - "title":"Whitelist", - "uri":"elb_zq_bm_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"85" - }, - { - "desc":"This API is used to add a whitelist to control access to a specific listener. After a whitelist is added, only IP addresses in the whitelist can access the listener.POST ", - "product_code":"elb", - "title":"Adding a Whitelist", - "uri":"elb_zq_bm_0001.html", - "doc_type":"api", - "p_code":"85", - "code":"86" - }, - { - "desc":"This API is used to query the whitelists. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Parameters marker, limit, an", - "product_code":"elb", - "title":"Querying Whitelists", - "uri":"elb_zq_bm_0002.html", - "doc_type":"api", - "p_code":"85", - "code":"87" - }, - { - "desc":"This API is used to query details about a whitelist using its ID.GET /v2.0/lbaas/whitelists/{whitelist_id}NoneExample request: Querying details of a whitelistGET https://", - "product_code":"elb", - "title":"Querying Details of a Whitelist", - "uri":"elb_zq_bm_0003.html", - "doc_type":"api", - "p_code":"85", - "code":"88" - }, - { - "desc":"This API is used to update a whitelist. You can enable or disable the whitelist function or change IP addresses in the whitelist. If you change IP addresses in the whitel", - "product_code":"elb", - "title":"Updating a Whitelist", - "uri":"elb_zq_bm_0004.html", - "doc_type":"api", - "p_code":"85", - "code":"89" - }, - { - "desc":"This API is used to delete a specific whitelist.DELETE /v2.0/lbaas/whitelists/{whitelist_id}NoneNoneExample request: Deleting a whitelistDELETE https://{Endpoint}/v2.0/lb", - "product_code":"elb", - "title":"Deleting a Whitelist", - "uri":"elb_zq_bm_0005.html", - "doc_type":"api", - "p_code":"85", - "code":"90" - }, - { - "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":"elb", - "title":"Certificate", - "uri":"elb_zq_zs_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"91" - }, - { - "desc":"This API is used to create a certificate. After a certificate is bound to a listener, the load balancer authenticates the client using this certificate, and backend serve", - "product_code":"elb", - "title":"Creating a Certificate", - "uri":"elb_zq_zs_0001.html", - "doc_type":"api", - "p_code":"91", - "code":"92" - }, - { - "desc":"This API is used to query all the certificates. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.Parameters marker, lim", - "product_code":"elb", - "title":"Querying Certificates", - "uri":"elb_zq_zs_0002.html", - "doc_type":"api", - "p_code":"91", - "code":"93" - }, - { - "desc":"This API is used to query details about a certificate.GET /v2.0/lbaas/certificates/{certificate_id}NoneExample request: Querying details of a certificateGET https://{Endp", - "product_code":"elb", - "title":"Querying Details of a Certificate", - "uri":"elb_zq_zs_0003.html", - "doc_type":"api", - "p_code":"91", - "code":"94" - }, - { - "desc":"This API is used to update a certificate.PUT /v2.0/lbaas/certificates/{certificate_id}Example request: Updating a certificatePUT https://{Endpoint}/v2.0/lbaas/certificate", - "product_code":"elb", - "title":"Updating a Certificate", - "uri":"elb_zq_zs_0004.html", - "doc_type":"api", - "p_code":"91", - "code":"95" - }, - { - "desc":"This API is used to delete a specific certificate.If the target certificate is used by a listener, the certificate cannot be deleted, and 409 code will be displayed.DELET", - "product_code":"elb", - "title":"Deleting a Certificate", - "uri":"elb_zq_zs_0005.html", - "doc_type":"api", - "p_code":"91", - "code":"96" - }, - { - "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":"elb", - "title":"Tag", - "uri":"elb_zq_bq_0000.html", - "doc_type":"api", - "p_code":"38", - "code":"97" - }, - { - "desc":"This API is used to add a tag to a specific load balancer for easier management.You can also use this API for dedicated load balancers.A maximum of 20 tags can be added t", - "product_code":"elb", - "title":"Adding a Tag to a Load Balancer", - "uri":"elb_zq_bq_0001.html", - "doc_type":"api", - "p_code":"97", - "code":"98" - }, - { - "desc":"This API is used to batch add tags to or delete tags from a load balancer.You can also use this API for dedicated load balancers.A maximum of 20 tags can be added to a lo", - "product_code":"elb", - "title":"Batch Adding or Deleting Load Balancer Tags", - "uri":"elb_zq_bq_0002.html", - "doc_type":"api", - "p_code":"97", - "code":"99" - }, - { - "desc":"This API is used to query all the tags of one load balancer.You can also use this API for dedicated load balancers.GET /v2.0/{project_id}/loadbalancers/{loadbalancer_id}/", - "product_code":"elb", - "title":"Querying All Tags of a Load Balancer", - "uri":"elb_zq_bq_0003.html", - "doc_type":"api", - "p_code":"97", - "code":"100" - }, - { - "desc":"This API is used to query the tags of all the load balancers.You can also use this API for dedicated load balancers.GET /v2.0/{project_id}/loadbalancers/tagsNoneExample r", - "product_code":"elb", - "title":"Querying the Tags of All Load Balancers", - "uri":"elb_zq_bq_0004.html", - "doc_type":"api", - "p_code":"97", - "code":"101" - }, - { - "desc":"This API is used to query load balancers using tags.You can also use this API for dedicated load balancers.NonePOST /v2.0/{project_id}/loadbalancers/resource_instances/ac", - "product_code":"elb", - "title":"Querying Load Balancers by Tag", - "uri":"elb_zq_bq_0005.html", - "doc_type":"api", - "p_code":"97", - "code":"102" - }, - { - "desc":"This API is used to delete a tag with a specific key from a load balancer.You can also use this API for dedicated load balancers.NoneDELETE /v2.0/{project_id}/loadbalance", - "product_code":"elb", - "title":"Deleting a Tag from a Load Balancer", - "uri":"elb_zq_bq_0006.html", - "doc_type":"api", - "p_code":"97", - "code":"103" - }, - { - "desc":"This API is used to add a tag to a specific listener.You can also use this API for dedicated load balancers.A maximum of 20 tags can be added to a listener.Note the follo", - "product_code":"elb", - "title":"Adding a Tag to a Listener", - "uri":"elb_zq_bq_0007.html", - "doc_type":"api", - "p_code":"97", - "code":"104" - }, - { - "desc":"This API is used to batch add tags to or delete tags from a listener.You can also use this API for dedicated load balancers.A maximum of 20 tags can be added to a listene", - "product_code":"elb", - "title":"Batch Adding or Deleting Listener Tags", - "uri":"elb_zq_bq_0008.html", - "doc_type":"api", - "p_code":"97", - "code":"105" - }, - { - "desc":"This API is used to query all tags of one listener.You can also use this API for dedicated load balancers.NoneGET /v2.0/{project_id}/listeners/{listener_id}/tagsNoneExamp", - "product_code":"elb", - "title":"Querying All Tags of a Listener", - "uri":"elb_zq_bq_0009.html", - "doc_type":"api", - "p_code":"97", - "code":"106" - }, - { - "desc":"This API is used to query the tags of all listeners.You can also use this API for dedicated load balancers.NoneGET /v2.0/{project_id}/listeners/tagsNoneExample requestGET", - "product_code":"elb", - "title":"Querying the Tags of All Listeners", - "uri":"elb_zq_bq_0010.html", - "doc_type":"api", - "p_code":"97", - "code":"107" - }, - { - "desc":"This API is used to query listeners by tag.You can also use this API for dedicated load balancers.NonePOST /v2.0/{project_id}/listeners/resource_instances/actionExample r", - "product_code":"elb", - "title":"Querying Listeners by Tag", - "uri":"elb_zq_bq_0011.html", - "doc_type":"api", - "p_code":"97", - "code":"108" - }, - { - "desc":"This API is used to delete a tag with a specific key from a listener.You can also use this API for dedicated load balancers.NoneDELETE /v2.0/{project_id}/listeners/{liste", - "product_code":"elb", - "title":"Deleting a Tag from a Listener", - "uri":"elb_zq_bq_0012.html", - "doc_type":"api", - "p_code":"97", - "code":"109" - }, - { - "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":"elb", - "title":"Status Codes", - "uri":"elb_zq_bq_0013.html", - "doc_type":"api", - "p_code":"97", - "code":"110" - }, - { - "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":"elb", - "title":"Dedicated Load Balancer APIs", - "uri":"elb_dx_0000.html", - "doc_type":"api", - "p_code":"", - "code":"111" - }, - { - "desc":"By default, load balancers created in the eu-nl region are dedicated load balancers. APIs for dedicated load balancers are only available in this region. Shared load bala", - "product_code":"elb", - "title":"API Call Precaution", - "uri":"en-us_topic_0000001088310753.html", - "doc_type":"api", - "p_code":"111", - "code":"112" - }, - { - "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":"elb", - "title":"Quota", - "uri":"topic_300000000.html", - "doc_type":"api", - "p_code":"111", - "code":"113" - }, - { - "desc":"This API is used to query resource quotas of a specific user.GET /v3/{project_id}/elb/quotasStatus code: 200Status code: 200Successful request.See Error Codes.", - "product_code":"elb", - "title":"Querying Quotas", - "uri":"ShowQuota.html", - "doc_type":"api", - "p_code":"113", - "code":"114" - }, - { - "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":"elb", - "title":"AZ", - "uri":"topic_300000001.html", - "doc_type":"api", - "p_code":"111", - "code":"115" - }, - { - "desc":"This API is used to query all available AZs when you create a dedicated load balancer.One set of AZs is returned. When you create a dedicated load balancer, you can selec", - "product_code":"elb", - "title":"Querying AZs", - "uri":"ListAvailabilityZones.html", - "doc_type":"api", - "p_code":"115", - "code":"116" - }, - { - "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":"elb", - "title":"Load Balancer Flavor", - "uri":"topic_300000002.html", - "doc_type":"api", - "p_code":"111", - "code":"117" - }, - { - "desc":"This API is used to query all load balancer flavors that are available to a specific user in a specific region.Parameters marker, limit, and page_reverse are used for pag", - "product_code":"elb", - "title":"Querying Flavors", - "uri":"ListFlavors.html", - "doc_type":"api", - "p_code":"117", - "code":"118" - }, - { - "desc":"This API is used to view details of a flavor.This API can only be used to view the details of a flavor.GET /v3/{project_id}/elb/flavors/{flavor_id}Status code: 200Status ", - "product_code":"elb", - "title":"Viewing Details of a Flavor", - "uri":"ShowFlavor.html", - "doc_type":"api", - "p_code":"117", - "code":"119" - }, - { - "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":"elb", - "title":"Load Balancer", - "uri":"topic_300000003.html", - "doc_type":"api", - "p_code":"111", - "code":"120" - }, - { - "desc":"This API is used to create a dedicated load balancer. When you create the load balancer, note the following:Specify both vip_subnet_cidr_id and vip_address if you want to", - "product_code":"elb", - "title":"Creating a Load Balancer", - "uri":"CreateLoadBalancer.html", - "doc_type":"api", - "p_code":"120", - "code":"121" - }, - { - "desc":"This API is used to query all load balancers. Both filtered query and pagination query are supported.Parameters marker, limit, and page_reverse are used for pagination qu", - "product_code":"elb", - "title":"Querying Load Balancers", - "uri":"ListLoadBalancers.html", - "doc_type":"api", - "p_code":"120", - "code":"122" - }, - { - "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":"elb", - "title":"Viewing Details of a Load Balancer", - "uri":"ShowLoadBalancer.html", - "doc_type":"api", - "p_code":"120", - "code":"123" - }, - { - "desc":"This API is used to update a load balancer.PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}Status code: 200Status code: 200Successful request.See Error Codes.", - "product_code":"elb", - "title":"Updating a Load Balancer", - "uri":"UpdateLoadBalancer.html", - "doc_type":"api", - "p_code":"120", - "code":"124" - }, - { - "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":"elb", - "title":"Deleting a Load Balancer", - "uri":"DeleteLoadBalancer.html", - "doc_type":"api", - "p_code":"120", - "code":"125" - }, - { - "desc":"This API is used to query the status tree of a load balancer and show information about all resources associated with the load balancer.When admin_state_up is set to fals", - "product_code":"elb", - "title":"Querying the Status Tree of a Load Balancer", - "uri":"ShowLoadBalancerStatus.html", - "doc_type":"api", - "p_code":"120", - "code":"126" - }, - { - "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":"elb", - "title":"Certificate", - "uri":"topic_300000004.html", - "doc_type":"api", - "p_code":"111", - "code":"127" - }, - { - "desc":"This API is used to create an SSL certificate.POST /v3/{project_id}/elb/certificatesStatus code: 201Status code: 201Successful request.See Error Codes.", - "product_code":"elb", - "title":"Creating a Certificate", - "uri":"CreateCertificate.html", - "doc_type":"api", - "p_code":"127", - "code":"128" - }, - { - "desc":"This API is used to query all SSL certificates.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect onl", - "product_code":"elb", - "title":"Querying Certificates", - "uri":"ListCertificates.html", - "doc_type":"api", - "p_code":"127", - "code":"129" - }, - { - "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":"elb", - "title":"Viewing Details of a Certificate", - "uri":"ShowCertificate.html", - "doc_type":"api", - "p_code":"127", - "code":"130" - }, - { - "desc":"This API is used to update an SSL certificate.PUT /v3/{project_id}/elb/certificates/{certificate_id}Status code: 200Status code: 200Successful request.See Error Codes.", - "product_code":"elb", - "title":"Updating a Certificate", - "uri":"UpdateCertificate.html", - "doc_type":"api", - "p_code":"127", - "code":"131" - }, - { - "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":"elb", - "title":"Deleting a Certificate", - "uri":"DeleteCertificate.html", - "doc_type":"api", - "p_code":"127", - "code":"132" - }, - { - "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":"elb", - "title":"Listener", - "uri":"topic_300000005.html", - "doc_type":"api", - "p_code":"111", - "code":"133" - }, - { - "desc":"This API is used to add a listener to a load balancer.Only the administrator can specify connection_limit.The listener protocol can be TCP, HTTP, UDP, or HTTPS.The listen", - "product_code":"elb", - "title":"Adding a Listener", - "uri":"CreateListener.html", - "doc_type":"api", - "p_code":"133", - "code":"134" - }, - { - "desc":"This API is used to query listeners.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect only when they", - "product_code":"elb", - "title":"Querying Listeners", - "uri":"ListListeners.html", - "doc_type":"api", - "p_code":"133", - "code":"135" - }, - { - "desc":"This API is used to view details of a listener.GET /v3/{project_id}/elb/listeners/{listener_id}Status code: 200Status code: 200Successful request.See Error Codes.", - "product_code":"elb", - "title":"Viewing Details of a Listener", - "uri":"ShowListener.html", - "doc_type":"api", - "p_code":"133", - "code":"136" - }, - { - "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. Only th", - "product_code":"elb", - "title":"Updating a Listener", - "uri":"UpdateListener.html", - "doc_type":"api", - "p_code":"133", - "code":"137" - }, - { - "desc":"This API is used to delete a listener.Before you delete a listener, delete the associated backend server group or disassociate the backend server group from the listener,", - "product_code":"elb", - "title":"Deleting a Listener", - "uri":"DeleteListener.html", - "doc_type":"api", - "p_code":"133", - "code":"138" - }, - { - "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":"elb", - "title":"Backend Server Group", - "uri":"topic_300000006.html", - "doc_type":"api", - "p_code":"111", - "code":"139" - }, - { - "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", - "p_code":"139", - "code":"140" - }, - { - "desc":"This API is used to query all backend server groups.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effec", - "product_code":"elb", - "title":"Querying Backend Server Groups", - "uri":"ListPools.html", - "doc_type":"api", - "p_code":"139", - "code":"141" - }, - { - "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":"elb", - "title":"Viewing Details of a Backend Server Group", - "uri":"ShowPool.html", - "doc_type":"api", - "p_code":"139", - "code":"142" - }, - { - "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":"elb", - "title":"Updating a Backend Server Group", - "uri":"UpdatePool.html", - "doc_type":"api", - "p_code":"139", - "code":"143" - }, - { - "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":"elb", - "title":"Deleting a Backend Server Group", - "uri":"DeletePool.html", - "doc_type":"api", - "p_code":"139", - "code":"144" - }, - { - "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":"elb", - "title":"Backend Server", - "uri":"topic_300000007.html", - "doc_type":"api", - "p_code":"111", - "code":"145" - }, - { - "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":"elb", - "title":"Adding a Backend Server", - "uri":"CreateMember.html", - "doc_type":"api", - "p_code":"145", - "code":"146" - }, - { - "desc":"This API is used to query all backend servers.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect only", - "product_code":"elb", - "title":"Querying Backend Servers", - "uri":"ListMembers.html", - "doc_type":"api", - "p_code":"145", - "code":"147" - }, - { - "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":"elb", - "title":"Viewing Details of a Backend Server", - "uri":"ShowMember.html", - "doc_type":"api", - "p_code":"145", - "code":"148" - }, - { - "desc":"The backend server can be updated only when the provisioning status of the associated load balancer is ACTIVE.PUT /v3/{project_id}/elb/pools/{pool_id}/members/{member_id}", - "product_code":"elb", - "title":"Updating a Backend Server", - "uri":"UpdateMember.html", - "doc_type":"api", - "p_code":"145", - "code":"149" - }, - { - "desc":"This API is used to remove a backend server.When you remove backend servers, note the following:After you remove a backend server, new connections to this server will not", - "product_code":"elb", - "title":"Removing a Backend Server", - "uri":"DeleteMember.html", - "doc_type":"api", - "p_code":"145", - "code":"150" - }, - { - "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":"elb", - "title":"Health Check", - "uri":"topic_300000008.html", - "doc_type":"api", - "p_code":"111", - "code":"151" - }, - { - "desc":"This API is used to configure a health check.The security groups must have rules that allow access from 100.125.0.0/16. If you want to use UDP for health checks, ensure t", - "product_code":"elb", - "title":"Configuring a Health Check", - "uri":"CreateHealthMonitor.html", - "doc_type":"api", - "p_code":"151", - "code":"152" - }, - { - "desc":"This API is used to query all health checks.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect only w", - "product_code":"elb", - "title":"Querying Health Checks", - "uri":"ListHealthMonitors.html", - "doc_type":"api", - "p_code":"151", - "code":"153" - }, - { - "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":"elb", - "title":"Viewing Details of a Health Check", - "uri":"ShowHealthMonitor.html", - "doc_type":"api", - "p_code":"151", - "code":"154" - }, - { - "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":"elb", - "title":"Updating a Health Check", - "uri":"UpdateHealthMonitor.html", - "doc_type":"api", - "p_code":"151", - "code":"155" - }, - { - "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":"elb", - "title":"Deleting a Health Check", - "uri":"DeleteHealthMonitor.html", - "doc_type":"api", - "p_code":"151", - "code":"156" - }, - { - "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":"elb", - "title":"Forwarding Policy", - "uri":"topic_300000009.html", - "doc_type":"api", - "p_code":"111", - "code":"157" - }, - { - "desc":"This API is used to add a forwarding policy.The protocol of the listener to which requests are redirected can only be HTTPS.The listener associated with the forwarding po", - "product_code":"elb", - "title":"Adding a Forwarding Policy", - "uri":"CreateL7Policy.html", - "doc_type":"api", - "p_code":"157", - "code":"158" - }, - { - "desc":"This API is used to query all forwarding policies.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect ", - "product_code":"elb", - "title":"Querying Forwarding Policies", - "uri":"ListL7Policies.html", - "doc_type":"api", - "p_code":"157", - "code":"159" - }, - { - "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":"elb", - "title":"Viewing Details of a Forwarding Policy", - "uri":"ShowL7Policy.html", - "doc_type":"api", - "p_code":"157", - "code":"160" - }, - { - "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":"elb", - "title":"Updating a Forwarding Policy", - "uri":"UpdateL7Policy.html", - "doc_type":"api", - "p_code":"157", - "code":"161" - }, - { - "desc":"This API is used to delete a forwarding policy.DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}NoneNoneSee Error Codes.", - "product_code":"elb", - "title":"Deleting a Forwarding Policy", - "uri":"DeleteL7Policy.html", - "doc_type":"api", - "p_code":"157", - "code":"162" - }, - { - "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":"elb", - "title":"Forwarding Rule", - "uri":"topic_300000010.html", - "doc_type":"api", - "p_code":"111", - "code":"163" - }, - { - "desc":"This API is used to add a forwarding rule.POST /v3/{project_id}/elb/l7policies/{l7policy_id}/rulesStatus code: 201Status code: 201Successful request.See Error Codes.", - "product_code":"elb", - "title":"Adding a Forwarding Rule", - "uri":"CreateL7Rule.html", - "doc_type":"api", - "p_code":"163", - "code":"164" - }, - { - "desc":"This API is used to query all forwarding rules.Parameters marker, limit, and page_reverse are used for pagination query.Parameters marker and page_reverse take effect onl", - "product_code":"elb", - "title":"Querying Forwarding Rules", - "uri":"ListL7Rules.html", - "doc_type":"api", - "p_code":"163", - "code":"165" - }, - { - "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: 200Successful reques", - "product_code":"elb", - "title":"Viewing Details of a Forwarding Rule", - "uri":"ShowL7Rule.html", - "doc_type":"api", - "p_code":"163", - "code":"166" - }, - { - "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":"elb", - "title":"Updating a Forwarding Rule", - "uri":"UpdateL7Rule.html", - "doc_type":"api", - "p_code":"163", - "code":"167" - }, - { - "desc":"This API is used to delete a forwarding rule.DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}NoneNoneSee Error Codes.", - "product_code":"elb", - "title":"Deleting a Forwarding Rule", - "uri":"DeleteL7Rule.html", - "doc_type":"api", - "p_code":"163", - "code":"168" - }, - { - "desc":"Queries all available versions.If there is no version added to the URL, all available versions are returned.GET /NoneNoneExample requestGET /Example response{\n \"version", - "product_code":"elb", - "title":"Querying Versions", - "uri":"elb_fl_0006.html", - "doc_type":"api", - "p_code":"", - "code":"169" - }, - { - "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":"elb", - "title":"Examples", - "uri":"elb_eg_v3_0000.html", - "doc_type":"api", - "p_code":"", - "code":"170" - }, - { - "desc":"Call APIs to create a dedicated load balancer and bind a new EIP to it.You have created a VPC and a subnet.Query the subnet you have created.Send GET https://{vpc_endpoin", - "product_code":"elb", - "title":"Creating a Dedicated Load Balancer and Binding a New EIP to It", - "uri":"en-us_topic_0000001127879251.html", - "doc_type":"api", - "p_code":"170", - "code":"171" - }, - { - "desc":"Call the API to add a listener to a dedicated load balancer.You have created a dedicated load balancer.You have obtained the ID of the dedicated load balancer.Add a liste", - "product_code":"elb", - "title":"Adding a Listener to a Dedicated Load Balancer", - "uri":"elb_eg_v3_0002.html", - "doc_type":"api", - "p_code":"170", - "code":"172" - }, - { - "desc":"Call APIs to delete a dedicated load balancer.Before you delete a dedicated load balancer, delete all resources associated with it. Figure 1 shows the associated resource", - "product_code":"elb", - "title":"Deleting a Dedicated Load Balancer", - "uri":"elb_eg_v3_0003.html", - "doc_type":"api", - "p_code":"170", - "code":"173" - }, - { - "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":"elb", - "title":"Common Parameters", - "uri":"elb_gc_0000.html", - "doc_type":"api", - "p_code":"", - "code":"174" - }, - { - "desc":"The following error code descriptions are only suitable for classic load balancers.If an error occurs when using an API, an error response will be returned, which contain", - "product_code":"elb", - "title":"Error Codes", - "uri":"elb_gc_0001.html", - "doc_type":"api", - "p_code":"174", - "code":"175" - }, - { - "desc":"The following code descriptions are only suitable for shared load balancers.", - "product_code":"elb", - "title":"HTTP Status Codes of Shared Load Balancers", - "uri":"elb_gc_0002.html", - "doc_type":"api", - "p_code":"174", - "code":"176" - }, - { - "desc":"The following code descriptions are only suitable for dedicated load balancers.", - "product_code":"elb", - "title":"HTTP Status Codes for Dedicated Load Balancers", - "uri":"errorcode.html", - "doc_type":"api", - "p_code":"174", - "code":"177" - }, - { - "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":"elb", - "title":"Appendix", - "uri":"elb_fl_0000.html", - "doc_type":"api", - "p_code":"", - "code":"178" - }, - { - "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":"elb", - "title":"Status Codes", - "uri":"elb_gc_1102.html", - "doc_type":"api", - "p_code":"178", - "code":"179" - }, - { - "desc":"This section describes the metrics that can be monitored by Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the metr", - "product_code":"elb", - "title":"ELB Metrics", - "uri":"elb_fl_0002.html", - "doc_type":"api", - "p_code":"178", - "code":"180" - }, - { - "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":"elb", - "title":"General Information About Shared Load Balancers", - "uri":"elb_fl_0003.html", - "doc_type":"api", - "p_code":"178", - "code":"181" - }, - { - "desc":"APIs v2.0 allow users to query data in pages by adding the limit and marker parameters to the URL of the list request. The query results are displayed in the ascending or", - "product_code":"elb", - "title":"Querying Data in Pages", - "uri":"elb_fl_0004.html", - "doc_type":"api", - "p_code":"181", - "code":"182" - }, - { - "desc":"APIs v2.0 enable the system to sort queried results based on customized keys by adding the sort_key and sort_dir parameters to the URL of the list request. sort_key speci", - "product_code":"elb", - "title":"Sequencing Query Results", - "uri":"elb_fl_0005.html", - "doc_type":"api", - "p_code":"181", - "code":"183" - }, - { - "desc":"The basic workflow of elastic load balancers contains the following: creating a load balancer, adding a listener to a specified load balancer, adding a backend server gro", - "product_code":"elb", - "title":"Basic Workflow", - "uri":"elb_fl_0007.html", - "doc_type":"api", - "p_code":"181", - "code":"184" - }, - { - "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":"elb", - "title":"Change History", - "uri":"elb_xd_0000.html", - "doc_type":"api", - "p_code":"", - "code":"185" - } -] \ No newline at end of file + { + "desc":"dummy", + "product_code":"elb", + "title":"API Usage Guidelines", + "uri":"elb_pro_0000.html", + "doc_type":"api", + "p_code":"", + "code":"1" + } +] diff --git a/docs/elb/api-ref/CreateCertificate.html b/docs/elb/api-ref/CreateCertificate.html deleted file mode 100644 index e68036c22..000000000 --- a/docs/elb/api-ref/CreateCertificate.html +++ /dev/null @@ -1,388 +0,0 @@ - - -

Creating a Certificate

-

Function

This API is used to create an SSL certificate.

- -

URI

POST /v3/{project_id}/elb/certificates

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID of the certificate.

-
- -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

certificate

-

Yes

-

CreateCertificateOption object

-

Specifies the certificate.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateCertificateOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

certificate

-

Yes

-

String

-

Specifies the private key of the certificate. The value must be PEM encoded.

-

description

-

No

-

String

-

Provides supplementary information about the certificate.

-

Minimum: 0

-

Maximum: 255

-

domain

-

No

-

String

-

Specifies the domain names used by the server certificate.

-

  • This parameter will take effect only when type is set to server, and its default value is "".

    -

  • This parameter will not take effect even if it is passed and type is set to client. However, domain names will still be verified.

    -
-

Note:

-

  • The value can contain 0 to 1024 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 30 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

    -
-

name

-

No

-

String

-

Specifies the certificate name. Only letters, digits, underscores, and hyphens are allowed.

-

Minimum: 0

-

Maximum: 255

-

private_key

-

No

-

String

-

Specifies the private key of the server certificate. The value must be PEM encoded.

-

  • This parameter will be ignored if type is set to client. A CA server can still be created and used normally. This parameter will be left blank even if you enter a private key that is not PEM encoded.

    -

  • This parameter is valid and mandatory only when type is set to server. If you enter an invalid private key, an error is returned.

    -
-

project_id

-

No

-

String

-

Specifies the ID of the project where the certificate is used.

-

Minimum: 1

-

Maximum: 32

-

type

-

No

-

String

-

Specifies the certificate type.

-

The value can be server or client. server indicates server certificates, and client indicates CA certificates. The default value is server.

-

enterprise_project_id

-

No

-

String

-

Specifies the enterprise project ID. The value cannot be "", "0", or the ID of an enterprise project that does not exist.

-

If this parameter is not passed during resource creation, the resource belongs to the default enterprise project.

-

This parameter is unsupported. Please do not use it.

-
- - -

Response Parameters

Status code: 201

- - - - - - - - - - - - - - - -
Table 5 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

certificate

-

CertificateInfo object

-

Specifies the certificate.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 CertificateInfo

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is unsupported. Please do not use it.

-

certificate

-

String

-

Specifies the private key of the certificate. The value must be PEM encoded.

-

description

-

String

-

Provides supplementary information about the certificate.

-

Minimum: 1

-

Maximum: 255

-

domain

-

String

-

Specifies the domain names used by the server certificate.

-

  • This parameter will take effect only when type is set to server, and its default value is "".

    -

  • This parameter will not take effect even if it is passed and type is set to client. However, domain names will still be verified.

    -
-

Note:

-

  • The value can contain 0 to 1024 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 30 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

    -
-

Minimum: 1

-

Maximum: 1024

-

id

-

String

-

Specifies a certificate ID.

-

name

-

String

-

Specifies the certificate name.

-

Minimum: 1

-

Maximum: 255

-

private_key

-

String

-

Specifies the private key of the server certificate. The value must be PEM encoded.

-

  • This parameter will be ignored if type is set to client. A CA server can still be created and used normally. This parameter will be left blank even if you enter a private key that is not PEM encoded.

    -

  • This parameter is valid and mandatory only when type is set to server. If you enter an invalid private key, an error is returned.

    -
-

type

-

String

-

Specifies the certificate type. The value can be server or client. server indicates server certificates, and client indicates CA certificates. The default value is server.

-

created_at

-

String

-

Specifies the time when the certificate was created.

-

updated_at

-

String

-

Specifies the time when the certificate was updated.

-

expire_time

-

String

-

Specifies the time when the certificate expires.

-

project_id

-

String

-

Specifies the project ID.

-
- - -

Example Requests

POST https://{elb_endponit}/v3/{project_id}/elb/certificates
-
-{
-  "certificate" : {
-    "name" : "My Certificate",
-    "type" : "server",
-    "private_key" : "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M\n253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPe\ntB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rM\nMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXt\nCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2Chl\nZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08k\nEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/Hl\nfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQB\nZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKr\nciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9M\nEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7Ale\nkrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CT\nXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kx\nGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dt\nJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLr\niWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZ\nlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBU\nxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB\n1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAd\nXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak\n/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4Vha\nfI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf\n7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9o\njHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIuk\nfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd\n3fy+1rCUwzOp9LSjtJYf4ege\n-----END PRIVATE KEY-----",
-    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD\nb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAG\nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\n0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5\nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh9\n7B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaS\nIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/K\ny09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0Wy\nYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29t\nhwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUA\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce+77s96i3I\n-----END CERTIFICATE-----"
-  }
-}
- -

Example Responses

Status code: 201

-

Successful request.

-
{
-  "certificate" : {
-    "id" : "233a325e5e3e4ce8beeb320aa714cc12",
-    "name" : "My Certificate",
-    "description" : "",
-    "admin_state_up" : true,
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "updated_at" : "2019-03-31T23:26:49Z",
-    "type" : "server",
-    "created_at" : "2019-03-31T22:23:51Z",
-    "expire_time" : "2045-11-17T13:25:47Z",
-    "private_key" : "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M\n253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPe\ntB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rM\nMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXt\nCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2Chl\nZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08k\nEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/Hl\nfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQB\nZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKr\nciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9M\nEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7Ale\nkrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CT\nXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kx\nGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dt\nJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLr\niWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZ\nlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBU\nxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB\n1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAd\nXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak\n/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4Vha\nfI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf\n7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9o\njHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIuk\nfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd\n3fy+1rCUwzOp9LSjtJYf4ege\n-----END PRIVATE KEY-----",
-    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD\nb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAG\nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\n0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5\nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh9\n7B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaS\nIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/K\ny09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0Wy\nYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29t\nhwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUA\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce+77s96i3I\n-----END CERTIFICATE-----"
-  },
-  "request_id" : "98414965-856c-4be3-8a33-3e08432a222e"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

201

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Certificate - diff --git a/docs/elb/api-ref/CreateHealthMonitor.html b/docs/elb/api-ref/CreateHealthMonitor.html deleted file mode 100644 index 108578182..000000000 --- a/docs/elb/api-ref/CreateHealthMonitor.html +++ /dev/null @@ -1,511 +0,0 @@ - - -

Configuring a Health Check

-

Function

This API is used to configure a health check.

- -

Constraints

The security groups must have rules that allow access from 100.125.0.0/16. If you want to use UDP for health checks, ensure that the protocol of the backend server group is UDP.

- -

URI

POST /v3/{project_id}/elb/healthmonitors

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

healthmonitor

-

Yes

-

CreateHealthMonitorOption object

-

Specifies the health check.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateHealthMonitorOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the health check. Two value options are available. true indicates that the health check is enabled, and false indicates that the health check is disabled.

-

Default: true

-

delay

-

Yes

-

Integer

-

Specifies the interval between health checks, in seconds.

-

Minimum: 1

-

Maximum: 50

-

domain_name

-

No

-

String

-

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

-

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

-

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.

-

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

-

Minimum: 1

-

Maximum: 100

-

expected_codes

-

No

-

String

-

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

-

The value options are as follows:

-

  • A specific value, for example, 200

    -

  • A list of values that are separated with commas (,), for example, 200, 202

    -

  • A value range, for example, 200-204

    -
-

This parameter is unsupported. Please do not use it.

-

Default: 200

-

Minimum: 1

-

Maximum: 64

-

http_method

-

No

-

String

-

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 unsupported. Please do not use it.

-

Default: GET

-

Minimum: 1

-

Maximum: 16

-

max_retries

-

Yes

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

Minimum: 1

-

Maximum: 10

-

max_retries_down

-

No

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

-

Minimum: 1

-

Maximum: 10

-

Default: 3

-

monitor_port

-

No

-

Integer

-

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

-

Minimum: 1

-

Maximum: 65535

-

name

-

No

-

String

-

Specifies the health check name.

-

Minimum: 0

-

Maximum: 255

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group for which the health check is configured.

-

project_id

-

No

-

String

-

Specifies the project ID.

-

Minimum: 1

-

Maximum: 32

-

timeout

-

Yes

-

Integer

-

Specifies the maximum time required for waiting for a response from the health check, in seconds. It is recommended that you set the value less than that of parameter delay.

-

Minimum: 1

-

Maximum: 50

-

type

-

Yes

-

String

-

Specifies the health check protocol.

-

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

-

url_path

-

No

-

String

-

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /. This parameter is available only when type is set to HTTP.

-

Default: /

-

Minimum: 1

-

Maximum: 255

-
- - -

Response Parameters

Status code: 201

- - - - - - - - - - - - - - - -
Table 5 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

healthmonitor

-

HealthMonitor object

-

Specifies the health check.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 HealthMonitor

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the health check. Two value options are available. true indicates that the health check is enabled, and false indicates that the health check is disabled.

-

Default: true

-

delay

-

Integer

-

Specifies the interval between health checks, in seconds.

-

Minimum: 1

-

Maximum: 50

-

domain_name

-

String

-

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

-

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

-

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.

-

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

-

expected_codes

-

String

-

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

-

The value options are as follows:

-

  • A specific value, for example, 200

    -

  • A list of values that are separated with commas (,), for example, 200, 202

    -

  • A value range, for example, 200-204

    -
-

This parameter is unsupported. Please do not use it.

-

Default: 200

-

http_method

-

String

-

Specifies the HTTP method. This parameter will take effect only when type is set to HTTP.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

-

This parameter is unsupported. Please do not use it.

-

Default: GET

-

id

-

String

-

Specifies the health check ID.

-

max_retries

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

Minimum: 1

-

Maximum: 10

-

max_retries_down

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

-

Minimum: 1

-

Maximum: 10

-

Default: 3

-

monitor_port

-

Integer

-

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

-

Minimum: 1

-

Maximum: 65535

-

name

-

String

-

Specifies the health check name.

-

pools

-

Array of PoolRef objects

-

Lists the IDs of backend server groups for which the health check is configured.

-

project_id

-

String

-

Specifies the project ID.

-

timeout

-

Integer

-

Specifies the maximum time required for waiting for a response from the health check, in seconds. It is recommended that you set the value less than that of parameter delay.

-

Minimum: 1

-

Maximum: 50

-

type

-

String

-

Specifies the health check protocol.

-

url_path

-

String

-

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /. This parameter is available only when type is set to HTTP.

-

Default: /

-
- - - - - - - - - - - - -
Table 7 PoolRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-
- - -

Example Requests

POST
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors
-
-{
-  "healthmonitor" : {
-    "name" : "My Healthmonitor",
-    "max_retries" : 3,
-    "pool_id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0",
-    "type" : "HTTP",
-    "timeout" : 30,
-    "delay" : 1
-  }
-}
- -

Example Responses

Status code: 201

-

Successful request.

-
{
-  "request_id" : "0e837340-f1bd-4037-8f61-9923d0f0b19e",
-  "healthmonitor" : {
-    "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "name" : "My Healthmonitor",
-    "delay" : 1,
-    "max_retries" : 3,
-    "pools" : [ {
-      "id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0"
-    } ],
-    "admin_state_up" : true,
-    "timeout" : 30,
-    "type" : "HTTP",
-    "expected_codes" : "200",
-    "url_path" : "/",
-    "http_method" : "GET"
-  }
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

201

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/CreateL7Policy.html b/docs/elb/api-ref/CreateL7Policy.html deleted file mode 100644 index 797fd659f..000000000 --- a/docs/elb/api-ref/CreateL7Policy.html +++ /dev/null @@ -1,948 +0,0 @@ - - -

Adding a Forwarding Policy

-

Function

This API is used to add a forwarding policy.

- -

Constraints

The protocol of the listener to which requests are redirected can only be HTTPS.

-

The listener associated with the forwarding policy cannot be any listener added to other load balancers.

- -

URI

POST /v3/{project_id}/elb/l7policies

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy

-

Yes

-

CreateL7PolicyOption object

-

Specifies the forwarding policy.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateL7PolicyOption

Parameter

-

Mandatory

-

Type

-

Description

-

action

-

Yes

-

String

-

Specifies where requests will be forwarded. The value can be one of the following:

-

  • REDIRECT_TO_POOL: Requests will be forwarded to another backend server group.

    -

  • REDIRECT_TO_LISTENER: Requests will be redirected to an HTTPS listener.

    -
-

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.

-

Minimum: 1

-

Maximum: 255

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding policy. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

description

-

No

-

String

-

Provides supplementary information about the forwarding policy.

-

Minimum: 0

-

Maximum: 255

-

listener_id

-

Yes

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

  • If action is set to REDIRECT_TO_POOL, the forwarding policy can be added to an HTTP or HTTPS listener.

    -

  • If action is set to REDIRECT_TO_LISTENER, the forwarding policy can be added to an HTTP listener.

    -
-

name

-

No

-

String

-

Specifies the forwarding policy name.

-

Minimum: 0

-

Maximum: 255

-

position

-

No

-

Integer

-

Specifies the forwarding policy priority. The value cannot be updated.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 100

-

project_id

-

No

-

String

-

Specifies the ID of the project where the forwarding policy is used.

-

Minimum: 1

-

Maximum: 32

-

redirect_listener_id

-

No

-

String

-

Specifies the ID of the listener to which requests are redirected. This parameter is mandatory when action is set to REDIRECT_TO_LISTENER.

-

For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

redirect_pool_id

-

No

-

String

-

Specifies the ID of the backend server group that requests are forwarded to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_POOL. The specified backend server group cannot be the default one associated with the listener, or any backend server group associated with the forwarding policies of other listeners.

-

This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.

-

redirect_url

-

No

-

String

-

Specifies the URL to which requests are forwarded.

-

Format: protocol://host:port/path?query

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 255

-

rules

-

No

-

Array of CreateL7PolicyRuleOption objects

-

Lists the forwarding rules in the forwarding policy.

-

The list can contain a maximum of 10 forwarding rules (if conditions is specified, a condition is considered as a rule).

-

If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

-

The entire list will be replaced if you update it.

-

priority

-

No

-

Integer

-

Specifies the forwarding policy priority. This parameter is available only for dedicated load balancers and will take effect when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

A smaller value indicates a higher priority. The value must be unique for each forwarding policy of the same listener.

-

If action is set to REDIRECT_TO_LISTENER, the value can only be 0, indicating that REDIRECT_TO_LISTENER has the highest priority.

-

  • If enhance_l7policy_enable is set to false, forwarding policies are automatically prioritized based on the original sorting logic. Forwarding policy priorities are independent of each other regardless of domain names. If forwarding policies use the same domain name, their priorities follow the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If prefix match is used for matching, the longer the path, the higher the priority. If a forwarding policy contains only a domain name without a path specified, the path is /, and prefix match is used by default.

    -

  • If enhance_l7policy_enable is set to true and this parameter is not passed, the priority will set to a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. There will be two cases: a) If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to create because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, please specify a value or adjust the priorities of existing forwarding policies. b) If no forwarding policies exist, the highest priority of existing forwarding policies will set to 1 by default.

    -
-

This parameter is unsupported. Please do not use it.

-

Minimum: 0

-

Maximum: 10000

-

redirect_url_config

-

No

-

CreateRedirectUrlConfig object

-

Specifies the URL to which requests are forwarded.

-

For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

For dedicated load balancers, this parameter will take effect only when advanced forwarding is enabled (enhance_l7policy_enable is set to true). If it is passed when enhance_l7policy_enable is set to false, an error will be returned.

-

Format: protocol://host:port/path?query

-

At least one of the four parameters (protocol, host, port, and path) must be passed, or their values cannot be set to ${xxx} at the same time. (${xxx} indicates that the value in the request will be inherited. For example, ${host} indicates the host in the URL to be redirected.)

-

The values of protocol and port cannot be the same as those of the associated listener, and either host or path must be passed or their values cannot be ${xxx} at the same time.

-

This parameter is unsupported. Please do not use it.

-

fixed_response_config

-

No

-

CreateFixtedResponseConfig object

-

Specifies the configuration of the page that will be returned. This parameter will take effect when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 CreateL7PolicyRuleOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule. The value can be true or false, and the default value is true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

type

-

Yes

-

String

-

Specifies the match content. The value can be one of the following:

-

  • HOST_NAME: A domain name will be used for matching.

    -

  • PATH: A URL will be used for matching.

    -
-

If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

-

compare_type

-

Yes

-

String

-

Specifies how requests are matched with the domain name or URL.

-

If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO (exact match).

-

If type is set to PATH, this parameter can be set to REGEX (regular expression match), STARTS_WITH (prefix match), or EQUAL_TO (exact match).

-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported. The value can be true or false, and the default value is false.

-

This parameter is unsupported. Please do not use it.

-

Default: false

-

key

-

No

-

String

-

Specifies the key of the match item. For example, if an HTTP header is used for matching, key is the name of the HTTP header parameter.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 255

-

value

-

Yes

-

String

-

Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name.

-

  • If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH and compare_type to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-

conditions

-

No

-

Array of CreateRuleCondition objects

-

Specifies the conditions contained in a forwarding rule. This parameter will take effect when enhance_l7policy_enable is set to true.

-

If conditions is specified, key and value will not take effect, and the value of this parameter will contain all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - -
Table 6 CreateRuleCondition

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

No

-

String

-

Specifies the key of match item. This parameter is left blank.

-

Minimum: 1

-

Maximum: 128

-

value

-

Yes

-

String

-

Specifies the value of the match item.

-

  • If type is set to HOST_NAME, key is left blank, and value indicates the domain name, which can contain 1 to 128 characters, including letters, digits, hyphens (-), periods (.), and asterisks (), and must start with a letter, digit, or asterisk (). If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH, key is left blank, and value indicates the request path, which can contain 1 to 128 characters. If compare_type is set to STARTS_WITH or EQUAL_TO for the forwarding rule, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 CreateRedirectUrlConfig

Parameter

-

Mandatory

-

Type

-

Description

-

protocol

-

No

-

String

-

Specifies the protocol for redirection. The default value is ${protocol}, indicating that the protocol of the request will be used.

-

Value options:

-

  • HTTP

    -

  • HTTPS

    -

  • ${protocol}

    -
-

Default: ${protocol}

-

Minimum: 1

-

Maximum: 36

-

host

-

No

-

String

-

Specifies the host name that requests are redirected to. The value can contain only letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. The default value is ${host}, indicating that the host of the request will be used.

-

Default: ${host}

-

Minimum: 1

-

Maximum: 128

-

port

-

No

-

String

-

Specifies the port that requests are redirected to. The default value is ${port}, indicating that the port of the request will be used.

-

Default: ${port}

-

Minimum: 1

-

Maximum: 16

-

path

-

No

-

String

-

Specifies the path that requests are redirected to. The default value is ${path}, indicating that the path of the request will be used.

-

The value can contain only letters, digits, and special characters _-';@^- %#&$.*+?,=!:|/()[]{} and must start with a slash (/).

-

Default: ${path}

-

Minimum: 1

-

Maximum: 128

-

query

-

No

-

String

-

Specifies the query string set in the URL for redirection. The default value is ${query}, indicating that the query string of the request will be used.

-

For example, in the URL https://www.xxx.com:8080/elb?type=loadbalancer, ${query} indicates type=loadbalancer. If this parameter is set to ${query}&name=my_name, the URL will be redirected to https://www.xxx.com:8080/elb?type=loadbalancer&name=my_name.

-

The value is case-sensitive and can contain only letters, digits, and special characters !$&'()*+,-./:;=?@^_`

-

Default: ${query}

-

Minimum: 0

-

Maximum: 128

-

status_code

-

Yes

-

String

-

Specifies the status code returned after the requests are redirected.

-

Value options:

-

  • 301

    -

  • 302

    -

  • 303

    -

  • 307

    -

  • 308

    -
-

Minimum: 1

-

Maximum: 16

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 CreateFixtedResponseConfig

Parameter

-

Mandatory

-

Type

-

Description

-

status_code

-

Yes

-

String

-

Specifies the fixed HTTP status code configured in the forwarding rule. The value can be any integer in the range of 200–299, 400–499, or 500–599.

-

Minimum: 1

-

Maximum: 16

-

content_type

-

No

-

String

-

Specifies the format of the response body.

-

Value options:

-

  • text/plain

    -

  • text/css

    -

  • text/html

    -

  • application/javascript

    -

  • application/json

    -
-

Minimum: 0

-

Maximum: 32

-

message_body

-

No

-

String

-

Specifies the content of the response body.

-

Minimum: 0

-

Maximum: 1024

-
- - -

Response Parameters

Status code: 201

- - - - - - - - - - - - - - - -
Table 9 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

l7policy

-

L7Policy object

-

Specifies the forwarding policy.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 L7Policy

Parameter

-

Type

-

Description

-

action

-

String

-

Specifies where requests will be forwarded. The value can be one of the following:

-

  • REDIRECT_TO_POOL: Requests will be forwarded to another backend server group.

    -

  • REDIRECT_TO_LISTENER: Requests will be redirected to an HTTPS listener.

    -
-

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.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding policy. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

String

-

Provides supplementary information about the forwarding policy.

-

id

-

String

-

Specifies the forwarding policy ID.

-

listener_id

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

  • If action is set to REDIRECT_TO_POOL, the forwarding policy can be added to an HTTP or HTTPS listener.

    -

  • If action is set to REDIRECT_TO_LISTENER, the forwarding policy can be added to an HTTP listener.

    -
-

name

-

String

-

Specifies the forwarding policy name.

-

Minimum: 1

-

Maximum: 255

-

position

-

Integer

-

Specifies the forwarding policy priority. This parameter cannot be updated.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 100

-

project_id

-

String

-

Specifies the project ID of the forwarding policy.

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding policy.

-

The value can only be ACTIVE.

-

Default: ACTIVE

-

redirect_listener_id

-

String

-

Specifies the ID of the listener that requests are redirected to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_LISTENER.

-

Only HTTPS listeners are supported, and the listener cannot be any listener added to other load balancers.

-

redirect_pool_id

-

String

-

Specifies the ID of the backend server group that requests are forwarded to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_POOL.

-

The specified backend server group cannot be the default one associated with the listener, or any backend server group associated with the forwarding policies of other listeners.

-

This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.

-

redirect_url

-

String

-

Specifies the URL to which requests are forwarded.

-

Format: protocol://host:port/path?query

-

This parameter is unsupported. Please do not use it.

-

rules

-

Array of RuleRef objects

-

Lists the forwarding rules in the forwarding policy.

-

redirect_url_config

-

RedirectUrlConfig object

-

Specifies the URL to which requests are forwarded.

-

For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

For dedicated load balancers, this parameter will take effect only when advanced forwarding is enabled (enhance_l7policy_enable is set to true). If it is passed when enhance_l7policy_enable is set to false, an error will be returned.

-

Format: protocol://host:port/path?query

-

At least one of the four parameters (protocol, host, port, and path) must be passed, or their values cannot be set to ${xxx} at the same time. (${xxx} indicates that the value in the request will be inherited. For example, ${host} indicates the host in the URL to be redirected.)

-

The values of protocol and port cannot be the same as those of the associated listener, and either host or path must be passed or their values cannot be ${xxx} at the same time.

-

This parameter is unsupported. Please do not use it.

-

fixed_response_config

-

FixtedResponseConfig object

-

Specifies the configuration of the page that will be returned. This parameter will take effect when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

This parameter is unsupported. Please do not use it.

-

priority

-

Integer

-

Specifies the forwarding policy priority. This parameter is available only for dedicated load balancers and will take effect when enhance_l7policy_enable is set to true.

-

A smaller value indicates a higher priority. The value must be unique for each forwarding policy of the same listener.

-

If action is set to REDIRECT_TO_LISTENER, the value can only be 0, indicating that REDIRECT_TO_LISTENER has the highest priority.

-

  • If enhance_l7policy_enable is set to false, forwarding policies are automatically prioritized based on the original sorting logic. Forwarding policy priorities are independent of each other regardless of domain names. If forwarding policies use the same domain name, their priorities follow the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If prefix match is used for matching, the longer the path, the higher the priority. If a forwarding policy contains only a domain name without a path specified, the path is /, and prefix match is used by default.

    -

  • If enhance_l7policy_enable is set to true and this parameter is not passed, the priority will set to a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. There will be two cases: a) If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to create because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, please specify a value or adjust the priorities of existing forwarding policies. b) If no forwarding policies exist, the highest priority of existing forwarding policies will set to 1 by default.

    -
-

This parameter is unsupported. Please do not use it.

-

Minimum: 0

-

Maximum: 10000

-
- - - - - - - - - - - - -
Table 11 RuleRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding rule ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 RedirectUrlConfig

Parameter

-

Type

-

Description

-

protocol

-

String

-

Specifies the protocol for redirection. The default value is ${protocol}, indicating that the protocol of the request will be used.

-

Value options:

-

  • HTTP

    -

  • HTTPS

    -

  • ${protocol}

    -
-

Minimum: 1

-

Maximum: 36

-

host

-

String

-

Specifies the host name that requests are redirected to. The value can contain only letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. The default value is ${host}, indicating that the host of the request will be used.

-

Default: ${host}

-

Minimum: 1

-

Maximum: 128

-

port

-

String

-

Specifies the port that requests are redirected to. The default value is ${port}, indicating that the port of the request will be used.

-

Default: ${port}

-

Minimum: 1

-

Maximum: 16

-

path

-

String

-

Specifies the path that requests are redirected to. The default value is ${path}, indicating that the path of the request will be used. The value can contain only letters, digits, and special characters _-';@^- %#&$.*+?,=!:|/()[]{} and must start with a slash (/).

-

Default: ${path}

-

Minimum: 1

-

Maximum: 128

-

query

-

String

-

Specifies the query string set in the URL for redirection. The default value is ${query}, indicating that the query string of the request will be used.

-

For example, in the URL https://www.xxx.com:8080/elb?type=loadbalancer, ${query} indicates type=loadbalancer. If this parameter is set to ${query}&name=my_name, the URL will be redirected to https://www.xxx.com:8080/elb?type=loadbalancer&name=my_name.

-

The value is case-sensitive and can contain only letters, digits, and special characters !$&'()*+,-./:;=?@^_`

-

Default: ${query}

-

Minimum: 0

-

Maximum: 128

-

status_code

-

String

-

Specifies the status code returned after the requests are redirected.

-

Value options:

-

  • 301

    -

  • 302

    -

  • 303

    -

  • 307

    -

  • 308

    -
-

Minimum: 1

-

Maximum: 16

-
- - - - - - - - - - - - - - - - - - - - -
Table 13 FixtedResponseConfig

Parameter

-

Type

-

Description

-

status_code

-

String

-

Specifies the HTTP status code configured in the forwarding policy. The value can be any integer in the range of 200–299, 400–499, or 500–599.

-

Minimum: 1

-

Maximum: 16

-

content_type

-

String

-

Specifies the format of the response body.

-

Value options:

-

  • text/plain

    -

  • text/css

    -

  • text/html

    -

  • application/javascript

    -

  • application/json

    -
-

Minimum: 0

-

Maximum: 32

-

message_body

-

String

-

Specifies the content of the response body.

-

Minimum: 0

-

Maximum: 1024

-
- - -

Example Requests

Creating a redirection for a listener

-
POST
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies   
-
-{
-  "l7policy" : {
-    "action" : "REDIRECT_TO_LISTENER",
-    "listener_id" : "e2220d2a-3faf-44f3-8cd6-0c42952bd0ab",
-    "redirect_listener_id" : "48a97732-449e-4aab-b561-828d29e45050"
-  }
-}
- -

Example Responses

Status code: 201

-

Successful request.

-
{
-  "request_id" : "b60d1d9a-5263-45b0-b1d6-2810ac7c52a1",
-  "l7policy" : {
-    "description" : "",
-    "admin_state_up" : true,
-    "rules" : [ ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "listener_id" : "e2220d2a-3faf-44f3-8cd6-0c42952bd0ab",
-    "redirect_listener_id" : "48a97732-449e-4aab-b561-828d29e45050",
-    "action" : "REDIRECT_TO_LISTENER",
-    "position" : 100,
-    "provisioning_status" : "ACTIVE",
-    "id" : "cf4360fd-8631-41ff-a6f5-b72c35da74be",
-    "name" : ""
-  }
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

201

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/CreateL7Rule.html b/docs/elb/api-ref/CreateL7Rule.html deleted file mode 100644 index aff63aad7..000000000 --- a/docs/elb/api-ref/CreateL7Rule.html +++ /dev/null @@ -1,448 +0,0 @@ - - -

Adding a Forwarding Rule

-

Function

This API is used to add a forwarding rule.

- -

URI

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

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

rule

-

Yes

-

CreateL7RuleOption object

-

Specifies the forwarding rule.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateL7RuleOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

compare_type

-

Yes

-

String

-

Specifies how requests are matched and forwarded.

-

  • If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO. Asterisks (*) can be used as wildcard characters.

    -

  • If type is set to PATH, this parameter can be set to REGEX, STARTS_WITH, or EQUAL_TO.

    -
-

key

-

No

-

String

-

Specifies the key of the match item. For example, if an HTTP header is used for matching, key is the name of the HTTP header parameter.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 255

-

value

-

Yes

-

String

-

Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name.

-

  • If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH and compare_type to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-

project_id

-

No

-

String

-

Specifies the project ID.

-

type

-

Yes

-

String

-

Specifies the match content. The value can be one of the following:

-

  • HOST_NAME: A domain name will be used for matching.

    -

  • PATH: A URL will be used for matching.

    -
-

If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported. The value can be true or false, and the default value is false.

-

This parameter is unsupported. Please do not use it.

-

Default: false

-

conditions

-

No

-

Array of CreateRuleCondition objects

-

Specifies the matching conditions of the forwarding rule. This parameter will take effect when enhance_l7policy_enable is set to true.

-

If conditions is specified, key and value will not take effect, and the value of this parameter will contain all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - -
Table 5 CreateRuleCondition

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

No

-

String

-

Specifies the key of match item. This parameter is left blank.

-

Minimum: 1

-

Maximum: 128

-

value

-

Yes

-

String

-

Specifies the value of the match item.

-

  • If type is set to HOST_NAME, key is left blank, and value indicates the domain name, which can contain 1 to 128 characters, including letters, digits, hyphens (-), periods (.), and asterisks (), and must start with a letter, digit, or asterisk (). If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH, key is left blank, and value indicates the request path, which can contain 1 to 128 characters. If compare_type is set to STARTS_WITH or EQUAL_TO for the forwarding rule, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-
- - -

Response Parameters

Status code: 201

- - - - - - - - - - - - - - - -
Table 6 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

rule

-

L7Rule object

-

Specifies the forwarding rule.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 L7Rule

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding rule. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

compare_type

-

String

-

Specifies how requests are matched with the domain name or URL.

-

  • If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO.

    -

  • If type is set to PATH, this parameter can be set to REGEX, STARTS_WITH, or EQUAL_TO.

    -
-

key

-

String

-

Specifies the key of the match content. This parameter will not take effect when type is set to HOST_NAME or PATH. It can be updated but will not take effect.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 255

-

project_id

-

String

-

Specifies the project ID.

-

type

-

String

-

Specifies the match content. The value can be one of the following:

-

  • HOST_NAME: A domain name will be used for matching.

    -

  • PATH: A URL will be used for matching.

    -
-

If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

-

value

-

String

-

Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name.

-

  • If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH and compare_type to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding rule.

-

The value can only be ACTIVE.

-

invert

-

Boolean

-

Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but remains invalid.

-

Default: false

-

id

-

String

-

Specifies the forwarding policy ID.

-

conditions

-

Array of RuleCondition objects

-

Specifies the matching conditions of the forwarding rule.

-

  • If conditions is specified, key and value will not take effect, and the value of this parameter will contain all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique.

    -

  • If conditions is not specified, the values of key and value are displayed.

    -
-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - -
Table 8 RuleCondition

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the key of match item. This parameter is left blank.

-

Minimum: 1

-

Maximum: 128

-

value

-

String

-

Specifies the value of the match item.

-

  • If type is set to HOST_NAME, key is left blank, and value indicates the domain name, which can contain 1 to 128 characters, including letters, digits, hyphens (-), periods (.), and asterisks (), and must start with a letter, digit, or asterisk (). If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH, key is left blank, and value indicates the request path, which can contain 1 to 128 characters. If compare_type is set to STARTS_WITH or EQUAL_TO for the forwarding rule, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-
- - -

Example Requests

POST
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules
-
-{
-  "rule" : {
-    "compare_type" : "EQUAL_TO",
-    "type" : "PATH",
-    "value" : "/bbb.html"
-  }
-}
- -

Example Responses

Status code: 201

-

Successful request.

-
{
-  "rule" : {
-    "compare_type" : "EQUAL_TO",
-    "provisioning_status" : "ACTIVE",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "invert" : false,
-    "admin_state_up" : true,
-    "value" : "/bbb.html",
-    "type" : "PATH",
-    "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7"
-  },
-  "request_id" : "3639f1b7-f04b-496e-9218-ec5a9e493f69"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

201

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/CreateListener.html b/docs/elb/api-ref/CreateListener.html deleted file mode 100644 index 78f5c55c2..000000000 --- a/docs/elb/api-ref/CreateListener.html +++ /dev/null @@ -1,975 +0,0 @@ - - -

Adding a Listener

-

Function

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

- -

Constraints

Only the administrator can specify connection_limit.

- - -

URI

POST /v3/{project_id}/elb/listeners

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

listener

-

Yes

-

CreateListenerOption object

-

Specifies the listener.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateListenerOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the listener. The value can only be true.

-

This parameter is unsupported. Please do not use it.

-

client_ca_tls_container_ref

-

No

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

Minimum: 1

-

Maximum: 128

-

default_pool_id

-

No

-

String

-

Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.

-

Minimum: 1

-

Maximum: 36

-

default_tls_container_ref

-

No

-

String

-

Specifies the ID of the server certificate used by the listener.

-

Minimum: 1

-

Maximum: 128

-

description

-

No

-

String

-

Provides supplementary information about the listener.

-

Minimum: 0

-

Maximum: 255

-

http2_enable

-

No

-

Boolean

-

Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect.

-

Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.

-

insert_headers

-

No

-

ListenerInsertHeaders object

-

Specifies the HTTP header fields.

-

loadbalancer_id

-

Yes

-

String

-

Specifies the ID of the load balancer that the listener is added to.

-

Minimum: 1

-

Maximum: 36

-

name

-

No

-

String

-

Specifies the listener name.

-

Minimum: 0

-

Maximum: 255

-

project_id

-

No

-

String

-

Specifies the project ID.

-

Minimum: 1

-

Maximum: 32

-

protocol

-

Yes

-

String

-

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

-

protocol_port

-

Yes

-

Integer

-

Specifies the port used by the listener.

-

Minimum: 1

-

Maximum: 65535

-

sni_container_refs

-

No

-

Array of strings

-

Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

-

Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.

-

This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.

-

tags

-

No

-

Array of Tag objects

-

Lists the tags.

-

tls_ciphers_policy

-

No

-

String

-

Specifies the security policy that will be used by the listener.

-

This parameter is available only for HTTPS listeners. The default value is tls-1-0.

-

An error will be returned if the protocol of the listener is not HTTPS.

-

Value options:

-

  • tls-1-0

    -

  • tls-1-1

    -

  • tls-1-2

    -

  • tls-1-2-strict

    -
-

enable_member_retry

-

No

-

Boolean

-

Specifies whether to enable health check retries for backend servers.

-

This parameter is available only for HTTP and HTTPS listeners.

-

An error will be returned if you configure this parameter for TCP and UDP listeners.

-

Default: true

-

keepalive_timeout

-

No

-

Integer

-

Specifies the idle timeout duration, in seconds.

-

  • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.

    -

  • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.

    -

  • For UDP listeners, this parameter is not available. An error will be returned if you configure this parameter for UDP listeners.

    -
-

client_timeout

-

No

-

Integer

-

Specifies the timeout duration for waiting for a request from a client, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

An error will be returned if you configure this parameter for TCP and UDP listeners.

-

Minimum: 1

-

Maximum: 300

-

Default: 60

-

member_timeout

-

No

-

Integer

-

Specifies the timeout duration for waiting for a request from a backend server, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

An error will be returned if you configure this parameter for TCP and UDP listeners.

-

ipgroup

-

No

-

CreateListenerIpGroupOption object

-

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.

-

This parameter is unsupported. Please do not use it.

-

transparent_client_ip_enable

-

No

-

Boolean

-

Specifies whether to pass source IP addresses of the clients to backend servers.

-

Shared load balancers: The value can be true or false, and the default value is false for TCP and UDP listeners. The value can only be true for HTTP and HTTPS listeners. If this parameter is not passed, the default value is true.

-

Dedicated load balancers: The value can only be true for all types of listeners. If this parameter is not passed, the default value is true.

-

enhance_l7policy_enable

-

No

-

Boolean

-

Specifies whether to enable advanced forwarding. The value can be true or false (default).

-

  • true indicates that advanced forwarding will be enabled.

    -

  • false indicates that advanced forwarding will not be enabled.

    -
-

The following parameters will be available only when advanced forwarding is enabled:

-

  • redirect_url_config

    -

  • fixed_response_config

    -

  • priority

    -

  • conditions

    -
-

For details, see the descriptions in the APIs of forwarding policies and forwarding rules.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ListenerInsertHeaders

Parameter

-

Mandatory

-

Type

-

Description

-

X-Forwarded-ELB-IP

-

No

-

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

-

X-Forwarded-Port

-

No

-

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

-

X-Forwarded-For-Port

-

No

-

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

-

X-Forwarded-Host

-

Yes

-

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

-
- - - - - - - - - - - - - - - - - - - -
Table 6 Tag

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

No

-

String

-

Specifies the tag key.

-

value

-

No

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 CreateListenerIpGroupOption

Parameter

-

Mandatory

-

Type

-

Description

-

ipgroup_id

-

Yes

-

String

-

Specifies the ID of the IP address group associated with the listener.

-

  • If ip_list is set to [] and type to whitelist, no IP addresses are allowed to access the listener.

    -

  • If ip_list is set to [] and type to blacklist, any IP address is allowed to access the listener.

    -

  • The specified IP address group must exist and this parameter cannot be set to null.

    -
-

IP address groups are not supported for now.

-

enable_ipgroup

-

No

-

Boolean

-

Specifies whether to enable access control.

-

  • true (default): Access control will be enabled.

    -

  • false: Access control will be disabled.

    -
-

A listener with access control enabled can be directly deleted.

-

type

-

No

-

String

-

Specifies how access to the listener is controlled.

-

  • white (default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener.

    -

  • black: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.

    -
-
- - -

Response Parameters

Status code: 201

- - - - - - - - - - - - - - - -
Table 8 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

listener

-

Listener object

-

Specifies the listener.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 Listener

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the listener. And the value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

client_ca_tls_container_ref

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

connection_limit

-

Integer

-

Specifies the maximum number of connections. The default value is -1.

-

This parameter is unsupported. Please do not use it.

-

created_at

-

String

-

Specifies the time when the listener was created.

-

default_pool_id

-

String

-

Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server.

-

default_tls_container_ref

-

String

-

Specifies the ID of the server certificate used by the listener.

-

description

-

String

-

Provides supplementary information about the listener.

-

http2_enable

-

Boolean

-

Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect.

-

Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.

-

Default: true

-

id

-

String

-

Specifies the listener ID.

-

insert_headers

-

ListenerInsertHeaders object

-

Specifies the HTTP header fields.

-

loadbalancers

-

Array of LoadBalancerRef objects

-

Specifies the ID of the load balancer that the listener is added to.

-

name

-

String

-

Specifies the listener name.

-

project_id

-

String

-

Specifies the ID of the project where the listener is used.

-

protocol

-

String

-

Specifies the protocol used by the listener.

-

protocol_port

-

Integer

-

Specifies the port used by the listener.

-

Minimum: 1

-

Maximum: 65535

-

sni_container_refs

-

Array of strings

-

Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

-

Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.

-

This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.

-

tags

-

Array of Tag objects

-

Lists the tags.

-

updated_at

-

String

-

Specifies the time when the listener was updated.

-

tls_ciphers_policy

-

String

-

Specifies the security policy used by the listener. This parameter is available only for HTTPS listeners.

-

The value can be tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0.

-

enable_member_retry

-

Boolean

-

Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners.

-

keepalive_timeout

-

Integer

-

Specifies the idle timeout duration, in seconds.

-

  • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.

    -

  • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.

    -

  • For UDP listeners, this parameter does not take effect.

    -
-

client_timeout

-

Integer

-

Specifies the timeout duration for waiting for a request from a client, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

member_timeout

-

Integer

-

Specifies the timeout duration for waiting for a request from a backend server, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

ipgroup

-

ListenerIpGroup object

-

Specifies the IP address group associated with the listener.

-

This parameter is unsupported. Please do not use it.

-

transparent_client_ip_enable

-

Boolean

-

Specifies whether to pass source IP addresses of the clients to backend servers.

-

Shared load balancers: The value can be true or false, and the default value is false for TCP and UDP listeners. The value can only be true for HTTP and HTTPS listeners. If this parameter is not passed, the default value is true.

-

Dedicated load balancers: The value can only be true for all types of listeners. If this parameter is not passed, the default value is true.

-

enhance_l7policy_enable

-

Boolean

-

Specifies whether to enable advanced forwarding. The value can be true or false (default).

-

  • true indicates that advanced forwarding will be enabled.

    -

  • false indicates that advanced forwarding will not be enabled.

    -
-

The following parameters will be available only when advanced forwarding is enabled:

-

  • redirect_url_config

    -

  • fixed_response_config

    -

  • priority

    -

  • conditions

    -
-

For details, see the descriptions in the APIs of forwarding policies and forwarding rules.

-

This parameter is unsupported. Please do not use it.

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

Parameter

-

Type

-

Description

-

X-Forwarded-ELB-IP

-

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

-

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

-

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

-

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

-
- - - - - - - - - - - - -
Table 11 LoadBalancerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-
- - - - - - - - - - - - - - - - -
Table 12 Tag

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

-

value

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - - - - - - - -
Table 13 ListenerIpGroup

Parameter

-

Type

-

Description

-

ipgroup_id

-

String

-

Specifies the ID of the IP address group associated with the listener.

-

  • If ip_list is set to [] and type to whitelist, no IP addresses are allowed to access the listener.

    -

  • If ip_list is set to [] and type to blacklist, any IP address is allowed to access the listener.

    -

  • The specified IP address group must exist and this parameter cannot be set to null.

    -
-

enable_ipgroup

-

Boolean

-

Specifies whether to enable access control.

-

  • true: Access control is enabled.

    -

  • false: Access control is disabled.

    -
-

A listener with access control enabled can be directly deleted.

-

type

-

String

-

Specifies how access to the listener is controlled.

-

  • white: A whitelist is configured. Only IP addresses in the whitelist can access the listener.

    -

  • black: A blacklist is configured. IP addresses in the blacklist are not allowed to access the listener.

    -
-
- - -

Example Requests

- -

Example Responses

Status code: 201

-

Successful request.

-
{
-  "listener" : {
-    "id" : "683cf917-3e51-4c41-830c-bc3a57e090f0",
-    "name" : "My listener",
-    "protocol_port" : 90,
-    "protocol" : "HTTPS",
-    "description" : "",
-    "default_tls_container_ref" : "4e7761d7c7d141c389479f2641c8bff8",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "ac82ca77-8be3-4d65-9c4d-155771b463df"
-    } ],
-    "project_id" : "060576782980d5762f9ec014dd2f1148",
-    "sni_container_refs" : [ ],
-    "connection_limit" : -1,
-    "tls_ciphers_policy" : "tls-1-0",
-    "tags" : [ ],
-    "created_at" : "2021-04-02T07:48:38Z",
-    "updated_at" : "2021-04-02T07:48:38Z",
-    "http2_enable" : false,
-    "insert_headers" : {
-      "X-Forwarded-ELB-IP" : false,
-      "X-Forwarded-Host" : true,
-      "X-Forwarded-For-Port" : false,
-      "X-Forwarded-Port" : false
-    },
-    "member_timeout" : 60,
-    "client_timeout" : 60,
-    "keepalive_timeout" : 60,
-    "enable_member_retry" : true,
-    "transparent_client_ip_enable" : true,
-    "enhance_l7policy_enable" : false
-  },
-  "request_id" : "830de7c7c38232d925db168bfb3cb0e8"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

201

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/CreateLoadBalancer.html b/docs/elb/api-ref/CreateLoadBalancer.html deleted file mode 100644 index aee3a720e..000000000 --- a/docs/elb/api-ref/CreateLoadBalancer.html +++ /dev/null @@ -1,1049 +0,0 @@ - - -

Creating a Load Balancer

-

Function

This API is used to create a dedicated load balancer. When you create the load balancer, note the following:

- - -

Constraints

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

- - -

URI

POST /v3/{project_id}/elb/loadbalancers

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

Minimum: 1

-

Maximum: 255

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

No

-

String

-

Shows authentication information.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

loadbalancer

-

Yes

-

CreateLoadBalancerOption object

-

Specifies the load balancer.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateLoadBalancerOption

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the load balancer name.

-

Minimum: 0

-

Maximum: 255

-

description

-

No

-

String

-

Provides supplementary information about the load balancer.

-

Minimum: 0

-

Maximum: 255

-

vip_address

-

No

-

String

-

Specifies the virtual IP address bound to the load balancer. The IP address must be from the IPv4 subnet of the VPC where the load balancer works and IP address should not be occupied by other services.

-

Note:

-
  • If both vip_subnet_cidr_id and vip_address are specified, a dedicated load balancer with a private IPv4 address will be created, and the virtual IP address specified by vip_address is the private IP address of the load balancer.
  • If only vip_subnet_cidr_id is specified, a dedicated load balancer with a private IPv4 address will be created, and the system will automatically assign a virtual IP address to the load balancer.
-

vip_subnet_cidr_id

-

No

-

String

-

Specifies the ID of the IPv4 subnet where the load balancer works. You can query neutron_subnet_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

-
  • Both vip_subnet_cidr_id and vip_address are required if you want to create a dedicated load balancer with a private IPv4 address.
  • publicip and either vpc_id or vip_subnet_cidr_id are required if you want to create a dedicated load balancer with a new IPv4 EIP.
  • publicip_ids and either vpc_id or vip_subnet_cidr_id are required if you want to with a dedicated load balancer with an existing IPv4 EIP.
  • The subnet specified by vip_subnet_cidr_id must be in the VPC specified by vpc_id if you specify both vpc_id and vip_subnet_cidr_id.
-

ipv6_vip_virsubnet_id

-

No

-

String

-

Specifies the ID of the IPv6 subnet where the load balancer works. You can query id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

-

Note:

-
  • ipv6_vip_virsubnet_id is required if you want to create a load balancer with a private IPv6 address.
  • Both ipv6_vip_virsubnet_id and ipv6_bandwidth are required if you want to create a load balancer with a public IPv6 address.
  • The subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id if you specify both ipv6_vip_virsubnet_id and vpc_id.
  • IPv6 must be enabled for the subnet where the load balancer works.
-

This parameter is unsupported. Please do not use it.

-

provider

-

No

-

String

-

Specifies the provider of the load balancer. The value can only be vlb.

-

l4_flavor_id

-

No

-

String

-

Specifies the ID of the Layer-4 flavor.

-

Specify either l4_flavor_id or l7_flavor_id or both l4_flavor_id and l7_flavor_id when you create a load balancer.

-

project_id

-

No

-

String

-

Specifies the project ID.

-

guaranteed

-

No

-

Boolean

-

Specifies whether the load balancer is a dedicated load balancer. The value can only be true.

-

Default: true

-

vpc_id

-

No

-

String

-

Specifies the ID of the VPC where the load balancer works. You can query id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/vpcs).

-
  • The subnet specified by vip_subnet_cidr_id must be in the VPC specified by vpc_id if you specify both vip_subnet_cidr_id and vpc_id.
  • The subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id if you specify both ipv6_vip_virsubnet_id and vpc_id.
-

availability_zone_list

-

Yes

-

Array of strings

-

Specifies the list of AZs where the load balancer can be created. You can query the AZs by calling the API (GET https://{ELB_Endpoint}/v3/{project_id}/elb/availability-zones). Select one or more AZs in the same set.

-

enterprise_project_id

-

No

-

String

-

Specifies the enterprise project ID. The value cannot be "", "0", or the ID of an enterprise project that does not exist. If this parameter is not passed during resource creation, the resource belongs to the default enterprise project.

-

This parameter is unsupported. Please do not use it.

-

tags

-

No

-

Array of Tag objects

-

Lists the tags added to the load balancer. Example: "tags":[{"key":"my_tag","value":"my_tag_value"}]

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the load balancer. The value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

l7_flavor_id

-

No

-

String

-

Specifies the ID of the Layer-7 flavor.

-

Specify either l4_flavor_id or l7_flavor_id or both l4_flavor_id and l7_flavor_id when you create a load balancer.

-

Minimum: 1

-

Maximum: 255

-

ipv6_bandwidth

-

No

-

BandwidthRef object

-

Specifies the ID of the bandwidth. This parameter is available only when you create or update a dedicated load balancer that has an IPv6 address bound.

-

If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

-

This parameter is unsupported. Please do not use it.

-

publicip_ids

-

No

-

Array of strings

-

Specifies the ID of the EIP the system will automatically assign and bind to the load balancer during load balancer creation. Currently, only the first EIP will be bound to the load balancer although multiple EIP IDs can be set.

-

publicip

-

No

-

CreateLoadBalancerPublicIpOption object

-

Provides information about the new IPv4 EIP that will be bound to the dedicated load balancer during load balancer creation.

-

elb_virsubnet_ids

-

Yes

-

Array of strings

-

Lists the IDs of subnets on the downstream plane. You can query parameter id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

-

If there is more than one subnet, the first subnet in the list will be used.

-

The subnets must be in the VPC where the load balancer works.

-

ip_target_enable

-

No

-

Boolean

-

Specifies whether to enable cross-VPC backend. The value can be true (enabled) or false (disabled). This function is supported only by dedicated load balancers.

-

If you enable this function, you can add 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 their IP addresses.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - -
Table 5 Tag

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

No

-

String

-

Specifies the tag key.

-

value

-

No

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - -
Table 6 BandwidthRef

Parameter

-

Mandatory

-

Type

-

Description

-

id

-

Yes

-

String

-

Specifies the shared bandwidth ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 CreateLoadBalancerPublicIpOption

Parameter

-

Mandatory

-

Type

-

Description

-

ip_version

-

No

-

Integer

-

Specifies the IP address version. The value can be 4 (IPv4) or 6 (IPv6).

-

IPv6 is unsupported. The value cannot be 6.

-

Default: 4

-

network_type

-

Yes

-

String

-

Specifies the EIP type. The value can be 5_bgp (default) and 5_mailbgp.

- NOTE:

In eu-de, the value of this parameter can only be 5_gray.

- -

Minimum: 1

-

Maximum: 36

-

description

-

No

-

String

-

Provides supplementary information about the IPv4 EIP.

-

Minimum: 1

-

Maximum: 255

-

bandwidth

-

Yes

-

CreateLoadBalancerBandwidthOption object

-

Provides supplementary information about the bandwidth.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 CreateLoadBalancerBandwidthOption

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the bandwidth name.

-

Minimum: 1

-

Maximum: 64

-

size

-

No

-

Integer

-

Specifies the bandwidth range.

-

The default range is 1 Mbit/s to 2,000 Mbit/s. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.)

-

Note:

-

The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The following are the details:

-
  • The minimum increment is 1 Mbit/s if the bandwidth range is from 0 Mbit/s to 300 Mbit/s.
  • The minimum increment is 50 Mbit/s if the bandwidth range is from 300 Mbit/s to 1,000 Mbit/s.
  • The minimum increment is 500 Mbit/s if the bandwidth is greater than 1,000 Mbit/s.
-

This parameter is mandatory if id is set to null.

-

Minimum: 0

-

Maximum: 99999

-

charge_mode

-

No

-

String

-

Specifies how the bandwidth used by the EIP is billed.

-

Currently, the bandwidth can be billed only by traffic.

-

This parameter is mandatory if id is set to null.

-

share_type

-

No

-

String

-

Specifies the bandwidth type.

-

The value options are as follows:

-
  • PER: indicates dedicated bandwidth.
  • WHOLE: indicates shared bandwidth.
-

This parameter is mandatory when id is set to null. It will be ignored if the value of id is not null.

-

id

-

No

-

String

-

Specifies the ID of the shared bandwidth. You can add a load balancer to a shared bandwidth by specifying its ID.

-

If you have specified an ID, you do not need to pass other parameters. Even if you pass other parameters, the system will automatically ignore these parameters.

-
- - -

Response Parameters

Status code: 201

- - - - - - - - - - - - - - - -
Table 9 Response body parameters

Parameter

-

Type

-

Description

-

loadbalancer

-

LoadBalancer object

-

Specifies the load balancer.

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 LoadBalancer

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-

Default: Automatically generated

-

description

-

String

-

Provides supplementary information about the load balancer.

-

Minimum: 1

-

Maximum: 255

-

provisioning_status

-

String

-

Specifies the provisioning status of the load balancer. The value can only be ACTIVE.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the load balancer. The value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

provider

-

String

-

Specifies the provider of the load balancer. The value can only be vlb.

-

Default: vlb

-

pools

-

Array of PoolRef objects

-

Lists the IDs of backend server groups associated with the load balancer.

-

listeners

-

Array of ListenerRef objects

-

Lists the IDs of listeners added to the load balancer.

-

operating_status

-

String

-

Specifies the operating status of the load balancer. The value can only be ONLINE.

-

Minimum: 1

-

Maximum: 16

-

vip_address

-

String

-

Specifies the private IPv4 address bound to the load balancer.

-

Minimum: 1

-

Maximum: 64

-

vip_subnet_cidr_id

-

String

-

Specifies the ID of the IPv4 subnet where the load balancer works.

-

Minimum: 1

-

Maximum: 36

-

name

-

String

-

Specifies the name of the load balancer.

-

Minimum: 1

-

Maximum: 255

-

project_id

-

String

-

Specifies the project ID of the load balancer.

-

Minimum: 1

-

Maximum: 32

-

vip_port_id

-

String

-

Specifies the ID of the port bound to the virtual IP address (the value of vip_address) of the load balancer.

-

When you create a dedicated load balancer, the system automatically creates a port for the load balancer and associates the port with a default security group. However, security group rules containing the port will not affect traffic to and from the load balancer.

-

tags

-

Array of Tag objects

-

Lists the tags added to the load balancer.

-

created_at

-

String

-

Specifies the time when the load balancer was created.

-

Minimum: 1

-

Maximum: 20

-

updated_at

-

String

-

Specifies the time when the load balancer was updated.

-

Minimum: 1

-

Maximum: 20

-

guaranteed

-

Boolean

-

Specifies whether the load balancer is a dedicated load balancer.

-

The value can be true or false. true indicates a dedicated load balancer, and false indicates a shared load balancer. When dedicated load balancers are launched in the eu-de region, either true or false will be returned when you use the API to query or update a load balancer.

-

Default: true

-

vpc_id

-

String

-

Specifies the ID of the VPC where the load balancer works.

-

eips

-

Array of EipInfo objects

-

Specifies the EIP bound to the load balancer.

-

ipv6_vip_address

-

String

-

Specifies the IPv6 address bound to the load balancer.

-

This parameter is unsupported. Please do not use it.

-

Default: None

-

Minimum: 1

-

Maximum: 64

-

ipv6_vip_virsubnet_id

-

String

-

Specifies the ID of the IPv6 subnet where the load balancer works.

-

This parameter is unsupported. Please do not use it.

-

ipv6_vip_port_id

-

String

-

Specifies the ID of the port bound to the IPv6 address.

-

This parameter is unsupported. Please do not use it.

-

availability_zone_list

-

Array of strings

-

Specifies the list of AZs where the load balancer is created.

-

enterprise_project_id

-

String

-

Specifies the enterprise project ID.

-

If this parameter is not passed during resource creation, the resource belongs to the default enterprise project.

-

This parameter is unsupported. Please do not use it.

-

Default: 0

-

l4_flavor_id

-

String

-

Specifies the Layer-4 flavor.

-

Minimum: 1

-

Maximum: 255

-

l4_scale_flavor_id

-

String

-

Specifies the reserved Layer 4 flavor.

-

Minimum: 1

-

Maximum: 255

-

l7_flavor_id

-

String

-

Specifies the Layer-7 flavor.

-

Minimum: 1

-

Maximum: 255

-

l7_scale_flavor_id

-

String

-

Specifies the reserved Layer 7 flavor.

-

Minimum: 1

-

Maximum: 255

-

publicips

-

Array of PublicIpInfo objects

-

Specifies the EIP bound to the load balancer.

-

elb_virsubnet_ids

-

Array of strings

-

Specifies the ID of the subnet on the downstream plane. The ports used by the load balancer dynamically occupy IP addresses in the subnet.

-

ip_target_enable

-

Boolean

-

Specifies whether to enable cross-VPC backend.

-

This parameter is unsupported. Please do not use it.

-

Default: false

-

frozen_scene

-

String

-

Specifies the scenario where the load balancer is frozen. Use commas to separate multiple scenarios.

-

If the value is ARREAR, the load balancer is frozen because your account is in arrears.

-

ipv6_bandwidth

-

BandwidthRef object

-

Specifies the ID of the bandwidth. This parameter is available only when you create or update a dedicated load balancer that has an IPv6 address bound.

-

If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - -
Table 11 PoolRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-
- - - - - - - - - - - - -
Table 12 ListenerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-
- - - - - - - - - - - - - - - - -
Table 13 Tag

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

-

value

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - - - - - - - -
Table 14 EipInfo

Parameter

-

Type

-

Description

-

eip_id

-

String

-

Specifies the EIP ID.

-

eip_address

-

String

-

Specifies the specific IP address.

-

ip_version

-

Integer

-

Specifies the IP version. 4 indicates IPv4, and 6 indicates IPv6.

-

IPv6 is unsupported. The value cannot be 6.

-
- - - - - - - - - - - - - - - - - - - - -
Table 15 PublicIpInfo

Parameter

-

Type

-

Description

-

publicip_id

-

String

-

Specifies the EIP ID.

-

publicip_address

-

String

-

Specifies the IP address.

-

ip_version

-

Integer

-

Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6).

-

IPv6 is unsupported. The value cannot be 6.

-
- - - - - - - - - - - - -
Table 16 BandwidthRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the shared bandwidth ID.

-
- - -

Example Requests

Example 1: Creating a load balancer with an IPv4 EIP

-
POST
-
-https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
-
-{
-  "loadbalancer" : {
-    "vpc_id" : "e5a892ff-3c33-44ef-ada5-b713eb1f7a8b",
-    "availability_zone_list" : [ "br-iaas-odin1a" ],
-    "admin_state_up" : true,
-    "vip_subnet_cidr_id" : "1800b6b8-a69f-4719-813d-24d62aaf32bd",
-    "elb_virsubnet_ids" : [ "1fe8c0a8-d648-4294-8ea5-4d7f0c700e69" ],
-    "name" : "elb-ipv4-public",
-    "publicip" : {
-      "network_type" : "5_bgp",
-      "bandwidth" : {
-        "size" : 2,
-        "share_type" : "PER",
-        "charge_mode" : "traffic",
-        "name" : "elb_eip_traffic"
-      }
-    }
-  }
-}
- -

Example Responses

Status code: 201

-

Successful request.

-
{
-  "request_id" : "86bb342be098113734389bffcf593607",
-  "loadbalancer" : {
-    "id" : "badd5a4b-14cf-4319-ac91-4182a80dee9a",
-    "project_id" : "060576782980d5762f9ec014dd2f1148",
-    "name" : "elb-ipv4-public",
-    "description" : "",
-    "vip_port_id" : "265c13fb-49a9-4f51-b848-7f0cced0aef0",
-    "vip_address" : "192.168.0.151",
-    "admin_state_up" : true,
-    "provisioning_status" : "ACTIVE",
-    "operating_status" : "ONLINE",
-    "listeners" : [ ],
-    "pools" : [ ],
-    "tags" : [ ],
-    "provider" : "vlb",
-    "created_at" : "2021-03-29T02:44:47Z",
-    "updated_at" : "2021-03-29T02:44:47Z",
-    "vpc_id" : "e5a892ff-3c33-44ef-ada5-b713eb1f7a8b",
-    "enterprise_project_id" : "0",
-    "availability_zone_list" : [ "br-iaas-odin1a" ],
-    "publicips" : [ {
-      "publicip_id" : "448d497a-8f65-4c17-b2b2-f21279446e00",
-      "publicip_address" : "10.246.170.154",
-      "ip_version" : 4
-    } ],
-    "elb_virsubnet_ids" : [ "4df3e391-5ebf-4300-b614-cf5a4e793666" ],
-    "elb_virsubnet_type" : "dualstack",
-    "ip_target_enable" : false,
-    "eips" : [ {
-      "eip_id" : "448d497a-8f65-4c17-b2b2-f21279446e00",
-      "eip_address" : "10.246.170.154",
-      "ip_version" : 4
-    } ],
-    "guaranteed" : true,
-    "l4_flavor_id" : "e5acacda-f861-404e-9871-df480c49d185",
-    "l7_flavor_id" : "2f124f60-980a-42f3-b201-35461df1b936",
-    "vip_subnet_cidr_id" : "1800b6b8-a69f-4719-813d-24d62aaf32bd"
-  }
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

201

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/CreateMember.html b/docs/elb/api-ref/CreateMember.html deleted file mode 100644 index 605efd836..000000000 --- a/docs/elb/api-ref/CreateMember.html +++ /dev/null @@ -1,375 +0,0 @@ - - -

Adding a Backend Server

-

Function

This API is used to add a backend server.

- -

Constraints

When you add backend servers, note the following:

- - -

URI

POST /v3/{project_id}/elb/pools/{pool_id}/members

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

member

-

Yes

-

CreateMemberOption object

-

Specifies request parameters for creating a backend server.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateMemberOption

Parameter

-

Mandatory

-

Type

-

Description

-

address

-

Yes

-

String

-

Specifies the IP address of the backend server.

-

  • The IP address must be in the subnet specified by subnet_cidr_id, for example, 192.168.3.11.

    -

  • The IP address can only be the IP address of the primary NIC.

    -

  • If subnet_cidr_id is left blank, cross-VPC backend is enabled. In this case, these servers must use IPv4 addresses.

    -
-

Minimum: 1

-

Maximum: 64

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server.

-

Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers exist. If cloud servers exist, the value is true. Otherwise, the value is false.

-

name

-

No

-

String

-

Specifies the backend server name.

-

Minimum: 0

-

Maximum: 255

-

project_id

-

No

-

String

-

Specifies the project ID.

-

Minimum: 1

-

Maximum: 32

-

protocol_port

-

Yes

-

Integer

-

Specifies the port used by the backend server to receive requests.

-

Minimum: 1

-

Maximum: 65535

-

subnet_cidr_id

-

No

-

String

-

Specifies the ID of the subnet where the backend server works.

-

This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated. Only IPv4 subnets are supported.

-

This parameter can be left blank, indicating that cross-VPC backend servers can be added. In this case, IP addresses of these servers must be IPv4 addresses, the protocol of the backend server group must be TCP, HTTP, or HTTPS, and cross-VPC backend must have been enabled for the load balancer.

-

Minimum: 1

-

Maximum: 36

-

weight

-

No

-

Integer

-

Specifies the weight of the backend server.

-

Requests are routed to backend servers in the same backend server group based on their weights.

-

If the weight is 0, the backend server will not accept new requests.

-

This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

-

Minimum: 0

-

Maximum: 100

-

Default: 1

-
- - -

Response Parameters

Status code: 201

- - - - - - - - - - - - - - - -
Table 5 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

member

-

Member object

-

Specifies the backend server.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 Member

Parameter

-

Type

-

Description

-

address

-

String

-

Specifies the IP address of the backend server.

-

The IP address must be in the subnet specified by subnet_cidr_id, for example, 192.168.3.11. The IP address can only be the IP address of the primary NIC.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server.

-

Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers exist. If cloud servers exist, the value is true. Otherwise, the value is false.

-

Default: true

-

id

-

String

-

Specifies the backend server ID.

-

name

-

String

-

Specifies the backend server name.

-

operating_status

-

String

-

Specifies the operating status of the backend server. The value can be one of the following:

-

  • ONLINE: The backend server is running normally.

    -

  • NO_MONITOR: No health check is configured for the backend server group to which the backend server belongs.

    -

  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.

    -
-

project_id

-

String

-

Specifies the project ID.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server to receive requests.

-

Minimum: 1

-

Maximum: 65535

-

subnet_cidr_id

-

String

-

Specifies the ID of the subnet where the backend server works. This subnet must be in the VPC as the subnet of the load balancer associated with the backend server. Only IPv4 subnets are supported. If the value is left blank, the backend server is not in the load balancer's VPC.

-

weight

-

Integer

-

Specifies the weight of the backend server.

-

Requests are routed to backend servers in the same backend server group based on their weights.

-

If the weight is 0, the backend server will not accept new requests.

-

This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

-

Minimum: 0

-

Maximum: 100

-

Default: 1

-

ip_version

-

String

-

This is a read-only attribute, which is automatically generated based on the address parameter. The value can be v4 or v6.

-

Default: v4

-
- - -

Example Requests

POST
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members
-
-{
-  "member" : {
-    "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74",
-    "protocol_port" : 89,
-    "name" : "My member",
-    "address" : "120.10.10.16"
-  }
-}
- -

Example Responses

Status code: 201

-

Successful request.

-
{
-  "member" : {
-    "name" : "My member",
-    "weight" : 1,
-    "admin_state_up" : false,
-    "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "address" : "120.10.10.16",
-    "protocol_port" : 89,
-    "id" : "1923923e-fe8a-484f-bdbc-e11559b1f48f",
-    "operating_status" : "NO_MONITOR",
-    "ip_version" : "v4"
-  },
-  "request_id" : "f354090d-41db-41e0-89c6-7a943ec50792"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

201

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/CreatePool.html b/docs/elb/api-ref/CreatePool.html deleted file mode 100644 index 44dc6c20c..000000000 --- a/docs/elb/api-ref/CreatePool.html +++ /dev/null @@ -1,654 +0,0 @@ - - -

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.

-

If listener_id is specified, the listener must have no backend server group associated.

- -

URI

POST /v3/{project_id}/elb/pools

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

pool

-

Yes

-

CreatePoolOption object

-

Specifies the backend server group.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreatePoolOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server group. The value can only be updated to true.

-

This parameter is unsupported. Please do not use it.

-

description

-

No

-

String

-

Provides supplementary information about the backend server group.

-

Minimum: 0

-

Maximum: 255

-

lb_algorithm

-

Yes

-

String

-

Specifies the load balancing algorithm used by the load balancer to route requests to backend servers.

-

The value can be one of the following:

-

  • ROUND_ROBIN: weighted round robin

    -

  • LEAST_CONNECTIONS: weighted least connections

    -

  • SOURCE_IP: source IP hash

    -
-

When the value is SOURCE_IP, the weights of backend servers are invalid.

-

listener_id

-

No

-

String

-

Specifies the ID of the listener associated with the backend server group. Specify either listener_id or loadbalancer_id, or both of them.

-

Minimum: 1

-

Maximum: 36

-

loadbalancer_id

-

No

-

String

-

Specifies the ID of the associated load balancer. Specify either listener_id or loadbalancer_id, or both of them.

-

Minimum: 1

-

Maximum: 36

-

name

-

No

-

String

-

Specifies the backend server group name.

-

Minimum: 0

-

Maximum: 255

-

project_id

-

No

-

String

-

Specifies the project ID.

-

protocol

-

Yes

-

String

-

Specifies the protocol used by the backend server group to receive requests. TCP, UDP, and HTTP are supported.

-

  • For UDP listeners, the protocol of the backend server group must be UDP.

    -

  • For TCP listeners, the protocol of the backend server group must be TCP.

    -

  • For HTTP or HTTPS listeners, the protocol of the backend server group must be HTTP.

    -
-

Minimum: 1

-

Maximum: 255

-

session_persistence

-

No

-

CreatePoolSessionPersistenceOption object

-

Specifies whether to enable sticky sessions.

-

slow_start

-

No

-

CreatePoolSlowStartOption object

-

Specifies whether to enable slow start. After you enable slow start, new backend servers added to the backend server group are warmed up, and the number of requests they can receive increases linearly during the configured slow start duration.

-

This parameter can be used when the protocol of the backend server group is HTTP or HTTPS. An error will be returned if the protocol is not HTTP or HTTPS.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 CreatePoolSessionPersistenceOption

Parameter

-

Mandatory

-

Type

-

Description

-

cookie_name

-

No

-

String

-

Specifies the cookie name. This parameter will take effect only when type is set to APP_COOKIE. Otherwise, an error will be returned.

-

The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 0

-

Maximum: 1024

-

type

-

Yes

-

String

-

Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, only SOURCE_IP takes effect.

    -

  • For dedicated load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can only be HTTP_COOKIE.

    -

  • For shared load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can be HTTP_COOKIE or APP_COOKIE.

    -
-

persistence_timeout

-

No

-

Integer

-

Specifies the stickiness duration, in minutes. This parameter will not take effect when type is set to APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60, and the default value is 1.

    -

  • If the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440, and the default value is 1440.

    -
-
- - - - - - - - - - - - - - - - - - - -
Table 6 CreatePoolSlowStartOption

Parameter

-

Mandatory

-

Type

-

Description

-

enable

-

Yes

-

Boolean

-

Specifies whether to enable slow start.

-

true indicates that this function is enabled, and false indicates this function is disabled.

-

Default: false

-

duration

-

Yes

-

Integer

-

Specifies the slow start duration, in seconds.

-

The value ranges from 30 to 1200, and the default value is 30.

-

Minimum: 30

-

Maximum: 1200

-

Default: 30

-
- - -

Response Parameters

Status code: 201

- - - - - - - - - - - - - - - -
Table 7 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

pool

-

Pool object

-

Specifies the backend server group.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 Pool

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server group. The value can only be updated to true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

String

-

Provides supplementary information about the backend server group.

-

healthmonitor_id

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

id

-

String

-

Specifies the backend server group ID.

-

lb_algorithm

-

String

-

Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the backend server group.

-

The value can be ROUND_ROBIN (weighted round robin), LEAST_CONNECTIONS (weighted least connections), or SOURCE_IP (source IP hash).

-

When the value is SOURCE_IP, the weight parameter is invalid.

-

listeners

-

Array of ListenerRef objects

-

Lists the listeners associated with the backend server group.

-

loadbalancers

-

Array of LoadBalancerRef objects

-

Lists the IDs of load balancers associated with the backend server group.

-

If only listener_id is specified during the creation of the backend server group, the ID of the loadbalancers parameter in the response is the ID of the load balancer to which the listener is added.

-

members

-

Array of MemberRef objects

-

Lists the backend servers in the backend server group.

-

name

-

String

-

Specifies the backend server group name.

-

project_id

-

String

-

Specifies the project ID.

-

protocol

-

String

-

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

-

  • For UDP listeners, the protocol of the backend server group must be UDP.

    -

  • For TCP listeners, the protocol of the backend server group must be TCP.

    -

  • For HTTP or HTTPS listeners, the protocol of the backend server group must be HTTP.

    -
-

session_persistence

-

SessionPersistence object

-

Specifies the sticky session.

-

ip_version

-

String

-

Specifies the IP version supported by the backend server group.

-

  • Shared load balancers: The default value is v4.

    -

  • Dedicated load balancers: The value can be dualstack, v4, or v6.

    -
-

When the protocol of the backend server group is TCP or UDP, ip_version is set to dualstack, indicating that both IPv4 and IPv6 are supported.

-

When the protocol of the backend server group is HTTP, ip_version is set to v4.

-

IPv6 is unsupported. Only v4 is returned.

-

Default: dualstack

-

slow_start

-

SlowStart object

-

Specifies whether to enable slow start. After you enable slow start, new backend servers added to the backend server group are warmed up, and the number of requests they can receive increases linearly during the configured slow start duration.

-

This parameter can be used when the protocol of the backend server group is HTTP or HTTPS. An error will be returned if the protocol is not HTTP or HTTPS.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - -
Table 9 ListenerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-
- - - - - - - - - - - - -
Table 10 LoadBalancerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-
- - - - - - - - - - - - -
Table 11 MemberRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

-
- - - - - - - - - - - - - - - - - - - - -
Table 12 SessionPersistence

Parameter

-

Type

-

Description

-

cookie_name

-

String

-

Specifies the cookie name.

-

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

-

The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 0

-

Maximum: 1024

-

type

-

String

-

Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, only SOURCE_IP takes effect.

    -

  • For dedicated load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can only be HTTP_COOKIE.

    -

  • For shared load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can be HTTP_COOKIE or APP_COOKIE.

    -
-

persistence_timeout

-

Integer

-

Specifies the stickiness duration, in minutes. This parameter will not take effect when type is set to APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60, and the default value is 1.

    -

  • If the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440, and the default value is 1440.

    -
-
- - - - - - - - - - - - - - - - -
Table 13 SlowStart

Parameter

-

Type

-

Description

-

enable

-

Boolean

-

Specifies whether to enable slow start.

-

true indicates that this function is enabled, and false indicates this function is disabled.

-

Default: false

-

duration

-

Integer

-

Specifies the slow start duration, in seconds.

-

The value ranges from 30 to 1200, and the default value is 30.

-

Minimum: 30

-

Maximum: 1200

-

Default: 30

-
- - -

Example Requests

Adding an HTTP backend server group

-
POST
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools
-
-{
-  "pool" : {
-    "name" : "My pool",
-    "lb_algorithm" : "LEAST_CONNECTIONS",
-    "listener_id" : "0b11747a-b139-492f-9692-2df0b1c87193",
-    "protocol" : "HTTP",
-    "slow_start" : {
-      "enable" : true,
-      "duration" : 50
-    }
-  }
-}
- -

Example Responses

Status code: 201

-

Successful request.

-
{
-  "pool" : {
-    "lb_algorithm" : "LEAST_CONNECTIONS",
-    "protocol" : "HTTP",
-    "description" : "",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "098b2f68-af1c-41a9-8efd-69958722af62"
-    } ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "listeners" : [ {
-      "id" : "0b11747a-b139-492f-9692-2df0b1c87193"
-    } ],
-    "members" : [ ],
-    "id" : "36ce7086-a496-4666-9064-5ba0e6840c75",
-    "name" : "My pool",
-    "ip_version" : "v4",
-    "slow_start" : {
-      "enable" : true,
-      "duration" : 50
-    }
-  },
-  "request_id" : "2d974978-0733-404d-a21a-b29204f4803a"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

201

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/CreatePool1.html b/docs/elb/api-ref/CreatePool1.html deleted file mode 100644 index 44dc6c20c..000000000 --- a/docs/elb/api-ref/CreatePool1.html +++ /dev/null @@ -1,654 +0,0 @@ - - -

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.

-

If listener_id is specified, the listener must have no backend server group associated.

- -

URI

POST /v3/{project_id}/elb/pools

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

pool

-

Yes

-

CreatePoolOption object

-

Specifies the backend server group.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreatePoolOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server group. The value can only be updated to true.

-

This parameter is unsupported. Please do not use it.

-

description

-

No

-

String

-

Provides supplementary information about the backend server group.

-

Minimum: 0

-

Maximum: 255

-

lb_algorithm

-

Yes

-

String

-

Specifies the load balancing algorithm used by the load balancer to route requests to backend servers.

-

The value can be one of the following:

-

  • ROUND_ROBIN: weighted round robin

    -

  • LEAST_CONNECTIONS: weighted least connections

    -

  • SOURCE_IP: source IP hash

    -
-

When the value is SOURCE_IP, the weights of backend servers are invalid.

-

listener_id

-

No

-

String

-

Specifies the ID of the listener associated with the backend server group. Specify either listener_id or loadbalancer_id, or both of them.

-

Minimum: 1

-

Maximum: 36

-

loadbalancer_id

-

No

-

String

-

Specifies the ID of the associated load balancer. Specify either listener_id or loadbalancer_id, or both of them.

-

Minimum: 1

-

Maximum: 36

-

name

-

No

-

String

-

Specifies the backend server group name.

-

Minimum: 0

-

Maximum: 255

-

project_id

-

No

-

String

-

Specifies the project ID.

-

protocol

-

Yes

-

String

-

Specifies the protocol used by the backend server group to receive requests. TCP, UDP, and HTTP are supported.

-

  • For UDP listeners, the protocol of the backend server group must be UDP.

    -

  • For TCP listeners, the protocol of the backend server group must be TCP.

    -

  • For HTTP or HTTPS listeners, the protocol of the backend server group must be HTTP.

    -
-

Minimum: 1

-

Maximum: 255

-

session_persistence

-

No

-

CreatePoolSessionPersistenceOption object

-

Specifies whether to enable sticky sessions.

-

slow_start

-

No

-

CreatePoolSlowStartOption object

-

Specifies whether to enable slow start. After you enable slow start, new backend servers added to the backend server group are warmed up, and the number of requests they can receive increases linearly during the configured slow start duration.

-

This parameter can be used when the protocol of the backend server group is HTTP or HTTPS. An error will be returned if the protocol is not HTTP or HTTPS.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 CreatePoolSessionPersistenceOption

Parameter

-

Mandatory

-

Type

-

Description

-

cookie_name

-

No

-

String

-

Specifies the cookie name. This parameter will take effect only when type is set to APP_COOKIE. Otherwise, an error will be returned.

-

The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 0

-

Maximum: 1024

-

type

-

Yes

-

String

-

Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, only SOURCE_IP takes effect.

    -

  • For dedicated load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can only be HTTP_COOKIE.

    -

  • For shared load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can be HTTP_COOKIE or APP_COOKIE.

    -
-

persistence_timeout

-

No

-

Integer

-

Specifies the stickiness duration, in minutes. This parameter will not take effect when type is set to APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60, and the default value is 1.

    -

  • If the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440, and the default value is 1440.

    -
-
- - - - - - - - - - - - - - - - - - - -
Table 6 CreatePoolSlowStartOption

Parameter

-

Mandatory

-

Type

-

Description

-

enable

-

Yes

-

Boolean

-

Specifies whether to enable slow start.

-

true indicates that this function is enabled, and false indicates this function is disabled.

-

Default: false

-

duration

-

Yes

-

Integer

-

Specifies the slow start duration, in seconds.

-

The value ranges from 30 to 1200, and the default value is 30.

-

Minimum: 30

-

Maximum: 1200

-

Default: 30

-
- - -

Response Parameters

Status code: 201

- - - - - - - - - - - - - - - -
Table 7 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

pool

-

Pool object

-

Specifies the backend server group.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 Pool

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server group. The value can only be updated to true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

String

-

Provides supplementary information about the backend server group.

-

healthmonitor_id

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

id

-

String

-

Specifies the backend server group ID.

-

lb_algorithm

-

String

-

Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the backend server group.

-

The value can be ROUND_ROBIN (weighted round robin), LEAST_CONNECTIONS (weighted least connections), or SOURCE_IP (source IP hash).

-

When the value is SOURCE_IP, the weight parameter is invalid.

-

listeners

-

Array of ListenerRef objects

-

Lists the listeners associated with the backend server group.

-

loadbalancers

-

Array of LoadBalancerRef objects

-

Lists the IDs of load balancers associated with the backend server group.

-

If only listener_id is specified during the creation of the backend server group, the ID of the loadbalancers parameter in the response is the ID of the load balancer to which the listener is added.

-

members

-

Array of MemberRef objects

-

Lists the backend servers in the backend server group.

-

name

-

String

-

Specifies the backend server group name.

-

project_id

-

String

-

Specifies the project ID.

-

protocol

-

String

-

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

-

  • For UDP listeners, the protocol of the backend server group must be UDP.

    -

  • For TCP listeners, the protocol of the backend server group must be TCP.

    -

  • For HTTP or HTTPS listeners, the protocol of the backend server group must be HTTP.

    -
-

session_persistence

-

SessionPersistence object

-

Specifies the sticky session.

-

ip_version

-

String

-

Specifies the IP version supported by the backend server group.

-

  • Shared load balancers: The default value is v4.

    -

  • Dedicated load balancers: The value can be dualstack, v4, or v6.

    -
-

When the protocol of the backend server group is TCP or UDP, ip_version is set to dualstack, indicating that both IPv4 and IPv6 are supported.

-

When the protocol of the backend server group is HTTP, ip_version is set to v4.

-

IPv6 is unsupported. Only v4 is returned.

-

Default: dualstack

-

slow_start

-

SlowStart object

-

Specifies whether to enable slow start. After you enable slow start, new backend servers added to the backend server group are warmed up, and the number of requests they can receive increases linearly during the configured slow start duration.

-

This parameter can be used when the protocol of the backend server group is HTTP or HTTPS. An error will be returned if the protocol is not HTTP or HTTPS.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - -
Table 9 ListenerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-
- - - - - - - - - - - - -
Table 10 LoadBalancerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-
- - - - - - - - - - - - -
Table 11 MemberRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

-
- - - - - - - - - - - - - - - - - - - - -
Table 12 SessionPersistence

Parameter

-

Type

-

Description

-

cookie_name

-

String

-

Specifies the cookie name.

-

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

-

The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 0

-

Maximum: 1024

-

type

-

String

-

Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, only SOURCE_IP takes effect.

    -

  • For dedicated load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can only be HTTP_COOKIE.

    -

  • For shared load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can be HTTP_COOKIE or APP_COOKIE.

    -
-

persistence_timeout

-

Integer

-

Specifies the stickiness duration, in minutes. This parameter will not take effect when type is set to APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60, and the default value is 1.

    -

  • If the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440, and the default value is 1440.

    -
-
- - - - - - - - - - - - - - - - -
Table 13 SlowStart

Parameter

-

Type

-

Description

-

enable

-

Boolean

-

Specifies whether to enable slow start.

-

true indicates that this function is enabled, and false indicates this function is disabled.

-

Default: false

-

duration

-

Integer

-

Specifies the slow start duration, in seconds.

-

The value ranges from 30 to 1200, and the default value is 30.

-

Minimum: 30

-

Maximum: 1200

-

Default: 30

-
- - -

Example Requests

Adding an HTTP backend server group

-
POST
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools
-
-{
-  "pool" : {
-    "name" : "My pool",
-    "lb_algorithm" : "LEAST_CONNECTIONS",
-    "listener_id" : "0b11747a-b139-492f-9692-2df0b1c87193",
-    "protocol" : "HTTP",
-    "slow_start" : {
-      "enable" : true,
-      "duration" : 50
-    }
-  }
-}
- -

Example Responses

Status code: 201

-

Successful request.

-
{
-  "pool" : {
-    "lb_algorithm" : "LEAST_CONNECTIONS",
-    "protocol" : "HTTP",
-    "description" : "",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "098b2f68-af1c-41a9-8efd-69958722af62"
-    } ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "listeners" : [ {
-      "id" : "0b11747a-b139-492f-9692-2df0b1c87193"
-    } ],
-    "members" : [ ],
-    "id" : "36ce7086-a496-4666-9064-5ba0e6840c75",
-    "name" : "My pool",
-    "ip_version" : "v4",
-    "slow_start" : {
-      "enable" : true,
-      "duration" : 50
-    }
-  },
-  "request_id" : "2d974978-0733-404d-a21a-b29204f4803a"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

201

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/DeleteCertificate.html b/docs/elb/api-ref/DeleteCertificate.html deleted file mode 100644 index 4bc7839b6..000000000 --- a/docs/elb/api-ref/DeleteCertificate.html +++ /dev/null @@ -1,97 +0,0 @@ - - -

Deleting a Certificate

-

Function

This API is used to delete an SSL certificate.

- -

Constraints

If the certificate is used by a listener, the certificate cannot be deleted, and the 409 Conflict error code will be displayed.

- -

URI

DELETE /v3/{project_id}/elb/certificates/{certificate_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

certificate_id

-

Yes

-

String

-

Specifies a certificate ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

None

- -

Example Requests

DELETE
-https://{elb_endpoint}/v3/{project_id}/elb/certificates/{certificate_id}
- -

Example Responses

None

- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

204

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/DeleteHealthMonitor.html b/docs/elb/api-ref/DeleteHealthMonitor.html deleted file mode 100644 index c6fcd1737..000000000 --- a/docs/elb/api-ref/DeleteHealthMonitor.html +++ /dev/null @@ -1,98 +0,0 @@ - - -

Deleting a Health Check

-

Function

This API is used to delete a health check.

- -

Constraints

The health check can be deleted only when the provisioning status of the associated load balancer is ACTIVE.

- -

URI

DELETE /v3/{project_id}/elb/healthmonitors/{healthmonitor_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

healthmonitor_id

-

Yes

-

String

-

Specifies the health check ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

None

- -

Example Requests

DELETE
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors/c2b210b2-60c4-449d-91e2-9e9ea1dd7441
- -

Example Responses

None

- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

204

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/DeleteL7Policy.html b/docs/elb/api-ref/DeleteL7Policy.html deleted file mode 100644 index 41320a65e..000000000 --- a/docs/elb/api-ref/DeleteL7Policy.html +++ /dev/null @@ -1,96 +0,0 @@ - - -

Deleting a Forwarding Policy

-

Function

This API is used to delete a forwarding policy.

- -

URI

DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

None

- -

Example Requests

DELETE
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be
- -

Example Responses

None

- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

204

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/DeleteL7Rule.html b/docs/elb/api-ref/DeleteL7Rule.html deleted file mode 100644 index a9e7e2e62..000000000 --- a/docs/elb/api-ref/DeleteL7Rule.html +++ /dev/null @@ -1,105 +0,0 @@ - - -

Deleting a Forwarding Rule

-

Function

This API is used to delete a forwarding rule.

- -

URI

DELETE /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}

- - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-

l7rule_id

-

Yes

-

String

-

Specifies the forwarding rule ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

None

- -

Example Requests

DELETE
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules/84f4fcae-9c15-4e19-a99f-72c0b08fd3d7
- -

Example Responses

None

- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

204

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/DeleteListener.html b/docs/elb/api-ref/DeleteListener.html deleted file mode 100644 index 401da3162..000000000 --- a/docs/elb/api-ref/DeleteListener.html +++ /dev/null @@ -1,97 +0,0 @@ - - -

Deleting a Listener

-

Function

This API is used to delete a listener.

- -

Constraints

Before you delete a listener, delete the associated backend server group or disassociate the backend server group from the listener, and then delete all forwarding policies.

- -

URI

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

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

None

- -

Example Requests

DELETE
-https://{elb_endpoint}/v3/{project_id}/elb/listeners/{listener_id}
- -

Example Responses

None

- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

204

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/DeleteLoadBalancer.html b/docs/elb/api-ref/DeleteLoadBalancer.html deleted file mode 100644 index 31fad32dc..000000000 --- a/docs/elb/api-ref/DeleteLoadBalancer.html +++ /dev/null @@ -1,98 +0,0 @@ - - -

Deleting a Load Balancer

-

Function

This API is used to delete a load balancer.

- -

Constraints

All listeners added to the load balancer must be deleted before the load balancer is deleted.

- -

URI

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

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

None

- -

Example Requests

DELETE
-
-https://{elb_endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
- -

Example Responses

None

- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

204

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/DeleteMember.html b/docs/elb/api-ref/DeleteMember.html deleted file mode 100644 index 6e6074c8d..000000000 --- a/docs/elb/api-ref/DeleteMember.html +++ /dev/null @@ -1,110 +0,0 @@ - - -

Removing a Backend Server

-

Function

This API is used to remove a backend server.

- -

Constraints

When you remove backend servers, note the following:

- - -

URI

DELETE /v3/{project_id}/elb/pools/{pool_id}/members/{member_id}

- - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-

member_id

-

Yes

-

String

-

Specifies the backend server ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

None

- -

Example Requests

DELETE
-
-https://{elb_endpoint}/v3/9a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members/1923923e-fe8a-484f-bdbc-e11559b1f48f
- -

Example Responses

None

- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

204

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/DeletePool.html b/docs/elb/api-ref/DeletePool.html deleted file mode 100644 index 260bee64d..000000000 --- a/docs/elb/api-ref/DeletePool.html +++ /dev/null @@ -1,98 +0,0 @@ - - -

Deleting a Backend Server Group

-

Function

This API is used to delete a backend server group.

- -

Constraints

A backend server group can be deleted only after all servers are removed from the group, the health check configured for the group is deleted, and the group has no forwarding policies associated.

- -

URI

DELETE /v3/{project_id}/elb/pools/{pool_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

None

- -

Example Requests

DELETE
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75
- -

Example Responses

None

- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

204

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/ListAvailabilityZones.html b/docs/elb/api-ref/ListAvailabilityZones.html deleted file mode 100644 index 1257c1680..000000000 --- a/docs/elb/api-ref/ListAvailabilityZones.html +++ /dev/null @@ -1,154 +0,0 @@ - - -

Querying AZs

-

Function

This API is used to query all available AZs when you create a dedicated load balancer.

-

One set of AZs is returned. When you create a dedicated load balancer, you can select one or more AZs only in the set.

- -

URI

GET /v3/{project_id}/elb/availability-zones

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

availability_zones

-

Array<Array<AvailabilityZone>>

-

Specifies the AZs that are available during load balancer creation.

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-
- - - - - - - - - - - - - - - - -
Table 4 AvailabilityZone

Parameter

-

Type

-

Description

-

state

-

String

-

Specifies the AZ status. The value can only be ACTIVE.

-

code

-

String

-

Specifies the AZ code.

-
- - -

Example Requests

GET
-
-https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/availability-zones
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "availability_zones" : [ [ {
-    "state" : "ACTIVE",
-    "code" : "az1"
-  }, {
-    "state" : "ACTIVE",
-    "code" : "az2"
-  }, {
-    "state" : "ACTIVE",
-    "code" : "az3"
-  } ] ],
-  "request_id" : "0d799435-259e-459f-b2bc-0beee06f6a77"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: AZ - - - diff --git a/docs/elb/api-ref/ListCertificates.html b/docs/elb/api-ref/ListCertificates.html deleted file mode 100644 index b8c94cd80..000000000 --- a/docs/elb/api-ref/ListCertificates.html +++ /dev/null @@ -1,424 +0,0 @@ - - -

Querying Certificates

-

Function

This API is used to query all SSL certificates.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query.

-

Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v3/{project_id}/elb/certificates

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the last record on the previous page.

-

Note:

-

  • This parameter must be used together with limit.

    -

  • If this parameter is not specified, the first page will be queried.

    -

  • This parameter cannot be left blank or set to an invalid ID.

    -
-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-

Minimum: 0

-

Maximum: 2000

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link. This parameter must be used together with limit.

-

id

-

No

-

Array

-

Specifies a certificate ID.

-

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

-

name

-

No

-

Array

-

Specifies the certificate name.

-

Multiple names can be queried in the format of name=xxx&name=xxx.

-

description

-

No

-

Array

-

Provides supplementary information about the certificate.

-

Multiple descriptions can be queried in the format of description=xxx&description=xxx.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is unsupported. Please do not use it.

-

domain

-

No

-

Array

-

Specifies the domain names used by the server certificate. This parameter is available only when type is set to server.

-

Multiple domain names can be queried in the format of domain=xxx&domain=xxx.

-

type

-

No

-

Array

-

Specifies the certificate type.

-

The value can be server or client. server indicates server certificates, and client indicates CA certificates.

-

Multiple types can be queried in the format of type=xxx&type=xxx.

-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 3 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

page_info

-

PageInfo object

-

Certificate pagination information

-

certificates

-

Array of CertificateInfo objects

-

Lists the certificates.

-
- - - - - - - - - - - - - - - - - - - - -
Table 5 PageInfo

Parameter

-

Type

-

Description

-

previous_marker

-

String

-

Specifies the ID of the first record in the pagination query result. This parameter will not be returned if no query result is returned.

-

next_marker

-

String

-

Marks the start record on the next page in the pagination query result. This parameter will not be returned if there is no next page.

-

current_count

-

Integer

-

Specifies the number of records.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 CertificateInfo

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is unsupported. Please do not use it.

-

certificate

-

String

-

Specifies the private key of the certificate. The value must be PEM encoded.

-

description

-

String

-

Provides supplementary information about the certificate.

-

Minimum: 1

-

Maximum: 255

-

domain

-

String

-

Specifies the domain names used by the server certificate.

-

  • This parameter will take effect only when type is set to server, and its default value is "".

    -

  • This parameter will not take effect even if it is passed and type is set to client. However, domain names will still be verified.

    -
-

Note:

-

  • The value can contain 0 to 1024 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 30 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

    -
-

Minimum: 1

-

Maximum: 1024

-

id

-

String

-

Specifies a certificate ID.

-

name

-

String

-

Specifies the certificate name.

-

Minimum: 1

-

Maximum: 255

-

private_key

-

String

-

Specifies the private key of the server certificate. The value must be PEM encoded.

-

  • This parameter will be ignored if type is set to client. A CA server can still be created and used normally. This parameter will be left blank even if you enter a private key that is not PEM encoded.

    -

  • This parameter is valid and mandatory only when type is set to server. If you enter an invalid private key, an error is returned.

    -
-

type

-

String

-

Specifies the certificate type. The value can be server or client. server indicates server certificates, and client indicates CA certificates. The default value is server.

-

created_at

-

String

-

Specifies the time when the certificate was created.

-

updated_at

-

String

-

Specifies the time when the certificate was updated.

-

expire_time

-

String

-

Specifies the time when the certificate expires.

-

project_id

-

String

-

Specifies the project ID.

-
- - -

Example Requests

GET https://{elb_endpoint}/v3/{project_id}/elb/certificates
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "certificates" : [ {
-    "id" : "5494a835d88f40ff940554992f2f04d4",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "name" : "https_certificatekkkk",
-    "type" : "server",
-    "description" : "description for certificatehhhh",
-    "private_key" : "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M\n253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPe\ntB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rM\nMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXt\nCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2Chl\nZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08k\nEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/Hl\nfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQB\nZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKr\nciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9M\nEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7Ale\nkrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CT\nXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kx\nGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dt\nJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLr\niWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZ\nlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBU\nxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB\n1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAd\nXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak\n/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4Vha\nfI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf\n7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9o\njHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIuk\nfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd\n3fy+1rCUwzOp9LSjtJYf4ege\n-----END PRIVATE KEY-----",
-    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD\nb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAG\nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\n0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5\nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh9\n7B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaS\nIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/K\ny09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0Wy\nYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29t\nhwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUA\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce+77s96i3I\n-----END CERTIFICATE-----",
-    "admin_state_up" : true,
-    "created_at" : "2019-04-21T18:59:43Z",
-    "updated_at" : "2019-04-21T18:59:43Z",
-    "expire_time" : "2045-11-17T13:25:47Z"
-  }, {
-    "id" : "7875ccb4c6b44cdb90ab2ab89892ab71",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "name" : "https_certificatekkkk",
-    "type" : "client",
-    "domain" : "sda.com",
-    "description" : "description for certificatehhhh",
-    "private_key" : "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M\n253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPe\ntB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rM\nMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXt\nCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2Chl\nZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08k\nEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/Hl\nfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQB\nZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKr\nciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9M\nEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7Ale\nkrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CT\nXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kx\nGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dt\nJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLr\niWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZ\nlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBU\nxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB\n1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAd\nXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak\n/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4Vha\nfI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf\n7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9o\njHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIuk\nfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd\n3fy+1rCUwzOp9LSjtJYf4ege\n-----END PRIVATE KEY-----",
-    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD\nb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAG\nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\n0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5\nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh9\n7B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaS\nIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/K\ny09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0Wy\nYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29t\nhwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUA\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce+77s96i3I\n-----END CERTIFICATE-----",
-    "admin_state_up" : true,
-    "created_at" : "2018-10-29T20:16:17Z",
-    "updated_at" : "2019-04-06T21:33:24Z",
-    "expire_time" : "2045-11-17T13:25:47Z"
-  }, {
-    "id" : "7f41c96223d34ebaa3c8e836b6625ec0",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "name" : "asdf",
-    "type" : "server",
-    "domain" : "sda.com",
-    "description" : "",
-    "private_key" : "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M\n253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPe\ntB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rM\nMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXt\nCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2Chl\nZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08k\nEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/Hl\nfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQB\nZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKr\nciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9M\nEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7Ale\nkrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CT\nXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kx\nGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dt\nJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLr\niWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZ\nlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBU\nxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB\n1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAd\nXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak\n/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4Vha\nfI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf\n7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9o\njHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIuk\nfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd\n3fy+1rCUwzOp9LSjtJYf4ege\n-----END PRIVATE KEY-----",
-    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD\nb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAG\nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\n0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5\nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh9\n7B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaS\nIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/K\ny09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0Wy\nYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29t\nhwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUA\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce+77s96i3I\n-----END CERTIFICATE-----",
-    "admin_state_up" : true,
-    "created_at" : "2019-03-31T22:23:51Z",
-    "updated_at" : "2019-03-31T23:26:49Z",
-    "expire_time" : "2045-11-17T13:25:47Z"
-  } ],
-  "page_info" : {
-    "previous_marker" : "5494a835d88f40ff940554992f2f04d4",
-    "current_count" : 3
-  },
-  "request_id" : "a27e7ae6-d901-4ec2-8e66-b8a1413819ad"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/ListFlavors.html b/docs/elb/api-ref/ListFlavors.html deleted file mode 100644 index 9a1b5b0f0..000000000 --- a/docs/elb/api-ref/ListFlavors.html +++ /dev/null @@ -1,391 +0,0 @@ - - -

Querying Flavors

-

Function

This API is used to query all load balancer flavors that are available to a specific user in a specific region.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query.

-

Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v3/{project_id}/elb/flavors

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the last record on the previous page.

-

Note:

-

  • This parameter must be used together with limit.

    -

  • If this parameter is not specified, the first page will be queried.

    -

  • This parameter cannot be left blank or set to an invalid ID.

    -
-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-

Minimum: 0

-

Maximum: 2000

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction.

-

The value can be true or false, and the default value is false.

-

The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

Array

-

Specifies the flavor ID.

-

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

-

name

-

No

-

Array

-

Specifies the flavor name.

-

Multiple names can be queried in the format of name=xxx&name=xxx.

-

type

-

No

-

Array

-

Specifies the flavor type. Flavors can be filtered by type.

-

Multiple types can be queried in the format of type=xxx&type=xxx.

-

shared

-

No

-

Boolean

-

Specifies whether the flavor is available to all users.

-

  • true indicates that the flavor is available to all users.

    -

  • false indicates that the flavor is available only to a specific user.

    -
-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 3 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

flavors

-

Array of Flavor objects

-

Lists the flavors.

-

page_info

-

PageInfo object

-

Shows pagination information about the load balancer flavors.

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 Flavor

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the flavor ID.

-

info

-

FlavorInfo object

-

Specifies the flavor details.

-

name

-

String

-

Specifies the flavor name.

-

shared

-

Boolean

-

Specifies whether the flavor is available to all users.

-

  • true indicates that the flavor is available to all users.

    -

  • false indicates that the flavor is available only to a specific user.

    -
-

Default: true

-

project_id

-

String

-

Specifies the project ID.

-

type

-

String

-

Specifies the flavor type. Flavors can be filtered by type.

-

Minimum: 1

-

Maximum: 32

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 FlavorInfo

Parameter

-

Type

-

Description

-

connection

-

Integer

-

Specifies the maximum concurrent connections.

-

cps

-

Integer

-

Specifies the number of new connections per second.

-

qps

-

Integer

-

Specifies the number of requests per second at Layer 7.

-

bandwidth

-

Integer

-

Specifies the inbound and outbound bandwidth in the unit of Kbit/s.

-
- - - - - - - - - - - - - - - - - - - - -
Table 7 PageInfo

Parameter

-

Type

-

Description

-

previous_marker

-

String

-

Specifies the ID of the first record in the pagination query result. This parameter will not be returned if no query result is returned.

-

next_marker

-

String

-

Marks the start record on the next page in the pagination query result. This parameter will not be returned if there is no next page.

-

current_count

-

Integer

-

Specifies the number of records.

-
- - -

Example Requests

GET
-
-https://{ELB_Endpoint}/v3/{060576782980d5762f9ec014dd2f1148}/elb/flavors?limit=2&marker=179568ef-5ba4-4ca0-8c5e-5d581db779b1
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "flavors" : [ {
-    "shared" : true,
-    "project_id" : "573d73c9f90e48d0bddfa0eb202b25c2",
-    "info" : {
-      "connection" : 1000000,
-      "cps" : 80000,
-      "qps" : 50000
-    },
-    "id" : "b2c5d750-5ea8-42f8-a6a8-8b0a1441168a",
-    "name" : "L7_flavor.elb.s2.medium",
-    "type" : "L7"
-  }, {
-    "shared" : true,
-    "project_id" : "573d73c9f90e48d0bddfa0eb202b25c2",
-    "info" : {
-      "connection" : 6000,
-      "cps" : 3000
-    },
-    "id" : "becf3beb-7653-45ab-a025-961597a901bc",
-    "name" : "L4_flavor.elb.s2.small",
-    "type" : "L4"
-  }, {
-    "shared" : true,
-    "project_id" : "3fb9975312cc43808cb274e2ac25d30c",
-    "info" : {
-      "connection" : 6000,
-      "cps" : 3000,
-      "qps" : 1000
-    },
-    "id" : "fb9394ab-d63d-4b4d-8ea0-b6dc974accc6",
-    "name" : "L7_flavor.elb.s1.small",
-    "type" : "L7"
-  } ],
-  "page_info" : {
-    "next_marker" : "fb9394ab-d63d-4b4d-8ea0-b6dc974accc6",
-    "previous_marker" : "b2c5d750-5ea8-42f8-a6a8-8b0a1441168a",
-    "current_count" : 3
-  },
-  "request_id" : "07b7cabe-bfb5-4809-8c28-5a90a961a707"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Load Balancer Flavor - - - diff --git a/docs/elb/api-ref/ListHealthMonitors.html b/docs/elb/api-ref/ListHealthMonitors.html deleted file mode 100644 index 616411d06..000000000 --- a/docs/elb/api-ref/ListHealthMonitors.html +++ /dev/null @@ -1,562 +0,0 @@ - - -

Querying Health Checks

-

Function

This API is used to query all health checks.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query.

-

Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v3/{project_id}/elb/healthmonitors

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the last record on the previous page.

-

Note:

-

  • This parameter must be used together with limit.

    -

  • If this parameter is not specified, the first page will be queried.

    -

  • This parameter cannot be left blank or set to an invalid ID.

    -
-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-

Minimum: 0

-

Maximum: 2000

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction.

-

The value can be true or false, and the default value is false.

-

The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

Array

-

Specifies the health check ID.

-

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

-

monitor_port

-

No

-

Array

-

Specifies the port used for the health check.

-

Multiple ports can be queried in the format of monitor_port=xxx&monitor_port=xxx.

-

domain_name

-

No

-

Array

-

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

-

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

-

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

-

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

-

Multiple domain names can be queried in the format of domain_name=xxx&domain_name=xxx.

-

name

-

No

-

Array

-

Specifies the health check name.

-

Multiple names can be queried in the format of name=xxx&name=xxx.

-

delay

-

No

-

Array

-

Specifies the interval between health checks, in seconds.

-

Multiple intervals can be queried in the format of delay=xxx&delay=xxx.

-

max_retries

-

No

-

Array

-

Specifies the maximum number of retries.

-

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

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the health check.

-

Although this parameter can be used in the APIs for creating and updating health checks, its actual value depends on whether cloud servers that serve as the backend servers exist. If cloud servers exist, the value is true. Otherwise, the value is false.

-

max_retries_down

-

No

-

Array

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE. The value ranges from 1 to 10.

-

timeout

-

No

-

Integer

-

Specifies the maximum time required for waiting for a response from the health check, in seconds. It is recommended that you set the value less than that of parameter delay.

-

type

-

No

-

Array

-

Specifies the health check protocol.

-

Multiple protocols can be queried in the format of type=xxx&type=xxx.

-

expected_codes

-

No

-

Array

-

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

-

The value options are as follows:

-

  • A specific value, for example, 200

    -

  • A list of values that are separated with commas (,), for example, 200, 202

    -

  • A value range, for example, 200-204

    -
-

Multiple status codes can be queried in the format of expected_codes=xxx&expected_codes=xxx.

-

This parameter is unsupported. Please do not use it.

-

url_path

-

No

-

Array

-

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /. This parameter is available only when type is set to HTTP.

-

Multiple paths can be queried in the format of url_path=xxx&url_path=xxx.

-

http_method

-

No

-

Array

-

Specifies the HTTP method. This parameter will take effect only when type is set to HTTP.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

-

Multiple methods can be queried in the format of http_method=xxx&http_method=xxx.

-

This parameter is unsupported. Please do not use it.

-

enterprise_project_id

-

No

-

Array

-

Specifies the enterprise project ID.

-

  • If this parameter is not passed, resources in the default enterprise project are queried, and authentication is performed based on the default enterprise project.

    -

  • If this parameter is passed, its value can be the ID of an existing enterprise project or all_granted_eps.

    -
-

If the value is a specific ID, resources in the specific enterprise project are required. If the value is all_granted_eps, resources in all enterprise projects are queried.

-

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

-

This parameter is unsupported. Please do not use it.

-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 3 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

page_info

-

PageInfo object

-

Shows pagination information.

-

healthmonitors

-

Array of HealthMonitor objects

-

Specifies the health check.

-
- - - - - - - - - - - - - - - - - - - - -
Table 5 PageInfo

Parameter

-

Type

-

Description

-

previous_marker

-

String

-

Specifies the ID of the first record in the pagination query result. This parameter will not be returned if no query result is returned.

-

next_marker

-

String

-

Marks the start record on the next page in the pagination query result. This parameter will not be returned if there is no next page.

-

current_count

-

Integer

-

Specifies the number of records.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 HealthMonitor

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the health check. Two value options are available. true indicates that the health check is enabled, and false indicates that the health check is disabled.

-

Default: true

-

delay

-

Integer

-

Specifies the interval between health checks, in seconds.

-

Minimum: 1

-

Maximum: 50

-

domain_name

-

String

-

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

-

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

-

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.

-

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

-

expected_codes

-

String

-

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

-

The value options are as follows:

-

  • A specific value, for example, 200

    -

  • A list of values that are separated with commas (,), for example, 200, 202

    -

  • A value range, for example, 200-204

    -
-

This parameter is unsupported. Please do not use it.

-

Default: 200

-

http_method

-

String

-

Specifies the HTTP method. This parameter will take effect only when type is set to HTTP.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

-

This parameter is unsupported. Please do not use it.

-

Default: GET

-

id

-

String

-

Specifies the health check ID.

-

max_retries

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

Minimum: 1

-

Maximum: 10

-

max_retries_down

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

-

Minimum: 1

-

Maximum: 10

-

Default: 3

-

monitor_port

-

Integer

-

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

-

Minimum: 1

-

Maximum: 65535

-

name

-

String

-

Specifies the health check name.

-

pools

-

Array of PoolRef objects

-

Lists the IDs of backend server groups for which the health check is configured.

-

project_id

-

String

-

Specifies the project ID.

-

timeout

-

Integer

-

Specifies the maximum time required for waiting for a response from the health check, in seconds. It is recommended that you set the value less than that of parameter delay.

-

Minimum: 1

-

Maximum: 50

-

type

-

String

-

Specifies the health check protocol.

-

url_path

-

String

-

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /. This parameter is available only when type is set to HTTP.

-

Default: /

-
- - - - - - - - - - - - -
Table 7 PoolRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "healthmonitors" : [ {
-    "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "name" : "My Healthmonitor update",
-    "delay" : 10,
-    "max_retries" : 10,
-    "pools" : [ {
-      "id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0"
-    } ],
-    "admin_state_up" : true,
-    "timeout" : 30,
-    "type" : "HTTP",
-    "expected_codes" : "200",
-    "url_path" : "/",
-    "http_method" : "GET"
-  }, {
-    "id" : "cda1af03-0660-4fd2-8edf-e38c79846e08",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "domain_name" : "akik..un.com",
-    "name" : "lijunqiu",
-    "delay" : 50,
-    "max_retries" : 1,
-    "pools" : [ {
-      "id" : "ae6e45ba-be84-4074-8ac6-bc4a56484809"
-    } ],
-    "admin_state_up" : false,
-    "timeout" : 3,
-    "type" : "UDP_CONNECT",
-    "url_path" : "/world"
-  } ],
-  "page_info" : {
-    "next_marker" : "cda1af03-0660-4fd2-8edf-e38c79846e08",
-    "previous_marker" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
-    "current_count" : 2
-  },
-  "request_id" : "814bc40e-8b0a-4ced-b8e5-f136c3e1df6a"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/ListL7Policies.html b/docs/elb/api-ref/ListL7Policies.html deleted file mode 100644 index 04219761e..000000000 --- a/docs/elb/api-ref/ListL7Policies.html +++ /dev/null @@ -1,712 +0,0 @@ - - -

Querying Forwarding Policies

-

Function

This API is used to query all forwarding policies.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query.

-

Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v3/{project_id}/elb/l7policies

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the last record on the previous page.

-

Note:

-

  • This parameter must be used together with limit.

    -

  • If this parameter is not specified, the first page will be queried.

    -

  • This parameter cannot be left blank or set to an invalid ID.

    -
-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-

Minimum: 0

-

Maximum: 2000

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction.

-

The value can be true or false, and the default value is false.

-

The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

enterprise_project_id

-

No

-

Array

-

Specifies the enterprise project ID.

-

  • If this parameter is not passed, resources in the default enterprise project are queried, and authentication is performed based on the default enterprise project.

    -

  • If this parameter is passed, its value can be the ID of an existing enterprise project or all_granted_eps.

    -
-

If the value is a specific ID, resources in the specific enterprise project are required. If the value is all_granted_eps, resources in all enterprise projects are queried.

-

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

-

This parameter is unsupported. Please do not use it.

-

id

-

No

-

Array

-

Specifies the forwarding policy ID.

-

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

-

name

-

No

-

Array

-

Specifies the forwarding policy name.

-

Multiple names can be queried in the format of name=xxx&name=xxx.

-

description

-

No

-

Array

-

Provides supplementary information about the forwarding policy.

-

Multiple descriptions can be queried in the format of description=xxx&description=xxx.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding policy. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

listener_id

-

No

-

Array

-

Specifies the ID of the listener to which the forwarding policy is added.

-

  • If action is set to REDIRECT_TO_POOL, the forwarding policy can be added to an HTTP or HTTPS listener.

    -

  • If action is set to REDIRECT_TO_LISTENER, the forwarding policy can be added to an HTTP listener.

    -
-

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

-

position

-

No

-

Array

-

Specifies the forwarding policy priority.

-

Multiple priorities can be queried in the format of position=xxx&position=xxx.

-

This parameter is unsupported. Please do not use it.

-

action

-

No

-

Array

-

Specifies where requests will be forwarded. The value can be one of the following:

-

  • REDIRECT_TO_POOL: Requests will be forwarded to another backend server group.

    -

  • REDIRECT_TO_LISTENER: Requests will be redirected to an HTTPS listener.

    -
-

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

-

redirect_url

-

No

-

Array

-

Specifies the URL to which requests are forwarded.

-

Multiple URLs can be queried in the format of redirect_url=xxx&redirect_url=xxx.

-

This parameter is unsupported. Please do not use it.

-

redirect_pool_id

-

No

-

Array

-

Specifies the ID of the backend server group to which requests are forwarded. This parameter will take effect and is mandatory when action is set to REDIRECT_TO_POOL.

-

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

-

redirect_listener_id

-

No

-

Array

-

Specifies the ID of the listener to which requests are redirected. This parameter will take effect and is mandatory when action is set to REDIRECT_TO_LISTENER.

-

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

-

provisioning_status

-

No

-

Array

-

Specifies the provisioning status of the forwarding policy. The value can only be ACTIVE, indicating that the forwarding policy is provisioned successfully.

-

Multiple provisioning statuses can be queried in the format of provisioning_status=xxx&provisioning_status=xxx.

-

display_all_rules

-

No

-

Boolean

-

Specifies whether to display all information about the forwarding rule in the forwarding policy. The value can be true or false.

-

  • true indicates all information about the forwarding rule is displayed.

    -

  • false indicates that only the rule ID is displayed.

    -
-

priority

-

No

-

Array

-

Specifies the forwarding policy priority. A smaller value indicates a higher priority.

-

Multiple priorities can be queried in the format of position=xxx&position=xxx.

-

This parameter is unsupported. Please do not use it.

-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 3 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

page_info

-

PageInfo object

-

Shows pagination information.

-

l7policies

-

Array of L7Policy objects

-

Lists the forwarding policies.

-
- - - - - - - - - - - - - - - - - - - - -
Table 5 PageInfo

Parameter

-

Type

-

Description

-

previous_marker

-

String

-

Specifies the ID of the first record in the pagination query result. This parameter will not be returned if no query result is returned.

-

next_marker

-

String

-

Marks the start record on the next page in the pagination query result. This parameter will not be returned if there is no next page.

-

current_count

-

Integer

-

Specifies the number of records.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 L7Policy

Parameter

-

Type

-

Description

-

action

-

String

-

Specifies where requests will be forwarded. The value can be one of the following:

-

  • REDIRECT_TO_POOL: Requests will be forwarded to another backend server group.

    -

  • REDIRECT_TO_LISTENER: Requests will be redirected to an HTTPS listener.

    -
-

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.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding policy. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

String

-

Provides supplementary information about the forwarding policy.

-

id

-

String

-

Specifies the forwarding policy ID.

-

listener_id

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

  • If action is set to REDIRECT_TO_POOL, the forwarding policy can be added to an HTTP or HTTPS listener.

    -

  • If action is set to REDIRECT_TO_LISTENER, the forwarding policy can be added to an HTTP listener.

    -
-

name

-

String

-

Specifies the forwarding policy name.

-

Minimum: 1

-

Maximum: 255

-

position

-

Integer

-

Specifies the forwarding policy priority. This parameter cannot be updated.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 100

-

project_id

-

String

-

Specifies the project ID of the forwarding policy.

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding policy.

-

The value can only be ACTIVE.

-

Default: ACTIVE

-

redirect_listener_id

-

String

-

Specifies the ID of the listener that requests are redirected to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_LISTENER.

-

Only HTTPS listeners are supported, and the listener cannot be any listener added to other load balancers.

-

redirect_pool_id

-

String

-

Specifies the ID of the backend server group that requests are forwarded to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_POOL.

-

The specified backend server group cannot be the default one associated with the listener, or any backend server group associated with the forwarding policies of other listeners.

-

This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.

-

redirect_url

-

String

-

Specifies the URL to which requests are forwarded.

-

Format: protocol://host:port/path?query

-

This parameter is unsupported. Please do not use it.

-

rules

-

Array of RuleRef objects

-

Lists the forwarding rules in the forwarding policy.

-

redirect_url_config

-

RedirectUrlConfig object

-

Specifies the URL to which requests are forwarded.

-

For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

For dedicated load balancers, this parameter will take effect only when advanced forwarding is enabled (enhance_l7policy_enable is set to true). If it is passed when enhance_l7policy_enable is set to false, an error will be returned.

-

Format: protocol://host:port/path?query

-

At least one of the four parameters (protocol, host, port, and path) must be passed, or their values cannot be set to ${xxx} at the same time. (${xxx} indicates that the value in the request will be inherited. For example, ${host} indicates the host in the URL to be redirected.)

-

The values of protocol and port cannot be the same as those of the associated listener, and either host or path must be passed or their values cannot be ${xxx} at the same time.

-

This parameter is unsupported. Please do not use it.

-

fixed_response_config

-

FixtedResponseConfig object

-

Specifies the configuration of the page that will be returned. This parameter will take effect when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

This parameter is unsupported. Please do not use it.

-

priority

-

Integer

-

Specifies the forwarding policy priority. This parameter is available only for dedicated load balancers and will take effect when enhance_l7policy_enable is set to true.

-

A smaller value indicates a higher priority. The value must be unique for each forwarding policy of the same listener.

-

If action is set to REDIRECT_TO_LISTENER, the value can only be 0, indicating that REDIRECT_TO_LISTENER has the highest priority.

-

  • If enhance_l7policy_enable is set to false, forwarding policies are automatically prioritized based on the original sorting logic. Forwarding policy priorities are independent of each other regardless of domain names. If forwarding policies use the same domain name, their priorities follow the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If prefix match is used for matching, the longer the path, the higher the priority. If a forwarding policy contains only a domain name without a path specified, the path is /, and prefix match is used by default.

    -

  • If enhance_l7policy_enable is set to true and this parameter is not passed, the priority will set to a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. There will be two cases: a) If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to create because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, please specify a value or adjust the priorities of existing forwarding policies. b) If no forwarding policies exist, the highest priority of existing forwarding policies will set to 1 by default.

    -
-

This parameter is unsupported. Please do not use it.

-

Minimum: 0

-

Maximum: 10000

-
- - - - - - - - - - - - -
Table 7 RuleRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding rule ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 RedirectUrlConfig

Parameter

-

Type

-

Description

-

protocol

-

String

-

Specifies the protocol for redirection. The default value is ${protocol}, indicating that the protocol of the request will be used.

-

Value options:

-

  • HTTP

    -

  • HTTPS

    -

  • ${protocol}

    -
-

Minimum: 1

-

Maximum: 36

-

host

-

String

-

Specifies the host name that requests are redirected to. The value can contain only letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. The default value is ${host}, indicating that the host of the request will be used.

-

Default: ${host}

-

Minimum: 1

-

Maximum: 128

-

port

-

String

-

Specifies the port that requests are redirected to. The default value is ${port}, indicating that the port of the request will be used.

-

Default: ${port}

-

Minimum: 1

-

Maximum: 16

-

path

-

String

-

Specifies the path that requests are redirected to. The default value is ${path}, indicating that the path of the request will be used. The value can contain only letters, digits, and special characters _-';@^- %#&$.*+?,=!:|/()[]{} and must start with a slash (/).

-

Default: ${path}

-

Minimum: 1

-

Maximum: 128

-

query

-

String

-

Specifies the query string set in the URL for redirection. The default value is ${query}, indicating that the query string of the request will be used.

-

For example, in the URL https://www.xxx.com:8080/elb?type=loadbalancer, ${query} indicates type=loadbalancer. If this parameter is set to ${query}&name=my_name, the URL will be redirected to https://www.xxx.com:8080/elb?type=loadbalancer&name=my_name.

-

The value is case-sensitive and can contain only letters, digits, and special characters !$&'()*+,-./:;=?@^_`

-

Default: ${query}

-

Minimum: 0

-

Maximum: 128

-

status_code

-

String

-

Specifies the status code returned after the requests are redirected.

-

Value options:

-

  • 301

    -

  • 302

    -

  • 303

    -

  • 307

    -

  • 308

    -
-

Minimum: 1

-

Maximum: 16

-
- - - - - - - - - - - - - - - - - - - - -
Table 9 FixtedResponseConfig

Parameter

-

Type

-

Description

-

status_code

-

String

-

Specifies the HTTP status code configured in the forwarding policy. The value can be any integer in the range of 200–299, 400–499, or 500–599.

-

Minimum: 1

-

Maximum: 16

-

content_type

-

String

-

Specifies the format of the response body.

-

Value options:

-

  • text/plain

    -

  • text/css

    -

  • text/html

    -

  • application/javascript

    -

  • application/json

    -
-

Minimum: 0

-

Maximum: 32

-

message_body

-

String

-

Specifies the content of the response body.

-

Minimum: 0

-

Maximum: 1024

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies?display_all_rules=true
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "request_id" : "d3c67339-be91-4813-bb24-85728a5d326a",
-  "l7policies" : [ {
-    "redirect_pool_id" : "3b34340d-59e8-4c70-9ef5-b41b12023dc9",
-    "description" : "",
-    "admin_state_up" : true,
-    "rules" : [ {
-      "id" : "1e5f17df-feec-427e-a162-8e4e05e91085"
-    } ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "listener_id" : "e2220d2a-3faf-44f3-8cd6-0c42952bd0ab",
-    "action" : "REDIRECT_TO_POOL",
-    "position" : 100,
-    "provisioning_status" : "ACTIVE",
-    "id" : "0d7bf316-2e03-411f-bf29-c403c04e52bf",
-    "name" : "elbv3"
-  }, {
-    "redirect_pool_id" : "3b34340d-59e8-4c70-9ef5-b41b12023dc9",
-    "description" : "",
-    "admin_state_up" : true,
-    "rules" : [ {
-      "id" : "0f5e8c34-09d1-4588-8459-f9b9add0be05"
-    } ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "listener_id" : "e2220d2a-3faf-44f3-8cd6-0c42952bd0ab",
-    "action" : "REDIRECT_TO_POOL",
-    "position" : 100,
-    "provisioning_status" : "ERROR",
-    "id" : "2587d8b1-9e8d-459c-9081-7bccaa075d2b",
-    "name" : "elbv3"
-  } ],
-  "page_info" : {
-    "next_marker" : "2587d8b1-9e8d-459c-9081-7bccaa075d2b",
-    "previous_marker" : "0d7bf316-2e03-411f-bf29-c403c04e52bf",
-    "current_count" : 2
-  }
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/ListL7Rules.html b/docs/elb/api-ref/ListL7Rules.html deleted file mode 100644 index 08e0d40b0..000000000 --- a/docs/elb/api-ref/ListL7Rules.html +++ /dev/null @@ -1,471 +0,0 @@ - - -

Querying Forwarding Rules

-

Function

This API is used to query all forwarding rules.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query.

-

Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

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

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-

Minimum: 0

-

Maximum: 2000

-

marker

-

No

-

String

-

Specifies the ID of the last record on the previous page.

-

Note:

-

  • This parameter must be used together with limit.

    -

  • If this parameter is not specified, the first page will be queried.

    -

  • This parameter cannot be left blank or set to an invalid ID.

    -
-

page_reverse

-

No

-

Boolean

-

Specifies the page direction.

-

The value can be true or false, and the default value is false.

-

The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

Array

-

Specifies the forwarding rule ID.

-

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

-

compare_type

-

No

-

Array

-

Specifies how requests are matched with the domain name or URL.

-

  • If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO.

    -

  • If type is set to PATH, this parameter can be set to REGEX, STARTS_WITH, or EQUAL_TO.

    -
-

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

-

provisioning_status

-

No

-

Array

-

Specifies the provisioning status of the forwarding rule. The value can only be ACTIVE, indicating that the forwarding rule is provisioned successfully.

-

Multiple provisioning statuses can be queried in the format of provisioning_status=xxx&provisioning_status=xxx.

-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but remains invalid.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

value

-

No

-

Array

-

Specifies the value of the match content.

-

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

-

key

-

No

-

Array

-

Specifies the key of the match content that is used to identify the forwarding rule.

-

Multiple keys can be queried in the format of key=xxx&key=xxx.

-

This parameter is unsupported. Please do not use it.

-

type

-

No

-

Array

-

Specifies the match content. The value can be HOST_NAME or PATH.

-

HOST_NAME indicates that the domain name will be used for matching, and PATH indicates that the URL will be used for matching.

-

The type value must be unique for each forwarding rule in a forwarding policy.

-

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

-

enterprise_project_id

-

No

-

Array

-

Specifies the enterprise project ID.

-

  • If this parameter is not passed, resources in the default enterprise project are queried, and authentication is performed based on the default enterprise project.

    -

  • If this parameter is passed, its value can be the ID of an existing enterprise project or all_granted_eps.

    -
-

If the value is a specific ID, resources in the specific enterprise project are required. If the value is all_granted_eps, resources in all enterprise projects are queried.

-

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

-

This parameter is unsupported. Please do not use it.

-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 3 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

page_info

-

PageInfo object

-

Shows pagination information.

-

rules

-

Array of L7Rule objects

-

Lists the forwarding rules.

-
- - - - - - - - - - - - - - - - - - - - -
Table 5 PageInfo

Parameter

-

Type

-

Description

-

previous_marker

-

String

-

Specifies the ID of the first record in the pagination query result. This parameter will not be returned if no query result is returned.

-

next_marker

-

String

-

Marks the start record on the next page in the pagination query result. This parameter will not be returned if there is no next page.

-

current_count

-

Integer

-

Specifies the number of records.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 L7Rule

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding rule. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

compare_type

-

String

-

Specifies how requests are matched with the domain name or URL.

-

  • If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO.

    -

  • If type is set to PATH, this parameter can be set to REGEX, STARTS_WITH, or EQUAL_TO.

    -
-

key

-

String

-

Specifies the key of the match content. This parameter will not take effect when type is set to HOST_NAME or PATH. It can be updated but will not take effect.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 255

-

project_id

-

String

-

Specifies the project ID.

-

type

-

String

-

Specifies the match content. The value can be one of the following:

-

  • HOST_NAME: A domain name will be used for matching.

    -

  • PATH: A URL will be used for matching.

    -
-

If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

-

value

-

String

-

Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name.

-

  • If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH and compare_type to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding rule.

-

The value can only be ACTIVE.

-

invert

-

Boolean

-

Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but remains invalid.

-

Default: false

-

id

-

String

-

Specifies the forwarding policy ID.

-

conditions

-

Array of RuleCondition objects

-

Specifies the matching conditions of the forwarding rule.

-

  • If conditions is specified, key and value will not take effect, and the value of this parameter will contain all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique.

    -

  • If conditions is not specified, the values of key and value are displayed.

    -
-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - -
Table 7 RuleCondition

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the key of match item. This parameter is left blank.

-

Minimum: 1

-

Maximum: 128

-

value

-

String

-

Specifies the value of the match item.

-

  • If type is set to HOST_NAME, key is left blank, and value indicates the domain name, which can contain 1 to 128 characters, including letters, digits, hyphens (-), periods (.), and asterisks (), and must start with a letter, digit, or asterisk (). If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH, key is left blank, and value indicates the request path, which can contain 1 to 128 characters. If compare_type is set to STARTS_WITH or EQUAL_TO for the forwarding rule, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "rules" : [ {
-    "compare_type" : "STARTS_WITH",
-    "provisioning_status" : "ACTIVE",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "invert" : false,
-    "admin_state_up" : true,
-    "value" : "/ccc.html",
-    "type" : "PATH",
-    "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7"
-  } ],
-  "page_info" : {
-    "previous_marker" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7",
-    "current_count" : 1
-  },
-  "request_id" : "ae4dbd7d-9271-4040-98b6-3bfe45bb15ee"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/ListListeners.html b/docs/elb/api-ref/ListListeners.html deleted file mode 100644 index 065b94d8e..000000000 --- a/docs/elb/api-ref/ListListeners.html +++ /dev/null @@ -1,856 +0,0 @@ - - -

Querying Listeners

-

Function

This API is used to query listeners.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query.

-

Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v3/{project_id}/elb/listeners

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-

Minimum: 0

-

Maximum: 2000

-

marker

-

No

-

String

-

Specifies the ID of the last record on the previous page.

-

Note:

-

  • This parameter must be used together with limit.

    -

  • If this parameter is not specified, the first page will be queried.

    -

  • This parameter cannot be left blank or set to an invalid ID.

    -
-

page_reverse

-

No

-

Boolean

-

Specifies the page direction.

-

The value can be true or false, and the default value is false.

-

The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

protocol_port

-

No

-

Array

-

Specifies the port used by the listener.

-

Multiple ports can be queried in the format of protocol_port=xxx&protocol_port=xxx.

-

protocol

-

No

-

Array

-

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

-

Multiple protocols can be queried in the format of protocol=xxx&protocol=xxx.

-

description

-

No

-

Array

-

Provides supplementary information about the listener.

-

Multiple descriptions can be queried in the format of description=xxx&description=xxx.

-

default_tls_container_ref

-

No

-

Array

-

Specifies the ID of the server certificate used by the listener.

-

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

-

client_ca_tls_container_ref

-

No

-

Array

-

Specifies the ID of the CA certificate used by the listener.

-

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

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the listener. The value can only be true.

-

This parameter is unsupported. Please do not use it.

-

connection_limit

-

No

-

Array

-

Specifies the maximum number of connections that the load balancer can handle. The default value is -1.

-

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

-

This parameter is unsupported. Please do not use it.

-

default_pool_id

-

No

-

Array

-

Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests will be routed to the default backend server.

-

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

-

id

-

No

-

Array

-

Specifies the listener ID.

-

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

-

name

-

No

-

Array

-

Specifies the name of the listener added to the load balancer.

-

Multiple names can be queried in the format of name=xxx&name=xxx.

-

http2_enable

-

No

-

Boolean

-

Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect.

-

Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.

-

loadbalancer_id

-

No

-

Array

-

Specifies the ID of the load balancer that the listener is added to.

-

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

-

tls_ciphers_policy

-

No

-

Array

-

Specifies the security policy used by the listener. This parameter is available only for HTTPS listeners.

-

The value can be tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0.

-

Multiple security policies can be queried in the format of tls_ciphers_policy=xxx&tls_ciphers_policy=xxx.

-

member_address

-

No

-

Array

-

Specifies the private IP address bound to the backend server. This parameter is used only as a query condition and is not included in the response.

-

Multiple IP addresses can be queried in the format of member_address=xxx&member_address=xxx.

-

member_device_id

-

No

-

Array

-

Specifies the ID of the cloud server that serves as a backend server. This parameter is used only as a query condition and is not included in the response.

-

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

-

enterprise_project_id

-

No

-

Array

-

Specifies the enterprise project ID.

-

  • If this parameter is not passed, resources in the default enterprise project are queried, and authentication is performed based on the default enterprise project.

    -

  • If this parameter is passed, its value can be the ID of an existing enterprise project or all_granted_eps.

    -
-

If the value is a specific ID, resources in the specific enterprise project are required. If the value is all_granted_eps, resources in all enterprise projects are queried.

-

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

-

This parameter is unsupported. Please do not use it.

-

enable_member_retry

-

No

-

Boolean

-

Specifies whether to enable health check retries for backend servers.

-

member_timeout

-

No

-

Array

-

Specifies the timeout duration for waiting for a request from a backend server, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300.

-

Multiple durations can be queried in the format of member_timeout=xxx&member_timeout=xxx.

-

client_timeout

-

No

-

Array

-

Specifies the timeout duration for waiting for a request from a client, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300.

-

Multiple durations can be queried in the format of client_timeout=xxx&client_timeout=xxx.

-

keepalive_timeout

-

No

-

Array

-

Specifies the idle timeout duration, in seconds.

-

  • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.

    -

  • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.

    -

  • For UDP listeners, this parameter does not take effect.

    -
-

Multiple durations can be queried in the format of keepalive_timeout=xxx&keepalive_timeout=xxx.

-

transparent_client_ip_enable

-

No

-

Boolean

-

Specifies whether to pass source IP addresses of the clients to backend servers.

-

Shared load balancers: The value can be true or false, and the default value is false for TCP and UDP listeners. The value can only be true for HTTP and HTTPS listeners. If this parameter is not passed, the default value is true.

-

Dedicated load balancers: The value can only be true for all types of listeners. If this parameter is not passed, the default value is true.

-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 3 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

page_info

-

PageInfo object

-

Listener pagination information

-

listeners

-

Array of Listener objects

-

Lists the listeners.

-
- - - - - - - - - - - - - - - - - - - - -
Table 5 PageInfo

Parameter

-

Type

-

Description

-

previous_marker

-

String

-

Specifies the ID of the first record in the pagination query result. This parameter will not be returned if no query result is returned.

-

next_marker

-

String

-

Marks the start record on the next page in the pagination query result. This parameter will not be returned if there is no next page.

-

current_count

-

Integer

-

Specifies the number of records.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 Listener

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the listener. And the value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

client_ca_tls_container_ref

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

connection_limit

-

Integer

-

Specifies the maximum number of connections. The default value is -1.

-

This parameter is unsupported. Please do not use it.

-

created_at

-

String

-

Specifies the time when the listener was created.

-

default_pool_id

-

String

-

Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server.

-

default_tls_container_ref

-

String

-

Specifies the ID of the server certificate used by the listener.

-

description

-

String

-

Provides supplementary information about the listener.

-

http2_enable

-

Boolean

-

Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect.

-

Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.

-

Default: true

-

id

-

String

-

Specifies the listener ID.

-

insert_headers

-

ListenerInsertHeaders object

-

Specifies the HTTP header fields.

-

loadbalancers

-

Array of LoadBalancerRef objects

-

Specifies the ID of the load balancer that the listener is added to.

-

name

-

String

-

Specifies the listener name.

-

project_id

-

String

-

Specifies the ID of the project where the listener is used.

-

protocol

-

String

-

Specifies the protocol used by the listener.

-

protocol_port

-

Integer

-

Specifies the port used by the listener.

-

Minimum: 1

-

Maximum: 65535

-

sni_container_refs

-

Array of strings

-

Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

-

Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.

-

This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.

-

tags

-

Array of Tag objects

-

Lists the tags.

-

updated_at

-

String

-

Specifies the time when the listener was updated.

-

tls_ciphers_policy

-

String

-

Specifies the security policy used by the listener. This parameter is available only for HTTPS listeners.

-

The value can be tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0.

-

enable_member_retry

-

Boolean

-

Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners.

-

keepalive_timeout

-

Integer

-

Specifies the idle timeout duration, in seconds.

-

  • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.

    -

  • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.

    -

  • For UDP listeners, this parameter does not take effect.

    -
-

client_timeout

-

Integer

-

Specifies the timeout duration for waiting for a request from a client, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

member_timeout

-

Integer

-

Specifies the timeout duration for waiting for a request from a backend server, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

ipgroup

-

ListenerIpGroup object

-

Specifies the IP address group associated with the listener.

-

This parameter is unsupported. Please do not use it.

-

transparent_client_ip_enable

-

Boolean

-

Specifies whether to pass source IP addresses of the clients to backend servers.

-

Shared load balancers: The value can be true or false, and the default value is false for TCP and UDP listeners. The value can only be true for HTTP and HTTPS listeners. If this parameter is not passed, the default value is true.

-

Dedicated load balancers: The value can only be true for all types of listeners. If this parameter is not passed, the default value is true.

-

enhance_l7policy_enable

-

Boolean

-

Specifies whether to enable advanced forwarding. The value can be true or false (default).

-

  • true indicates that advanced forwarding will be enabled.

    -

  • false indicates that advanced forwarding will not be enabled.

    -
-

The following parameters will be available only when advanced forwarding is enabled:

-

  • redirect_url_config

    -

  • fixed_response_config

    -

  • priority

    -

  • conditions

    -
-

For details, see the descriptions in the APIs of forwarding policies and forwarding rules.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 ListenerInsertHeaders

Parameter

-

Type

-

Description

-

X-Forwarded-ELB-IP

-

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

-

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

-

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

-

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

-
- - - - - - - - - - - - -
Table 8 LoadBalancerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-
- - - - - - - - - - - - - - - - -
Table 9 Tag

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

-

value

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - - - - - - - -
Table 10 ListenerIpGroup

Parameter

-

Type

-

Description

-

ipgroup_id

-

String

-

Specifies the ID of the IP address group associated with the listener.

-

  • If ip_list is set to [] and type to whitelist, no IP addresses are allowed to access the listener.

    -

  • If ip_list is set to [] and type to blacklist, any IP address is allowed to access the listener.

    -

  • The specified IP address group must exist and this parameter cannot be set to null.

    -
-

enable_ipgroup

-

Boolean

-

Specifies whether to enable access control.

-

  • true: Access control is enabled.

    -

  • false: Access control is disabled.

    -
-

A listener with access control enabled can be directly deleted.

-

type

-

String

-

Specifies how access to the listener is controlled.

-

  • white: A whitelist is configured. Only IP addresses in the whitelist can access the listener.

    -

  • black: A blacklist is configured. IP addresses in the blacklist are not allowed to access the listener.

    -
-
- - -

Example Requests

GET
-
-https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/listeners?limit=2&marker=22e221c4-37c7-45d6-a76a-6e5a3bf485ba
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "request_id" : "e77338298c98d52202fd60bdacec0d75",
-  "listeners" : [ {
-    "id" : "683cf917-3e51-4c41-830c-bc3a57e090f0",
-    "name" : "My listener",
-    "protocol_port" : 90,
-    "protocol" : "HTTPS",
-    "description" : "",
-    "default_tls_container_ref" : "4e7761d7c7d141c389479f2641c8bff8",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "ac82ca77-8be3-4d65-9c4d-155771b463df"
-    } ],
-    "project_id" : "060576782980d5762f9ec014dd2f1148",
-    "sni_container_refs" : [ ],
-    "connection_limit" : -1,
-    "tls_ciphers_policy" : "tls-1-0",
-    "tags" : [ ],
-    "created_at" : "2021-04-02T07:48:38Z",
-    "updated_at" : "2021-04-02T07:48:38Z",
-    "http2_enable" : false,
-    "insert_headers" : {
-      "X-Forwarded-ELB-IP" : false,
-      "X-Forwarded-Host" : true,
-      "X-Forwarded-For-Port" : false,
-      "X-Forwarded-Port" : false
-    },
-    "member_timeout" : 60,
-    "client_timeout" : 60,
-    "keepalive_timeout" : 60,
-    "enable_member_retry" : true,
-    "transparent_client_ip_enable" : true,
-    "enhance_l7policy_enable" : false
-  }, {
-    "id" : "1173360b-5911-4aa9-a1ec-05e9f714370c",
-    "name" : "listener-sshd",
-    "protocol_port" : 22,
-    "protocol" : "TCP",
-    "description" : "",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "4d196846-d63c-4e7b-9875-2c4f04a48661"
-    } ],
-    "project_id" : "060576782980d5762f9ec014dd2f1148",
-    "sni_container_refs" : [ ],
-    "connection_limit" : -1,
-    "default_pool_id" : "6350052f-e060-4f80-b92f-f21255dba4c4",
-    "tags" : [ ],
-    "created_at" : "2021-04-01T08:21:15Z",
-    "updated_at" : "2021-04-01T08:21:15Z",
-    "http2_enable" : false,
-    "insert_headers" : {
-      "X-Forwarded-ELB-IP" : false,
-      "X-Forwarded-Host" : true,
-      "X-Forwarded-For-Port" : false,
-      "X-Forwarded-Port" : false
-    },
-    "keepalive_timeout" : 4000,
-    "enable_member_retry" : true,
-    "transparent_client_ip_enable" : true,
-    "enhance_l7policy_enable" : false
-  } ],
-  "page_info" : {
-    "next_marker" : "1173360b-5911-4aa9-a1ec-05e9f714370c",
-    "previous_marker" : "683cf917-3e51-4c41-830c-bc3a57e090f0",
-    "current_count" : 2
-  }
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/ListLoadBalancers.html b/docs/elb/api-ref/ListLoadBalancers.html deleted file mode 100644 index 3c50749e4..000000000 --- a/docs/elb/api-ref/ListLoadBalancers.html +++ /dev/null @@ -1,962 +0,0 @@ - - -

Querying Load Balancers

-

Function

This API is used to query all load balancers. Both filtered query and pagination query are supported.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query.

-

Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v3/{project_id}/elb/loadbalancers

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

Minimum: 1

-

Maximum: 255

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the last record on the previous page.

-

Note:

-
  • This parameter must be used together with limit.
  • If this parameter is not specified, the first page will be queried.
  • This parameter cannot be left blank or set to an invalid ID.
-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-

Minimum: 0

-

Maximum: 2000

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction.

-

The value can be true or false, and the default value is false.

-

The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

Array

-

Specifies the load balancer ID.

-

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

-

name

-

No

-

Array

-

Specifies the load balancer name.

-

Multiple names can be queried in the format of name=xxx&name=xxx.

-

description

-

No

-

Array

-

Provides supplementary information about the load balancer.

-

Multiple descriptions can be queried in the format of description=xxx&description=xxx.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the load balancer.

-

This parameter is unsupported. Please do not use it.

-

provisioning_status

-

No

-

Array

-

Specifies the provisioning status of the load balancer. The value can only be ACTIVE, indicating that the load balancer is provisioned successfully.

-

Multiple provisioning statuses can be queried in the format of provisioning_status=xxx&provisioning_status=xxx.

-

operating_status

-

No

-

Array

-

Specifies the operating status of the load balancer. The value can only be ONLINE, indicating that the load balancer is working normally.

-

Multiple operating statuses can be queried in the format of operating_status=xxx&operating_status=xxx.

-

guaranteed

-

No

-

Boolean

-

Specifies whether the load balancer is a dedicated load balancer. The value can only be true.

-

vpc_id

-

No

-

Array

-

Specifies the ID of the VPC where the load balancer works.

-

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

-

vip_port_id

-

No

-

Array

-

Specifies the ID of the port bound to the virtual IP address of the load balancer.

-

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

-

vip_address

-

No

-

Array

-

Specifies the virtual IP address bound to the load balancer.

-

Multiple virtual IP addresses can be queried in the format of vip_address=xxx&vip_address=xxx.

-

vip_subnet_cidr_id

-

No

-

Array

-

Specifies the ID of the subnet where the load balancer works.

-

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

-

l4_flavor_id

-

No

-

Array

-

Specifies the ID of the flavor at Layer 4.

-

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

-

l4_scale_flavor_id

-

No

-

Array

-

Specifies the elastic flavor that is reserved for now.

-

Multiple flavors can be queried in the format of l4_scale_flavor_id=xxx&l4_scale_flavor_id=xxx.

-

ipv6_vip_address

-

No

-

Array

-

Specifies the IPv6 address bound to the load balancer.

-

Multiple IPv6 addresses can be queried in the format of ipv6_vip_address=xxx&ipv6_vip_address=xxx.

-

This parameter is unsupported. Please do not use it.

-

ipv6_vip_virsubnet_id

-

No

-

Array

-

Specifies the ID of the IPv6 subnet where the load balancer works.

-

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

-

This parameter is unsupported. Please do not use it.

-

ipv6_vip_port_id

-

No

-

Array

-

Specifies the ID of the port bound to the IPv6 address of the load balancer.

-

Multiple ports can be queried in the format of ipv6_vip_port_id=xxx&ipv6_vip_port_id=xxx.

-

This parameter is unsupported. Please do not use it.

-

availability_zone_list

-

No

-

Array

-

Specifies the list of AZs where the load balancer is created. You can query the AZs by calling the API (/v3/{project_id}/elb/availability-zones).

-

Multiple AZs can be queried in the format of availability_zone_list=xxx&availability_zone_list=xxx.

-

eips

-

No

-

Array

-

Specifies the EIP bound to the load balancer.

-

The following is an example:

-

"eips": [ { "eip_id": "e9b72a9d-4275-455e-a724-853504e4d9c6", "eip_address": "88.88.14.122", "ip_version": 4 } ]

-

Multiple EIPs can be queried in the format of eips=eip_id=xxx&eips=eip_id=xxx.

-

l7_flavor_id

-

No

-

Array

-

Specifies the ID of the flavor at Layer 7.

-

Multiple flavors can be queried in the format of l7_flavor_id=xxx&l7_flavor_id=xxx.

-

l7_scale_flavor_id

-

No

-

Array

-

Specifies the elastic flavor that is reserved for now.

-

Multiple flavors can be queried in the format of l7_scale_flavor_id=xxx&l7_scale_flavor_id=xxx.

-

member_device_id

-

No

-

Array

-

Specifies the ID of the cloud server that serves as a backend server. This parameter is used only as a query condition and is not included in the response.

-

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

-

member_address

-

No

-

Array

-

Specifies the private IP address of the backend server. This parameter is used only as a query condition and is not included in the response.

-

enterprise_project_id

-

No

-

Array

-

Specifies the enterprise project ID.

-
  • If this parameter is not passed, resources in the default enterprise project are queried, and authentication is performed based on the default enterprise project.
  • If this parameter is passed, its value can be the ID of an existing enterprise project or all_granted_eps.
-

If the value is a specific ID, resources in the specific enterprise project are required. If the value is all_granted_eps, resources in all enterprise projects are queried.

-

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

-

This parameter is unsupported. Please do not use it.

-

publicips

-

No

-

Array

-

Specifies the public IP address bound to the load balancer.

-

The following is an example:

-

"publicips": [ { "publicip_id": "e9b72a9d-4275-455e-a724-853504e4d9c6", "publicip_address": "88.88.14.122", "publicip_ip_version": 4 } ]

-

Multiple EIPs can be queried in the format of publicips=publicip_id=xxx&publicips=publicip_id=xxx.

-

ip_version

-

No

-

Array

-

Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6).

-

Multiple versions can be queried in the format of ip_version=xxx&ip_version=xxx.

-

IPv6 is unsupported. The value cannot be 6.

-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 3 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

No

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

loadbalancers

-

Array of LoadBalancer objects

-

Lists the load balancers.

-

page_info

-

PageInfo object

-

Provides load balancer pagination information.

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 LoadBalancer

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-

Default: Automatically generated

-

description

-

String

-

Provides supplementary information about the load balancer.

-

Minimum: 1

-

Maximum: 255

-

provisioning_status

-

String

-

Specifies the provisioning status of the load balancer. The value can only be ACTIVE.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the load balancer. The value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

provider

-

String

-

Specifies the provider of the load balancer. The value can only be vlb.

-

Default: vlb

-

pools

-

Array of PoolRef objects

-

Lists the IDs of backend server groups associated with the load balancer.

-

listeners

-

Array of ListenerRef objects

-

Lists the IDs of listeners added to the load balancer.

-

operating_status

-

String

-

Specifies the operating status of the load balancer. The value can only be ONLINE.

-

Minimum: 1

-

Maximum: 16

-

vip_address

-

String

-

Specifies the private IPv4 address bound to the load balancer.

-

Minimum: 1

-

Maximum: 64

-

vip_subnet_cidr_id

-

String

-

Specifies the ID of the IPv4 subnet where the load balancer works.

-

Minimum: 1

-

Maximum: 36

-

name

-

String

-

Specifies the name of the load balancer.

-

Minimum: 1

-

Maximum: 255

-

project_id

-

String

-

Specifies the project ID of the load balancer.

-

Minimum: 1

-

Maximum: 32

-

vip_port_id

-

String

-

Specifies the ID of the port bound to the virtual IP address (the value of vip_address) of the load balancer.

-

When you create a dedicated load balancer, the system automatically creates a port for the load balancer and associates the port with a default security group. However, security group rules containing the port will not affect traffic to and from the load balancer.

-

tags

-

Array of Tag objects

-

Lists the tags added to the load balancer.

-

created_at

-

String

-

Specifies the time when the load balancer was created.

-

Minimum: 1

-

Maximum: 20

-

updated_at

-

String

-

Specifies the time when the load balancer was updated.

-

Minimum: 1

-

Maximum: 20

-

guaranteed

-

Boolean

-

Specifies whether the load balancer is a dedicated load balancer.

-

The value can be true or false. true indicates a dedicated load balancer, and false indicates a shared load balancer. When dedicated load balancers are launched in the eu-de region, either true or false will be returned when you use the API to query or update a load balancer.

-

Default: true

-

vpc_id

-

String

-

Specifies the ID of the VPC where the load balancer works.

-

eips

-

Array of EipInfo objects

-

Specifies the EIP bound to the load balancer.

-

ipv6_vip_address

-

String

-

Specifies the IPv6 address bound to the load balancer.

-

This parameter is unsupported. Please do not use it.

-

Default: None

-

Minimum: 1

-

Maximum: 64

-

ipv6_vip_virsubnet_id

-

String

-

Specifies the ID of the IPv6 subnet where the load balancer works.

-

This parameter is unsupported. Please do not use it.

-

ipv6_vip_port_id

-

String

-

Specifies the ID of the port bound to the IPv6 address.

-

This parameter is unsupported. Please do not use it.

-

availability_zone_list

-

Array of strings

-

Specifies the list of AZs where the load balancer is created.

-

enterprise_project_id

-

String

-

Specifies the enterprise project ID.

-

If this parameter is not passed during resource creation, the resource belongs to the default enterprise project.

-

This parameter is unsupported. Please do not use it.

-

Default: 0

-

l4_flavor_id

-

String

-

Specifies the Layer-4 flavor.

-

Minimum: 1

-

Maximum: 255

-

l4_scale_flavor_id

-

String

-

Specifies the reserved Layer 4 flavor.

-

Minimum: 1

-

Maximum: 255

-

l7_flavor_id

-

String

-

Specifies the Layer-7 flavor.

-

Minimum: 1

-

Maximum: 255

-

l7_scale_flavor_id

-

String

-

Specifies the reserved Layer 7 flavor.

-

Minimum: 1

-

Maximum: 255

-

publicips

-

Array of PublicIpInfo objects

-

Specifies the EIP bound to the load balancer.

-

elb_virsubnet_ids

-

Array of strings

-

Specifies the ID of the subnet on the downstream plane. The ports used by the load balancer dynamically occupy IP addresses in the subnet.

-

ip_target_enable

-

Boolean

-

Specifies whether to enable cross-VPC backend.

-

This parameter is unsupported. Please do not use it.

-

Default: false

-

frozen_scene

-

String

-

Specifies the scenario where the load balancer is frozen. Use commas to separate multiple scenarios.

-

If the value is ARREAR, the load balancer is frozen because your account is in arrears.

-

ipv6_bandwidth

-

BandwidthRef object

-

Specifies the ID of the bandwidth. This parameter is available only when you create or update a dedicated load balancer that has an IPv6 address bound.

-

If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - -
Table 6 PoolRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-
- - - - - - - - - - - - -
Table 7 ListenerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-
- - - - - - - - - - - - - - - - -
Table 8 Tag

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

-

value

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - - - - - - - -
Table 9 EipInfo

Parameter

-

Type

-

Description

-

eip_id

-

String

-

Specifies the EIP ID.

-

eip_address

-

String

-

Specifies the specific IP address.

-

ip_version

-

Integer

-

Specifies the IP version. 4 indicates IPv4, and 6 indicates IPv6.

-

IPv6 is unsupported. The value cannot be 6.

-
- - - - - - - - - - - - - - - - - - - - -
Table 10 PublicIpInfo

Parameter

-

Type

-

Description

-

publicip_id

-

String

-

Specifies the EIP ID.

-

publicip_address

-

String

-

Specifies the IP address.

-

ip_version

-

Integer

-

Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6).

-

IPv6 is unsupported. The value cannot be 6.

-
- - - - - - - - - - - - -
Table 11 BandwidthRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the shared bandwidth ID.

-
- - - - - - - - - - - - - - - - - - - - -
Table 12 PageInfo

Parameter

-

Type

-

Description

-

previous_marker

-

String

-

Specifies the ID of the first record in the pagination query result. This parameter will not be returned if no query result is returned.

-

next_marker

-

String

-

Marks the start record on the next page in the pagination query result. This parameter will not be returned if there is no next page.

-

current_count

-

Integer

-

Specifies the number of records.

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/{project_id}/elb/loadbalancers?limit={num}&marker={loadbalancer_id}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "loadbalancers" : [ {
-    "id" : "87627cb6-9ff1-4580-984f-cc564fa9fc34",
-    "project_id" : "b2782e6708b8475c993e6064bc456bf8",
-    "name" : "loadbalancer-cyf",
-    "description" : "simple lb-cyf",
-    "vip_port_id" : "0381c10b-4927-4fa5-a7b5-fa529c162a06",
-    "vip_address" : "192.168.0.26",
-    "admin_state_up" : true,
-    "provisioning_status" : "ACTIVE",
-    "operating_status" : "ONLINE",
-    "listeners" : [ ],
-    "pools" : [ ],
-    "tags" : [ ],
-    "provider" : "vlb",
-    "created_at" : "2019-05-24T02:09:39Z",
-    "updated_at" : "2019-05-24T02:09:39Z",
-    "vpc_id" : "2037c5bb-e04b-4de2-9300-9051af18e417",
-    "enterprise_project_id" : "0",
-    "availability_zone_list" : [ "AZ1" ],
-    "elb_virsubnet_ids" : [ "ad5d63bf-3b50-4e88-b4d9-e94a59aade48" ],
-    "eips" : [ ],
-    "guaranteed" : true,
-    "l4_flavor_id" : "22365281-de68-45e4-ada4-b0920b6da3c2",
-    "l7_flavor_id" : "0942eb8f-51fa-4354-87b1-bf4cfeca4823",
-    "vip_subnet_cidr_id" : "1992ec06-f364-4ae3-b936-6a8cc24633b7"
-  }, {
-    "id" : "09e86f09-03fc-440e-8132-03f3e149e979",
-    "project_id" : "b2782e6708b8475c993e6064bc456bf8",
-    "name" : "loadbalancer-cyf",
-    "description" : "simple lb-cyf",
-    "vip_port_id" : "e0bb984a-d094-4559-9b3b-bd61b5eb3a8f",
-    "vip_address" : "192.168.0.47",
-    "admin_state_up" : true,
-    "provisioning_status" : "ACTIVE",
-    "operating_status" : "ONLINE",
-    "listeners" : [ ],
-    "pools" : [ ],
-    "tags" : [ ],
-    "provider" : "vlb",
-    "created_at" : "2019-05-24T02:02:01Z",
-    "updated_at" : "2019-05-24T02:02:01Z",
-    "vpc_id" : "2037c5bb-e04b-4de2-9300-9051af18e417",
-    "enterprise_project_id" : "0",
-    "availability_zone_list" : [ "AZ1" ],
-    "elb_virsubnet_ids" : [ "ad5d63bf-3b50-4e88-b4d9-e94a59aade48" ],
-    "eips" : [ ],
-    "guaranteed" : true,
-    "vip_subnet_cidr_id" : "1992ec06-f364-4ae3-b936-6a8cc24633b7"
-  } ],
-  "page_info" : {
-    "next_marker" : "09e86f09-03fc-440e-8132-03f3e149e979",
-    "previous_marker" : "87627cb6-9ff1-4580-984f-cc564fa9fc34",
-    "current_count" : 2
-  },
-  "request_id" : "8709f187-c879-446c-a198-8f93ede2c178"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/ListMembers.html b/docs/elb/api-ref/ListMembers.html deleted file mode 100644 index 6390b6a19..000000000 --- a/docs/elb/api-ref/ListMembers.html +++ /dev/null @@ -1,470 +0,0 @@ - - -

Querying Backend Servers

-

Function

This API is used to query all backend servers.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query.

-

Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v3/{project_id}/elb/pools/{pool_id}/members

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the last record on the previous page.

-

Note:

-

  • This parameter must be used together with limit.

    -

  • If this parameter is not specified, the first page will be queried.

    -

  • This parameter cannot be left blank or set to an invalid ID.

    -
-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-

Minimum: 0

-

Maximum: 2000

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction.

-

The value can be true or false, and the default value is false.

-

The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

name

-

No

-

Array

-

Specifies the backend server name.

-

Multiple names can be queried in the format of name=xxx&name=xxx.

-

weight

-

No

-

Array

-

Specifies the weight of the backend server.

-

Requests are routed to backend servers in the same backend server group based on their weights. If the weight is 0, the backend server will not accept new requests.

-

This parameter will not take effect when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

-

Multiple weights can be queried in the format of weight=xxx&weight=xxx.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server.

-

Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers that serve as the backend servers exist. If cloud servers exist, the value is true. Otherwise, the value is false.

-

subnet_cidr_id

-

No

-

Array

-

Specifies the ID of the subnet where the backend server works.

-

This subnet must be in the same VPC as the subnet of the load balancer with which the backend server is associated. Only IPv4 subnets are supported.

-

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

-

address

-

No

-

Array

-

Specifies the IP address bound to the backend server.

-

  • The IP address must be in the subnet specified by subnet_cidr_id, for example, 192.168.3.11.

    -

  • The IP address can be used only by the primary NIC.

    -
-

Multiple IP addresses can be queried in the format of address=xxx&address=xxx.

-

protocol_port

-

No

-

Array

-

Specifies the port used by the backend server.

-

Multiple ports can be queried in the format of protocol_port=xxx&protocol_port=xxx.

-

id

-

No

-

Array

-

Specifies the backend server ID.

-

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

-

operating_status

-

No

-

Array

-

Specifies the operating status of the backend server. The value can be one of the following:

-

  • ONLINE: The backend server is running normally.

    -

  • NO_MONITOR: No health check is configured for the backend server group to which the backend server belongs.

    -

  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.

    -
-

Multiple operating statuses can be queried in the format of operating_status=xxx&operating_status=xxx.

-

enterprise_project_id

-

No

-

Array

-

Specifies the enterprise project ID.

-

  • If this parameter is not passed, resources in the default enterprise project are queried, and authentication is performed based on the default enterprise project.

    -

  • If this parameter is passed, its value can be the ID of an existing enterprise project or all_granted_eps.

    -
-

If the value is a specific ID, resources in the specific enterprise project are required. If the value is all_granted_eps, resources in all enterprise projects are queried.

-

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

-

This parameter is unsupported. Please do not use it.

-

ip_version

-

No

-

String

-

Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6).

-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 3 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

page_info

-

PageInfo object

-

Shows pagination information.

-

members

-

Array of Member objects

-

Lists the backend servers.

-
- - - - - - - - - - - - - - - - - - - - -
Table 5 PageInfo

Parameter

-

Type

-

Description

-

previous_marker

-

String

-

Specifies the ID of the first record in the pagination query result. This parameter will not be returned if no query result is returned.

-

next_marker

-

String

-

Marks the start record on the next page in the pagination query result. This parameter will not be returned if there is no next page.

-

current_count

-

Integer

-

Specifies the number of records.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 Member

Parameter

-

Type

-

Description

-

address

-

String

-

Specifies the IP address of the backend server.

-

The IP address must be in the subnet specified by subnet_cidr_id, for example, 192.168.3.11. The IP address can only be the IP address of the primary NIC.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server.

-

Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers exist. If cloud servers exist, the value is true. Otherwise, the value is false.

-

Default: true

-

id

-

String

-

Specifies the backend server ID.

-

name

-

String

-

Specifies the backend server name.

-

operating_status

-

String

-

Specifies the operating status of the backend server. The value can be one of the following:

-

  • ONLINE: The backend server is running normally.

    -

  • NO_MONITOR: No health check is configured for the backend server group to which the backend server belongs.

    -

  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.

    -
-

project_id

-

String

-

Specifies the project ID.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server to receive requests.

-

Minimum: 1

-

Maximum: 65535

-

subnet_cidr_id

-

String

-

Specifies the ID of the subnet where the backend server works. This subnet must be in the VPC as the subnet of the load balancer associated with the backend server. Only IPv4 subnets are supported. If the value is left blank, the backend server is not in the load balancer's VPC.

-

weight

-

Integer

-

Specifies the weight of the backend server.

-

Requests are routed to backend servers in the same backend server group based on their weights.

-

If the weight is 0, the backend server will not accept new requests.

-

This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

-

Minimum: 0

-

Maximum: 100

-

Default: 1

-

ip_version

-

String

-

This is a read-only attribute, which is automatically generated based on the address parameter. The value can be v4 or v6.

-

Default: v4

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/{project_id}/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "members" : [ {
-    "name" : "quark-neutron",
-    "weight" : 100,
-    "admin_state_up" : false,
-    "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "address" : "120.10.10.2",
-    "protocol_port" : 2100,
-    "id" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d",
-    "operating_status" : "NO_MONITOR",
-    "ip_version" : "v4"
-  }, {
-    "name" : "quark-neutron",
-    "weight" : 100,
-    "admin_state_up" : false,
-    "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "address" : "120.10.10.2",
-    "protocol_port" : 2101,
-    "id" : "315b928b-39e4-4d5f-8e48-39e9108c1035",
-    "operating_status" : "NO_MONITOR",
-    "ip_version" : "v4"
-  }, {
-    "name" : "quark-neutron",
-    "weight" : 100,
-    "admin_state_up" : false,
-    "subnet_cidr_id" : "27e4ab69-a5ed-46c6-921a-5212be19ce87",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "address" : "2001:db8:a583:6a::4",
-    "protocol_port" : 2101,
-    "id" : "53976f72-d2aa-47f5-baf4-4906ed6b42d6",
-    "operating_status" : "NO_MONITOR",
-    "ip_version" : "v6"
-  } ],
-  "page_info" : {
-    "previous_marker" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d",
-    "current_count" : 3
-  },
-  "request_id" : "87e29592-7ab8-401a-9bf4-66cf6747eab9"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/ListPools.html b/docs/elb/api-ref/ListPools.html deleted file mode 100644 index e2163bff7..000000000 --- a/docs/elb/api-ref/ListPools.html +++ /dev/null @@ -1,642 +0,0 @@ - - -

Querying Backend Server Groups

-

Function

This API is used to query all backend server groups.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query.

-

Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v3/{project_id}/elb/pools

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query parameters

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the last record on the previous page.

-

Note:

-

  • This parameter must be used together with limit.

    -

  • If this parameter is not specified, the first page will be queried.

    -

  • This parameter cannot be left blank or set to an invalid ID.

    -
-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-

Minimum: 0

-

Maximum: 2000

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link. This parameter must be used together with limit.

-

description

-

No

-

Array

-

Provides supplementary information about the backend server group.

-

Multiple descriptions can be queried in the format of description=xxx&description=xxx.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server group.

-

This parameter is unsupported. Please do not use it.

-

healthmonitor_id

-

No

-

Array

-

Specifies the ID of the health check configured for the backend server group.

-

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

-

id

-

No

-

Array

-

Specifies the ID of the backend server group.

-

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

-

name

-

No

-

Array

-

Specifies the backend server group name.

-

Multiple names can be queried in the format of name=xxx&name=xxx.

-

loadbalancer_id

-

No

-

Array

-

Specifies the ID of the load balancer associated with the backend server group.

-

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

-

protocol

-

No

-

Array

-

Specifies the protocol used by the backend server group to receive requests.

-

Multiple protocols can be queried in the format of protocol=xxx&protocol=xxx.

-

lb_algorithm

-

No

-

Array

-

Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the backend server group.

-

The value can be ROUND_ROBIN (weighted round robin), LEAST_CONNECTIONS (weighted least connections), or SOURCE_IP (source IP hash).

-

If the value is SOURCE_IP, weight will not take effect.

-

Multiple algorithms can be queried in the format of lb_algorithm=xxx&lb_algorithm=xxx.

-

enterprise_project_id

-

No

-

Array

-

Specifies the enterprise project ID.

-

  • If this parameter is not passed, resources in the default enterprise project are queried, and authentication is performed based on the default enterprise project.

    -

  • If this parameter is passed, its value can be the ID of an existing enterprise project or all_granted_eps.

    -
-

If the value is a specific ID, resources in the specific enterprise project are required. If the value is all_granted_eps, resources in all enterprise projects are queried.

-

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

-

This parameter is unsupported. Please do not use it.

-

ip_version

-

No

-

Array

-

Specifies the IP address version of the backend server group. The value can be dualstack, v4, or v6.

-

Multiple versions can be queried in the format of ip_version=xxx&ip_version=xxx.

-

member_address

-

No

-

Array

-

Specifies the private IP address bound to the backend server. This parameter is used only as a query condition and is not included in the response.

-

Multiple IP addresses can be queried in the format of member_address=xxx&member_address=xxx.

-

member_device_id

-

No

-

Array

-

Specifies the ID of the cloud server that serves as a backend server. This parameter is used only as a query condition and is not included in the response.

-

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

-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 3 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - - - - - -
Table 4 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

page_info

-

PageInfo object

-

Shows pagination information.

-

pools

-

Array of Pool objects

-

Lists the backend server groups.

-
- - - - - - - - - - - - - - - - - - - - -
Table 5 PageInfo

Parameter

-

Type

-

Description

-

previous_marker

-

String

-

Specifies the ID of the first record in the pagination query result. This parameter will not be returned if no query result is returned.

-

next_marker

-

String

-

Marks the start record on the next page in the pagination query result. This parameter will not be returned if there is no next page.

-

current_count

-

Integer

-

Specifies the number of records.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 Pool

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server group. The value can only be updated to true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

String

-

Provides supplementary information about the backend server group.

-

healthmonitor_id

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

id

-

String

-

Specifies the backend server group ID.

-

lb_algorithm

-

String

-

Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the backend server group.

-

The value can be ROUND_ROBIN (weighted round robin), LEAST_CONNECTIONS (weighted least connections), or SOURCE_IP (source IP hash).

-

When the value is SOURCE_IP, the weight parameter is invalid.

-

listeners

-

Array of ListenerRef objects

-

Lists the listeners associated with the backend server group.

-

loadbalancers

-

Array of LoadBalancerRef objects

-

Lists the IDs of load balancers associated with the backend server group.

-

If only listener_id is specified during the creation of the backend server group, the ID of the loadbalancers parameter in the response is the ID of the load balancer to which the listener is added.

-

members

-

Array of MemberRef objects

-

Lists the backend servers in the backend server group.

-

name

-

String

-

Specifies the backend server group name.

-

project_id

-

String

-

Specifies the project ID.

-

protocol

-

String

-

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

-

  • For UDP listeners, the protocol of the backend server group must be UDP.

    -

  • For TCP listeners, the protocol of the backend server group must be TCP.

    -

  • For HTTP or HTTPS listeners, the protocol of the backend server group must be HTTP.

    -
-

session_persistence

-

SessionPersistence object

-

Specifies the sticky session.

-

ip_version

-

String

-

Specifies the IP version supported by the backend server group.

-

  • Shared load balancers: The default value is v4.

    -

  • Dedicated load balancers: The value can be dualstack, v4, or v6.

    -
-

When the protocol of the backend server group is TCP or UDP, ip_version is set to dualstack, indicating that both IPv4 and IPv6 are supported.

-

When the protocol of the backend server group is HTTP, ip_version is set to v4.

-

IPv6 is unsupported. Only v4 is returned.

-

Default: dualstack

-

slow_start

-

SlowStart object

-

Specifies whether to enable slow start. After you enable slow start, new backend servers added to the backend server group are warmed up, and the number of requests they can receive increases linearly during the configured slow start duration.

-

This parameter can be used when the protocol of the backend server group is HTTP or HTTPS. An error will be returned if the protocol is not HTTP or HTTPS.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - -
Table 7 ListenerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-
- - - - - - - - - - - - -
Table 8 LoadBalancerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-
- - - - - - - - - - - - -
Table 9 MemberRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

-
- - - - - - - - - - - - - - - - - - - - -
Table 10 SessionPersistence

Parameter

-

Type

-

Description

-

cookie_name

-

String

-

Specifies the cookie name.

-

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

-

The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 0

-

Maximum: 1024

-

type

-

String

-

Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, only SOURCE_IP takes effect.

    -

  • For dedicated load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can only be HTTP_COOKIE.

    -

  • For shared load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can be HTTP_COOKIE or APP_COOKIE.

    -
-

persistence_timeout

-

Integer

-

Specifies the stickiness duration, in minutes. This parameter will not take effect when type is set to APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60, and the default value is 1.

    -

  • If the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440, and the default value is 1440.

    -
-
- - - - - - - - - - - - - - - - -
Table 11 SlowStart

Parameter

-

Type

-

Description

-

enable

-

Boolean

-

Specifies whether to enable slow start.

-

true indicates that this function is enabled, and false indicates this function is disabled.

-

Default: false

-

duration

-

Integer

-

Specifies the slow start duration, in seconds.

-

The value ranges from 30 to 1200, and the default value is 30.

-

Minimum: 30

-

Maximum: 1200

-

Default: 30

-
- - -

Example Requests

GET https://{elb_endpoint}/v3/{project_id}/elb/pools?limit=2
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "pools" : [ {
-    "lb_algorithm" : "ROUND_ROBIN",
-    "protocol" : "HTTP",
-    "description" : "",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "309a0f61-0b62-45f2-97d1-742f3434338e"
-    } ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "session_persistence" : {
-      "cookie_name" : "my_cookie",
-      "type" : "APP_COOKIE",
-      "persistence_timeout" : 1
-    },
-    "healthmonitor_id" : "",
-    "listeners" : [ ],
-    "members" : [ ],
-    "id" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103",
-    "name" : "",
-    "ip_version" : "v4"
-  }, {
-    "lb_algorithm" : "SOURCE_IP",
-    "protocol" : "TCP",
-    "description" : "",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "d9763e59-64b7-4e93-aec7-0ff7881ef9bc"
-    } ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "session_persistence" : {
-      "cookie_name" : "",
-      "type" : "SOURCE_IP",
-      "persistence_timeout" : 1
-    },
-    "healthmonitor_id" : "",
-    "listeners" : [ {
-      "id" : "8d21db6f-b475-429e-a9cb-90439b0413b2"
-    } ],
-    "members" : [ ],
-    "id" : "74db02d1-5711-4c77-b383-a450e2b93142",
-    "name" : "pool_tcp_001",
-    "ip_version" : "dualstack"
-  } ],
-  "page_info" : {
-    "next_marker" : "74db02d1-5711-4c77-b383-a450e2b93142",
-    "previous_marker" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103",
-    "current_count" : 2
-  },
-  "request_id" : "a1a7e852-1928-48f7-bbc9-ca8469898713"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/ShowCertificate.html b/docs/elb/api-ref/ShowCertificate.html deleted file mode 100644 index da2be7594..000000000 --- a/docs/elb/api-ref/ShowCertificate.html +++ /dev/null @@ -1,252 +0,0 @@ - - -

Viewing Details of a Certificate

-

Function

This API is used to view details of an SSL certificate.

- -

URI

GET /v3/{project_id}/elb/certificates/{certificate_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

certificate_id

-

Yes

-

String

-

Specifies a certificate ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

certificate

-

CertificateInfo object

-

Specifies the certificate.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CertificateInfo

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is unsupported. Please do not use it.

-

certificate

-

String

-

Specifies the private key of the certificate. The value must be PEM encoded.

-

description

-

String

-

Provides supplementary information about the certificate.

-

Minimum: 1

-

Maximum: 255

-

domain

-

String

-

Specifies the domain names used by the server certificate.

-

  • This parameter will take effect only when type is set to server, and its default value is "".

    -

  • This parameter will not take effect even if it is passed and type is set to client. However, domain names will still be verified.

    -
-

Note:

-

  • The value can contain 0 to 1024 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 30 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

    -
-

Minimum: 1

-

Maximum: 1024

-

id

-

String

-

Specifies a certificate ID.

-

name

-

String

-

Specifies the certificate name.

-

Minimum: 1

-

Maximum: 255

-

private_key

-

String

-

Specifies the private key of the server certificate. The value must be PEM encoded.

-

  • This parameter will be ignored if type is set to client. A CA server can still be created and used normally. This parameter will be left blank even if you enter a private key that is not PEM encoded.

    -

  • This parameter is valid and mandatory only when type is set to server. If you enter an invalid private key, an error is returned.

    -
-

type

-

String

-

Specifies the certificate type. The value can be server or client. server indicates server certificates, and client indicates CA certificates. The default value is server.

-

created_at

-

String

-

Specifies the time when the certificate was created.

-

updated_at

-

String

-

Specifies the time when the certificate was updated.

-

expire_time

-

String

-

Specifies the time when the certificate expires.

-

project_id

-

String

-

Specifies the project ID.

-
- - -

Example Requests

GET
-https://{elb_endpoint}/v3/{project_id}/elb/certificates/{certificate_id}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "certificate" : {
-    "id" : "5494a835d88f40ff940554992f2f04d4",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "name" : "https_certificatekkkk",
-    "type" : "server",
-    "description" : "description for certificatehhhh",
-    "private_key" : "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M\n253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPe\ntB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rM\nMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXt\nCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2Chl\nZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08k\nEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/Hl\nfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQB\nZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKr\nciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9M\nEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7Ale\nkrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CT\nXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kx\nGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dt\nJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLr\niWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZ\nlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBU\nxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB\n1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAd\nXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak\n/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4Vha\nfI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf\n7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9o\njHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIuk\nfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd\n3fy+1rCUwzOp9LSjtJYf4ege\n-----END PRIVATE KEY-----",
-    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD\nb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAG\nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\n0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5\nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh9\n7B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaS\nIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/K\ny09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0Wy\nYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29t\nhwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUA\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce+77s96i3I\n-----END CERTIFICATE-----",
-    "admin_state_up" : true,
-    "created_at" : "2019-03-31T22:23:51Z",
-    "updated_at" : "2019-03-31T23:26:49Z",
-    "expire_time" : "2045-11-17T13:25:47Z"
-  },
-  "request_id" : "a94af450-5ac0-4185-946c-27a59a16c1d3"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/ShowFlavor.html b/docs/elb/api-ref/ShowFlavor.html deleted file mode 100644 index 97d6b6edb..000000000 --- a/docs/elb/api-ref/ShowFlavor.html +++ /dev/null @@ -1,238 +0,0 @@ - - -

Viewing Details of a Flavor

-

Function

This API is used to view details of a flavor.

- -

Constraints

This API can only be used to view the details of a flavor.

- -

URI

GET /v3/{project_id}/elb/flavors/{flavor_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

flavor_id

-

Yes

-

String

-

Specifies the flavor ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

flavor

-

Flavor object

-

Specifies the flavor.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Flavor

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the flavor ID.

-

info

-

FlavorInfo object

-

Specifies the flavor details.

-

name

-

String

-

Specifies the flavor name.

-

shared

-

Boolean

-

Specifies whether the flavor is available to all users.

-

  • true indicates that the flavor is available to all users.

    -

  • false indicates that the flavor is available only to a specific user.

    -
-

Default: true

-

project_id

-

String

-

Specifies the project ID.

-

type

-

String

-

Specifies the flavor type. Flavors can be filtered by type.

-

Minimum: 1

-

Maximum: 32

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 FlavorInfo

Parameter

-

Type

-

Description

-

connection

-

Integer

-

Specifies the maximum concurrent connections.

-

cps

-

Integer

-

Specifies the number of new connections per second.

-

qps

-

Integer

-

Specifies the number of requests per second at Layer 7.

-

bandwidth

-

Integer

-

Specifies the inbound and outbound bandwidth in the unit of Kbit/s.

-
- - -

Example Requests

GET https://{elb_endpoint}/v3/{project_id}/elb/flavors/{flavor_id}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "flavor" : {
-    "shared" : true,
-    "project_id" : "573d73c9f90e48d0bddfa0eb202b25c2",
-    "info" : {
-      "connection" : 6000,
-      "cps" : 3000,
-      "qps" : 1000
-    },
-    "id" : "becf3beb-7653-45ab-a025-961597a901bc",
-    "name" : "L7_flavor.elb.s1.small",
-    "type" : "L7"
-  },
-  "request_id" : "3b9fb516-b7bb-4760-9128-4a23dd36ae10"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Load Balancer Flavor - - - diff --git a/docs/elb/api-ref/ShowHealthMonitor.html b/docs/elb/api-ref/ShowHealthMonitor.html deleted file mode 100644 index 6c5b987cf..000000000 --- a/docs/elb/api-ref/ShowHealthMonitor.html +++ /dev/null @@ -1,304 +0,0 @@ - - -

Viewing Details of a Health Check

-

Function

This API is used to view details of a health check.

- -

URI

GET /v3/{project_id}/elb/healthmonitors/{healthmonitor_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

healthmonitor_id

-

Yes

-

String

-

Specifies the health check ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

healthmonitor

-

HealthMonitor object

-

Specifies the health check.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 HealthMonitor

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the health check. Two value options are available. true indicates that the health check is enabled, and false indicates that the health check is disabled.

-

Default: true

-

delay

-

Integer

-

Specifies the interval between health checks, in seconds.

-

Minimum: 1

-

Maximum: 50

-

domain_name

-

String

-

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

-

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

-

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.

-

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

-

expected_codes

-

String

-

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

-

The value options are as follows:

-

  • A specific value, for example, 200

    -

  • A list of values that are separated with commas (,), for example, 200, 202

    -

  • A value range, for example, 200-204

    -
-

This parameter is unsupported. Please do not use it.

-

Default: 200

-

http_method

-

String

-

Specifies the HTTP method. This parameter will take effect only when type is set to HTTP.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

-

This parameter is unsupported. Please do not use it.

-

Default: GET

-

id

-

String

-

Specifies the health check ID.

-

max_retries

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

Minimum: 1

-

Maximum: 10

-

max_retries_down

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

-

Minimum: 1

-

Maximum: 10

-

Default: 3

-

monitor_port

-

Integer

-

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

-

Minimum: 1

-

Maximum: 65535

-

name

-

String

-

Specifies the health check name.

-

pools

-

Array of PoolRef objects

-

Lists the IDs of backend server groups for which the health check is configured.

-

project_id

-

String

-

Specifies the project ID.

-

timeout

-

Integer

-

Specifies the maximum time required for waiting for a response from the health check, in seconds. It is recommended that you set the value less than that of parameter delay.

-

Minimum: 1

-

Maximum: 50

-

type

-

String

-

Specifies the health check protocol.

-

url_path

-

String

-

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /. This parameter is available only when type is set to HTTP.

-

Default: /

-
- - - - - - - - - - - - -
Table 5 PoolRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors/c2b210b2-60c4-449d-91e2-9e9ea1dd7441
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "healthmonitor" : {
-    "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "name" : "My Healthmonitor update",
-    "delay" : 10,
-    "max_retries" : 10,
-    "pools" : [ {
-      "id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0"
-    } ],
-    "admin_state_up" : true,
-    "timeout" : 30,
-    "type" : "HTTP",
-    "expected_codes" : "200",
-    "url_path" : "/",
-    "http_method" : "GET"
-  },
-  "request_id" : "3702e8f0-f5f0-4d35-9097-fc7160005fae"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/ShowL7Policy.html b/docs/elb/api-ref/ShowL7Policy.html deleted file mode 100644 index 31f298aa9..000000000 --- a/docs/elb/api-ref/ShowL7Policy.html +++ /dev/null @@ -1,450 +0,0 @@ - - -

Viewing Details of a Forwarding Policy

-

Function

This API is used to view details of a forwarding policy.

- -

URI

GET /v3/{project_id}/elb/l7policies/{l7policy_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

l7policy

-

L7Policy object

-

Specifies the forwarding policy.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 L7Policy

Parameter

-

Type

-

Description

-

action

-

String

-

Specifies where requests will be forwarded. The value can be one of the following:

-

  • REDIRECT_TO_POOL: Requests will be forwarded to another backend server group.

    -

  • REDIRECT_TO_LISTENER: Requests will be redirected to an HTTPS listener.

    -
-

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.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding policy. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

String

-

Provides supplementary information about the forwarding policy.

-

id

-

String

-

Specifies the forwarding policy ID.

-

listener_id

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

  • If action is set to REDIRECT_TO_POOL, the forwarding policy can be added to an HTTP or HTTPS listener.

    -

  • If action is set to REDIRECT_TO_LISTENER, the forwarding policy can be added to an HTTP listener.

    -
-

name

-

String

-

Specifies the forwarding policy name.

-

Minimum: 1

-

Maximum: 255

-

position

-

Integer

-

Specifies the forwarding policy priority. This parameter cannot be updated.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 100

-

project_id

-

String

-

Specifies the project ID of the forwarding policy.

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding policy.

-

The value can only be ACTIVE.

-

Default: ACTIVE

-

redirect_listener_id

-

String

-

Specifies the ID of the listener that requests are redirected to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_LISTENER.

-

Only HTTPS listeners are supported, and the listener cannot be any listener added to other load balancers.

-

redirect_pool_id

-

String

-

Specifies the ID of the backend server group that requests are forwarded to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_POOL.

-

The specified backend server group cannot be the default one associated with the listener, or any backend server group associated with the forwarding policies of other listeners.

-

This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.

-

redirect_url

-

String

-

Specifies the URL to which requests are forwarded.

-

Format: protocol://host:port/path?query

-

This parameter is unsupported. Please do not use it.

-

rules

-

Array of RuleRef objects

-

Lists the forwarding rules in the forwarding policy.

-

redirect_url_config

-

RedirectUrlConfig object

-

Specifies the URL to which requests are forwarded.

-

For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

For dedicated load balancers, this parameter will take effect only when advanced forwarding is enabled (enhance_l7policy_enable is set to true). If it is passed when enhance_l7policy_enable is set to false, an error will be returned.

-

Format: protocol://host:port/path?query

-

At least one of the four parameters (protocol, host, port, and path) must be passed, or their values cannot be set to ${xxx} at the same time. (${xxx} indicates that the value in the request will be inherited. For example, ${host} indicates the host in the URL to be redirected.)

-

The values of protocol and port cannot be the same as those of the associated listener, and either host or path must be passed or their values cannot be ${xxx} at the same time.

-

This parameter is unsupported. Please do not use it.

-

fixed_response_config

-

FixtedResponseConfig object

-

Specifies the configuration of the page that will be returned. This parameter will take effect when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

This parameter is unsupported. Please do not use it.

-

priority

-

Integer

-

Specifies the forwarding policy priority. This parameter is available only for dedicated load balancers and will take effect when enhance_l7policy_enable is set to true.

-

A smaller value indicates a higher priority. The value must be unique for each forwarding policy of the same listener.

-

If action is set to REDIRECT_TO_LISTENER, the value can only be 0, indicating that REDIRECT_TO_LISTENER has the highest priority.

-

  • If enhance_l7policy_enable is set to false, forwarding policies are automatically prioritized based on the original sorting logic. Forwarding policy priorities are independent of each other regardless of domain names. If forwarding policies use the same domain name, their priorities follow the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If prefix match is used for matching, the longer the path, the higher the priority. If a forwarding policy contains only a domain name without a path specified, the path is /, and prefix match is used by default.

    -

  • If enhance_l7policy_enable is set to true and this parameter is not passed, the priority will set to a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. There will be two cases: a) If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to create because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, please specify a value or adjust the priorities of existing forwarding policies. b) If no forwarding policies exist, the highest priority of existing forwarding policies will set to 1 by default.

    -
-

This parameter is unsupported. Please do not use it.

-

Minimum: 0

-

Maximum: 10000

-
- - - - - - - - - - - - -
Table 5 RuleRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding rule ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 RedirectUrlConfig

Parameter

-

Type

-

Description

-

protocol

-

String

-

Specifies the protocol for redirection. The default value is ${protocol}, indicating that the protocol of the request will be used.

-

Value options:

-

  • HTTP

    -

  • HTTPS

    -

  • ${protocol}

    -
-

Minimum: 1

-

Maximum: 36

-

host

-

String

-

Specifies the host name that requests are redirected to. The value can contain only letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. The default value is ${host}, indicating that the host of the request will be used.

-

Default: ${host}

-

Minimum: 1

-

Maximum: 128

-

port

-

String

-

Specifies the port that requests are redirected to. The default value is ${port}, indicating that the port of the request will be used.

-

Default: ${port}

-

Minimum: 1

-

Maximum: 16

-

path

-

String

-

Specifies the path that requests are redirected to. The default value is ${path}, indicating that the path of the request will be used. The value can contain only letters, digits, and special characters _-';@^- %#&$.*+?,=!:|/()[]{} and must start with a slash (/).

-

Default: ${path}

-

Minimum: 1

-

Maximum: 128

-

query

-

String

-

Specifies the query string set in the URL for redirection. The default value is ${query}, indicating that the query string of the request will be used.

-

For example, in the URL https://www.xxx.com:8080/elb?type=loadbalancer, ${query} indicates type=loadbalancer. If this parameter is set to ${query}&name=my_name, the URL will be redirected to https://www.xxx.com:8080/elb?type=loadbalancer&name=my_name.

-

The value is case-sensitive and can contain only letters, digits, and special characters !$&'()*+,-./:;=?@^_`

-

Default: ${query}

-

Minimum: 0

-

Maximum: 128

-

status_code

-

String

-

Specifies the status code returned after the requests are redirected.

-

Value options:

-

  • 301

    -

  • 302

    -

  • 303

    -

  • 307

    -

  • 308

    -
-

Minimum: 1

-

Maximum: 16

-
- - - - - - - - - - - - - - - - - - - - -
Table 7 FixtedResponseConfig

Parameter

-

Type

-

Description

-

status_code

-

String

-

Specifies the HTTP status code configured in the forwarding policy. The value can be any integer in the range of 200–299, 400–499, or 500–599.

-

Minimum: 1

-

Maximum: 16

-

content_type

-

String

-

Specifies the format of the response body.

-

Value options:

-

  • text/plain

    -

  • text/css

    -

  • text/html

    -

  • application/javascript

    -

  • application/json

    -
-

Minimum: 0

-

Maximum: 32

-

message_body

-

String

-

Specifies the content of the response body.

-

Minimum: 0

-

Maximum: 1024

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "l7policy" : {
-    "description" : "",
-    "admin_state_up" : true,
-    "rules" : [ ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "listener_id" : "e2220d2a-3faf-44f3-8cd6-0c42952bd0ab",
-    "redirect_listener_id" : "48a97732-449e-4aab-b561-828d29e45050",
-    "action" : "REDIRECT_TO_LISTENER",
-    "position" : 100,
-    "provisioning_status" : "ACTIVE",
-    "id" : "cf4360fd-8631-41ff-a6f5-b72c35da74be",
-    "name" : ""
-  },
-  "request_id" : "6be83ec4-623e-4840-a417-2fcdf8ad5dfa"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/ShowL7Rule.html b/docs/elb/api-ref/ShowL7Rule.html deleted file mode 100644 index beb4ff57b..000000000 --- a/docs/elb/api-ref/ShowL7Rule.html +++ /dev/null @@ -1,282 +0,0 @@ - - -

Viewing Details of a Forwarding Rule

-

Function

This API is used to view details of a forwarding rule.

- -

URI

GET /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}

- - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy.

-

l7rule_id

-

Yes

-

String

-

Specifies the forwarding rule.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

rule

-

L7Rule object

-

Specifies the forwarding rule.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 L7Rule

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding rule. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

compare_type

-

String

-

Specifies how requests are matched with the domain name or URL.

-

  • If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO.

    -

  • If type is set to PATH, this parameter can be set to REGEX, STARTS_WITH, or EQUAL_TO.

    -
-

key

-

String

-

Specifies the key of the match content. This parameter will not take effect when type is set to HOST_NAME or PATH. It can be updated but will not take effect.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 255

-

project_id

-

String

-

Specifies the project ID.

-

type

-

String

-

Specifies the match content. The value can be one of the following:

-

  • HOST_NAME: A domain name will be used for matching.

    -

  • PATH: A URL will be used for matching.

    -
-

If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

-

value

-

String

-

Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name.

-

  • If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH and compare_type to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding rule.

-

The value can only be ACTIVE.

-

invert

-

Boolean

-

Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but remains invalid.

-

Default: false

-

id

-

String

-

Specifies the forwarding policy ID.

-

conditions

-

Array of RuleCondition objects

-

Specifies the matching conditions of the forwarding rule.

-

  • If conditions is specified, key and value will not take effect, and the value of this parameter will contain all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique.

    -

  • If conditions is not specified, the values of key and value are displayed.

    -
-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - -
Table 5 RuleCondition

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the key of match item. This parameter is left blank.

-

Minimum: 1

-

Maximum: 128

-

value

-

String

-

Specifies the value of the match item.

-

  • If type is set to HOST_NAME, key is left blank, and value indicates the domain name, which can contain 1 to 128 characters, including letters, digits, hyphens (-), periods (.), and asterisks (), and must start with a letter, digit, or asterisk (). If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH, key is left blank, and value indicates the request path, which can contain 1 to 128 characters. If compare_type is set to STARTS_WITH or EQUAL_TO for the forwarding rule, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules/84f4fcae-9c15-4e19-a99f-72c0b08fd3d7
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "rule" : {
-    "compare_type" : "STARTS_WITH",
-    "provisioning_status" : "ACTIVE",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "invert" : false,
-    "admin_state_up" : true,
-    "value" : "/ccc.html",
-    "type" : "PATH",
-    "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7"
-  },
-  "request_id" : "0d799435-259e-459f-b2bc-0beee06f6a77"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/ShowListener.html b/docs/elb/api-ref/ShowListener.html deleted file mode 100644 index c2cab99c7..000000000 --- a/docs/elb/api-ref/ShowListener.html +++ /dev/null @@ -1,515 +0,0 @@ - - -

Viewing Details of a Listener

-

Function

This API is used to view details of a listener.

- -

URI

GET /v3/{project_id}/elb/listeners/{listener_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

listener

-

Listener object

-

Specifies the listener.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Listener

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the listener. And the value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

client_ca_tls_container_ref

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

connection_limit

-

Integer

-

Specifies the maximum number of connections. The default value is -1.

-

This parameter is unsupported. Please do not use it.

-

created_at

-

String

-

Specifies the time when the listener was created.

-

default_pool_id

-

String

-

Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server.

-

default_tls_container_ref

-

String

-

Specifies the ID of the server certificate used by the listener.

-

description

-

String

-

Provides supplementary information about the listener.

-

http2_enable

-

Boolean

-

Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect.

-

Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.

-

Default: true

-

id

-

String

-

Specifies the listener ID.

-

insert_headers

-

ListenerInsertHeaders object

-

Specifies the HTTP header fields.

-

loadbalancers

-

Array of LoadBalancerRef objects

-

Specifies the ID of the load balancer that the listener is added to.

-

name

-

String

-

Specifies the listener name.

-

project_id

-

String

-

Specifies the ID of the project where the listener is used.

-

protocol

-

String

-

Specifies the protocol used by the listener.

-

protocol_port

-

Integer

-

Specifies the port used by the listener.

-

Minimum: 1

-

Maximum: 65535

-

sni_container_refs

-

Array of strings

-

Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

-

Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.

-

This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.

-

tags

-

Array of Tag objects

-

Lists the tags.

-

updated_at

-

String

-

Specifies the time when the listener was updated.

-

tls_ciphers_policy

-

String

-

Specifies the security policy used by the listener. This parameter is available only for HTTPS listeners.

-

The value can be tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0.

-

enable_member_retry

-

Boolean

-

Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners.

-

keepalive_timeout

-

Integer

-

Specifies the idle timeout duration, in seconds.

-

  • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.

    -

  • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.

    -

  • For UDP listeners, this parameter does not take effect.

    -
-

client_timeout

-

Integer

-

Specifies the timeout duration for waiting for a request from a client, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

member_timeout

-

Integer

-

Specifies the timeout duration for waiting for a request from a backend server, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

ipgroup

-

ListenerIpGroup object

-

Specifies the IP address group associated with the listener.

-

This parameter is unsupported. Please do not use it.

-

transparent_client_ip_enable

-

Boolean

-

Specifies whether to pass source IP addresses of the clients to backend servers.

-

Shared load balancers: The value can be true or false, and the default value is false for TCP and UDP listeners. The value can only be true for HTTP and HTTPS listeners. If this parameter is not passed, the default value is true.

-

Dedicated load balancers: The value can only be true for all types of listeners. If this parameter is not passed, the default value is true.

-

enhance_l7policy_enable

-

Boolean

-

Specifies whether to enable advanced forwarding. The value can be true or false (default).

-

  • true indicates that advanced forwarding will be enabled.

    -

  • false indicates that advanced forwarding will not be enabled.

    -
-

The following parameters will be available only when advanced forwarding is enabled:

-

  • redirect_url_config

    -

  • fixed_response_config

    -

  • priority

    -

  • conditions

    -
-

For details, see the descriptions in the APIs of forwarding policies and forwarding rules.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ListenerInsertHeaders

Parameter

-

Type

-

Description

-

X-Forwarded-ELB-IP

-

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

-

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

-

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

-

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

-
- - - - - - - - - - - - -
Table 6 LoadBalancerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-
- - - - - - - - - - - - - - - - -
Table 7 Tag

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

-

value

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - - - - - - - -
Table 8 ListenerIpGroup

Parameter

-

Type

-

Description

-

ipgroup_id

-

String

-

Specifies the ID of the IP address group associated with the listener.

-

  • If ip_list is set to [] and type to whitelist, no IP addresses are allowed to access the listener.

    -

  • If ip_list is set to [] and type to blacklist, any IP address is allowed to access the listener.

    -

  • The specified IP address group must exist and this parameter cannot be set to null.

    -
-

enable_ipgroup

-

Boolean

-

Specifies whether to enable access control.

-

  • true: Access control is enabled.

    -

  • false: Access control is disabled.

    -
-

A listener with access control enabled can be directly deleted.

-

type

-

String

-

Specifies how access to the listener is controlled.

-

  • white: A whitelist is configured. Only IP addresses in the whitelist can access the listener.

    -

  • black: A blacklist is configured. IP addresses in the blacklist are not allowed to access the listener.

    -
-
- - -

Example Requests

GET
-
-https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/listeners/683cf917-3e51-4c41-830c-bc3a57e090f0
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "listener" : {
-    "id" : "683cf917-3e51-4c41-830c-bc3a57e090f0",
-    "name" : "My listener",
-    "protocol_port" : 90,
-    "protocol" : "HTTPS",
-    "description" : "",
-    "default_tls_container_ref" : "4e7761d7c7d141c389479f2641c8bff8",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "ac82ca77-8be3-4d65-9c4d-155771b463df"
-    } ],
-    "project_id" : "060576782980d5762f9ec014dd2f1148",
-    "sni_container_refs" : [ ],
-    "connection_limit" : -1,
-    "tls_ciphers_policy" : "tls-1-0",
-    "tags" : [ ],
-    "created_at" : "2021-04-02T07:48:38Z",
-    "updated_at" : "2021-04-02T07:48:38Z",
-    "http2_enable" : false,
-    "insert_headers" : {
-      "X-Forwarded-ELB-IP" : false,
-      "X-Forwarded-Host" : true,
-      "X-Forwarded-For-Port" : false,
-      "X-Forwarded-Port" : false
-    },
-    "member_timeout" : 60,
-    "client_timeout" : 60,
-    "keepalive_timeout" : 60,
-    "enable_member_retry" : true,
-    "transparent_client_ip_enable" : true,
-    "enhance_l7policy_enable" : false
-  },
-  "request_id" : "830de7c7c38232d925db168bfb3cb0e8"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/ShowLoadBalancer.html b/docs/elb/api-ref/ShowLoadBalancer.html deleted file mode 100644 index e7e594766..000000000 --- a/docs/elb/api-ref/ShowLoadBalancer.html +++ /dev/null @@ -1,599 +0,0 @@ - - -

Viewing Details of a Load Balancer

-

Function

This API is used to view details of a load balancer.

- -

URI

GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

loadbalancer

-

LoadBalancer object

-

Specifies the load balancer.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 LoadBalancer

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-

Default: Automatically generated

-

description

-

String

-

Provides supplementary information about the load balancer.

-

Minimum: 1

-

Maximum: 255

-

provisioning_status

-

String

-

Specifies the provisioning status of the load balancer. The value can only be ACTIVE.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the load balancer. The value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

provider

-

String

-

Specifies the provider of the load balancer. The value can only be vlb.

-

Default: vlb

-

pools

-

Array of PoolRef objects

-

Lists the IDs of backend server groups associated with the load balancer.

-

listeners

-

Array of ListenerRef objects

-

Lists the IDs of listeners added to the load balancer.

-

operating_status

-

String

-

Specifies the operating status of the load balancer. The value can only be ONLINE.

-

Minimum: 1

-

Maximum: 16

-

vip_address

-

String

-

Specifies the private IPv4 address bound to the load balancer.

-

Minimum: 1

-

Maximum: 64

-

vip_subnet_cidr_id

-

String

-

Specifies the ID of the IPv4 subnet where the load balancer works.

-

Minimum: 1

-

Maximum: 36

-

name

-

String

-

Specifies the name of the load balancer.

-

Minimum: 1

-

Maximum: 255

-

project_id

-

String

-

Specifies the project ID of the load balancer.

-

Minimum: 1

-

Maximum: 32

-

vip_port_id

-

String

-

Specifies the ID of the port bound to the virtual IP address (the value of vip_address) of the load balancer.

-

When you create a dedicated load balancer, the system automatically creates a port for the load balancer and associates the port with a default security group. However, security group rules containing the port will not affect traffic to and from the load balancer.

-

tags

-

Array of Tag objects

-

Lists the tags added to the load balancer.

-

created_at

-

String

-

Specifies the time when the load balancer was created.

-

Minimum: 1

-

Maximum: 20

-

updated_at

-

String

-

Specifies the time when the load balancer was updated.

-

Minimum: 1

-

Maximum: 20

-

guaranteed

-

Boolean

-

Specifies whether the load balancer is a dedicated load balancer.

-

The value can be true or false. true indicates a dedicated load balancer, and false indicates a shared load balancer. When dedicated load balancers are launched in the eu-de region, either true or false will be returned when you use the API to query or update a load balancer.

-

Default: true

-

vpc_id

-

String

-

Specifies the ID of the VPC where the load balancer works.

-

eips

-

Array of EipInfo objects

-

Specifies the EIP bound to the load balancer.

-

ipv6_vip_address

-

String

-

Specifies the IPv6 address bound to the load balancer.

-

This parameter is unsupported. Please do not use it.

-

Default: None

-

Minimum: 1

-

Maximum: 64

-

ipv6_vip_virsubnet_id

-

String

-

Specifies the ID of the IPv6 subnet where the load balancer works.

-

This parameter is unsupported. Please do not use it.

-

ipv6_vip_port_id

-

String

-

Specifies the ID of the port bound to the IPv6 address.

-

This parameter is unsupported. Please do not use it.

-

availability_zone_list

-

Array of strings

-

Specifies the list of AZs where the load balancer is created.

-

enterprise_project_id

-

String

-

Specifies the enterprise project ID.

-

If this parameter is not passed during resource creation, the resource belongs to the default enterprise project.

-

This parameter is unsupported. Please do not use it.

-

Default: 0

-

l4_flavor_id

-

String

-

Specifies the Layer-4 flavor.

-

Minimum: 1

-

Maximum: 255

-

l4_scale_flavor_id

-

String

-

Specifies the reserved Layer 4 flavor.

-

Minimum: 1

-

Maximum: 255

-

l7_flavor_id

-

String

-

Specifies the Layer-7 flavor.

-

Minimum: 1

-

Maximum: 255

-

l7_scale_flavor_id

-

String

-

Specifies the reserved Layer 7 flavor.

-

Minimum: 1

-

Maximum: 255

-

publicips

-

Array of PublicIpInfo objects

-

Specifies the EIP bound to the load balancer.

-

elb_virsubnet_ids

-

Array of strings

-

Specifies the ID of the subnet on the downstream plane. The ports used by the load balancer dynamically occupy IP addresses in the subnet.

-

ip_target_enable

-

Boolean

-

Specifies whether to enable cross-VPC backend.

-

This parameter is unsupported. Please do not use it.

-

Default: false

-

frozen_scene

-

String

-

Specifies the scenario where the load balancer is frozen. Use commas to separate multiple scenarios.

-

If the value is ARREAR, the load balancer is frozen because your account is in arrears.

-

ipv6_bandwidth

-

BandwidthRef object

-

Specifies the ID of the bandwidth. This parameter is available only when you create or update a dedicated load balancer that has an IPv6 address bound.

-

If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - -
Table 5 PoolRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-
- - - - - - - - - - - - -
Table 6 ListenerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-
- - - - - - - - - - - - - - - - -
Table 7 Tag

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

-

value

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - - - - - - - -
Table 8 EipInfo

Parameter

-

Type

-

Description

-

eip_id

-

String

-

Specifies the EIP ID.

-

eip_address

-

String

-

Specifies the specific IP address.

-

ip_version

-

Integer

-

Specifies the IP version. 4 indicates IPv4, and 6 indicates IPv6.

-

IPv6 is unsupported. The value cannot be 6.

-
- - - - - - - - - - - - - - - - - - - - -
Table 9 PublicIpInfo

Parameter

-

Type

-

Description

-

publicip_id

-

String

-

Specifies the EIP ID.

-

publicip_address

-

String

-

Specifies the IP address.

-

ip_version

-

Integer

-

Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6).

-

IPv6 is unsupported. The value cannot be 6.

-
- - - - - - - - - - - - -
Table 10 BandwidthRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the shared bandwidth ID.

-
- - -

Example Requests

Viewing details of a load balancer

-
GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
-
-GET
-
-https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/3dbde7e5-c277-4ea3-a424-edd339357eff
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "loadbalancer" : {
-    "id" : "3dbde7e5-c277-4ea3-a424-edd339357eff",
-    "project_id" : "060576782980d5762f9ec014dd2f1148",
-    "name" : "elb-l4-no-delete",
-    "vip_port_id" : "f079c7ee-65a9-44ef-be86-53d8927e59be",
-    "vip_address" : "10.0.0.196",
-    "admin_state_up" : true,
-    "provisioning_status" : "ACTIVE",
-    "operating_status" : "ONLINE",
-    "listeners" : [ ],
-    "pools" : [ {
-      "id" : "1d864dc9-f6ef-4366-b59d-7034cde2328f"
-    }, {
-      "id" : "c0a2e4a1-c028-4a24-a62f-e721c52f5513"
-    }, {
-      "id" : "79308896-6169-4c28-acbc-e139eb661996"
-    } ],
-    "tags" : [ ],
-    "created_at" : "2019-12-02T09:55:11Z",
-    "updated_at" : "2019-12-02T09:55:11Z",
-    "vpc_id" : "70711260-9de9-4d96-9839-0ae698e00109",
-    "enterprise_project_id" : "0",
-    "availability_zone_list" : [ ],
-    "publicips" : [ ],
-    "elb_virsubnet_ids" : [ "ad5d63bf-3b50-4e88-b4d9-e94a59aade48" ],
-    "eips" : [ ],
-    "guaranteed" : true,
-    
-    "l4_flavor_id" : "e5acacda-f861-404e-9871-df480c49d185",
-    "vip_subnet_cidr_id" : "396d918a-756e-4163-8450-3bdc860109cf"
-  },
-  "request_id" : "1a47cfbf-969f-4e40-8c0e-c2e60b14bcac"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/ShowLoadBalancerStatus.html b/docs/elb/api-ref/ShowLoadBalancerStatus.html deleted file mode 100644 index eb7e630cf..000000000 --- a/docs/elb/api-ref/ShowLoadBalancerStatus.html +++ /dev/null @@ -1,566 +0,0 @@ - - -

Querying the Status Tree of a Load Balancer

-

Function

This API is used to query the status tree of a load balancer and show information about all resources associated with the load balancer.

-

When admin_state_up is set to false and operating_status to OFFLINE for a backend server, DISABLED is returned for operating_status of the backend server in the response of this API.

- -

URI

GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/statuses

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

statuses

-

LoadBalancerStatusResult object

-

Provides information about the load balancer status tree.

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-
- - - - - - - - - - - - -
Table 4 LoadBalancerStatusResult

Parameter

-

Type

-

Description

-

loadbalancer

-

LoadBalancerStatus object

-

Specifies the statuses of the load balancer and its associated resources.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 LoadBalancerStatus

Parameter

-

Type

-

Description

-

name

-

String

-

Specifies the load balancer name.

-

Minimum: 1

-

Maximum: 255

-

provisioning_status

-

String

-

Specifies the provisioning status of the load balancer.

-

The value can only be ACTIVE.

-

listeners

-

Array of LoadBalancerStatusListener objects

-

Lists the listeners added to the load balancer.

-

pools

-

Array of LoadBalancerStatusPool objects

-

Lists the backend server groups associated with the load balancer.

-

id

-

String

-

Specifies the load balancer ID.

-

operating_status

-

String

-

Specifies the operating status of the load balancer.

-

The value can only be one of the following:

-

  • ONLINE (default): The load balancer is running normally.

    -

  • DEGRADED: This status is displayed only when operating_status is set to OFFLINE for a backend server associated with the load balancer and the API for querying the load balancer status tree is called.

    -

  • DISABLED: This status is displayed only when admin_state_up of the load balancer is set to false and the API for querying the load balancer status tree is called.

    -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 LoadBalancerStatusListener

Parameter

-

Type

-

Description

-

name

-

String

-

Specifies the name of the listener added to the load balancer.

-

Minimum: 1

-

Maximum: 255

-

provisioning_status

-

String

-

Specifies the provisioning status of the listener. The value can only be ACTIVE.

-

Default: ACTIVE

-

pools

-

Array of LoadBalancerStatusPool objects

-

Specifies the operating status of the backend server group associated with the listener.

-

l7policies

-

Array of LoadBalancerStatusPolicy objects

-

Specifies the operating status of the forwarding policy added to the listener.

-

id

-

String

-

Specifies the listener ID.

-

operating_status

-

String

-

Specifies the operating status of the listener.

-

The value can only be one of the following:

-

  • ONLINE (default): The listener is running normally.

    -

  • DISABLED: This status is displayed only when admin_state_up of the load balancer or the listener is set to false and the API for querying the load balancer status tree is called.

    -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 LoadBalancerStatusPolicy

Parameter

-

Type

-

Description

-

action

-

String

-

Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener. The value can be REDIRECT_TO_POOL or REDIRECT_TO_LISTENER.

-

id

-

String

-

Specifies the policy ID.

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding policy.

-

The value can only be ACTIVE.

-

Default: ACTIVE

-

name

-

String

-

Specifies the policy name.

-

Minimum: 1

-

Maximum: 255

-

rules

-

Array of LoadBalancerStatusL7Rule objects

-

Specifies the forwarding rule.

-
- - - - - - - - - - - - - - - - - - - - -
Table 8 LoadBalancerStatusL7Rule

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the forwarding rule.

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding rule.

-

The value can only be ACTIVE.

-

type

-

String

-

Specifies the match content. The value can be HOST_NAME or PATH.

-

HOST_NAME indicates that the domain name will be used for matching, and PATH indicates that the URL will be used for matching.

-

The type value must be unique for each forwarding rule in a forwarding policy.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 LoadBalancerStatusPool

Parameter

-

Type

-

Description

-

provisioning_status

-

String

-

Specifies the provisioning status of the backend server group. The value can only be ACTIVE.

-

name

-

String

-

Specifies the name of the backend server group.

-

Minimum: 1

-

Maximum: 255

-

healthmonitor

-

LoadBalancerStatusHealthMonitor object

-

Specifies the health check results of backend servers in the load balancer status tree.

-

members

-

Array of LoadBalancerStatusMember objects

-

Specifies the backend server.

-

id

-

String

-

Specifies the ID of the backend server group.

-

operating_status

-

String

-

Specifies the operating status of the backend server group.

-

The value can be one of the following:

-

  • ONLINE: The backend server group is running normally.

    -

  • DEGRADED: This status is displayed only when operating_status of a backend server in the group is set to OFFLINE and the API for querying the load balancer status tree is called.

    -

  • DISABLED: This status is displayed only when admin_state_up of the backend server group or the associated load balancer is set to false and the API for querying the load balancer status tree is called.

    -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 LoadBalancerStatusHealthMonitor

Parameter

-

Type

-

Description

-

type

-

String

-

Specifies the health check protocol. The value can be TCP, UDP_CONNECT, or HTTP.

-

id

-

String

-

Specifies the health check ID.

-

name

-

String

-

Specifies the health check name.

-

Minimum: 1

-

Maximum: 255

-

provisioning_status

-

String

-

Specifies the provisioning status of the health check. The value can only be ACTIVE.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 11 LoadBalancerStatusMember

Parameter

-

Type

-

Description

-

provisioning_status

-

String

-

Specifies the provisioning status of the backend server. The value can only be ACTIVE.

-

Default: ACTIVE

-

address

-

String

-

Specifies the IP address of the backend server.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server to receive requests. The port number ranges from 1 to 65535.

-

id

-

String

-

Specifies the backend server ID.

-

operating_status

-

String

-

Specifies the operating status of the backend server.

-

The value can be one of the following:

-

  • ONLINE: The backend server is running normally.

    -

  • NO_MONITOR: No health check is configured for the backend server group to which the backend server belongs.

    -

  • DISABLED: The backend server is not available. This status is displayed only when admin_state_up of the backend server, or the backend server group to which it belongs, or the associated load balancer is set to false and the API for querying the load balancer status tree is called.

    -

  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.

    -
-
- - -

Example Requests

Querying the status tree of a load balancer

-
GET
-
-https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/38278031-cfca-44be-81be-a412f618773b/statuses
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "statuses" : {
-    "loadbalancer" : {
-      "name" : "lb-jy",
-      "provisioning_status" : "ACTIVE",
-      "listeners" : [ {
-        "name" : "listener-jy-1",
-        "provisioning_status" : "ACTIVE",
-        "pools" : [ {
-          "name" : "pool-jy-1",
-          "provisioning_status" : "ACTIVE",
-          "healthmonitor" : {
-            "type" : "TCP",
-            "id" : "7422b51a-0ed2-4702-9429-4f88349276c6",
-            "name" : "",
-            "provisioning_status" : "ACTIVE"
-          },
-          "members" : [ {
-            "protocol_port" : 80,
-            "address" : "192.168.44.11",
-            "id" : "7bbf7151-0dce-4087-b316-06c7fa17b894",
-            "operating_status" : "ONLINE",
-            "provisioning_status" : "ACTIVE"
-          } ],
-          "id" : "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
-          "operating_status" : "ONLINE"
-        } ],
-        "l7policies" : [ ],
-        "id" : "eb84c5b4-9bc5-4bee-939d-3900fb05dc7b",
-        "operating_status" : "ONLINE"
-      } ],
-      "pools" : [ {
-        "name" : "pool-jy-1",
-        "provisioning_status" : "ACTIVE",
-        "healthmonitor" : {
-          "type" : "TCP",
-          "id" : "7422b51a-0ed2-4702-9429-4f88349276c6",
-          "name" : "",
-          "provisioning_status" : "ACTIVE"
-        },
-        "members" : [ {
-          "protocol_port" : 80,
-          "address" : "192.168.44.11",
-          "id" : "7bbf7151-0dce-4087-b316-06c7fa17b894",
-          "operating_status" : "ONLINE",
-          "provisioning_status" : "ACTIVE"
-        } ],
-        "id" : "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
-        "operating_status" : "ONLINE"
-      } ],
-      "id" : "38278031-cfca-44be-81be-a412f618773b",
-      "operating_status" : "ONLINE"
-    }
-  }
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/ShowMember.html b/docs/elb/api-ref/ShowMember.html deleted file mode 100644 index 0de9d1905..000000000 --- a/docs/elb/api-ref/ShowMember.html +++ /dev/null @@ -1,245 +0,0 @@ - - -

Viewing Details of a Backend Server

-

Function

This API is used to view details of a backend server.

- -

URI

GET /v3/{project_id}/elb/pools/{pool_id}/members/{member_id}

- - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-

member_id

-

Yes

-

String

-

Specifies the backend server ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

member

-

Member object

-

Specifies the backend server.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Member

Parameter

-

Type

-

Description

-

address

-

String

-

Specifies the IP address of the backend server.

-

The IP address must be in the subnet specified by subnet_cidr_id, for example, 192.168.3.11. The IP address can only be the IP address of the primary NIC.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server.

-

Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers exist. If cloud servers exist, the value is true. Otherwise, the value is false.

-

Default: true

-

id

-

String

-

Specifies the backend server ID.

-

name

-

String

-

Specifies the backend server name.

-

operating_status

-

String

-

Specifies the operating status of the backend server. The value can be one of the following:

-

  • ONLINE: The backend server is running normally.

    -

  • NO_MONITOR: No health check is configured for the backend server group to which the backend server belongs.

    -

  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.

    -
-

project_id

-

String

-

Specifies the project ID.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server to receive requests.

-

Minimum: 1

-

Maximum: 65535

-

subnet_cidr_id

-

String

-

Specifies the ID of the subnet where the backend server works. This subnet must be in the VPC as the subnet of the load balancer associated with the backend server. Only IPv4 subnets are supported. If the value is left blank, the backend server is not in the load balancer's VPC.

-

weight

-

Integer

-

Specifies the weight of the backend server.

-

Requests are routed to backend servers in the same backend server group based on their weights.

-

If the weight is 0, the backend server will not accept new requests.

-

This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

-

Minimum: 0

-

Maximum: 100

-

Default: 1

-

ip_version

-

String

-

This is a read-only attribute, which is automatically generated based on the address parameter. The value can be v4 or v6.

-

Default: v4

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members/1923923e-fe8a-484f-bdbc-e11559b1f48f
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "member" : {
-    "name" : "My member",
-    "weight" : 10,
-    "admin_state_up" : false,
-    "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "address" : "120.10.10.16",
-    "protocol_port" : 89,
-    "id" : "1923923e-fe8a-484f-bdbc-e11559b1f48f",
-    "operating_status" : "NO_MONITOR",
-    "ip_version" : "v4"
-  },
-  "request_id" : "45688823-45f1-40cd-9d24-e51a9574a45b"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/ShowPool.html b/docs/elb/api-ref/ShowPool.html deleted file mode 100644 index 73da88648..000000000 --- a/docs/elb/api-ref/ShowPool.html +++ /dev/null @@ -1,410 +0,0 @@ - - -

Viewing Details of a Backend Server Group

-

Function

This API is used to view details of a backend server group.

- -

URI

GET /v3/{project_id}/elb/pools/{pool_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

pool

-

Pool object

-

Specifies the backend server group.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Pool

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server group. The value can only be updated to true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

String

-

Provides supplementary information about the backend server group.

-

healthmonitor_id

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

id

-

String

-

Specifies the backend server group ID.

-

lb_algorithm

-

String

-

Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the backend server group.

-

The value can be ROUND_ROBIN (weighted round robin), LEAST_CONNECTIONS (weighted least connections), or SOURCE_IP (source IP hash).

-

When the value is SOURCE_IP, the weight parameter is invalid.

-

listeners

-

Array of ListenerRef objects

-

Lists the listeners associated with the backend server group.

-

loadbalancers

-

Array of LoadBalancerRef objects

-

Lists the IDs of load balancers associated with the backend server group.

-

If only listener_id is specified during the creation of the backend server group, the ID of the loadbalancers parameter in the response is the ID of the load balancer to which the listener is added.

-

members

-

Array of MemberRef objects

-

Lists the backend servers in the backend server group.

-

name

-

String

-

Specifies the backend server group name.

-

project_id

-

String

-

Specifies the project ID.

-

protocol

-

String

-

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

-

  • For UDP listeners, the protocol of the backend server group must be UDP.

    -

  • For TCP listeners, the protocol of the backend server group must be TCP.

    -

  • For HTTP or HTTPS listeners, the protocol of the backend server group must be HTTP.

    -
-

session_persistence

-

SessionPersistence object

-

Specifies the sticky session.

-

ip_version

-

String

-

Specifies the IP version supported by the backend server group.

-

  • Shared load balancers: The default value is v4.

    -

  • Dedicated load balancers: The value can be dualstack, v4, or v6.

    -
-

When the protocol of the backend server group is TCP or UDP, ip_version is set to dualstack, indicating that both IPv4 and IPv6 are supported.

-

When the protocol of the backend server group is HTTP, ip_version is set to v4.

-

IPv6 is unsupported. Only v4 is returned.

-

Default: dualstack

-

slow_start

-

SlowStart object

-

Specifies whether to enable slow start. After you enable slow start, new backend servers added to the backend server group are warmed up, and the number of requests they can receive increases linearly during the configured slow start duration.

-

This parameter can be used when the protocol of the backend server group is HTTP or HTTPS. An error will be returned if the protocol is not HTTP or HTTPS.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - -
Table 5 ListenerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-
- - - - - - - - - - - - -
Table 6 LoadBalancerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-
- - - - - - - - - - - - -
Table 7 MemberRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

-
- - - - - - - - - - - - - - - - - - - - -
Table 8 SessionPersistence

Parameter

-

Type

-

Description

-

cookie_name

-

String

-

Specifies the cookie name.

-

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

-

The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 0

-

Maximum: 1024

-

type

-

String

-

Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, only SOURCE_IP takes effect.

    -

  • For dedicated load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can only be HTTP_COOKIE.

    -

  • For shared load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can be HTTP_COOKIE or APP_COOKIE.

    -
-

persistence_timeout

-

Integer

-

Specifies the stickiness duration, in minutes. This parameter will not take effect when type is set to APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60, and the default value is 1.

    -

  • If the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440, and the default value is 1440.

    -
-
- - - - - - - - - - - - - - - - -
Table 9 SlowStart

Parameter

-

Type

-

Description

-

enable

-

Boolean

-

Specifies whether to enable slow start.

-

true indicates that this function is enabled, and false indicates this function is disabled.

-

Default: false

-

duration

-

Integer

-

Specifies the slow start duration, in seconds.

-

The value ranges from 30 to 1200, and the default value is 30.

-

Minimum: 30

-

Maximum: 1200

-

Default: 30

-
- - -

Example Requests

GET
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "pool" : {
-    "lb_algorithm" : "LEAST_CONNECTIONS",
-    "protocol" : "TCP",
-    "description" : "My pool",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "098b2f68-af1c-41a9-8efd-69958722af62"
-    } ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "session_persistence" : "",
-    "healthmonitor_id" : "",
-    "listeners" : [ {
-      "id" : "0b11747a-b139-492f-9692-2df0b1c87193"
-    }, {
-      "id" : "61942790-2367-482a-8b0e-93840ea2a1c6"
-    }, {
-      "id" : "fd8f954c-f0f8-4d39-bb1d-41637cd6b1be"
-    } ],
-    "members" : [ ],
-    "id" : "36ce7086-a496-4666-9064-5ba0e6840c75",
-    "name" : "My pool.",
-    "ip_version" : "dualstack"
-  },
-  "request_id" : "c1a60da2-1ec7-4a1c-b4cc-73e1a57b368e"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/ShowQuota.html b/docs/elb/api-ref/ShowQuota.html deleted file mode 100644 index 2a9ae681c..000000000 --- a/docs/elb/api-ref/ShowQuota.html +++ /dev/null @@ -1,210 +0,0 @@ - - -

Querying Quotas

-

Function

This API is used to query resource quotas of a specific user.

- -

URI

GET /v3/{project_id}/elb/quotas

- - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

quota

-

Quota object

-

Specifies the quota details.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Quota

Parameter

-

Type

-

Description

-

certificate

-

Integer

-

Specifies the certificate quota. -1 indicates that the quota is not limited.

-

healthmonitor

-

Integer

-

Specifies the health check quota. -1 indicates that the quota is not limited.

-

l7policy

-

Integer

-

Specifies the forwarding policy quota. -1 indicates that the quota is not limited.

-

listener

-

Integer

-

Specifies the listener quota. -1 indicates that the quota is not limited.

-

loadbalancer

-

Integer

-

Specifies the load balancer quota. -1 indicates that the quota is not limited.

-

member

-

Integer

-

Specifies the backend server quota. -1 indicates that the quota is not limited.

-

members_per_pool

-

Integer

-

Specifies the quota of backend servers in a backend server group. -1 indicates that the quota is not limited.

-

pool

-

Integer

-

Specifies the backend server group quota. -1 indicates that the quota is not limited.

-

ipgroup

-

Integer

-

Specifies the IP address group quota. -1 indicates that the quota is not limited.

-

This parameter is unsupported. Please do not use it.

-

project_id

-

String

-

Specifies the project ID.

-
- - -

Example Requests

GET https://{elb_endpoint}/v3/{project_id}/elb/quotas
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "quota" : {
-    "member" : 500,
-    "members_per_pool" : 500,
-    "certificate" : 120,
-    "l7policy" : 500,
-    "listener" : 100,
-    "loadbalancer" : 50,
-    "healthmonitor" : -1,
-    "ipgroup" : 50,
-    "pool" : 500,
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24"
-  },
-  "request_id" : "8d7eba6f-ec79-42d2-8d8c-16149645549d"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Quota - - - diff --git a/docs/elb/api-ref/UpdateCertificate.html b/docs/elb/api-ref/UpdateCertificate.html deleted file mode 100644 index 88d0549e9..000000000 --- a/docs/elb/api-ref/UpdateCertificate.html +++ /dev/null @@ -1,358 +0,0 @@ - - -

Updating a Certificate

-

Function

This API is used to update an SSL certificate.

- -

URI

PUT /v3/{project_id}/elb/certificates/{certificate_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

certificate_id

-

Yes

-

String

-

Specifies a certificate ID.

-

project_id

-

Yes

-

String

-

Specifies the project ID of the certificate.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

certificate

-

Yes

-

UpdateCertificateOption object

-

Specifies request parameters for updating a certificate.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 UpdateCertificateOption

Parameter

-

Mandatory

-

Type

-

Description

-

certificate

-

No

-

String

-

Specifies the private key of the certificate. The value must be PEM encoded.

-

description

-

No

-

String

-

Provides supplementary information about the certificate.

-

Minimum: 0

-

Maximum: 255

-

name

-

No

-

String

-

Specifies the certificate name.

-

Minimum: 0

-

Maximum: 255

-

private_key

-

No

-

String

-

Specifies the private key of the server certificate. The value must be PEM encoded.

-

  • This parameter will be ignored if type is set to client. A CA server can still be created and used normally. This parameter will be left blank even if you enter a private key that is not PEM encoded.

    -

  • This parameter is valid and mandatory only when type is set to server. If you enter an invalid private key, an error is returned.

    -
-

domain

-

No

-

String

-

Specifies the domain names used by the server certificate.

-

  • This parameter will take effect only when type is set to server, and its default value is "".

    -

  • This parameter will not take effect even if it is passed and type is set to client. However, domain names will still be verified.

    -
-

Note:

-

  • The value can contain 0 to 1024 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 30 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

    -
-

Minimum: 0

-

Maximum: 1024

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 5 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

certificate

-

CertificateInfo object

-

Specifies the certificate.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 CertificateInfo

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is unsupported. Please do not use it.

-

certificate

-

String

-

Specifies the private key of the certificate. The value must be PEM encoded.

-

description

-

String

-

Provides supplementary information about the certificate.

-

Minimum: 1

-

Maximum: 255

-

domain

-

String

-

Specifies the domain names used by the server certificate.

-

  • This parameter will take effect only when type is set to server, and its default value is "".

    -

  • This parameter will not take effect even if it is passed and type is set to client. However, domain names will still be verified.

    -
-

Note:

-

  • The value can contain 0 to 1024 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 30 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

    -
-

Minimum: 1

-

Maximum: 1024

-

id

-

String

-

Specifies a certificate ID.

-

name

-

String

-

Specifies the certificate name.

-

Minimum: 1

-

Maximum: 255

-

private_key

-

String

-

Specifies the private key of the server certificate. The value must be PEM encoded.

-

  • This parameter will be ignored if type is set to client. A CA server can still be created and used normally. This parameter will be left blank even if you enter a private key that is not PEM encoded.

    -

  • This parameter is valid and mandatory only when type is set to server. If you enter an invalid private key, an error is returned.

    -
-

type

-

String

-

Specifies the certificate type. The value can be server or client. server indicates server certificates, and client indicates CA certificates. The default value is server.

-

created_at

-

String

-

Specifies the time when the certificate was created.

-

updated_at

-

String

-

Specifies the time when the certificate was updated.

-

expire_time

-

String

-

Specifies the time when the certificate expires.

-

project_id

-

String

-

Specifies the project ID.

-
- - -

Example Requests

PUT
-https://{elb_endponit}/v3/{project_id}/elb/certificates/{certificate_id}
-
-{
-  "certificate" : {
-    "name" : "My Certificate",
-    "description" : "Update my Certificate."
-  }
-}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "certificate" : {
-    "private_key" : "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M\n253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPe\ntB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rM\nMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXt\nCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2Chl\nZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08k\nEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/Hl\nfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQB\nZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKr\nciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9M\nEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7Ale\nkrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CT\nXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kx\nGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dt\nJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLr\niWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZ\nlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBU\nxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB\n1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAd\nXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak\n/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4Vha\nfI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf\n7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9o\njHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIuk\nfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd\n3fy+1rCUwzOp9LSjtJYf4ege\n-----END PRIVATE KEY-----",
-    "description" : "Update my Certificate.",
-    "created_at" : "2019-03-31T22:23:51Z",
-    "expire_time" : "2045-11-17T13:25:47Z",
-    "id" : "233a325e5e3e4ce8beeb320aa714cc12",
-    "name" : "My Certificate",
-    "certificate" : "-----BEGIN CERTIFICATE-----\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD\nb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAG\nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\n0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5\nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh9\n7B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaS\nIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/K\ny09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0Wy\nYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29t\nhwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUA\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce+77s96i3I\n-----END CERTIFICATE-----",
-    "admin_state_up" : true,
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "updated_at" : "2019-03-31T23:26:49Z",
-    "type" : "server"
-  },
-  "request_id" : "d9abea6b-98ee-4ad4-8c5d-185ded48742f"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/UpdateHealthMonitor.html b/docs/elb/api-ref/UpdateHealthMonitor.html deleted file mode 100644 index b8187e81f..000000000 --- a/docs/elb/api-ref/UpdateHealthMonitor.html +++ /dev/null @@ -1,494 +0,0 @@ - - -

Updating a Health Check

-

Function

This API is used to update a health check.

- -

Constraints

The health check can be updated only when the provisioning status of the associated load balancer is ACTIVE.

- -

URI

PUT /v3/{project_id}/elb/healthmonitors/{healthmonitor_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

healthmonitor_id

-

Yes

-

String

-

Specifies the health check ID.

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

healthmonitor

-

Yes

-

UpdateHealthMonitorOption object

-

Specifies the health check.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 UpdateHealthMonitorOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the health check. Two value options are available. true indicates that the health check is enabled, and false indicates that the health check is disabled.

-

Default: true

-

delay

-

No

-

Integer

-

Specifies the interval between health checks, in seconds.

-

Minimum: 1

-

Maximum: 50

-

domain_name

-

No

-

String

-

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

-

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

-

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.

-

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

-

Minimum: 1

-

Maximum: 100

-

expected_codes

-

No

-

String

-

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

-

The value options are as follows:

-

  • A specific value, for example, 200

    -

  • A list of values that are separated with commas (,), for example, 200, 202

    -

  • A value range, for example, 200-204

    -
-

This parameter is unsupported. Please do not use it.

-

Default: 200

-

Minimum: 1

-

Maximum: 64

-

http_method

-

No

-

String

-

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 unsupported. Please do not use it.

-

Default: GET

-

Minimum: 1

-

Maximum: 16

-

max_retries

-

No

-

Integer

-

Specifies the maximum health check retries.

-

Minimum: 1

-

Maximum: 10

-

max_retries_down

-

No

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

-

Minimum: 1

-

Maximum: 10

-

monitor_port

-

No

-

Integer

-

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

-

Minimum: 1

-

Maximum: 65535

-

name

-

No

-

String

-

Specifies the health check name.

-

Minimum: 0

-

Maximum: 255

-

timeout

-

No

-

Integer

-

Specifies the maximum time required for waiting for a response from the health check, in seconds. It is recommended that you set the value less than that of parameter delay.

-

Minimum: 1

-

Maximum: 50

-

url_path

-

No

-

String

-

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /. This parameter is available only when type is set to HTTP.

-

Default: /

-

Minimum: 1

-

Maximum: 255

-

type

-

No

-

String

-

Specifies the protocol used for the health check.

-

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 5 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

healthmonitor

-

HealthMonitor object

-

Specifies the health check.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 HealthMonitor

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the health check. Two value options are available. true indicates that the health check is enabled, and false indicates that the health check is disabled.

-

Default: true

-

delay

-

Integer

-

Specifies the interval between health checks, in seconds.

-

Minimum: 1

-

Maximum: 50

-

domain_name

-

String

-

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

-

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

-

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.

-

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

-

expected_codes

-

String

-

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

-

The value options are as follows:

-

  • A specific value, for example, 200

    -

  • A list of values that are separated with commas (,), for example, 200, 202

    -

  • A value range, for example, 200-204

    -
-

This parameter is unsupported. Please do not use it.

-

Default: 200

-

http_method

-

String

-

Specifies the HTTP method. This parameter will take effect only when type is set to HTTP.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

-

This parameter is unsupported. Please do not use it.

-

Default: GET

-

id

-

String

-

Specifies the health check ID.

-

max_retries

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

Minimum: 1

-

Maximum: 10

-

max_retries_down

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

-

Minimum: 1

-

Maximum: 10

-

Default: 3

-

monitor_port

-

Integer

-

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

-

Minimum: 1

-

Maximum: 65535

-

name

-

String

-

Specifies the health check name.

-

pools

-

Array of PoolRef objects

-

Lists the IDs of backend server groups for which the health check is configured.

-

project_id

-

String

-

Specifies the project ID.

-

timeout

-

Integer

-

Specifies the maximum time required for waiting for a response from the health check, in seconds. It is recommended that you set the value less than that of parameter delay.

-

Minimum: 1

-

Maximum: 50

-

type

-

String

-

Specifies the health check protocol.

-

url_path

-

String

-

Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /. This parameter is available only when type is set to HTTP.

-

Default: /

-
- - - - - - - - - - - - -
Table 7 PoolRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-
- - -

Example Requests

PUT
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors/c2b210b2-60c4-449d-91e2-9e9ea1dd7441
-
-{
-  "healthmonitor" : {
-    "name" : "My Healthmonitor update",
-    "max_retries" : 10,
-    "delay" : 10
-  }
-}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "request_id" : "08d6ffea-d092-4cfa-860a-e364f3bef1be",
-  "healthmonitor" : {
-    "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "name" : "My Healthmonitor update",
-    "delay" : 10,
-    "max_retries" : 10,
-    "pools" : [ {
-      "id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0"
-    } ],
-    "admin_state_up" : true,
-    "timeout" : 30,
-    "type" : "HTTP",
-    "expected_codes" : "200",
-    "url_path" : "/",
-    "http_method" : "GET"
-  }
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/UpdateL7Policy.html b/docs/elb/api-ref/UpdateL7Policy.html deleted file mode 100644 index a44c63334..000000000 --- a/docs/elb/api-ref/UpdateL7Policy.html +++ /dev/null @@ -1,875 +0,0 @@ - - -

Updating a Forwarding Policy

-

Function

This API is used to update a forwarding policy.

- -

URI

PUT /v3/{project_id}/elb/l7policies/{l7policy_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy

-

Yes

-

UpdateL7PolicyOption object

-

Specifies request parameters for updating a forwarding policy.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 UpdateL7PolicyOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding policy. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

No

-

String

-

Provides supplementary information about the forwarding policy.

-

Minimum: 0

-

Maximum: 255

-

name

-

No

-

String

-

Specifies the forwarding policy name.

-

Minimum: 0

-

Maximum: 255

-

redirect_listener_id

-

No

-

String

-

Specifies the ID of the listener that requests are redirected to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_LISTENER.

-

Only HTTPS listeners are supported, and the listener cannot be any listener added to other load balancers.

-

redirect_pool_id

-

No

-

String

-

Specifies the ID of the backend server group that requests are forwarded to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_POOL.

-

The specified backend server group cannot be the default one associated with the listener, or any backend server group associated with the forwarding policies of other listeners.

-

This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.

-

redirect_url_config

-

No

-

UpdateRedirectUrlConfig object

-

Specifies the URL to which requests are forwarded.

-

For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

For dedicated load balancers, this parameter will take effect only when advanced forwarding is enabled (enhance_l7policy_enable is set to true). If it is passed when enhance_l7policy_enable is set to false, an error will be returned.

-

Format: protocol://host:port/path?query

-

At least one of the four parameters (protocol, host, port, and path) must be passed, or their values cannot be set to ${xxx} at the same time. (${xxx} indicates that the value in the request will be inherited. For example, ${host} indicates the host in the URL to be redirected.)

-

The values of protocol and port cannot be the same as those of the associated listener, and either host or path must be passed or their values cannot be ${xxx} at the same time.

-

This parameter is unsupported. Please do not use it.

-

fixed_response_config

-

No

-

UpdateFixtedResponseConfig object

-

Specifies the configuration of the page that will be returned. This parameter will take effect when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

This parameter is unsupported. Please do not use it.

-

rules

-

No

-

Array of UpdateL7RuleOption objects

-

Lists the forwarding rules in the forwarding policy.

-

The list can contain a maximum of 10 forwarding rules (if conditions is specified, a condition is considered as a rule).

-

If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

-

priority

-

No

-

Integer

-

Specifies the forwarding policy priority. This parameter is available only for dedicated load balancers and will take effect when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener.

-

If action is set to REDIRECT_TO_LISTENER, the value can only be 0, indicating that REDIRECT_TO_LISTENER has the highest priority.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 0

-

Maximum: 10000

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 UpdateRedirectUrlConfig

Parameter

-

Mandatory

-

Type

-

Description

-

protocol

-

No

-

String

-

Specifies the protocol for redirection. The default value is ${protocol}, indicating that the protocol of the request will be used.

-

Value options:

-

  • HTTP

    -

  • HTTPS

    -

  • ${protocol}

    -
-

Minimum: 1

-

Maximum: 36

-

host

-

No

-

String

-

Specifies the host name that requests are redirected to. The value can contain only letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. The default value is ${host}, indicating that the host of the request will be used.

-

Default: ${host}

-

Minimum: 1

-

Maximum: 128

-

port

-

No

-

String

-

Specifies the port that requests are redirected to. The default value is ${port}, indicating that the port of the request will be used.

-

Default: ${port}

-

Minimum: 1

-

Maximum: 16

-

path

-

No

-

String

-

Specifies the path that requests are redirected to. The default value is ${path}, indicating that the path of the request will be used.

-

The value can contain only letters, digits, and special characters _-';@^- %#&$.*+?,=!:|/()[]{} and must start with a slash (/).

-

Default: ${path}

-

Minimum: 1

-

Maximum: 128

-

query

-

No

-

String

-

Specifies the query string set in the URL for redirection. The default value is ${query}, indicating that the query string of the request will be used.

-

For example, in the URL https://www.xxx.com:8080/elb?type=loadbalancer, ${query} indicates type=loadbalancer. If this parameter is set to ${query}&name=my_name, the URL will be redirected to https://www.xxx.com:8080/elb?type=loadbalancer&name=my_name.

-

The value is case-sensitive and can contain only letters, digits, and special characters !$&'()*+,-./:;=?@^_`

-

Default: ${query}

-

Minimum: 0

-

Maximum: 128

-

status_code

-

No

-

String

-

Specifies the status code returned after the requests are redirected.

-

Value options:

-

  • 301

    -

  • 302

    -

  • 303

    -

  • 307

    -

  • 308

    -
-

Minimum: 1

-

Maximum: 16

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 UpdateFixtedResponseConfig

Parameter

-

Mandatory

-

Type

-

Description

-

status_code

-

No

-

String

-

Specifies the HTTP status code configured in the forwarding rule. The value can be any integer in the range of 200–299, 400–499, or 500–599.

-

Minimum: 1

-

Maximum: 16

-

content_type

-

No

-

String

-

Specifies the format of the response body.

-

Value options:

-

  • text/plain

    -

  • text/css

    -

  • text/html

    -

  • application/javascript

    -

  • application/json

    -
-

Minimum: 1

-

Maximum: 64

-

message_body

-

No

-

String

-

Specifies the content of the response body.

-

Minimum: 0

-

Maximum: 1024

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 UpdateL7RuleOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

compare_type

-

No

-

String

-

Specifies how requests are matched with the domain name or URL.

-

  • If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO.

    -

  • If type is set to PATH, this parameter can be set to REGEX, STARTS_WITH, or EQUAL_TO.

    -
-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but remains invalid.

-

key

-

No

-

String

-

Specifies the key of the match item. For example, if an HTTP header is used for matching, key is the name of the HTTP header parameter.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 255

-

value

-

No

-

String

-

Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name.

-

  • If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH and compare_type to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-

conditions

-

No

-

Array of UpdateRuleCondition objects

-

Specifies the matching conditions of the forwarding rule. This parameter will take effect when enhance_l7policy_enable is set to true.

-

If conditions is specified, the values of key and value are invalid, and its value contains all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique. Only full update is supported.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - -
Table 8 UpdateRuleCondition

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

No

-

String

-

Specifies the key of match item. This parameter is left blank.

-

Minimum: 1

-

Maximum: 128

-

value

-

No

-

String

-

Specifies the value of the match item.

-

  • If type is set to HOST_NAME, key is left blank, and value indicates the domain name, which can contain 1 to 128 characters, including letters, digits, hyphens (-), periods (.), and asterisks (), and must start with a letter, digit, or asterisk (). If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH, key is left blank, and value indicates the request path, which can contain 1 to 128 characters. If compare_type is set to STARTS_WITH or EQUAL_TO for the forwarding rule, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 9 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

l7policy

-

L7Policy object

-

Specifies the forwarding policy.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 L7Policy

Parameter

-

Type

-

Description

-

action

-

String

-

Specifies where requests will be forwarded. The value can be one of the following:

-

  • REDIRECT_TO_POOL: Requests will be forwarded to another backend server group.

    -

  • REDIRECT_TO_LISTENER: Requests will be redirected to an HTTPS listener.

    -
-

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.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding policy. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

String

-

Provides supplementary information about the forwarding policy.

-

id

-

String

-

Specifies the forwarding policy ID.

-

listener_id

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

  • If action is set to REDIRECT_TO_POOL, the forwarding policy can be added to an HTTP or HTTPS listener.

    -

  • If action is set to REDIRECT_TO_LISTENER, the forwarding policy can be added to an HTTP listener.

    -
-

name

-

String

-

Specifies the forwarding policy name.

-

Minimum: 1

-

Maximum: 255

-

position

-

Integer

-

Specifies the forwarding policy priority. This parameter cannot be updated.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 100

-

project_id

-

String

-

Specifies the project ID of the forwarding policy.

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding policy.

-

The value can only be ACTIVE.

-

Default: ACTIVE

-

redirect_listener_id

-

String

-

Specifies the ID of the listener that requests are redirected to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_LISTENER.

-

Only HTTPS listeners are supported, and the listener cannot be any listener added to other load balancers.

-

redirect_pool_id

-

String

-

Specifies the ID of the backend server group that requests are forwarded to.

-

This parameter is valid and mandatory only when action is set to REDIRECT_TO_POOL.

-

The specified backend server group cannot be the default one associated with the listener, or any backend server group associated with the forwarding policies of other listeners.

-

This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.

-

redirect_url

-

String

-

Specifies the URL to which requests are forwarded.

-

Format: protocol://host:port/path?query

-

This parameter is unsupported. Please do not use it.

-

rules

-

Array of RuleRef objects

-

Lists the forwarding rules in the forwarding policy.

-

redirect_url_config

-

RedirectUrlConfig object

-

Specifies the URL to which requests are forwarded.

-

For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

For dedicated load balancers, this parameter will take effect only when advanced forwarding is enabled (enhance_l7policy_enable is set to true). If it is passed when enhance_l7policy_enable is set to false, an error will be returned.

-

Format: protocol://host:port/path?query

-

At least one of the four parameters (protocol, host, port, and path) must be passed, or their values cannot be set to ${xxx} at the same time. (${xxx} indicates that the value in the request will be inherited. For example, ${host} indicates the host in the URL to be redirected.)

-

The values of protocol and port cannot be the same as those of the associated listener, and either host or path must be passed or their values cannot be ${xxx} at the same time.

-

This parameter is unsupported. Please do not use it.

-

fixed_response_config

-

FixtedResponseConfig object

-

Specifies the configuration of the page that will be returned. This parameter will take effect when enhance_l7policy_enable is set to true. If this parameter is passed and enhance_l7policy_enable is set to false, an error will be returned. For shared load balancers, this parameter is not supported. If it is passed, an error will be returned.

-

This parameter is unsupported. Please do not use it.

-

priority

-

Integer

-

Specifies the forwarding policy priority. This parameter is available only for dedicated load balancers and will take effect when enhance_l7policy_enable is set to true.

-

A smaller value indicates a higher priority. The value must be unique for each forwarding policy of the same listener.

-

If action is set to REDIRECT_TO_LISTENER, the value can only be 0, indicating that REDIRECT_TO_LISTENER has the highest priority.

-

  • If enhance_l7policy_enable is set to false, forwarding policies are automatically prioritized based on the original sorting logic. Forwarding policy priorities are independent of each other regardless of domain names. If forwarding policies use the same domain name, their priorities follow the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If prefix match is used for matching, the longer the path, the higher the priority. If a forwarding policy contains only a domain name without a path specified, the path is /, and prefix match is used by default.

    -

  • If enhance_l7policy_enable is set to true and this parameter is not passed, the priority will set to a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. There will be two cases: a) If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to create because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, please specify a value or adjust the priorities of existing forwarding policies. b) If no forwarding policies exist, the highest priority of existing forwarding policies will set to 1 by default.

    -
-

This parameter is unsupported. Please do not use it.

-

Minimum: 0

-

Maximum: 10000

-
- - - - - - - - - - - - -
Table 11 RuleRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding rule ID.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 RedirectUrlConfig

Parameter

-

Type

-

Description

-

protocol

-

String

-

Specifies the protocol for redirection. The default value is ${protocol}, indicating that the protocol of the request will be used.

-

Value options:

-

  • HTTP

    -

  • HTTPS

    -

  • ${protocol}

    -
-

Minimum: 1

-

Maximum: 36

-

host

-

String

-

Specifies the host name that requests are redirected to. The value can contain only letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. The default value is ${host}, indicating that the host of the request will be used.

-

Default: ${host}

-

Minimum: 1

-

Maximum: 128

-

port

-

String

-

Specifies the port that requests are redirected to. The default value is ${port}, indicating that the port of the request will be used.

-

Default: ${port}

-

Minimum: 1

-

Maximum: 16

-

path

-

String

-

Specifies the path that requests are redirected to. The default value is ${path}, indicating that the path of the request will be used. The value can contain only letters, digits, and special characters _-';@^- %#&$.*+?,=!:|/()[]{} and must start with a slash (/).

-

Default: ${path}

-

Minimum: 1

-

Maximum: 128

-

query

-

String

-

Specifies the query string set in the URL for redirection. The default value is ${query}, indicating that the query string of the request will be used.

-

For example, in the URL https://www.xxx.com:8080/elb?type=loadbalancer, ${query} indicates type=loadbalancer. If this parameter is set to ${query}&name=my_name, the URL will be redirected to https://www.xxx.com:8080/elb?type=loadbalancer&name=my_name.

-

The value is case-sensitive and can contain only letters, digits, and special characters !$&'()*+,-./:;=?@^_`

-

Default: ${query}

-

Minimum: 0

-

Maximum: 128

-

status_code

-

String

-

Specifies the status code returned after the requests are redirected.

-

Value options:

-

  • 301

    -

  • 302

    -

  • 303

    -

  • 307

    -

  • 308

    -
-

Minimum: 1

-

Maximum: 16

-
- - - - - - - - - - - - - - - - - - - - -
Table 13 FixtedResponseConfig

Parameter

-

Type

-

Description

-

status_code

-

String

-

Specifies the HTTP status code configured in the forwarding policy. The value can be any integer in the range of 200–299, 400–499, or 500–599.

-

Minimum: 1

-

Maximum: 16

-

content_type

-

String

-

Specifies the format of the response body.

-

Value options:

-

  • text/plain

    -

  • text/css

    -

  • text/html

    -

  • application/javascript

    -

  • application/json

    -
-

Minimum: 0

-

Maximum: 32

-

message_body

-

String

-

Specifies the content of the response body.

-

Minimum: 0

-

Maximum: 1024

-
- - -

Example Requests

PUT
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be
-
-{
-  "l7policy" : {
-    "name" : "My policy.",
-    "description" : "Update policy.",
-    "redirect_listener_id" : "48a97732-449e-4aab-b561-828d29e45050"
-  }
-}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "request_id" : "e5c07525-1470-47b6-9b0c-567527a036aa",
-  "l7policy" : {
-    "description" : "Update policy.",
-    "admin_state_up" : true,
-    "rules" : [ ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "listener_id" : "e2220d2a-3faf-44f3-8cd6-0c42952bd0ab",
-    "redirect_listener_id" : "48a97732-449e-4aab-b561-828d29e45050",
-    "action" : "REDIRECT_TO_LISTENER",
-    "position" : 100,
-    "provisioning_status" : "ACTIVE",
-    "id" : "cf4360fd-8631-41ff-a6f5-b72c35da74be",
-    "name" : "My policy."
-  }
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/UpdateL7Rule.html b/docs/elb/api-ref/UpdateL7Rule.html deleted file mode 100644 index f07947e6f..000000000 --- a/docs/elb/api-ref/UpdateL7Rule.html +++ /dev/null @@ -1,433 +0,0 @@ - - -

Updating a Forwarding Rule

-

Function

This API is used to update a forwarding rule.

- -

URI

PUT /v3/{project_id}/elb/l7policies/{l7policy_id}/rules/{l7rule_id}

- - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-

l7rule_id

-

Yes

-

String

-

Specifies the forwarding rule ID.

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

rule

-

Yes

-

UpdateL7RuleOption object

-

Specifies request parameters for updating a forwarding rule.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 UpdateL7RuleOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

compare_type

-

No

-

String

-

Specifies how requests are matched with the domain name or URL.

-

  • If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO.

    -

  • If type is set to PATH, this parameter can be set to REGEX, STARTS_WITH, or EQUAL_TO.

    -
-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but remains invalid.

-

key

-

No

-

String

-

Specifies the key of the match item. For example, if an HTTP header is used for matching, key is the name of the HTTP header parameter.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 255

-

value

-

No

-

String

-

Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name.

-

  • If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH and compare_type to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-

conditions

-

No

-

Array of UpdateRuleCondition objects

-

Specifies the matching conditions of the forwarding rule. This parameter will take effect when enhance_l7policy_enable is set to true.

-

If conditions is specified, the values of key and value are invalid, and its value contains all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique. Only full update is supported.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - -
Table 5 UpdateRuleCondition

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

No

-

String

-

Specifies the key of match item. This parameter is left blank.

-

Minimum: 1

-

Maximum: 128

-

value

-

No

-

String

-

Specifies the value of the match item.

-

  • If type is set to HOST_NAME, key is left blank, and value indicates the domain name, which can contain 1 to 128 characters, including letters, digits, hyphens (-), periods (.), and asterisks (), and must start with a letter, digit, or asterisk (). If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH, key is left blank, and value indicates the request path, which can contain 1 to 128 characters. If compare_type is set to STARTS_WITH or EQUAL_TO for the forwarding rule, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 6 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

rule

-

L7Rule object

-

Specifies the forwarding rule.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 L7Rule

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding rule. The default value is true.

-

This parameter is unsupported. Please do not use it.

-

compare_type

-

String

-

Specifies how requests are matched with the domain name or URL.

-

  • If type is set to HOST_NAME, this parameter can only be set to EQUAL_TO.

    -

  • If type is set to PATH, this parameter can be set to REGEX, STARTS_WITH, or EQUAL_TO.

    -
-

key

-

String

-

Specifies the key of the match content. This parameter will not take effect when type is set to HOST_NAME or PATH. It can be updated but will not take effect.

-

This parameter is unsupported. Please do not use it.

-

Minimum: 1

-

Maximum: 255

-

project_id

-

String

-

Specifies the project ID.

-

type

-

String

-

Specifies the match content. The value can be one of the following:

-

  • HOST_NAME: A domain name will be used for matching.

    -

  • PATH: A URL will be used for matching.

    -
-

If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

-

value

-

String

-

Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name.

-

  • If type is set to HOST_NAME, the value can contain letters, digits, hyphens (-), and periods (.) and must start with a letter or digit. If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH and compare_type to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-

provisioning_status

-

String

-

Specifies the provisioning status of the forwarding rule.

-

The value can only be ACTIVE.

-

invert

-

Boolean

-

Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but remains invalid.

-

Default: false

-

id

-

String

-

Specifies the forwarding policy ID.

-

conditions

-

Array of RuleCondition objects

-

Specifies the matching conditions of the forwarding rule.

-

  • If conditions is specified, key and value will not take effect, and the value of this parameter will contain all conditions configured for the forwarding rule. The keys in the list must be the same, whereas each value must be unique.

    -

  • If conditions is not specified, the values of key and value are displayed.

    -
-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - -
Table 8 RuleCondition

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the key of match item. This parameter is left blank.

-

Minimum: 1

-

Maximum: 128

-

value

-

String

-

Specifies the value of the match item.

-

  • If type is set to HOST_NAME, key is left blank, and value indicates the domain name, which can contain 1 to 128 characters, including letters, digits, hyphens (-), periods (.), and asterisks (), and must start with a letter, digit, or asterisk (). If you want to use a wildcard domain name, enter an asterisk (*) as the leftmost label of the domain name.

    -

  • If type is set to PATH, key is left blank, and value indicates the request path, which can contain 1 to 128 characters. If compare_type is set to STARTS_WITH or EQUAL_TO for the forwarding rule, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|/()[]{}

    -
-

Minimum: 1

-

Maximum: 128

-
- - -

Example Requests

PUT
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules/84f4fcae-9c15-4e19-a99f-72c0b08fd3d7
-
-{
-  "rule" : {
-    "compare_type" : "STARTS_WITH",
-    "value" : "/ccc.html"
-  }
-}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "rule" : {
-    "compare_type" : "STARTS_WITH",
-    "provisioning_status" : "ACTIVE",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "invert" : false,
-    "admin_state_up" : true,
-    "value" : "/ccc.html",
-    "type" : "PATH",
-    "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7"
-  },
-  "request_id" : "133096f9-e754-430d-a2c2-e61fe1190aa8"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/UpdateListener.html b/docs/elb/api-ref/UpdateListener.html deleted file mode 100644 index 71f1b0e6d..000000000 --- a/docs/elb/api-ref/UpdateListener.html +++ /dev/null @@ -1,863 +0,0 @@ - - -

Updating a Listener

-

Function

This API is used to update a listener.

- -

Constraints

If the provisioning status of the load balancer that the listener is added to is not ACTIVE, the listener cannot be updated. Only the administrator can specify connection_limit.

- -

URI

PUT /v3/{project_id}/elb/listeners/{listener_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-

project_id

-

Yes

-

String

-

Specifies the tenant ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

listener

-

Yes

-

UpdateListenerOption object

-

Specifies the listener.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 UpdateListenerOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the listener. And the value can only be true.

-

This parameter is unsupported. Please do not use it.

-

client_ca_tls_container_ref

-

No

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

default_pool_id

-

No

-

String

-

Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server.

-

Minimum: 1

-

Maximum: 36

-

default_tls_container_ref

-

No

-

String

-

Specifies the ID of the server certificate used by the listener.

-

description

-

No

-

String

-

Provides supplementary information about the listener.

-

Minimum: 1

-

Maximum: 255

-

http2_enable

-

No

-

Boolean

-

Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect.

-

Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.

-

Default: true

-

insert_headers

-

No

-

ListenerInsertHeaders object

-

Specifies the HTTP header fields.

-

name

-

No

-

String

-

Specifies the listener name.

-

Minimum: 1

-

Maximum: 255

-

sni_container_refs

-

No

-

Array of strings

-

Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

-

Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.

-

This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.

-

tls_ciphers_policy

-

No

-

String

-

Specifies the security policy used by the listener.

-

This parameter is available only for HTTPS listeners. The default value is tls-1-0.

-

An error will be returned if the protocol of the listener is not HTTPS.

-

Value options:

-

  • tls-1-0

    -

  • tls-1-1

    -

  • tls-1-2

    -

  • tls-1-2-strict

    -
-

enable_member_retry

-

No

-

Boolean

-

Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners of Shared load balancers.

-

Default: false

-

member_timeout

-

No

-

Integer

-

Specifies the timeout duration for waiting for a request from a backend server, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

client_timeout

-

No

-

Integer

-

Specifies the timeout duration for waiting for a request from a client, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

keepalive_timeout

-

No

-

Integer

-

Specifies the idle timeout duration, in seconds.

-

  • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.

    -

  • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.

    -

  • For UDP listeners, this parameter is invalid.

    -
-

ipgroup

-

No

-

UpdateListenerIpGroupOption object

-

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.

-

This parameter is unsupported. Please do not use it.

-

transparent_client_ip_enable

-

No

-

Boolean

-

Specifies whether to pass source IP addresses of the clients to backend servers.

-

Shared load balancers: The value can be true or false, and the default value is false for TCP and UDP listeners. The value can only be true for HTTP and HTTPS listeners. If this parameter is not passed, the default value is true.

-

Dedicated load balancers: The value can only be true for all types of listeners. If this parameter is not passed, the default value is true.

-

enhance_l7policy_enable

-

No

-

Boolean

-

Specifies whether to enable advanced forwarding. The value can be true or false (default).

-

  • true indicates that advanced forwarding will be enabled. Advanced forwarding cannot be disabled once it is enabled.

    -

  • false indicates that advanced forwarding will not be enabled.

    -
-

The following parameters will be available only when advanced forwarding is enabled:

-

  • redirect_url_config

    -

  • fixed_response_config

    -

  • priority

    -

  • conditions

    -
-

For details, see the descriptions in the APIs of forwarding policies and forwarding rules.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 ListenerInsertHeaders

Parameter

-

Mandatory

-

Type

-

Description

-

X-Forwarded-ELB-IP

-

No

-

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

-

X-Forwarded-Port

-

No

-

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

-

X-Forwarded-For-Port

-

No

-

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

-

X-Forwarded-Host

-

Yes

-

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

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 UpdateListenerIpGroupOption

Parameter

-

Mandatory

-

Type

-

Description

-

ipgroup_id

-

No

-

String

-

Specifies the ID of the IP address group associated with the listener.

-

  • If ip_list is set to [] and type to whitelist, no IP addresses are allowed to access the listener.

    -

  • If ip_list is set to [] and type to blacklist, any IP address is allowed to access the listener.

    -

  • The specified IP address group must exist and this parameter cannot be set to null.

    -
-

IP address groups are not supported for now.

-

enable_ipgroup

-

No

-

Boolean

-

Specifies whether access control is enabled.

-

  • true: Access control is enabled.

    -

  • false: Access control is disabled.

    -
-

A listener with access control enabled can be directly deleted.

-

type

-

No

-

String

-

Specifies how access to the listener is controlled.

-

  • white: A whitelist is configured. Only IP addresses in the whitelist can access the listener.

    -

  • black: A blacklist is configured. IP addresses in the blacklist are not allowed to access the listener.

    -
-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 7 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

listener

-

Listener object

-

Specifies the listener.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 Listener

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the listener. And the value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

client_ca_tls_container_ref

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

connection_limit

-

Integer

-

Specifies the maximum number of connections. The default value is -1.

-

This parameter is unsupported. Please do not use it.

-

created_at

-

String

-

Specifies the time when the listener was created.

-

default_pool_id

-

String

-

Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server.

-

default_tls_container_ref

-

String

-

Specifies the ID of the server certificate used by the listener.

-

description

-

String

-

Provides supplementary information about the listener.

-

http2_enable

-

Boolean

-

Specifies whether to use HTTP/2. This parameter is available only for HTTPS listeners. If you configure this parameter for other types of listeners, it will not take effect.

-

Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default.

-

Default: true

-

id

-

String

-

Specifies the listener ID.

-

insert_headers

-

ListenerInsertHeaders object

-

Specifies the HTTP header fields.

-

loadbalancers

-

Array of LoadBalancerRef objects

-

Specifies the ID of the load balancer that the listener is added to.

-

name

-

String

-

Specifies the listener name.

-

project_id

-

String

-

Specifies the ID of the project where the listener is used.

-

protocol

-

String

-

Specifies the protocol used by the listener.

-

protocol_port

-

Integer

-

Specifies the port used by the listener.

-

Minimum: 1

-

Maximum: 65535

-

sni_container_refs

-

Array of strings

-

Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

-

Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.

-

This parameter will be ignored and an empty array will be returned if the listener's protocol is not HTTPS.

-

tags

-

Array of Tag objects

-

Lists the tags.

-

updated_at

-

String

-

Specifies the time when the listener was updated.

-

tls_ciphers_policy

-

String

-

Specifies the security policy used by the listener. This parameter is available only for HTTPS listeners.

-

The value can be tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0.

-

enable_member_retry

-

Boolean

-

Specifies whether to enable health check retries for backend servers. This parameter is available only for HTTP and HTTPS listeners.

-

keepalive_timeout

-

Integer

-

Specifies the idle timeout duration, in seconds.

-

  • For TCP listeners, the value ranges from 10 to 4000, and the default value is 300.

    -

  • For HTTP and HTTPS listeners, the value ranges from 0 to 4000, and the default value is 60.

    -

  • For UDP listeners, this parameter does not take effect.

    -
-

client_timeout

-

Integer

-

Specifies the timeout duration for waiting for a request from a client, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

member_timeout

-

Integer

-

Specifies the timeout duration for waiting for a request from a backend server, in seconds.

-

This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60.

-

ipgroup

-

ListenerIpGroup object

-

Specifies the IP address group associated with the listener.

-

This parameter is unsupported. Please do not use it.

-

transparent_client_ip_enable

-

Boolean

-

Specifies whether to pass source IP addresses of the clients to backend servers.

-

Shared load balancers: The value can be true or false, and the default value is false for TCP and UDP listeners. The value can only be true for HTTP and HTTPS listeners. If this parameter is not passed, the default value is true.

-

Dedicated load balancers: The value can only be true for all types of listeners. If this parameter is not passed, the default value is true.

-

enhance_l7policy_enable

-

Boolean

-

Specifies whether to enable advanced forwarding. The value can be true or false (default).

-

  • true indicates that advanced forwarding will be enabled.

    -

  • false indicates that advanced forwarding will not be enabled.

    -
-

The following parameters will be available only when advanced forwarding is enabled:

-

  • redirect_url_config

    -

  • fixed_response_config

    -

  • priority

    -

  • conditions

    -
-

For details, see the descriptions in the APIs of forwarding policies and forwarding rules.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 ListenerInsertHeaders

Parameter

-

Type

-

Description

-

X-Forwarded-ELB-IP

-

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

-

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

-

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

-

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

-
- - - - - - - - - - - - -
Table 10 LoadBalancerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-
- - - - - - - - - - - - - - - - -
Table 11 Tag

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

-

value

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - - - - - - - -
Table 12 ListenerIpGroup

Parameter

-

Type

-

Description

-

ipgroup_id

-

String

-

Specifies the ID of the IP address group associated with the listener.

-

  • If ip_list is set to [] and type to whitelist, no IP addresses are allowed to access the listener.

    -

  • If ip_list is set to [] and type to blacklist, any IP address is allowed to access the listener.

    -

  • The specified IP address group must exist and this parameter cannot be set to null.

    -
-

enable_ipgroup

-

Boolean

-

Specifies whether to enable access control.

-

  • true: Access control is enabled.

    -

  • false: Access control is disabled.

    -
-

A listener with access control enabled can be directly deleted.

-

type

-

String

-

Specifies how access to the listener is controlled.

-

  • white: A whitelist is configured. Only IP addresses in the whitelist can access the listener.

    -

  • black: A blacklist is configured. IP addresses in the blacklist are not allowed to access the listener.

    -
-
- - -

Example Requests

PUT
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners/0b11747a-b139-492f-9692-2df0b1c87193
-
-{
-  "listener" : {
-    "description" : "My listener update.",
-    "name" : "listener-1",
-    "http2_enable" : true
-  }
-}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "listener" : {
-    "id" : "e2baad06-8095-4159-a14e-d1f0137bac06",
-    "name" : "listener-1",
-    "protocol_port" : 77,
-    "protocol" : "HTTP",
-    "description" : "My listener update.",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "c285bc7b-56d5-43bd-9589-075ee0a5c777"
-    } ],
-    "project_id" : "060576782980d5762f9ec014dd2f1148",
-    "sni_container_refs" : [ ],
-    "connection_limit" : -1,
-    "default_pool_id" : "61609d20-5230-4b72-8274-46212bbf317c",
-    "tags" : [ ],
-    "created_at" : "2020-07-28T11:35:21Z",
-    "updated_at" : "2020-07-28T11:35:21Z",
-    "http2_enable" : true,
-    "insert_headers" : {
-      "X-Forwarded-ELB-IP" : false,
-      "X-Forwarded-Host" : true,
-      "X-Forwarded-For-Port" : false,
-      "X-Forwarded-Port" : false
-    },
-    "member_timeout" : 60,
-    "client_timeout" : 60,
-    "keepalive_timeout" : 60,
-    "enable_member_retry" : true,
-    "transparent_client_ip_enable" : true,
-    "enhance_l7policy_enable" : false
-  },
-  "request_id" : "619dc40f7ec73c0f13b5b5127904b71e"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/UpdateLoadBalancer.html b/docs/elb/api-ref/UpdateLoadBalancer.html deleted file mode 100644 index cc6595e2b..000000000 --- a/docs/elb/api-ref/UpdateLoadBalancer.html +++ /dev/null @@ -1,784 +0,0 @@ - - -

Updating a Load Balancer

-

Function

This API is used to update a load balancer.

- -

URI

PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

loadbalancer

-

Yes

-

UpdateLoadBalancerOption object

-

Specifies the load balancer.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 UpdateLoadBalancerOption

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the load balancer name.

-

Minimum: 0

-

Maximum: 255

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the load balancer. And the value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

No

-

String

-

Provides supplementary information about the load balancer.

-

Minimum: 0

-

Maximum: 255

-

ipv6_vip_virsubnet_id

-

No

-

String

-

Specifies the ID of the IPv6 subnet where the load balancer works. You can query id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

-

The IPv6 subnet can be updated using ipv6_vip_virsubnet_id, and the private IPv6 address of the load balancer will be changed accordingly.

-

The IPv6 subnet must be in the VPC specified by vpc_id.

-

Note:

-
  • ipv6_vip_virsubnet_id can be updated only when guaranteed is set to true.
  • Enter null if the IPv6 address is unbound from the load balancer.
-

This parameter is unsupported. Please do not use it.

-

vip_subnet_cidr_id

-

No

-

String

-

Specifies the ID of the IPv4 subnet where the load balancer works. You can query neutron_subnet_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

-
  • The IPv4 subnet can be updated using vip_subnet_cidr_id, and the private IPv4 address of the load balancer will be changed accordingly.
  • If vip_address is also specified, the IP address specified by it must be in the subnet specified by vip_subnet_cidr_id and will be used as the private IPv4 address of the load balancer.
  • The IPv4 subnet must be in the VPC specified by vpc_id.
-

Note:

-
  • vip_subnet_cidr_id can be updated only when guaranteed is set to true.
  • Enter null if the private IPv4 address is unbound from the load balancer.
-

Minimum: 1

-

Maximum: 36

-

vip_address

-

No

-

String

-

Specifies the virtual IP address bound to the load balancer. The IP address must be from the IPv4 subnet of the VPC where the load balancer works and IP address should not be occupied by other services.

-

The IP address specified by this parameter must be in the subnet specified by vip_subnet_cidr_id and will be used as the private IPv4 address of the load balancer.

-

vip_address can be updated only when guaranteed is set to true.

-

Minimum: 1

-

Maximum: 36

-

l4_flavor_id

-

No

-

String

-

Specifies the ID of the Layer-4 flavor.

-

Note:

-
  • This parameter can be updated only when guaranteed is set to true.
  • The value cannot be changed from null to a specific value, or the other way around. If you need to change the flavor, you must select a larger one.
-

Minimum: 1

-

Maximum: 255

-

l7_flavor_id

-

No

-

String

-

Specifies the ID of the Layer-7 flavor.

-

Note:

-
  • This parameter can be updated only when guaranteed is set to true.
  • The value cannot be changed from null to a specific value, or the other way around. If you need to change the flavor, you must select a larger one.
-

ipv6_bandwidth

-

No

-

BandwidthRef object

-

Specifies the ID of the bandwidth. This parameter is available only when you create or update a dedicated load balancer that has an IPv6 address bound.

-

If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

-

This parameter is unsupported. Please do not use it.

-

ip_target_enable

-

No

-

Boolean

-

Specifies whether to enable cross-VPC backend. The value can only be true.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - -
Table 5 BandwidthRef

Parameter

-

Mandatory

-

Type

-

Description

-

id

-

Yes

-

String

-

Specifies the shared bandwidth ID.

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 6 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

loadbalancer

-

LoadBalancer object

-

Specifies the load balancer.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 LoadBalancer

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-

Default: Automatically generated

-

description

-

String

-

Provides supplementary information about the load balancer.

-

Minimum: 1

-

Maximum: 255

-

provisioning_status

-

String

-

Specifies the provisioning status of the load balancer. The value can only be ACTIVE.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the load balancer. The value can only be true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

provider

-

String

-

Specifies the provider of the load balancer. The value can only be vlb.

-

Default: vlb

-

pools

-

Array of PoolRef objects

-

Lists the IDs of backend server groups associated with the load balancer.

-

listeners

-

Array of ListenerRef objects

-

Lists the IDs of listeners added to the load balancer.

-

operating_status

-

String

-

Specifies the operating status of the load balancer. The value can only be ONLINE.

-

Minimum: 1

-

Maximum: 16

-

vip_address

-

String

-

Specifies the private IPv4 address bound to the load balancer.

-

Minimum: 1

-

Maximum: 64

-

vip_subnet_cidr_id

-

String

-

Specifies the ID of the IPv4 subnet where the load balancer works.

-

Minimum: 1

-

Maximum: 36

-

name

-

String

-

Specifies the name of the load balancer.

-

Minimum: 1

-

Maximum: 255

-

project_id

-

String

-

Specifies the project ID of the load balancer.

-

Minimum: 1

-

Maximum: 32

-

vip_port_id

-

String

-

Specifies the ID of the port bound to the virtual IP address (the value of vip_address) of the load balancer.

-

When you create a dedicated load balancer, the system automatically creates a port for the load balancer and associates the port with a default security group. However, security group rules containing the port will not affect traffic to and from the load balancer.

-

tags

-

Array of Tag objects

-

Lists the tags added to the load balancer.

-

created_at

-

String

-

Specifies the time when the load balancer was created.

-

Minimum: 1

-

Maximum: 20

-

updated_at

-

String

-

Specifies the time when the load balancer was updated.

-

Minimum: 1

-

Maximum: 20

-

guaranteed

-

Boolean

-

Specifies whether the load balancer is a dedicated load balancer.

-

The value can be true or false. true indicates a dedicated load balancer, and false indicates a shared load balancer. When dedicated load balancers are launched in the eu-de region, either true or false will be returned when you use the API to query or update a load balancer.

-

Default: true

-

vpc_id

-

String

-

Specifies the ID of the VPC where the load balancer works.

-

eips

-

Array of EipInfo objects

-

Specifies the EIP bound to the load balancer.

-

ipv6_vip_address

-

String

-

Specifies the IPv6 address bound to the load balancer.

-

This parameter is unsupported. Please do not use it.

-

Default: None

-

Minimum: 1

-

Maximum: 64

-

ipv6_vip_virsubnet_id

-

String

-

Specifies the ID of the IPv6 subnet where the load balancer works.

-

This parameter is unsupported. Please do not use it.

-

ipv6_vip_port_id

-

String

-

Specifies the ID of the port bound to the IPv6 address.

-

This parameter is unsupported. Please do not use it.

-

availability_zone_list

-

Array of strings

-

Specifies the list of AZs where the load balancer is created.

-

enterprise_project_id

-

String

-

Specifies the enterprise project ID.

-

If this parameter is not passed during resource creation, the resource belongs to the default enterprise project.

-

This parameter is unsupported. Please do not use it.

-

Default: 0

-

l4_flavor_id

-

String

-

Specifies the Layer-4 flavor.

-

Minimum: 1

-

Maximum: 255

-

l4_scale_flavor_id

-

String

-

Specifies the reserved Layer 4 flavor.

-

Minimum: 1

-

Maximum: 255

-

l7_flavor_id

-

String

-

Specifies the Layer-7 flavor.

-

Minimum: 1

-

Maximum: 255

-

l7_scale_flavor_id

-

String

-

Specifies the reserved Layer 7 flavor.

-

Minimum: 1

-

Maximum: 255

-

publicips

-

Array of PublicIpInfo objects

-

Specifies the EIP bound to the load balancer.

-

elb_virsubnet_ids

-

Array of strings

-

Specifies the ID of the subnet on the downstream plane. The ports used by the load balancer dynamically occupy IP addresses in the subnet.

-

ip_target_enable

-

Boolean

-

Specifies whether to enable cross-VPC backend.

-

This parameter is unsupported. Please do not use it.

-

Default: false

-

frozen_scene

-

String

-

Specifies the scenario where the load balancer is frozen. Use commas to separate multiple scenarios.

-

If the value is ARREAR, the load balancer is frozen because your account is in arrears.

-

ipv6_bandwidth

-

BandwidthRef object

-

Specifies the ID of the bandwidth. This parameter is available only when you create or update a dedicated load balancer that has an IPv6 address bound.

-

If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - -
Table 8 PoolRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-
- - - - - - - - - - - - -
Table 9 ListenerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-
- - - - - - - - - - - - - - - - -
Table 10 Tag

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

-

value

-

String

-

Specifies the tag value.

-
- - - - - - - - - - - - - - - - - - - - -
Table 11 EipInfo

Parameter

-

Type

-

Description

-

eip_id

-

String

-

Specifies the EIP ID.

-

eip_address

-

String

-

Specifies the specific IP address.

-

ip_version

-

Integer

-

Specifies the IP version. 4 indicates IPv4, and 6 indicates IPv6.

-

IPv6 is unsupported. The value cannot be 6.

-
- - - - - - - - - - - - - - - - - - - - -
Table 12 PublicIpInfo

Parameter

-

Type

-

Description

-

publicip_id

-

String

-

Specifies the EIP ID.

-

publicip_address

-

String

-

Specifies the IP address.

-

ip_version

-

Integer

-

Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6).

-

IPv6 is unsupported. The value cannot be 6.

-
- - - - - - - - - - - - -
Table 13 BandwidthRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the shared bandwidth ID.

-
- - -

Example Requests

PUT
-
-https://{elb_endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
-
-{
-  "loadbalancer" : {
-    "admin_state_up" : true,
-    "description" : "loadbalancer",
-    "name" : "loadbalancer-update"
-  }
-}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "request_id" : "010dad1e-32a3-4405-ab83-62a1fc5f8722",
-  "loadbalancer" : {
-    "id" : "2e073bf8-edfe-4e51-a699-d915b0b8af89",
-    "project_id" : "b2782e6708b8475c993e6064bc456bf8",
-    "name" : "loadbalancer-update",
-    "description" : "loadbalancer",
-    "admin_state_up" : true,
-    "provisioning_status" : "ACTIVE",
-    "operating_status" : "ONLINE",
-    "listeners" : [ {
-      "id" : "41937176-bf64-4b58-8e0d-9ff2d0d32c54"
-    }, {
-      "id" : "abc6ac93-ad0e-4765-bd5a-eec632efde56"
-    }, {
-      "id" : "b9d8ba97-6d60-467d-838d-f3550b54c22a"
-    }, {
-      "id" : "fd797ebd-263d-4b18-96e9-e9188d36c69e"
-    } ],
-    "pools" : [ {
-      "id" : "0aabcaa8-c35c-4ddc-a60c-9032d0ac0b80"
-    }, {
-      "id" : "165d9092-396e-4a8d-b398-067496a447d2"
-    } ],
-    "tags" : [ ],
-    "provider" : "vlb",
-    "created_at" : "2019-04-20T03:10:37Z",
-    "updated_at" : "2019-05-24T02:11:58Z",
-    "vpc_id" : "2037c5bb-e04b-4de2-9300-9051af18e417",
-    "enterprise_project_id" : "0",
-    "availability_zone_list" : [ "AZ1", "AZ2", "dc3" ],
-    "eips" : [ ],
-    "guaranteed" : true
-  }
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/UpdateMember.html b/docs/elb/api-ref/UpdateMember.html deleted file mode 100644 index 51efde274..000000000 --- a/docs/elb/api-ref/UpdateMember.html +++ /dev/null @@ -1,324 +0,0 @@ - - -

Updating a Backend Server

-

Function

The backend server can be updated only when the provisioning status of the associated load balancer is ACTIVE.

- -

URI

PUT /v3/{project_id}/elb/pools/{pool_id}/members/{member_id}

- - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

member_id

-

Yes

-

String

-

Specifies the backend server ID.

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

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

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

Specifies the token used for IAM authentication.

-
- - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

member

-

Yes

-

UpdateMemberOption object

-

Specifies request parameters for updating a backend server.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 UpdateMemberOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server.

-

Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers exist. If cloud servers exist, the value is true. Otherwise, the value is false.

-

name

-

No

-

String

-

Specifies the backend server name.

-

Minimum: 0

-

Maximum: 255

-

weight

-

No

-

Integer

-

Specifies the weight of the backend server.

-

Requests are routed to backend servers in the same backend server group based on their weights. If the weight is 0, the backend server will not accept new requests.

-

This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

-

Minimum: 0

-

Maximum: 100

-

Default: 1

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 5 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

member

-

Member object

-

Specifies the backend server.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 Member

Parameter

-

Type

-

Description

-

address

-

String

-

Specifies the IP address of the backend server.

-

The IP address must be in the subnet specified by subnet_cidr_id, for example, 192.168.3.11. The IP address can only be the IP address of the primary NIC.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server.

-

Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers exist. If cloud servers exist, the value is true. Otherwise, the value is false.

-

Default: true

-

id

-

String

-

Specifies the backend server ID.

-

name

-

String

-

Specifies the backend server name.

-

operating_status

-

String

-

Specifies the operating status of the backend server. The value can be one of the following:

-

  • ONLINE: The backend server is running normally.

    -

  • NO_MONITOR: No health check is configured for the backend server group to which the backend server belongs.

    -

  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.

    -
-

project_id

-

String

-

Specifies the project ID.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server to receive requests.

-

Minimum: 1

-

Maximum: 65535

-

subnet_cidr_id

-

String

-

Specifies the ID of the subnet where the backend server works. This subnet must be in the VPC as the subnet of the load balancer associated with the backend server. Only IPv4 subnets are supported. If the value is left blank, the backend server is not in the load balancer's VPC.

-

weight

-

Integer

-

Specifies the weight of the backend server.

-

Requests are routed to backend servers in the same backend server group based on their weights.

-

If the weight is 0, the backend server will not accept new requests.

-

This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server.

-

Minimum: 0

-

Maximum: 100

-

Default: 1

-

ip_version

-

String

-

This is a read-only attribute, which is automatically generated based on the address parameter. The value can be v4 or v6.

-

Default: v4

-
- - -

Example Requests

PUT
-
-https://{elb_endpoint}/v3/9a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members/1923923e-fe8a-484f-bdbc-e11559b1f48f
-
-{
-  "member" : {
-    "name" : "My member",
-    "weight" : 10
-  }
-}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "member" : {
-    "name" : "My member",
-    "weight" : 10,
-    "admin_state_up" : false,
-    "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74",
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "address" : "120.10.10.16",
-    "protocol_port" : 89,
-    "id" : "1923923e-fe8a-484f-bdbc-e11559b1f48f",
-    "operating_status" : "NO_MONITOR",
-    "ip_version" : "v4"
-  },
-  "request_id" : "e7b569d4-15ad-494d-9dd9-8cd740eef8f6"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/UpdatePool.html b/docs/elb/api-ref/UpdatePool.html deleted file mode 100644 index 70e80b4cf..000000000 --- a/docs/elb/api-ref/UpdatePool.html +++ /dev/null @@ -1,590 +0,0 @@ - - -

Updating a Backend Server Group

-

Function

This API is used to update a backend server group.

- -

Constraints

The backend server group can be updated only when the provisioning status of the associated load balancer is ACTIVE.

- -

URI

PUT /v3/{project_id}/elb/pools/{pool_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Path parameters

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the backend server group ID.

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request Parameters

- - - - - - - - - - - - -
Table 2 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

pool

-

Yes

-

UpdatePoolOption object

-

Specifies the backend server group.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 UpdatePoolOption

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server group. The value can only be updated to true.

-

This parameter is unsupported. Please do not use it.

-

description

-

No

-

String

-

Provides supplementary information about the backend server group.

-

Minimum: 0

-

Maximum: 255

-

lb_algorithm

-

No

-

String

-

Specifies the load balancing algorithm used by the load balancer to route requests to backend servers.

-

The value can be one of the following:

-

  • ROUND_ROBIN: weighted round robin

    -

  • LEAST_CONNECTIONS: weighted least connections

    -

  • SOURCE_IP: source IP hash

    -
-

When the value is SOURCE_IP, the weights of backend servers are invalid.

-

name

-

No

-

String

-

Specifies the backend server group name.

-

Minimum: 0

-

Maximum: 255

-

session_persistence

-

No

-

UpdatePoolSessionPersistenceOption object

-

Specifies whether to enable sticky sessions.

-

slow_start

-

No

-

UpdatePoolSlowStartOption object

-

Specifies whether to enable slow start. After you enable slow start, new backend servers added to the backend server group are warmed up, and the number of requests they can receive increases linearly during the configured slow start duration.

-

This parameter can be used when the protocol of the backend server group is HTTP or HTTPS. An error will be returned if the protocol is not HTTP or HTTPS.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 UpdatePoolSessionPersistenceOption

Parameter

-

Mandatory

-

Type

-

Description

-

cookie_name

-

No

-

String

-

Specifies the cookie name.

-

This parameter will take effect only when type is set to APP_COOKIE. Otherwise, an error will be returned.

-

The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 0

-

Maximum: 1024

-

type

-

Yes

-

String

-

Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, only SOURCE_IP takes effect.

    -

  • For dedicated load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can only be HTTP_COOKIE.

    -

  • For shared load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can be HTTP_COOKIE or APP_COOKIE.

    -
-

persistence_timeout

-

No

-

Integer

-

Specifies the stickiness duration, in minutes.

-

This parameter will not take effect when type is set to APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60, and the default value is 1.

    -

  • If the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440, and the default value is 1440.

    -
-
- - - - - - - - - - - - - - - - - - - -
Table 5 UpdatePoolSlowStartOption

Parameter

-

Mandatory

-

Type

-

Description

-

enable

-

Yes

-

Boolean

-

Specifies whether slow start is enabled.

-

true indicates that slow start is enabled, and false indicates slow start is disabled.

-

Default: false

-

duration

-

Yes

-

Integer

-

Specifies the slow start duration, in seconds.

-

The value ranges from 30 to 1200, and the default value is 30.

-

Minimum: 30

-

Maximum: 1200

-

Default: 30

-
- - -

Response Parameters

Status code: 200

- - - - - - - - - - - - - - - -
Table 6 Response body parameters

Parameter

-

Type

-

Description

-

request_id

-

String

-

Specifies the request ID. The value is automatically generated.

-

pool

-

Pool object

-

Specifies the backend server group.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 Pool

Parameter

-

Type

-

Description

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server group. The value can only be updated to true.

-

This parameter is unsupported. Please do not use it.

-

Default: true

-

description

-

String

-

Provides supplementary information about the backend server group.

-

healthmonitor_id

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

id

-

String

-

Specifies the backend server group ID.

-

lb_algorithm

-

String

-

Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the backend server group.

-

The value can be ROUND_ROBIN (weighted round robin), LEAST_CONNECTIONS (weighted least connections), or SOURCE_IP (source IP hash).

-

When the value is SOURCE_IP, the weight parameter is invalid.

-

listeners

-

Array of ListenerRef objects

-

Lists the listeners associated with the backend server group.

-

loadbalancers

-

Array of LoadBalancerRef objects

-

Lists the IDs of load balancers associated with the backend server group.

-

If only listener_id is specified during the creation of the backend server group, the ID of the loadbalancers parameter in the response is the ID of the load balancer to which the listener is added.

-

members

-

Array of MemberRef objects

-

Lists the backend servers in the backend server group.

-

name

-

String

-

Specifies the backend server group name.

-

project_id

-

String

-

Specifies the project ID.

-

protocol

-

String

-

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

-

  • For UDP listeners, the protocol of the backend server group must be UDP.

    -

  • For TCP listeners, the protocol of the backend server group must be TCP.

    -

  • For HTTP or HTTPS listeners, the protocol of the backend server group must be HTTP.

    -
-

session_persistence

-

SessionPersistence object

-

Specifies the sticky session.

-

ip_version

-

String

-

Specifies the IP version supported by the backend server group.

-

  • Shared load balancers: The default value is v4.

    -

  • Dedicated load balancers: The value can be dualstack, v4, or v6.

    -
-

When the protocol of the backend server group is TCP or UDP, ip_version is set to dualstack, indicating that both IPv4 and IPv6 are supported.

-

When the protocol of the backend server group is HTTP, ip_version is set to v4.

-

IPv6 is unsupported. Only v4 is returned.

-

Default: dualstack

-

slow_start

-

SlowStart object

-

Specifies whether to enable slow start. After you enable slow start, new backend servers added to the backend server group are warmed up, and the number of requests they can receive increases linearly during the configured slow start duration.

-

This parameter can be used when the protocol of the backend server group is HTTP or HTTPS. An error will be returned if the protocol is not HTTP or HTTPS.

-

This parameter is unsupported. Please do not use it.

-
- - - - - - - - - - - - -
Table 8 ListenerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-
- - - - - - - - - - - - -
Table 9 LoadBalancerRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-
- - - - - - - - - - - - -
Table 10 MemberRef

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

-
- - - - - - - - - - - - - - - - - - - - -
Table 11 SessionPersistence

Parameter

-

Type

-

Description

-

cookie_name

-

String

-

Specifies the cookie name.

-

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

-

The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

-

Minimum: 0

-

Maximum: 1024

-

type

-

String

-

Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, only SOURCE_IP takes effect.

    -

  • For dedicated load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can only be HTTP_COOKIE.

    -

  • For shared load balancers, if the protocol of the backend server group is HTTP or HTTPS, the value can be HTTP_COOKIE or APP_COOKIE.

    -
-

persistence_timeout

-

Integer

-

Specifies the stickiness duration, in minutes. This parameter will not take effect when type is set to APP_COOKIE.

-

  • If the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60, and the default value is 1.

    -

  • If the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440, and the default value is 1440.

    -
-
- - - - - - - - - - - - - - - - -
Table 12 SlowStart

Parameter

-

Type

-

Description

-

enable

-

Boolean

-

Specifies whether to enable slow start.

-

true indicates that this function is enabled, and false indicates this function is disabled.

-

Default: false

-

duration

-

Integer

-

Specifies the slow start duration, in seconds.

-

The value ranges from 30 to 1200, and the default value is 30.

-

Minimum: 30

-

Maximum: 1200

-

Default: 30

-
- - -

Example Requests

PUT
-
-https://{elb_endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75
-
-{
-  "pool" : {
-    "name" : "My pool.",
-    "description" : "My pool update",
-    "lb_algorithm" : "LEAST_CONNECTIONS"
-  }
-}
- -

Example Responses

Status code: 200

-

Successful request.

-
{
-  "pool" : {
-    "lb_algorithm" : "LEAST_CONNECTIONS",
-    "protocol" : "TCP",
-    "description" : "My pool update",
-    "admin_state_up" : true,
-    "loadbalancers" : [ {
-      "id" : "098b2f68-af1c-41a9-8efd-69958722af62"
-    } ],
-    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
-    "listeners" : [ {
-      "id" : "0b11747a-b139-492f-9692-2df0b1c87193"
-    }, {
-      "id" : "61942790-2367-482a-8b0e-93840ea2a1c6"
-    }, {
-      "id" : "fd8f954c-f0f8-4d39-bb1d-41637cd6b1be"
-    } ],
-    "members" : [ ],
-    "id" : "36ce7086-a496-4666-9064-5ba0e6840c75",
-    "name" : "My pool.",
-    "ip_version" : "dualstack"
-  },
-  "request_id" : "8f40128b-c72b-4b64-986a-f7e2c633d75f"
-}
- -

Status Codes

- - - - - - - - -

Status Code

-

Description

-

200

-

Successful request.

-
- - -

Error Codes

See Error Codes.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/api-elb(chm).iml b/docs/elb/api-ref/api-elb(chm).iml deleted file mode 100644 index 8021953ed..000000000 --- a/docs/elb/api-ref/api-elb(chm).iml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/docs/elb/api-ref/elb_dx_0000.html b/docs/elb/api-ref/elb_dx_0000.html deleted file mode 100644 index 85208d757..000000000 --- a/docs/elb/api-ref/elb_dx_0000.html +++ /dev/null @@ -1,33 +0,0 @@ - - -

Dedicated Load Balancer APIs

- - - - - diff --git a/docs/elb/api-ref/elb_eg_v3_0000.html b/docs/elb/api-ref/elb_eg_v3_0000.html deleted file mode 100644 index 09d647dbb..000000000 --- a/docs/elb/api-ref/elb_eg_v3_0000.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Examples

- - - - - diff --git a/docs/elb/api-ref/elb_eg_v3_0002.html b/docs/elb/api-ref/elb_eg_v3_0002.html deleted file mode 100644 index cd9e7117c..000000000 --- a/docs/elb/api-ref/elb_eg_v3_0002.html +++ /dev/null @@ -1,65 +0,0 @@ - - -

Adding a Listener to a Dedicated Load Balancer

-

Scenarios

Call the API to add a listener to a dedicated load balancer.

- -

Prerequisites

- -

Procedure

  1. Add a listener.
    1. Send POST https://{elb_endpoint}/v3/{project_id}/elb/listeners. project_id indicates the project ID.
    2. Add X-Auth-Token to the request header.
    3. Ensure that the following parameters are passed in the request body:
      {
-	"listener": {
- 		"protocol_port": 80, // Frontend port. The listener will use this port to receive requests.
-		"protocol": "HTTP", // Frontend protocol. The listener will use this protocol to receive requests.
-		"loadbalancer_id": "f77281cb-9f58-4347-8f82-2180d8bea789", // Load balancer that the listener is added to
-		"name": "my_listener" // Listener name
-	}
-}
      -
    4. Check the response.
      • The request is successful if the following response is displayed:
        {
-    "listener": {
-        "id": "90ad2705-4ffd-43d3-8f75-af8086bde841",
-        "name": "my_listener",
-        "protocol_port": 80,
-        "protocol": "HTTP",
-        "description": "",
-        "default_tls_container_ref": null,
-        "admin_state_up": true,
-        "loadbalancers": [
-            {
-                "id": "f77281cb-9f58-4347-8f82-2180d8bea789"
-            }
-        ],
-        "client_ca_tls_container_ref": null,
-        "project_id": "057ef081eb00d2732fd1c01a9be75e6f",
-        "sni_container_refs": [],
-        "connection_limit": -1,
-        "default_pool_id": null,
-        "tls_ciphers_policy": null,
-        "tags": [],
-        "created_at": "2020-11-21T03:09:13Z",
-        "updated_at": "2020-11-21T03:09:13Z",
-        "http2_enable": false,
-        "insert_headers": {
-            "X-Forwarded-ELB-IP": false,
-            "X-Forwarded-Host": true,
-            "X-Forwarded-For-Port": false,
-            "X-Forwarded-Port": false
-        },
-        "member_timeout": 60,
-        "client_timeout": 60,
-        "keepalive_timeout": 60,
-        "ipgroup": null,
-        "enable_member_retry": true,
-        "transparent_client_ip_enable": true
-    },
-    "request_id": "fcd61ee6a6a6c673c65fa0df0577fed9"
-}
        -
      • If the request is abnormal, locate the fault by referring to HTTP Status Codes for Dedicated Load Balancers.
      -
    -
- - - - -Parent topic: Examples - - - diff --git a/docs/elb/api-ref/elb_eg_v3_0003.html b/docs/elb/api-ref/elb_eg_v3_0003.html deleted file mode 100644 index c21e19e31..000000000 --- a/docs/elb/api-ref/elb_eg_v3_0003.html +++ /dev/null @@ -1,31 +0,0 @@ - - -

Deleting a Dedicated Load Balancer

-

Scenarios

Call APIs to delete a dedicated load balancer.

-

Before you delete a dedicated load balancer, delete all resources associated with it. Figure 1 shows the associated resources.

-Figure 1 Resources associated with a dedicated load balancer
- -

Procedure

Perform the following steps to delete the associated resources and the load balancer. Skip the corresponding step if the associated resources do not exist. For example, you can skip 1 if no health check is configured.

-
  1. Delete the health check configured for each associated backend server group.
    1. Send DELETE https://{elb_endpoint}/v3/{project_id}/elb/healthmonitors/{healthmonitor_id}. project_id indicates the project ID, and healthmonitor_id indicates the health check ID.
    2. Add X-Auth-Token to the request header.
    3. Check the response. -
    -
  2. Remove backend servers from each associated backend server group.
    1. Send DELETE https://{elb_endpoint}/v3/{project_id}/elb/pools/{pool_id}/members/{member_id}. project_id indicates the project ID, pool_id indicates the backend server group ID, and member_id indicates the backend server ID.
    2. Add X-Auth-Token to the request header.
    3. Check the response. -
    -
  3. Delete each associated backend server group.
    1. Send DELETE https://{elb_endpoint}/v3/{project_id}/elb/pools/{pool_id}. project_id indicates the project ID, and pool_id indicates the backend server group ID.
    2. Add X-Auth-Token to the request header.
    3. Check the response. -
    -
  4. Delete the forwarding rules added to each listener.
    1. Send DELETE https://{elb_endpoint}/v3/{project_id}/elb/l7policies/{policy_id}/rules/{rule_id}. project_id indicates the project ID, policy_id indicates the forwarding policy ID, and rule_id indicates the forwarding rule ID.
    2. Add X-Auth-Token to the request header.
    3. Check the response. -
    -
  5. Delete the forwarding policies added to each listener.
    1. Send DELETE https://{elb_endpoint}/v3/{project_id}/elb/l7policies/{policy_id}. project_id indicates the project ID, and policy_id indicates the forwarding policy ID.
    2. Add X-Auth-Token to the request header.
    3. Check the response. -
    -
  6. Delete each listener added to the load balancer.
    1. Send DELETE https://{elb_endpoint}/v3/{project_id}/elb/listeners/{listener_id}. project_id indicates the project ID, and listener_id indicates the listener ID.
    2. Add X-Auth-Token to the request header.
    3. Check the response. -
    -
  7. Delete the load balancer.
    1. Send DELETE https://{elb_endpoint}/v3/{project_id}/elbloadbalancers/{loadbalancer_id}. project_id indicates the project ID, and loadbalancer_id indicates the load balancer ID.
    2. Add X-Auth-Token to the request header.
    3. Check the response. -
    -
- - - - -Parent topic: Examples - - - diff --git a/docs/elb/api-ref/elb_fl_0000.html b/docs/elb/api-ref/elb_fl_0000.html deleted file mode 100644 index 9d97f9642..000000000 --- a/docs/elb/api-ref/elb_fl_0000.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Appendix

- - - - - diff --git a/docs/elb/api-ref/elb_fl_0002.html b/docs/elb/api-ref/elb_fl_0002.html deleted file mode 100644 index d9994a131..000000000 --- a/docs/elb/api-ref/elb_fl_0002.html +++ /dev/null @@ -1,177 +0,0 @@ - - -

ELB Metrics

-

Introduction

This section describes the metrics that can be monitored by Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the metrics of a monitored object and the generated alarms.

- -

Namespace

SYS.ELB

- -

Metrics

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Metric

-

Metric Name

-

Description

-

Value Range

-

Remarks

-

m1_cps

-

Concurrent Connections

-

Total number of concurrent connections processed by the monitored object per second

-

Unit: count

-

≥ 0

-

Monitored object: an elastic load balancer, elastic load balancer listener, or classic load balancer

-

m2_act_conn

-

Active Connections

-

Total number of active connections processed by the monitored object per second

-

Unit: count

-

≥ 0

-

Monitored object: an elastic load balancer, elastic load balancer listener, or classic load balancer

-

m3_inact_conn

-

Inactive Connections

-

Total number of inactive connections processed by the monitored object per second

-

Unit: count

-

≥ 0

-

Monitored object: an elastic load balancer, elastic load balancer listener, or classic load balancer

-

m4_ncps

-

New Connections

-

Total number of new connections processed by the monitored object per second

-

Unit: count

-

≥ 0

-

Monitored object: an elastic load balancer, elastic load balancer listener, or classic load balancer

-

m5_in_pps

-

Incoming Packets

-

Incoming packets received by the monitored object per second

-

Unit: count

-

≥ 0

-

Monitored object: an elastic load balancer, elastic load balancer listener, or classic load balancer

-

m6_out_pps

-

Outgoing Packets

-

Outgoing packets sent from the monitored object per second

-

Unit: count

-

≥ 0

-

Monitored object: an elastic load balancer, elastic load balancer listener, or classic load balancer

-

m7_in_Bps

-

Inbound Rate

-

Incoming bytes received by the monitored object per second

-

Unit: Byte/s

-

≥ 0

-

Monitored object: an elastic load balancer, elastic load balancer listener, or classic load balancer

-

m8_out_Bps

-

Outbound Rate

-

Outgoing bytes sent from the monitored object per second

-

Unit: Byte/s

-

≥ 0

-

Monitored object: an elastic load balancer, elastic load balancer listener, or classic load balancer

-

m9_abnormal_servers

-

Unhealthy Servers

-

Number of backend servers considered unhealthy

-

Unit: count

-

≥ 0

-

Monitored object: an elastic load balancer or classic load balancer

-

ma_normal_servers

-

Healthy Servers

-

Number of backend servers considered healthy

-

Unit: count

-

≥ 0

-

Monitored object: an elastic load balancer or classic load balancer

-
- - -

Dimensions

- - - - - - - - - - - - - - -

Key

-

Value

-

lb_instance_id

-

ID of a classic load balancer

-

lbaas_instance_id

-

ID of an elastic load balancer

-

lbaas_listener_id

-

ID of an elastic load balancer listener

-
- - - - - -Parent topic: Appendix - - - diff --git a/docs/elb/api-ref/elb_fl_0003.html b/docs/elb/api-ref/elb_fl_0003.html deleted file mode 100644 index b22c7fec2..000000000 --- a/docs/elb/api-ref/elb_fl_0003.html +++ /dev/null @@ -1,20 +0,0 @@ - - -

General Information About Shared Load Balancers

-

The following information applies only to shared load balancers.

- - - - - -Parent topic: Appendix - - - diff --git a/docs/elb/api-ref/elb_fl_0004.html b/docs/elb/api-ref/elb_fl_0004.html deleted file mode 100644 index fcc7890de..000000000 --- a/docs/elb/api-ref/elb_fl_0004.html +++ /dev/null @@ -1,93 +0,0 @@ - - -

Querying Data in Pages

-

APIs v2.0 allow users to query data in pages by adding the limit and marker parameters to the URL of the list request. The query results are displayed in the ascending order of IDs.

- -

Request

- - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Type

-

Mandatory

-

Description

-

limit

-

int

-

No

-

Specifies the number of records on each page.

-

marker

-

String

-

No

-

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

-

page_reverse

-

Bool

-

No

-

Specifies the paging sequence. The value can be true or false.

-
- - -

Response

None

- -

Example

- - -

- - - -Parent topic: General Information About Shared Load Balancers - - - diff --git a/docs/elb/api-ref/elb_fl_0005.html b/docs/elb/api-ref/elb_fl_0005.html deleted file mode 100644 index aa2d2b1d3..000000000 --- a/docs/elb/api-ref/elb_fl_0005.html +++ /dev/null @@ -1,46 +0,0 @@ - - -

Sequencing Query Results

-

APIs v2.0 enable the system to sort queried results based on customized keys by adding the sort_key and sort_dir parameters to the URL of the list request. sort_key specifies the parameter used for sequencing results, and sort_dir specifies whether results are displayed in ascending or descending order. These APIs allow sorting query results by multiple criteria. The number of sort_key parameters must be equal to that of sort_dir parameters. Otherwise, 400 status code is returned.

-

Example Request

GET /v2.0/networks?sort_key=name&sort_dir=asc&sort_key=status&sort_dir=desc
- -

Example Response

{
-    "networks": [
-        {
-            "status": "ACTIVE",
-            "subnets": [],
-            "name": "liudongtest ",
-            "admin_state_up": false,
-            "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
-            "id": "60c809cb-6731-45d0-ace8-3bf5626421a9"
-        },
-        {
-            "status": "ACTIVE",
-            "subnets": [
-                "132dc12d-c02a-4c90-9cd5-c31669aace04"
-            ],
-            "name": "publicnet",
-            "admin_state_up": true,
-            "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
-            "id": "9daeac7c-a98f-430f-8e38-67f9c044e299"
-        },
-        {
-            "status": "ACTIVE",
-            "subnets": [
-                "e25189a8-54df-4948-9396-d8291ffc92a0"
-            ],
-            "name": "testnet01",
-            "admin_state_up": true,
-            "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
-            "id": "3d42a0d4-a980-4613-ae76-a2cddecff054"
-        }
-    ]
-}
- - - - -Parent topic: General Information About Shared Load Balancers - - - diff --git a/docs/elb/api-ref/elb_fl_0006.html b/docs/elb/api-ref/elb_fl_0006.html deleted file mode 100644 index 7e56fe71b..000000000 --- a/docs/elb/api-ref/elb_fl_0006.html +++ /dev/null @@ -1,32 +0,0 @@ - - -

Querying Versions

-

Function

Queries all available versions.

-

If there is no version added to the URL, all available versions are returned.

- -

URI

GET /

- -

Request

None

- -

Response

None

- -

Example

- - - - diff --git a/docs/elb/api-ref/elb_fl_0007.html b/docs/elb/api-ref/elb_fl_0007.html deleted file mode 100644 index dc9ea0c1c..000000000 --- a/docs/elb/api-ref/elb_fl_0007.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Basic Workflow

-

The basic workflow of elastic load balancers contains the following: creating a load balancer, adding a listener to a specified load balancer, adding a backend server group to a specified listener, configuring a health check for a specified backend server group, and adding a backend server to a specified backend server group. Deletion operations include removing a backend server, deleting a health check, deleting a backend server group, deleting a listener, and deleting a load balancer.

-

Provision Resources

- -

Reclaim Resources

- - - - -Parent topic: General Information About Shared Load Balancers - - - diff --git a/docs/elb/api-ref/elb_gc_0000.html b/docs/elb/api-ref/elb_gc_0000.html deleted file mode 100644 index f9691cc17..000000000 --- a/docs/elb/api-ref/elb_gc_0000.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Common Parameters

- - - - - diff --git a/docs/elb/api-ref/elb_gc_0001.html b/docs/elb/api-ref/elb_gc_0001.html deleted file mode 100644 index a109914fa..000000000 --- a/docs/elb/api-ref/elb_gc_0001.html +++ /dev/null @@ -1,1249 +0,0 @@ - - -

Error Codes

-

The following error code descriptions are only suitable for classic load balancers.

-

Overview

If an error occurs when using an API, an error response will be returned, which contains the error code and a piece of message, as shown in the following example. The following table lists error codes and their descriptions.

- -

Example of Returned Error Information

{ 
-    "error": 
-    { 
-    "message": "listener exist, the port repeat", 
-    "code": "ELB.6101" 
-    } 
-}
- -

Error Codes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Error codes

Status Code

-

Error Code

-

Message

-

Description

-

Solution

-

400

-

ELB.0002

-

Api request is null.

-

The request is empty.

-

Change the parameter settings.

-

400

-

ELB.0004

-

Api response is null or invaild.

-

The response is empty.

-

Ensure that the backend server is healthy.

-

400

-

ELB.0230

-

Tenant_id is empty.

-

The project ID is left blank.

-

Correct the project ID.

-

400

-

ELB.1000

-

The loadbalancer URL is too long.

-

The URL length exceeds the limit.

-

Correct the URL.

-

400

-

ELB.1010

-

Query elb quota error.

-

Failed to query the quota.

-

Contact customer service.

-

400

-

ELB.1020

-

Lb ID is not correct.

-

Incorrect load balancer ID.

-

Change the parameter settings.

-

400

-

ELB.1001

-

Request parameters error, private_key or certificate is nil or empty.

-

Request parameters error, lb type, name, admin_state_up one of them is empty.

-

Parameter type, name, or admin_status_up is left blank.

-

Change the parameter settings.

-

400

-

ELB.1001

-

Request parameter is not valid.

-

The length of the load balancer name exceeds the limit.

-

Change the listener name.

-

400

-

ELB.1021

-

Request parameters error, name invalid.

-

Invalid load balancer name.

-

Change the parameter settings.

-

400

-

ELB.1031

-

Request parameters error, lb len description too long.

-

The length of the load balancer description exceeds the limit.

-

Change the description.

-

400

-

ELB.1041

-

Request parameters error, lb type is not valid.

-

Invalid load balancer type.

-

Change the parameter settings.

-

400

-

ELB.1051

-

Request parameters error, lb bandwidth is not valid.

-

Invalid load balancer bandwidth.

-

Change the parameter settings.

-

4000

-

ELB.1061

-

Request parameters error, lb vip_address and vip_subnet_id are nil.

-

The floating IP address or subnet ID is left blank.

-

Change the parameter settings.

-

400

-

ELB.1071

-

Request parameters error, lb vip_address is not valid.

-

Invalid floating IP address.

-

Change the parameter settings.

-

400

-

ELB.1081

-

Request parameters error, lb vpc_id is empty.

-

The VPC ID is left blank.

-

Change the parameter settings.

-

403

-

ELB.1091

-

Lb number larger than quota.

-

The number of load balancers exceeds the quota.

-

Request a higher quota or delete load balancers that are no longer needed.

-

400

-

ELB.1101

-

Vip address is exist.

-

The floating IP address exists.

-

Enter a valid floating IP address.

-

404

-

ELB.1002

-

Find lb failed.

-

The load balancer does not exist.

-

Change the load balancer ID.

-

400

-

ELB.1008

-

There is at least one member under the lb.

-

Failed to delete the load balancer.

-

Change the parameter settings.

-

400

-

ELB.1018

-

There is at least one member under the lb.

-

The load balancer has backend ECSs added.

-

Change the parameter settings.

-

400

-

ELB.1005

-

Update request paramters error.

-

Failed to modify the load balancer.

-

Check the parameters.

-

400

-

ELB.1015

-

Lb can not be updated.

-

The load balancer cannot be modified.

-

Check the parameters.

-

400

-

ELB.1025

-

Udpate request parameters error, name is too long.

-

The length of the load balancer name exceeds the limit.

-

Change the load balancer name.

-

400

-

ELB.1035

-

Update request parameters error, name is not valid.

-

Invalid load balancer name.

-

Change the load balancer name.

-

400

-

ELB.1045

-

Update request parameters error, description too long.

-

The length of the load balancer description exceeds the limit.

-

Change the description.

-

400

-

ELB.1003

-

Lb not exist.

-

The load balancer does not exist.

-

Check the load balancer ID.

-

400

-

ELB.1004

-

Query condition is not valid.

-

Invalid query condition.

-

Change the query condition.

-

400

-

ELB.6000

-

Listener ID length is not correct.

-

The length of the listener ID exceeds the limit.

-

Change the listener ID.

-

400

-

ELB.6010

-

Listener ID content is not correct.

-

Invalid listener ID.

-

Change the listener ID.

-

400

-

ELB.6030

-

Listener is not associated with loadbalancer id.

-

The listener does not belong to any load balancer.

-

Check the listener ID.

-

400

-

ELB.6040

-

The loadbalaner that the listener belongs to is not exist.

-

The load balancer to which the listener is added does not exist.

-

Check the load balancer ID.

-

400

-

ELB.6020

-

Listener url is not correct.

-

Incorrect listener URL.

-

Correct the URL.

-

400

-

ELB.6001

-

Request parameters error, "..nilKey.." is nil.

-

A mandatory parameter is left blank.

-

Specify the mandatory parameters.

-

400

-

ELB.6011

-

Request parameters error, listener name too long.

-

The length of the listener name exceeds the limit.

-

Change the listener name.

-

400

-

ELB.6021

-

Request parameters error, listener name is not valid.

-

Invalid listener name.

-

Change the listener name.

-

400

-

ELB.6031

-

Request parameters error, listener len description too long.

-

The length of the listener description exceeds the limit.

-

Change the description.

-

400

-

ELB.6041

-

Request parameters error, listener port is not in 1 ~ 65535.

-

Invalid port number.

-

Change the port number.

-

400

-

ELB.6051

-

Request parameters error, listener lb algorithm is not valid.

-

Invalid load balancing algorithm.

-

Change the load balancing algorithm.

-

400

-

ELB.6061

-

Request parameters error, listener protocol is not valid.

-

Invalid protocol used by the listener.

-

Change the protocol.

-

400

-

ELB.6071

-

Request parameters error, listener backend protocol is not valid.

-

Invalid backend ECS protocol.

-

Change the protocol.

-

400

-

ELB.6081

-

Request parameters error, listener sticky_session_type is not valid.

-

Invalid sticky session type.

-

Check the load balancer ID.

-

403

-

ELB.6091

-

Request lb has more than user listener quota.

-

The number of listeners reaches the limit.

-

No more listeners can be added.

-

400

-

ELB.6101

-

Listener port is repeated.

-

The port exists.

-

Use another port number.

-

503

-

ELB.6002

-

Delete listener failed, listener does not exist.

-

The listener does not exist.

-

Check the listener ID.

-

400

-

ELB.6015

-

This listener property cannot be updated

-

The property cannot be modified.

-

Select a property that can be modified.

-

400

-

ELB.6025

-

Udpate request parameters error, listener len name too long.

-

The length of the listener name exceeds the limit.

-

Change the listener name.

-

400

-

ELB.6035

-

Udpate request parameters error, listener name is not valid.

-

Invalid listener name.

-

Change the listener name.

-

400

-

ELB.6045

-

Update request parameters error, listener len description too long.

-

The length of the listener description exceeds the limit.

-

Change the description.

-

400

-

ELB.6003

-

Listener query condition is not valid.

-

Invalid query condition.

-

Change the query condition.

-

400

-

ELB.2000

-

Member url is not correct.

-

Incorrect backend ECS URL.

-

Correct the URL.

-

400

-

ELB.2003

-

Query member failed.

-

Failed to query the backend ECS.

-

Contact customer service.

-

400

-

ELB.2005

-

Update member failed.

-

Failed to update the backend ECS.

-

Contact customer service.

-

400

-

ELB.2010

-

Member listener ID length is not correct.

-

The length of the listener ID exceeds the limit.

-

Change the listener ID.

-

400

-

ELB.2020

-

Member listener ID content is not correct.

-

Incorrect listener ID.

-

Change the listener ID.

-

403

-

ELB.2001

-

Create member failed, the total amount of members exceeds the system setting.

-

Failed to add the ECS because the number of backend ECSs reaches the limit.

-

Check the maximum number of backend servers that can be added.

-

400

-

ELB.2011

-

Add member listener is not exist.

-

The listener does not exist.

-

Ensure that the listener exists.

-

400

-

ELB.2021

-

Request parameters error, member address is null.

-

Invalid address.

-

Check the IP address.

-

400

-

ELB.2002

-

Delete member input param error.

-

Incorrect parameters.

-

Change the parameter settings.

-

400

-

ELB.2012

-

This member is not exist.

-

The backend ECS does not exist.

-

Ensure that the backend server exists.

-

400

-

ELB.7000

-

Listener_id must not be null.

-

The listener ID is left blank.

-

Change the listener ID and deliver the request again.

-

400

-

ELB.7010

-

Healthcheck listener is not exist.

-

The listener with which the health check is associated does not exist.

-

Change the listener ID and deliver the request again.

-

400

-

ELB.7020

-

This healthcheck is not exist.

-

The health check does not exist.

-

Change the health check ID and deliver the request again.

-

400

-

ELB.7001

-

Healthcheck_interval is illegal.

-

Invalid health check interval.

-

Change the interval.

-

400

-

ELB.7002

-

Healthcheck delete condition is not valid.

-

Invalid query condition.

-

Change the query condition.

-

400

-

ELB.7001

-

Healthcheck update condition is not valid.

-

Invalid query condition.

-

Change the query condition.

-

400

-

ELB.7004

-

Healthcheck query condition is not valid.

-

Invalid query condition.

-

Change the query condition.

-

400

-

ELB.7014

-

Healthcheck configuration not exist.

-

The health check does not exist.

-

Check the health check ID.

-

400

-

ELB.8001

-

Create a SG error.

-

Failed to create the security group.

-

Contact customer service.

-

400

-

ELB.8101

-

Create VPC error.

-

Failed to create the VPC.

-

Contact customer service.

-

400

-

ELB.8102

-

Delete VPC error.

-

Failed to delete the VPC.

-

Contact customer service.

-

400

-

ELB.8103

-

Query VPC error.

-

Failed to query the VPC.

-

Contact customer service.

-

400

-

ELB.8201

-

Create subnet error.

-

Failed to create the subnet.

-

Contact customer service.

-

400

-

ELB.8202

-

Delete subnet error.

-

Failed to delete the subnet.

-

Contact customer service.

-

400

-

ELB.8203

-

Query subnet error.

-

Failed to query the subnet.

-

Contact customer service.

-

400

-

ELB.9001

-

Interval ELB create VM error.

-

Failed to add the ECS.

-

Contact customer service.

-

400

-

ELB.9002

-

Internal ELB delete VM error.

-

Failed to delete the ECS.

-

Contact customer service.

-

400

-

ELB.9003

-

Internal ELB query VM error.

-

Failed to query ECS details.

-

Contact customer service.

-

400

-

ELB.9006

-

Internal ELB update port fail.

-

Failed to update the port configured on the ECS data plane.

-

Contact customer service.

-

400

-

ELB.9007

-

Intenal ELB bind port fail.

-

Failed to bind the port configured on the ECS data plane.

-

Contact customer service.

-

400

-

ELB.9061

-

Internal ELB query topic fail.

-

Failed to query the SMN topic.

-

Contact customer service.

-

400

-

ELB.9062

-

Internal ELB create topic fail.

-

Failed to create the SMN topic.

-

Contact customer service.

-

400

-

ELB.9063

-

Internal ELB query subscription fail.

-

Failed to query the SMN subscription.

-

Contact customer service.

-

400

-

ELB.9064

-

Internal ELB create subscription fail.

-

Failed to create the SMN subscription.

-

Contact customer service.

-

400

-

ELB.9023

-

Internal ELB get image error.

-

Failed to query the image.

-

Contact customer service.

-

400

-

ELB.9033

-

Internal ELB get flavour error.

-

Failed to query ECS specifications.

-

Contact customer service.

-

400

-

ELB.9043

-

Internal ELB get interface error.

-

Failed to query the API bound to the ECS.

-

Contact customer service.

-

400

-

ELB.1007

-

Query internal ELB error.

-

Failed to query details of the private network load balancer.

-

Contact customer service.

-

400

-

ELB.1012

-

Create tenant resource relation error.

-

Failed to create the relationship between resources and the user.

-

Contact customer service.

-

400

-

ELB.1013

-

Update resource tenant allocation failed, cloud eye warning rule exceeds.

-

Failed to modify the quota of a resource because the quota set in the Cloud Eye alarm rule is too large.

-

Contact customer service.

-

400

-

ELB.1014

-

Query resouce tenant relation failed.

-

Failed to query the relationship between resources and the user.

-

Contact customer service.

-

400

-

ELB.1102

-

Token invalid

-

Invalid token.

-

Contact customer service.

-

400

-

ELB.1103

-

Token invalid

-

Invalid token.

-

Contact customer service.

-

400

-

ELB.1104

-

Token invalid

-

Invalid token.

-

Contact customer service.

-

400

-

ELB.1105

-

Token invalid

-

Invalid token.

-

Contact customer service.

-

400

-

ELB.1109

-

Authentication failed.

-

Real-name authentication failed.

-

Contact customer service.

-

400

-

ELB.1201

-

Get Token failed

-

Failed to obtain the token.

-

Contact customer service.

-

400

-

ELB.3001

-

Create floating IP failed.

-

Failed to assign the floating IP address.

-

Contact customer service.

-

400

-

ELB.3002

-

Delete floating IP failed.

-

Failed to release the floating IP address.

-

Contact customer service.

-

400

-

ELB.3003

-

Query floating IP failed.

-

Failed to query the floating IP address.

-

Contact customer service.

-

400

-

ELB.3004

-

Query floating IP list failed.

-

Failed to query floating IP addresses.

-

Contact customer service.

-

400

-

ELB.3005

-

Update floating IP failed.

-

Failed to update the floating IP address.

-

Contact customer service.

-

400

-

ELB.4001

-

Create elastic IP failed.

-

Failed to assign the EIP.

-

Contact customer service.

-

400

-

ELB.4002

-

Delete elastic IP failed.

-

Failed to release the EIP.

-

Contact customer service.

-

400

-

ELB.4003

-

Query elastic IP failed.

-

Failed to query the EIP.

-

Contact customer service.

-

400

-

ELB.4004

-

Query elastic IP list failed.

-

Failed to query EIPs.

-

Contact customer service.

-

400

-

ELB.4005

-

Update elastic IP failed.

-

Failed to update the EIP.

-

Contact customer service.

-

400

-

ELB.5003

-

Query bandwidth failed.

-

Failed to query the bandwidth.

-

Contact customer service.

-

400

-

ELB.5005

-

Update bandwidth failed.

-

Failed to update the bandwidth.

-

Contact customer service.

-

400

-

ELB.6004

-

Query listeners list failed.

-

Failed to query listeners.

-

Contact customer service.

-

400

-

ELB.6006

-

Query ECS failed.

-

Failed to query the ECS.

-

Contact customer service.

-
- - - - - -Parent topic: Common Parameters - - - diff --git a/docs/elb/api-ref/elb_gc_0002.html b/docs/elb/api-ref/elb_gc_0002.html deleted file mode 100644 index 0c33ef6d4..000000000 --- a/docs/elb/api-ref/elb_gc_0002.html +++ /dev/null @@ -1,1094 +0,0 @@ - - -

HTTP Status Codes of Shared Load Balancers

-

The following code descriptions are only suitable for shared load balancers.

- - - - - - - - - - - - - - - - - - - -
Table 1 Normal response codes

Status Code

-

Type

-

Description

-

200

-

OK

-

Normal response to GET and PUT requests.

-

201

-

Created

-

Normal response to POST requests.

-

204

-

No Content

-

Normal response to DELETE requests.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Error codes

Status Code

-

Type

-

Possible Cause

-

400

-

Bad request

-

Malformed request URI or body.

-

Invalid admin _state_up value.

-

Invalid parameters.

-

Batch operations are not allowed.

-

Failed to verify the parameters.

-

Incorrect request method, for example, updating attributes that can be specified during creation only.

-

The network is not external (the value of router:external is set to false).

-

The IaaS OpenStack network port has no floating IP address bound.

-

The requested floating IP address is not in the IP address range of the external network.

-

Invalid fixed IP address.

-

The router port does not have a fixed IP address.

-

The subnet for the router interface must have a gateway IP address.

-

401

-

Unauthorized

-

Authentication required.

-

403

-

Forbidden

-

The URI does not exist.

-

The resource cannot be found.

-

404

-

Not Found

-

The URI does not exist.

-

The resource cannot be found.

-

Invalid port ID.

-

409

-

Conflict

-

The port is already in use.

-

The IP address is already in use.

-

The IP address pool cannot contain gateway and broadcast addresses.

-

The requested floating IP address is already in use.

-

The internal IaaS OpenStack network port and fixed IP address are already associated with another floating IP addresses.

-

500

-

Internal server error.

-

Internal IaaS OpenStack network error.

-

503

-

Service unavailable

-

Failed to assign the MAC address.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Error codes

Module

-

HTTP Status Code

-

Error Code

-

Error Message

-

Description

-

Handling Measure

-

Load balancer

-

400

-

ELB.0002

-

RequestBody is null or empty,request is invalid.

-

The request body is empty.

-

Set the parameter by following the instructions in this guide.

-

401

-

ELB.1102

-

Token is error, Authentication required.

-

Empty token.

-

Use a correct token that has not expired.

-

400

-

ELB.0002

-

RequestBody is null, request is invalid.

-

Failed to convert the request body.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody loadbalancer[vip_subnet_id] is null, this is a required parameter.

-

vip_subnet_id in the request body is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.1202

-

1.decoded token is null.

-

2.checkEnterpriseProject is error.

-
  • The token is empty.
  • An error occurred during verification of ep_id.
-

Check the enterprise project ID.

-

403

-

ELB.9802

-

Policy doesn't allow elb:loadbalancers:list to be performed.

-

etc.

-

Authentication failure

-

Check whether you have the permission to perform this operation.

-

403

-

ELB.9803

-

Policy doesn't allow elb:loadbalancers:list to be performed.

-

etc.

-

Authentication failure

-

Check whether you have the permission to perform this operation.

-

403

-

ELB.9804

-

Policy doesn't allow elb:loadbalancers:list to be performed.

-

etc.

-

Authentication failure

-

Check whether you have the permission to perform this operation.

-

400

-

ELB.0004

-

Api response is null or invaild.

-

The response returned by Neutron is null.

-

Contact customer service.

-

400

-

ELB.9899

-

The default_tls_container_ref field of the TERMINATED_HTTPS listener does not allow updating to null

-

etc.

-

Combined API failed to send the request to Neutron.

-

Rectify the fault based on the error information.

-

400

-

ELB.9807

-

Quota exceeded for resources:['loadbalancer'].

-

The quota has been used up.

-

To expand the quota, contact customer service.

-

400

-

ELB.1204

-

Bind fail.

-

Failed to associate the load balancer with the enterprise project.

-

Contact customer service.

-

400

-

ELB.9805

-

Ep_id is not uuid.

-

ep_id in the URI is not a valid UUID.

-

Check the enterprise project ID.

-

400

-

ELB.9806

-

Loadbalancer_id in url is null or empty.

-

etc.

-

loadbalancer_id in the URI is empty.

-

Check whether the load balancer ID in the URL is correct.

-

404

-

ELB.9800

-

Resource could not be found.

-

The specified load balancer does not exist when ep_id is queried.

-

Check the load balancer ID.

-

400

-

ELB.9808

-

Tenant_id in token mismatches with tenant_id in url.

-

The value of tenant_id in the token is different from that in the URL.

-

Check whether parameter tenant_id in the token and URL is correct.

-

403

-

ELB.9801

-

Not be list action, enterprise_project_id must not be null.

-

In the fine-grained authorization scenario, the enterprise ID is not transmitted in the request for querying the load balancers.

-

Check whether the parameters in the request for querying the load balancers are correct.

-

Listener

-

400

-

ELB.0002

-

Listener is null, request is invalid.

-

The request body is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody listener[protocol] is null, this is a required parameter.

-

protocol in the request body is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody listener[protocol_port] is null, this is a required parameter.

-

protocol_port is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody listener[loadbalancer_id] is null, this is a required parameter.

-

loadbalancer_id is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.6200

-

Load Balaner *** already has a listener with protocol_port of ***.

-

The port number is in use.

-

Change the port number.

-

400

-

ELB.9807

-

Quota exceeded for resources:['listener'].

-

The quota has been used up.

-

To expand the quota, contact customer service.

-

Backend server group

-

400

-

ELB.0002

-

Pool is null, request is invalid.

-

The request body is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody pool[protocol] is null, this is a required parameter.

-

protocol is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody pool[lb_algorithm] is null, this is a required parameter.

-

lb_algorithm is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9807

-

Quota exceeded for resources:['pool'].

-

The quota has been used up.

-

To expand the quota, contact customer service.

-

400

-

ELB.9805

-

RequestBody pool[loadbalancer_id] and pool[listener_id] both are null, this has at least one parameter.

-

listener_id is empty.

-

Set the parameter by following the instructions in this guide.

-

Backend server

-

400

-

ELB.9805

-

RequestBody pool[session_persistence][type] is null. when pool[session_persistence] exists, this is a required parameter.

-

session_persistence is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.0002

-

Member is null,request is invalid.

-

The request body is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody member[address] is null, this is a required parameter.

-

address is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9807

-

Quota exceeded for resources:['member'].

-

The quota has been used up.

-

To expand the quota, contact customer service.

-

400

-

ELB.9805

-

RequestBody member[address]'s length is %s, greater than 64.

-

The value of address contains more than 64 characters.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody member[protocol_port] is null, this is a required parameter.

-

protocol_port is empty.

-

Set the parameter by following the instructions in this guide.

-

Health check

-

400

-

ELB.9805

-

RequestBody member[subnet_id] is null, this is a required parameter.

-

subnet_id is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.0002

-

healthmonitor is null,request is invalid.

-

The request body is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody healthmonitor[delay] is null, this is a required parameter.

-

delay is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody healthmonitor[max_retries] is null, this is a required parameter.

-

max_retries is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody healthmonitor[pool_id] is null, this is a required parameter.

-

pool_id is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9807

-

Quota exceeded for resources:['healthmonitor'].

-

The quota has been used up.

-

To expand the quota, contact customer service.

-

400

-

ELB.9805

-

RequestBody healthmonitor[timeout] is null, this is a required parameter.

-

timeout is empty.

-

Set the parameter by following the instructions in this guide.

-

Forwarding policy

-

400

-

ELB.9805

-

RequestBody healthmonitor[type] is null, this is a required parameter.

-

type is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.0002

-

l7policy is null,request is invalid.

-

The request body is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9807

-

Quota exceeded for resources:['l7policiey'].

-

The quota has been used up.

-

To expand the quota, contact customer service.

-

400

-

ELB.9805

-

RequestBody l7policy[listener_id] is null, this is a required parameter.

-

listener_id is empty.

-

Set the parameter by following the instructions in this guide.

-

Forwarding rule

-

400

-

ELB.9805

-

RequestBody l7policy[action] is null, this is a required parameter.

-

action is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.0002

-

Rule is null,request is invalid.

-

The request body is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody rule[type] is null, this is a required parameter.

-

type is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9807

-

Quota exceeded for resources:['l7policieyrule'].

-

The quota has been used up.

-

To expand the quota, contact customer service.

-

400

-

ELB.9805

-

RequestBody rule[compare_type] is null, this is a required parameter.

-

compare_type is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody rule[value] is null, this is a required parameter.

-

value is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody rule[value]'s length is %s, greater than 128.

-

The parameter value contains more than 128 characters.

-

Set the parameter by following the instructions in this guide.

-

Whitelist

-

400

-

ELB.9807

-

Quota exceeded for resources:['whitelist'].

-

The quota has been used up.

-

To expand the quota, contact customer service.

-

400

-

ELB.0002

-

whitelist is null,request is invalid.

-

The request body is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody whitelist[listener_id] is null, this is a required parameter.

-

listener_id is empty.

-

Set the parameter by following the instructions in this guide.

-

400

-

ELB.9805

-

RequestBody whitelist[listener_id]'s length is %s, greater than 255.

-

The value of listener_id contains more than 255 characters.

-

Set the parameter by following the instructions in this guide.

-

Label Management

-

400

-

ELB.0002

-

RequestBody is null or empty.

-

Invalid request body.

-

Set the parameter by following the instructions in this guide.

-

401

-

ELB.1102

-

Token is error, Authentication required.

-

Invalid token.

-

Use a correct token that has not expired.

-

400

-

ELB.0002

-

LogTankRequestBody is null, request is invalid.

-

Invalid request body.

-

Set the parameter by following the instructions in this guide.

-

LoadbalancerId in requestBody is null.

-

loadbalancer_id in the request body is empty.

-

Set the parameter by following the instructions in this guide.

-

LoggroupId in requestBody is null.

-

log_group_id in the request body is empty.

-

Set the parameter by following the instructions in this guide.

-

LogtopicId in requestBody is null.

-

log_topic_id in the request body is empty.

-

Set the parameter by following the instructions in this guide.

-

403

-

ELB.9802

-

Policy doesn't allow elb:logtanks:create to be performed.

-

Permission verification failed.

-

Check whether you have the permission to perform this operation.

-

403

-

ELB.9803

-

Policy doesn't allow elb:loadbalancers:list to be performed.

-

etc.

-

Permission verification failed.

-

Check whether you have the permission to perform this operation.

-

403

-

ELB.9804

-

Policy doesn't allow elb:loadbalancers:list to be performed.

-

etc.

-

Permission verification failed.

-

Check whether you have the permission to perform this operation.

-

400

-

ELB.9899

-

The default_tls_container_ref field of the TERMINATED_HTTPS listener does not allow updating to null.

-

Parameter default_tls_container_ref cannot be left blank.

-

Rectify the fault based on the error information.

-

Certificate

-

400

-

ELB.1001

-

Request parameters invalid.

-

Invalid parameter.

-

Enter a valid parameter.

-

400

-

ELB.5010

-

The certificate URL contains more than four parts.

-

The certificate URL contains more than four parts.

-

Enter a valid certificate URL.

-

400

-

ELB.5020

-

The certificate ID must be 32 characters.

-

The certificate ID is not a 32-character string.

-

Enter a valid certificate ID.

-

400

-

ELB.5030

-

Incorrect certificate URL.

-

Incorrect certificate URL.

-

Enter a valid certificate URL.

-

404

-

ELB.5040

-

The certificate does not exist.

-

The certificate does not exist.

-

Ensure that the certificate exists.

-

400

-

ELB.5131

-

Failed to query the certificate quota.

-

Failed to query the certificate quota.

-

Contact customer service.

-

400

-

ELB.5141

-

Failed to query the user certificate quota.

-

Failed to query the used certificate quota.

-

Contact customer service.

-

400

-

ELB.5151

-

The certificate quantity exceeds the quota.

-

The quota has been used up.

-

Ensure that the quantity of certificates is less than the quota.

-

400

-

ELB.1011

-

Private_key or certificate content is not valid.

-

Invalid public or private key of the server certificate.

-

Enter a valid public or private key.

-

400

-

ELB.5051

-

CA certificate content is not valid.

-

Invalid CA certificate content.

-

Enter valid certificate content.

-

400

-

ELB.5002

-

Failed to delete the certificate.

-

Failed to delete the certificate.

-

Contact customer service.

-

400

-

ELB.5033

-

Failed to update certificate.

-

Failed to modify the certificate.

-

Contact customer service.

-

400

-

ELB.5013

-

Private_key or certificate content is not valid.

-

Invalid public or private key of the server certificate.

-

Enter a valid public or private key.

-

400

-

ELB.5053

-

CA certificate content is not valid.

-

Invalid CA certificate content.

-

Enter valid certificate content.

-

400

-

ELB.5004

-

Invalid search criteria.

-

Invalid query condition.

-

Ensure that the query condition is correct.

-

API version

-

404

-

ELB.1110

-

version not found.

-

The API version does not exist.

-

Contact customer service.

-
- - - - -Parent topic: Common Parameters - - - diff --git a/docs/elb/api-ref/elb_gc_1102.html b/docs/elb/api-ref/elb_gc_1102.html deleted file mode 100644 index 039e5b6af..000000000 --- a/docs/elb/api-ref/elb_gc_1102.html +++ /dev/null @@ -1,156 +0,0 @@ - - -

Status Codes

- - - - - - - - - - - - - - - - - - - -
Table 1 Normal status codes

Status Code

-

Message

-

Description

-

200

-

OK

-

Normal response to GET and PUT requests.

-

201

-

Created

-

Normal response to POST requests.

-

204

-

No Content

-

Normal response to DELETE requests.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Error codes

Status Code

-

Message

-

Description

-

400

-

Bad request

-

Malformed request URI or body.

-

Invalid admin _state_up value.

-

Invalid parameters.

-

Batch operations are not allowed.

-

Failed to verify the parameters.

-

The method is not allowed for the request body, for example, trying to update attributes that be specified only during creation.

-

The network is not external (the value of router:external is set to false).

-

The IaaS OpenStack network port has no floating IP address bound.

-

The requested floating IP address is not in the IP address range of the external network.

-

Invalid fixed IP address.

-

The router port does not have a fixed IP address.

-

The subnet for the router interface must have a gateway IP address.

-

401

-

Unauthorized

-

Authentication required.

-

403

-

Forbidden

-

The URI does not exist.

-

The resource cannot be found.

-

404

-

Not found

-

The URI does not exist.

-

The resource cannot be found.

-

The port UUID is not valid.

-

409

-

Conflict

-

The port is already in use.

-

The IP address is already in use.

-

The IP address pool cannot contain gateway and broadcast addresses.

-

The requested floating IP address is already in use.

-

The internal IaaS OpenStack network port and fixed IP address are already associated with another floating IP addresses.

-

500

-

Internal IaaS OpenStack network error.

-

Failed to assign the MAC address.

-

503

-

Service unavailable

-

Failed to assign the MAC address.

-
- - - - -Parent topic: Appendix - - - diff --git a/docs/elb/api-ref/elb_jd_0000.html b/docs/elb/api-ref/elb_jd_0000.html deleted file mode 100644 index c0758a14f..000000000 --- a/docs/elb/api-ref/elb_jd_0000.html +++ /dev/null @@ -1,29 +0,0 @@ - - -

Classic Load Balancer APIs

- - - - - diff --git a/docs/elb/api-ref/elb_jd_bg_0000.html b/docs/elb/api-ref/elb_jd_bg_0000.html deleted file mode 100644 index e3440b215..000000000 --- a/docs/elb/api-ref/elb_jd_bg_0000.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

API Version

- - - - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_jd_bg_0001.html b/docs/elb/api-ref/elb_jd_bg_0001.html deleted file mode 100644 index 3e4f3c585..000000000 --- a/docs/elb/api-ref/elb_jd_bg_0001.html +++ /dev/null @@ -1,184 +0,0 @@ - - -

Querying All API Versions

-

Function

This API is used to query all API versions of ELB.

- -

URI

GET /

- -

Request

- -

Response

- -

Status Code

- - - - -Parent topic: API Version - - - diff --git a/docs/elb/api-ref/elb_jd_bg_0002.html b/docs/elb/api-ref/elb_jd_bg_0002.html deleted file mode 100644 index 3fbf2000c..000000000 --- a/docs/elb/api-ref/elb_jd_bg_0002.html +++ /dev/null @@ -1,203 +0,0 @@ - - -

Querying a Specific API Version

-

Function

This API is used to query a specific ELB API version.

- -

URI

GET /{api_version}

- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Description

-

api_version

-

Yes

-

Specifies the API version.

-
- - - -

Request

- -

Response

- -

Status Code

- - - - -Parent topic: API Version - - - diff --git a/docs/elb/api-ref/elb_jd_cj_0000.html b/docs/elb/api-ref/elb_jd_cj_0000.html deleted file mode 100644 index d963a478a..000000000 --- a/docs/elb/api-ref/elb_jd_cj_0000.html +++ /dev/null @@ -1,172 +0,0 @@ - - -

Querying Monitoring Metrics

-

Function

This API is used to query all metrics at Layer 4 and Layer 7.

-

Only users can query these metrics.

- -

URI

GET /v1.0/{project_id}/elbaas/monitor

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request

- - -

Response

- - - - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_jd_fz_0000.html b/docs/elb/api-ref/elb_jd_fz_0000.html deleted file mode 100644 index 5db998bcc..000000000 --- a/docs/elb/api-ref/elb_jd_fz_0000.html +++ /dev/null @@ -1,25 +0,0 @@ - - -

Load Balancer

- - - - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_jd_fz_0001.html b/docs/elb/api-ref/elb_jd_fz_0001.html deleted file mode 100644 index da265f2be..000000000 --- a/docs/elb/api-ref/elb_jd_fz_0001.html +++ /dev/null @@ -1,283 +0,0 @@ - - -

Creating a Load Balancer

-

Function

This API is used to create a load balancer.

- -

URI

POST /v1.0/{project_id}/elbaas/loadbalancers

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- -

- -

Request

- - - -

Response

- -

Status Code

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/elb_jd_fz_0002.html b/docs/elb/api-ref/elb_jd_fz_0002.html deleted file mode 100644 index 0920597fc..000000000 --- a/docs/elb/api-ref/elb_jd_fz_0002.html +++ /dev/null @@ -1,142 +0,0 @@ - - -

Deleting a Load Balancer

-

Function

This API is used to delete a load balancer. If the load balancer is a public network load balancer, this API deletes the EIP bound to the load balancer.

- -

Constraints

For a public network load balancer, you need to delete the backend ECSs added to all listeners of the load balancer before deleting it.

- -

URI

DELETE /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-
- - -

Request

- - -

Response

- -

Status Code

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/elb_jd_fz_0003.html b/docs/elb/api-ref/elb_jd_fz_0003.html deleted file mode 100644 index a27e3aeee..000000000 --- a/docs/elb/api-ref/elb_jd_fz_0003.html +++ /dev/null @@ -1,144 +0,0 @@ - - -

Deleting a Public Network Load Balancer

-

Function

This API is used to delete a public network load balancer. The EIP bound to the load balancer will not be deleted. If you need to delete this IP address, refer to Deleting a Load Balancer.

- -

Constraints

Before deleting a public network load balancer, you must remove all backend ECSs from the listener. This API cannot be used to delete a private network load balancer.

- -

URI

DELETE /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}/keep-eip

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/elb_jd_fz_0004.html b/docs/elb/api-ref/elb_jd_fz_0004.html deleted file mode 100644 index 7c4a0533d..000000000 --- a/docs/elb/api-ref/elb_jd_fz_0004.html +++ /dev/null @@ -1,186 +0,0 @@ - - -

Modifying a Load Balancer

-

Function

This API is used to modify the name, description, bandwidth, and administrative status of a load balancer.

- -

URI

PUT /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-

name

-

No

-

String

-
  • Specifies the load balancer name.
  • The value can contain 1 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-).
-

description

-

No

-

String

-
  • Provides supplementary information about the load balancer.
  • The value contains 0 to 128 characters and cannot contain angle brackets (< and >).
-

bandwidth

-

No

-

Integer

-
  • Specifies the bandwidth (Mbit/s). This parameter is mandatory when type is set to External.
  • The value ranges from 1 to 500.

    (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.)

    -
-

admin_state_up

-

No

-

Integer/Boolean

-
  • Specifies the administrative status of the load balancer.
  • Optional values:

    0 or false: indicates that the load balancer is stopped. Only users are allowed to enter the two values.

    -

    1 or true: indicates that the load balancer is running properly.

    -

    2 or false: indicates that the load balancer is frozen. Only the administrator is allowed to enter the two values.

    -
-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/elb_jd_fz_0005.html b/docs/elb/api-ref/elb_jd_fz_0005.html deleted file mode 100644 index 19c1949a5..000000000 --- a/docs/elb/api-ref/elb_jd_fz_0005.html +++ /dev/null @@ -1,232 +0,0 @@ - - -

Querying Details of a Load Balancer

-

Function

This API is used to query details about a load balancer.

- -

URI

GET /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/elb_jd_hd_0000.html b/docs/elb/api-ref/elb_jd_hd_0000.html deleted file mode 100644 index 53a9e8e37..000000000 --- a/docs/elb/api-ref/elb_jd_hd_0000.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

Backend ECS

- - - - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_jd_hd_0001.html b/docs/elb/api-ref/elb_jd_hd_0001.html deleted file mode 100644 index 91d5c0cbb..000000000 --- a/docs/elb/api-ref/elb_jd_hd_0001.html +++ /dev/null @@ -1,164 +0,0 @@ - - -

Adding Backend ECSs

-

Function

This API is used to add backend ECSs to a listener for monitoring.

-

To add backend ECSs to a UDP listener, IP addresses can be pinged and UDP services must be enabled.

- -

URI

POST /v1.0/{project_id}/elbaas/listeners/{listener_id}/members

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-

server_id

-

Yes

-

String

-

Specifies the backend ECS ID.

-

address

-

Yes

-

String

-

Specifies the private IP address of the backend ECS.

-
- - -

Request

- - -

Response

- -

Status Code

- - - - -Parent topic: Backend ECS - - - diff --git a/docs/elb/api-ref/elb_jd_hd_0002.html b/docs/elb/api-ref/elb_jd_hd_0002.html deleted file mode 100644 index 6c3761dbf..000000000 --- a/docs/elb/api-ref/elb_jd_hd_0002.html +++ /dev/null @@ -1,179 +0,0 @@ - - -

Removing Backend ECSs

-

Function

This API is used to remove backend ECSs from a listener. Multiple backend ECSs can be removed concurrently.

- -

URI

POST /v1.0/{project_id}/elbaas/listeners/{listener_id}/members/action

- - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-

removeMember

-

Yes

-

Array

-

Lists the removed backend ECSs.

-
- - - - - - - - - - - - - - -
Table 2 removeMember parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

id

-

Yes

-

String

-

Specifies the backend ECS ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Backend ECS - - - diff --git a/docs/elb/api-ref/elb_jd_hd_0003.html b/docs/elb/api-ref/elb_jd_hd_0003.html deleted file mode 100644 index e8d076aef..000000000 --- a/docs/elb/api-ref/elb_jd_hd_0003.html +++ /dev/null @@ -1,272 +0,0 @@ - - -

Querying Backend ECSs

-

Function

This API is used to query backend ECSs added to a listener. If you are the administrator, the backend ECS list will be empty.

- -

URI

GET /v1.0/{project_id}/elbaas/listeners/{listener_id}/members?limit=10&marker=0

-

Enter a question mark (?) and an ampersand (&) at the end of the URI to define multiple search criteria. This API allows filtering backend ECSs by each parameter in the response message except listeners, server_name, update_time, and create_time.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-

marker

-

No

-

String

-

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

-

limit

-

No

-

Integer

-

Specifies the number of records on each page.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Backend ECS - - - diff --git a/docs/elb/api-ref/elb_jd_jk_0000.html b/docs/elb/api-ref/elb_jd_jk_0000.html deleted file mode 100644 index 5949dd8a6..000000000 --- a/docs/elb/api-ref/elb_jd_jk_0000.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

Health Check

- - - - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_jd_jk_0001.html b/docs/elb/api-ref/elb_jd_jk_0001.html deleted file mode 100644 index 613634089..000000000 --- a/docs/elb/api-ref/elb_jd_jk_0001.html +++ /dev/null @@ -1,308 +0,0 @@ - - -

Configuring a Health Check

-

Function

This API is used to configure a health check for backend ECSs.

- -

URI

POST /v1.0/{project_id}/elbaas/healthcheck

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

listener_id

-

Yes

-

String

-

Specifies the ID of the listener with which the health check is associated.

-

healthcheck_protocol

-

No

-

String

-
  • Specifies the health check protocol. A listener using UDP is not allowed for a private network load balancer.
  • The value can be HTTP, TCP, or UDP.
-

healthcheck_uri

-

No

-

String

-
  • Specifies the health check URI. This parameter is valid when healthcheck_protocol is HTTP.
  • The value can contain 1 to 80 characters that must start with a slash (/) and can contain only letters, digits, and special characters such as -/.%?#&_=
-

healthcheck_connect_port

-

No

-

Integer

-
  • Specifies the health check port.
  • The port number ranges from 1 to 65535.
-

healthy_threshold

-

No

-

Integer

-
  • Specifies the number of consecutive health checks when the health check result of a backend ECS changes from fail to success.
  • The value ranges from 1 to 10.
-

unhealthy_threshold

-

No

-

Integer

-
  • Specifies the number of consecutive health checks when the health check result of a backend ECS changes from success to fail.
  • The value ranges from 1 to 10.
-

healthcheck_timeout

-

No

-

Integer

-
  • Specifies the maximum time required for waiting for a response from the health check in the unit of second.
  • The value ranges from 1 to 50.
-

healthcheck_interval

-

No

-

Integer

-
  • Specifies the maximum time between health checks in the unit of second.
  • The value ranges from 1 to 50.
-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/elb_jd_jk_0002.html b/docs/elb/api-ref/elb_jd_jk_0002.html deleted file mode 100644 index a48fb3b27..000000000 --- a/docs/elb/api-ref/elb_jd_jk_0002.html +++ /dev/null @@ -1,113 +0,0 @@ - - -

Deleting a Health Check

-

Function

This API is used to delete a health check.

- -

URI

DELETE /v1.0/{project_id}/elbaas/healthcheck/{healthcheck_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

healthcheck_id

-

Yes

-

String

-

Specifies the health check ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/elb_jd_jk_0003.html b/docs/elb/api-ref/elb_jd_jk_0003.html deleted file mode 100644 index 491b0df6a..000000000 --- a/docs/elb/api-ref/elb_jd_jk_0003.html +++ /dev/null @@ -1,284 +0,0 @@ - - -

Modifying a Health Check

-

Function

This API is used to modify information about a health check.

- -

URI

PUT /v1.0/{project_id}/elbaas/healthcheck/{healthcheck_id}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

healthcheck_id

-

Yes

-

String

-

Specifies the health check ID.

-

healthcheck_protocol

-

No

-

String

-
  • Specifies the health check protocol.
  • The value can be HTTP or TCP (case-insensitive).
-

healthcheck_uri

-

No

-

String

-
  • Specifies the health check URI. This parameter is valid when healthcheck_protocol is HTTP.
  • The value can contain 1 to 80 characters that must start with a slash (/) and can contain only letters, digits, and special characters such as -/.%?#&_=
-

healthcheck_connect_port

-

No

-

Integer

-
  • Specifies the health check port.
  • The port number ranges from 1 to 65535.
-

healthy_threshold

-

No

-

Integer

-
  • Specifies the number of consecutive health checks when the health check result of a backend ECS changes from fail to success.
  • The value ranges from 1 to 10.
-

unhealthy_threshold

-

No

-

Integer

-
  • Specifies the number of consecutive health checks when the health check result of a backend ECS changes from success to fail.
  • The value ranges from 1 to 10.
-

healthcheck_timeout

-

No

-

Integer

-
  • Specifies the maximum time required for waiting for a response from the health check in the unit of second.
  • The value ranges from 1 to 50.
-

healthcheck_interval

-

No

-

Integer

-
  • Specifies the maximum time between health checks in the unit of second.
  • The value ranges from 1 to 50.
-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/elb_jd_jk_0004.html b/docs/elb/api-ref/elb_jd_jk_0004.html deleted file mode 100644 index 2a0b4c559..000000000 --- a/docs/elb/api-ref/elb_jd_jk_0004.html +++ /dev/null @@ -1,213 +0,0 @@ - - -

Querying Details of a Health Check

-

Function

This API is used to query details about a health check.

- -

URI

GET /v1.0/{project_id}/elbaas/healthcheck/{healthcheck_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

healthcheck_id

-

Yes

-

String

-

Specifies the health check ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/elb_jd_job_0000.html b/docs/elb/api-ref/elb_jd_job_0000.html deleted file mode 100644 index 59d45f0c9..000000000 --- a/docs/elb/api-ref/elb_jd_job_0000.html +++ /dev/null @@ -1,305 +0,0 @@ - - -

Querying the Job Status

-

Function

This API is used to query the job status, such as the execution status of creating or deleting a load balancer.

- -

URI

GET /v1.0/{project_id}/jobs/{job_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

job_id

-

Yes

-

String

-

Specifies the job ID.

-
- - -

Request

- - -

Response

- -

Status Code

- - - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_jd_jt_0000.html b/docs/elb/api-ref/elb_jd_jt_0000.html deleted file mode 100644 index 09a3361b9..000000000 --- a/docs/elb/api-ref/elb_jd_jt_0000.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Listener

- - - - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_jd_jt_0001.html b/docs/elb/api-ref/elb_jd_jt_0001.html deleted file mode 100644 index fc637f5c0..000000000 --- a/docs/elb/api-ref/elb_jd_jt_0001.html +++ /dev/null @@ -1,485 +0,0 @@ - - -

Adding a Listener

-

Function

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

- -

URI

POST /v1.0/{project_id}/elbaas/listeners

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

name

-

Yes

-

String

-
  • Specifies the listener name.
  • The value can contain 1 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-).
-

description

-

No

-

String

-
  • Provides supplementary information about the listener.
  • The value contains 0 to 128 characters and cannot contain angle brackets (< and >).
-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-

protocol

-

Yes

-

String

-
  • Specifies the protocol used by the listener.
  • The value can be HTTP, TCP, HTTPS, SSL, or UDP.
  • A UDP listener cannot be added to a private network load balancer.
-

port

-

Yes

-

Integer

-
  • Specifies the port used by the listener.
  • The port number ranges from 1 to 65535.
-

backend_protocol

-

Yes

-

String

-
  • Specifies the backend ECS protocol.

    If protocol is set to UDP, the value of this parameter can only be UDP.

    -

    If protocol is set to SSL, the value of this parameter can only be TCP.

    -
  • The value can be HTTP, TCP, or UDP.
-

backend_port

-

Yes

-

Integer

-
  • Specifies the port used by backend ECSs.
  • The port number ranges from 1 to 65535.
-

lb_algorithm

-

Yes

-

String

-
  • Specifies the load balancing algorithm.
  • The value can be roundrobin, leastconn, or source.
-

session_sticky

-

No

-

Boolean

-
  • Specifies whether to enable the sticky session feature.
  • The value can be true or false. The feature is enabled when the value is true.
  • If protocol is set to SSL, the sticky session feature is not supported and the parameter is invalid.
  • If protocol is set to HTTP, HTTPS, or TCP and lb_algorithm is not roundrobin, the value of this parameter can only be false.
-

sticky_session_type

-

No

-

String

-

Specifies where the cookie is from. The only value is insert, indicating that the cookie is inserted by the load balancer.

-
  • This parameter is valid when protocol is set to HTTP and session_sticky to true.
  • This parameter is invalid when protocol is set to TCP, SSL, or UDP, which means that the parameter is unavailable or its value is set to null.
-

cookie_timeout

-

No

-

Integer

-
  • Specifies the cookie timeout duration. This parameter is valid when protocol is set to HTTP, session_sticky to true, and sticky_session_type to insert. This parameter is invalid when protocol is set to TCP, SSL, or UDP.
  • The value ranges from 1 to 1440.
-

tcp_timeout

-

No

-

Integer

-
  • Specifies the TCP session timeout duration. This parameter is valid when protocol is set to TCP.
  • The value ranges from 1 to 1440.
-

tcp_draining

-

No

-

Boolean

-
  • Specifies whether to maintain TCP connections to a backend ECS that has been removed. This parameter is valid when protocol is set to TCP.
  • The value can be true or false.
-

tcp_draining_timeout

-

No

-

Integer

-
  • Specifies the timeout duration for maintaining TCP connections to a backend ECS that has been removed in the unit of minute.

    This parameter is valid when protocol is set to TCP and tcp_draining to true.

    -
  • The value ranges from 0 to 60.
-

certificate_id

-

No

-

String

-
  • Specifies the certificate ID. This parameter is mandatory when protocol is set to HTTPS or SSL.
  • The ID can be obtained from the certificate list.
-

certificates

-

No

-

String

-
  • Lists the certificate IDs if protocol is set to HTTPS.
  • This parameter is mandatory in the SNI scenario and is valid only when the load balancer is a public network load balancer.
-

udp_timeout

-

No

-

Integer

-
  • Specifies the UDP session timeout duration. This parameter is valid when protocol is set to UDP.
  • The value ranges from 1 to 1440.
-

ssl_protocols

-

No

-

String

-
  • Specifies the supported SSL/TLS protocol version. This parameter is available only when protocol is set to HTTPS or SSL.
  • The value can be TLS 1.2 or TLS 1.2 TLS 1.1 TLS 1.0, and the default value is TLS 1.2.
-

ssl_ciphers

-

No

-

String

-
  • Specifies the cipher suites supported by a specific SSL/TLS protocol version. This parameter is available only when protocol is set to HTTPS or SSL.
  • The value is Default, Extended, or Strict.

    The value of Default is ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256.

    -

    The value of Extended is ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA.

    -

    The value of Strict is ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256.

    -

    The default value is Default. When ssl_protocols is set to TLS 1.2 TLS 1.1 TLS 1.0, this parameter can only be set to Extended.

    -
-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_jd_jt_0002.html b/docs/elb/api-ref/elb_jd_jt_0002.html deleted file mode 100644 index 4646e6ede..000000000 --- a/docs/elb/api-ref/elb_jd_jt_0002.html +++ /dev/null @@ -1,113 +0,0 @@ - - -

Deleting a Listener

-

Function

This API is used to delete a listener.

- -

URI

DELETE /v1.0/{project_id}/elbaas/listeners/{listener_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_jd_jt_0003.html b/docs/elb/api-ref/elb_jd_jt_0003.html deleted file mode 100644 index be50937c7..000000000 --- a/docs/elb/api-ref/elb_jd_jt_0003.html +++ /dev/null @@ -1,428 +0,0 @@ - - -

Modifying a Listener

-

Function

This API is used to modify the listener information, including the listener name, description, and status.

- -

URI

PUT /v1.0/{project_id}/elbaas/listeners/{listener_id}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-

name

-

No

-

String

-
  • Specifies the listener name.
  • The value can contain 1 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-).
-

description

-

No

-

String

-
  • Provides supplementary information about the listener.
  • The value contains 0 to 128 characters and cannot contain angle brackets (< and >).
-

port

-

No

-

Integer

-
  • Specifies the port used by the listener.
  • The port number ranges from 1 to 65535.
-

backend_port

-

No

-

Integer

-
  • Specifies the port used by backend ECSs.
  • The port number ranges from 1 to 65535.
-

lb_algorithm

-

No

-

String

-
  • Specifies the load balancing algorithm.
  • The value can be roundrobin, leastconn, or source.
-

tcp_timeout

-

No

-

Integer

-
  • Specifies the TCP session timeout duration. This parameter is valid when protocol is set to TCP.
  • The value ranges from 1 to 1440.
-

tcp_draining

-

No

-

Boolean

-
  • Specifies whether to maintain TCP connections to a backend ECS that has been removed. This parameter is valid when protocol is set to TCP.
  • The value can be true or false.
-

tcp_draining_timeout

-

No

-

Integer

-
  • Specifies the timeout duration for maintaining TCP connections to a backend ECS that has been removed in the unit of minute.

    This parameter is valid when protocol is set to TCP and tcp_draining to true.

    -
  • The value ranges from 0 to 60.
-

udp_timeout

-

No

-

Integer

-
  • Specifies the UDP session timeout duration. This parameter is valid when protocol is set to UDP.
  • The value ranges from 1 to 1440.
-

ssl_protocols

-

No

-

String

-
  • Specifies the supported SSL/TLS protocol version. This parameter is available only when protocol is set to HTTPS or SSL.
  • The value can be TLS 1.2 or TLS 1.2 TLS 1.1 TLS 1.0, and the default value is TLS 1.2.
-

ssl_ciphers

-

No

-

String

-
  • Specifies the cipher suites supported by a specific SSL/TLS protocol version. This parameter is available only when protocol is set to HTTPS or SSL.
  • The value is Default, Extended, or Strict.

    The value of Default is ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256.

    -

    The value of Extended is ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA.

    -

    The value of Strict is ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256.

    -

    The default value is Default. When ssl_protocols is set to TLS 1.2 TLS 1.1 TLS 1.0, this parameter can only be set to Extended.

    -
-

certificate_id

-

No

-

String

-
  • Specifies the default certificate ID. This parameter is mandatory when protocol is set to HTTPS or SSL.
  • The ID can be obtained from the certificate list.
-

certificates

-

No

-

String

-
  • Lists the certificate IDs if protocol is set to HTTPS.
  • This parameter is mandatory in the SNI scenario.
  • This parameter is valid only when the load balancer is a public network load balancer.
-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_jd_jt_0004.html b/docs/elb/api-ref/elb_jd_jt_0004.html deleted file mode 100644 index 8406a216b..000000000 --- a/docs/elb/api-ref/elb_jd_jt_0004.html +++ /dev/null @@ -1,345 +0,0 @@ - - -

Querying Details of a Listener

-

Function

This API is used to query details about a listener.

- -

URI

GET /v1.0/{project_id}/elbaas/listeners/{listener_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_jd_jt_0005.html b/docs/elb/api-ref/elb_jd_jt_0005.html deleted file mode 100644 index ac4dbe3ca..000000000 --- a/docs/elb/api-ref/elb_jd_jt_0005.html +++ /dev/null @@ -1,350 +0,0 @@ - - -

Querying Listeners

-

Function

This API is used to query listeners using search criteria and display them in a list.

- -

URI

GET /v1.0/{project_id}/elbaas/listeners?loadbalancer_id={loadbalancer_id}

-

Enter a question mark (?) and an ampersand (&) at the end of the URI to define multiple search criteria. You can filter the listeners using the parameters in the response except update_time, create_time, admin_state_up, session_sticky, and member_number.

- - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

loadbalancer_id

-

No

-

String

-

Specifies the load balancer ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_jd_pe_0000.html b/docs/elb/api-ref/elb_jd_pe_0000.html deleted file mode 100644 index f59e49e64..000000000 --- a/docs/elb/api-ref/elb_jd_pe_0000.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Quota

- - - - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_jd_pe_0001.html b/docs/elb/api-ref/elb_jd_pe_0001.html deleted file mode 100644 index e6f5d3fa3..000000000 --- a/docs/elb/api-ref/elb_jd_pe_0001.html +++ /dev/null @@ -1,208 +0,0 @@ - - -

Querying Load Balancer or Listener Quotas

-

Function

This API is used to query the load balancer or listener quotas.

- -

URI

GET /v1.0/{project_id}/elbaas/quotas

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Quota - - - diff --git a/docs/elb/api-ref/elb_jd_zs_0000.html b/docs/elb/api-ref/elb_jd_zs_0000.html deleted file mode 100644 index 71d5c9464..000000000 --- a/docs/elb/api-ref/elb_jd_zs_0000.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

Certificate

- - - - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_jd_zs_0001.html b/docs/elb/api-ref/elb_jd_zs_0001.html deleted file mode 100644 index 3a22d4f01..000000000 --- a/docs/elb/api-ref/elb_jd_zs_0001.html +++ /dev/null @@ -1,237 +0,0 @@ - - -

Creating a Certificate

-

Function

This API is used to create a certificate for an HTTPS listener.

- -

URI

POST /v1.0/{project_id}/elbaas/certificate

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

name

-

No

-

String

-
  • Specifies the certificate name.
  • The value can contain 0 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-).
-

description

-

No

-

String

-
  • Provides supplementary information about the certificate.
  • The value contains a maximum of 128 characters and cannot contain angle brackets (< and >).
-

domain

-

No

-

String

-
  • Specifies the domain name associated with the server certificate.
  • The value can contain a maximum of 254 characters that consist of letters, digits, hyphens (-), and periods (.), and must start with uppercase letters or digits.
-

certificate

-

Yes

-

String

-
  • Specifies the certificate content.
  • The value is in PEM coding format.
-

private_key

-

Yes

-

String

-
  • Specifies the private key of the certificate.
  • The value is in PEM coding format.
-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/elb_jd_zs_0002.html b/docs/elb/api-ref/elb_jd_zs_0002.html deleted file mode 100644 index 3fb6c5c7b..000000000 --- a/docs/elb/api-ref/elb_jd_zs_0002.html +++ /dev/null @@ -1,113 +0,0 @@ - - -

Deleting a Certificate

-

Function

This API is used to delete a certificate.

- -

URI

DELETE /v1.0/{project_id}/elbaas/certificate/{certificate_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

certificate_id

-

Yes

-

String

-

Specifies the certificate ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/elb_jd_zs_0003.html b/docs/elb/api-ref/elb_jd_zs_0003.html deleted file mode 100644 index d0332c22b..000000000 --- a/docs/elb/api-ref/elb_jd_zs_0003.html +++ /dev/null @@ -1,210 +0,0 @@ - - -

Modifying a Certificate

-

Function

This API is used to modify the name and description of a certificate.

- -

URI

PUT /v1.0/{project_id}/elbaas/certificate/{certificate_id}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-

certificate_id

-

Yes

-

String

-

Specifies the certificate ID.

-

name

-

No

-

String

-
  • Specifies the certificate name.
  • The value can contain 0 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-).
-

description

-

No

-

String

-
  • Provides supplementary information about the certificate.
  • The value contains a maximum of 128 characters and cannot contain angle brackets (< and >).
-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/elb_jd_zs_0004.html b/docs/elb/api-ref/elb_jd_zs_0004.html deleted file mode 100644 index 3d86c5ceb..000000000 --- a/docs/elb/api-ref/elb_jd_zs_0004.html +++ /dev/null @@ -1,211 +0,0 @@ - - -

Querying Certificates

-

Function

This API is used to query all the certificates.

- -

URI

GET /v1.0/{project_id}/elbaas/certificate

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request

- - -

Response

- - -

Status Code

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/elb_pro_0000.html b/docs/elb/api-ref/elb_pro_0000.html new file mode 100644 index 000000000..1c45cd57f --- /dev/null +++ b/docs/elb/api-ref/elb_pro_0000.html @@ -0,0 +1,3 @@ + + +

API Usage Guidelines

diff --git a/docs/elb/api-ref/elb_xd_0000.html b/docs/elb/api-ref/elb_xd_0000.html deleted file mode 100644 index d8dfd3d61..000000000 --- a/docs/elb/api-ref/elb_xd_0000.html +++ /dev/null @@ -1,106 +0,0 @@ - - -

Change History

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Released On

-

Description

-

2021-07-27

-

Modified the following content:

-

Added fields and descriptions about idle timeout duration.

-

2021-06-10

-

Modified the following content:

-

Added fields and descriptions about session stickiness duration.

-

2021-06-08

-

This release incorporates the following changes:

-

Added notes in Tag to state that the APIs can also be used to add tags to or remove tags from dedicated load balancers or their listeners.

-

2021-05-28

-

This release incorporates the following changes:

-

Changed enhanced load balancer to shared load balancer.

-

2021-02-05

-

This release incorporates the following changes:

-

Added Dedicated Load Balancer APIs.

-

Added API Call Precaution.

-

Added API Call Precaution.

-

Added API Call Precaution.

-

2020-02-26

-

This release incorporates the following changes:

-

Added Tag.

-

2019-06-11

-

This release incorporates the following changes:

-

Changed the value descriptions of the tag key and value in section "Tag".

-

2019-05-16

-

This release incorporates the following changes:

-

Added parameter project_id in sections of enhanced load balancer APIs.

-

2019-03-20

-

This release incorporates the following changes:

-

Added parameters created_at and updated_at in sections related to enhanced load balancers and listeners.

-

2018-11-30

-

This release incorporates the following changes:

-

Added the sni_container_refs parameter for enhanced load balancer APIs.

-

2018-10-12

-

Added API Version.

-

2018-09-13

-

This release incorporates the following changes:

-

Added descriptions of parameters loadbalancer_id and listener_id in Load Balancer and Listener.

-

2018-08-30

-

This release incorporates the following changes:

-

Changed the full name of the service to Elastic Load Balancing.

-

2018-07-20

-

This release incorporates the following changes:

-

Modified the constraints for adding a listener using the IP protocol (or in DR mode).

-

2018-05-30

-

This issue is the first official release.

-
- - - diff --git a/docs/elb/api-ref/elb_zq_0000.html b/docs/elb/api-ref/elb_zq_0000.html deleted file mode 100644 index 1c946874d..000000000 --- a/docs/elb/api-ref/elb_zq_0000.html +++ /dev/null @@ -1,31 +0,0 @@ - - -

Shared Load Balancer APIs

- - - - - diff --git a/docs/elb/api-ref/elb_zq_bm_0000.html b/docs/elb/api-ref/elb_zq_bm_0000.html deleted file mode 100644 index 77c2ff1ed..000000000 --- a/docs/elb/api-ref/elb_zq_bm_0000.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Whitelist

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_bm_0001.html b/docs/elb/api-ref/elb_zq_bm_0001.html deleted file mode 100644 index 14553d967..000000000 --- a/docs/elb/api-ref/elb_zq_bm_0001.html +++ /dev/null @@ -1,192 +0,0 @@ - - -

Adding a Whitelist

-

Function

This API is used to add a whitelist to control access to a specific listener. After a whitelist is added, only IP addresses in the whitelist can access the listener.

- -

URI

POST /v2.0/lbaas/whitelists

- -

Request

- - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

whitelist

-

Yes

-

Object

-

Specifies the whitelist. For details, see Table 2.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 whitelist parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the whitelist is used.

-

-

The value must be the same as the value of project_id in the token.

-

The value contains a maximum of 255 characters.

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-

Only one whitelist can be created for a listener.

-

enable_whitelist

-

No

-

Boolean

-

Specifies whether to enable access control.

-

true: Access control is enabled.

-

false: Access control is disabled.

-

The default value is true.

-

whitelist

-

No

-

String

-

Specifies the IP addresses in the whitelist. Use commas (,) to separate multiple IP addresses.

-

You can specify an IP address, for example, 192.168.11.1.

-

You can also specify an IP address range, for example, 192.168.0.1/24.

-

The default value is an empty string, that is, "".

-
- - -

Response

- - - - - - - - - - -
Table 3 Response parameters

Parameter

-

Type

-

Description

-

whitelist

-

Object

-

Specifies the whitelist. For details, see Table 4.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 whitelist parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the whitelist ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the whitelist is used.

-

The value contains a maximum of 255 characters.

-

listener_id

-

String

-

Specifies the ID of the listener to which the whitelist is added.

-

enable_whitelist

-

Boolean

-

Specifies whether to enable access control.

-

true: Access control is enabled.

-

false: Access control is disabled.

-

whitelist

-

String

-

Specifies the IP addresses in the whitelist.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Whitelist - - - diff --git a/docs/elb/api-ref/elb_zq_bm_0002.html b/docs/elb/api-ref/elb_zq_bm_0002.html deleted file mode 100644 index 2f7506a4d..000000000 --- a/docs/elb/api-ref/elb_zq_bm_0002.html +++ /dev/null @@ -1,258 +0,0 @@ - - -

Querying Whitelists

-

Function

This API is used to query the whitelists. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query. Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v2.0/lbaas/whitelists

- -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the whitelist from which pagination query starts, that is, the ID of the last whitelist on the previous page.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of whitelists on each page. If this parameter is not set, all whitelists are queried by default.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

String

-

Specifies the whitelist ID.

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the whitelist is used.

-

The value contains a maximum of 255 characters.

-

listener_id

-

No

-

String

-

Specifies the ID of the listener to which the whitelist is added.

-

enable_whitelist

-

No

-

Boolean

-

Specifies whether to enable access control.

-

true: Access control is enabled.

-

false: Access control is disabled.

-

whitelist

-

No

-

String

-

Specifies the IP addresses in the whitelist.

-
- - -

Response

- - - - - - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

whitelists

-

Array

-

Lists the whitelists. For details, see Table 3.

-

whitelists_links

-

Array

-

Provides links to the previous or next page during pagination query, respectively.

-

This parameter exists only in the response body of pagination query.

-

For details, see Table 4.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 whitelist parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the whitelist ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the whitelist is used.

-

The value contains a maximum of 255 characters.

-

listener_id

-

String

-

Specifies the ID of the listener to which the whitelist is added.

-

enable_whitelist

-

Bool

-

Specifies whether to enable access control.

-

true: Access control is enabled.

-

false: Access control is disabled.

-

whitelist

-

String

-

Specifies the IP addresses in the whitelist.

-
- - - - - - - - - - - - - - - - -
Table 4 whitelists_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page.

-

The value can be next or previous. The value next indicates the href containing the URL of the next page, and previous indicates the href containing the URL of the previous page.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Whitelist - - - diff --git a/docs/elb/api-ref/elb_zq_bm_0003.html b/docs/elb/api-ref/elb_zq_bm_0003.html deleted file mode 100644 index 7cc6394d0..000000000 --- a/docs/elb/api-ref/elb_zq_bm_0003.html +++ /dev/null @@ -1,125 +0,0 @@ - - -

Querying Details of a Whitelist

-

Function

This API is used to query details about a whitelist using its ID.

- -

URI

GET /v2.0/lbaas/whitelists/{whitelist_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

whitelist_id

-

Yes

-

String

-

Specifies the whitelist ID.

-
- - -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

whitelist

-

Object

-

Specifies the whitelist. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 whitelist parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the whitelist ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding rule is used.

-

The value contains a maximum of 255 characters.

-

listener_id

-

String

-

Specifies the ID of the listener to which the whitelist is added.

-

enable_whitelist

-

Boolean

-

Specifies whether to enable access control.

-

true: Access control is enabled.

-

false: Access control is disabled.

-

whitelist

-

String

-

Specifies the IP addresses in the whitelist.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Whitelist - - - diff --git a/docs/elb/api-ref/elb_zq_bm_0004.html b/docs/elb/api-ref/elb_zq_bm_0004.html deleted file mode 100644 index 9d8d91500..000000000 --- a/docs/elb/api-ref/elb_zq_bm_0004.html +++ /dev/null @@ -1,192 +0,0 @@ - - -

Updating a Whitelist

-

Function

This API is used to update a whitelist. You can enable or disable the whitelist function or change IP addresses in the whitelist. If you change IP addresses in the whitelist, it will be deleted, and a new one is generated.

- -

URI

PUT /v2.0/lbaas/whitelists/{whitelist_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

whitelist_id

-

Yes

-

String

-

Specifies the whitelist ID.

-
- - -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

whitelist

-

Yes

-

Object

-

Specifies the whitelist. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - -
Table 3 whitelist parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

enable_whitelist

-

No

-

Boolean

-

Specifies whether to enable access control.

-

true: Access control is enabled.

-

false: Access control is disabled.

-

The default value is true.

-

whitelist

-

No

-

String

-

Specifies the IP addresses in the whitelist. Use commas (,) to separate multiple IP addresses.

-

You can specify an IP address, for example, 192.168.11.1.

-

You can also specify an IP address range, for example, 192.168.0.1/24.

-

The default value is an empty string, that is, "".

-
- - -

Response

- - - - - - - - - - -
Table 4 Parameter description

Parameter

-

Type

-

Description

-

whitelist

-

Object

-

Specifies the whitelist. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 whitelist parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the whitelist ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the whitelist is used.

-

The value contains a maximum of 255 characters.

-

listener_id

-

String

-

Specifies the ID of the listener to which the whitelist is added.

-

enable_whitelist

-

Boolean

-

Specifies whether to enable access control.

-

true: Access control is enabled.

-

false: Access control is disabled.

-

whitelist

-

String

-

Specifies the IP addresses in the whitelist.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Whitelist - - - diff --git a/docs/elb/api-ref/elb_zq_bm_0005.html b/docs/elb/api-ref/elb_zq_bm_0005.html deleted file mode 100644 index 01d3dee14..000000000 --- a/docs/elb/api-ref/elb_zq_bm_0005.html +++ /dev/null @@ -1,49 +0,0 @@ - - -

Deleting a Whitelist

-

Function

This API is used to delete a specific whitelist.

- -

URI

DELETE /v2.0/lbaas/whitelists/{whitelist_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

whitelist_id

-

Yes

-

String

-

Specifies the whitelist ID.

-
- - -

Request

None

- -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Whitelist - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0000.html b/docs/elb/api-ref/elb_zq_bq_0000.html deleted file mode 100644 index 9d0c53bab..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0000.html +++ /dev/null @@ -1,39 +0,0 @@ - - -

Tag

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0001.html b/docs/elb/api-ref/elb_zq_bq_0001.html deleted file mode 100644 index c29f56f55..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0001.html +++ /dev/null @@ -1,130 +0,0 @@ - - -

Adding a Tag to a Load Balancer

-

Function

This API is used to add a tag to a specific load balancer for easier management.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

A maximum of 20 tags can be added to a load balancer.

-Note the following when you add tags: - - -

URI

POST /v2.0/{project_id}/loadbalancers/{loadbalancer_id}/tags

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-

loadbalancer_id

-

Yes

-

String

-

Specifies the ID of the load balancer to which a tag is to be added.

-
- - -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tag

-

Yes

-

Object

-

Specifies the tag. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - -
Table 3 tag parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Specifies the tag key.

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

value

-

Yes

-

String

-

Specifies the tag value.

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

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0002.html b/docs/elb/api-ref/elb_zq_bq_0002.html deleted file mode 100644 index 1882c4db0..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0002.html +++ /dev/null @@ -1,166 +0,0 @@ - - -

Batch Adding or Deleting Load Balancer Tags

-

Function

This API is used to batch add tags to or delete tags from a load balancer.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

A maximum of 20 tags can be added to a load balancer.

-

This API is idempotent.

- - -

URI

POST /v2.0/{project_id}/loadbalancers/{loadbalancer_id}/tags/action

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-

loadbalancer_id

-

Yes

-

String

-

Specifies the ID of the load balancer to which tags are to be added or from which tags are to be deleted.

-
- - -

Request

- - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tags

-

Yes

-

Array

-

Lists the tags. For details, see Table 3.

-

action

-

Yes

-

String

-

Specifies the operation type.

-

The value can be one of the following:

-
  • create: adds tags to the load balancer.
  • delete: deletes tags from the load balancer.
-
- - - - - - - - - - - - - - - - - - - -
Table 3 tags parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Specifies the tag key.

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

value

-

Yes

-

String

-

Specifies the tag value.

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

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0003.html b/docs/elb/api-ref/elb_zq_bq_0003.html deleted file mode 100644 index f4ebfa8f2..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0003.html +++ /dev/null @@ -1,120 +0,0 @@ - - -

Querying All Tags of a Load Balancer

-

Function

This API is used to query all the tags of one load balancer.

-

You can also use this API for dedicated load balancers.

- - -

URI

GET /v2.0/{project_id}/loadbalancers/{loadbalancer_id}/tags

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-

loadbalancer_id

-

Yes

-

String

-

Specifies the ID of the load balancer whose tags are to be queried.

-
- - -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

tags

-

Array

-

Lists the tags. For details, see Table 3.

-
- - - - - - - - - - - - - - - - -
Table 3 tags parameter description

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

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

value

-

String

-

Specifies the tag value.

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

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0004.html b/docs/elb/api-ref/elb_zq_bq_0004.html deleted file mode 100644 index d0d8f6ab3..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0004.html +++ /dev/null @@ -1,117 +0,0 @@ - - -

Querying the Tags of All Load Balancers

-

Function

This API is used to query the tags of all the load balancers.

-

You can also use this API for dedicated load balancers.

- - -

URI

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

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-
- - -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

tags

-

Array

-

Lists the tags. For details, see Table 3.

-
- - - - - - - - - - - - - - - - -
Table 3 tags parameter description

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

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

values

-

Array

-

Lists the tag values.

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

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0005.html b/docs/elb/api-ref/elb_zq_bq_0005.html deleted file mode 100644 index 611d7a5e6..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0005.html +++ /dev/null @@ -1,352 +0,0 @@ - - -

Querying Load Balancers by Tag

-

Function

This API is used to query load balancers using tags.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

None

- -

URI

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

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-
- - -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tags

-

No

-

Array

-

Specifies the included tags. A maximum of 20 keys are allowed for each query operation, and each key can have a maximum of 20 values.

-

The tag key cannot be left blank or set to an empty string.

-

Each tag key and each tag value of the same tag key must be unique.

-

limit

-

No

-

Integer

-

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

-

offset

-

No

-

Integer

-

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

-

action

-

Yes

-

String

-

Identifies the operation. The value can be filter or count.

-

filter: indicates pagination query.

-

count: indicates that all load balancers meeting the search criteria will be returned.

-

matches

-

No

-

Array

-

Specifies the search criteria. The tag key is the parameter to match, for example, resource_name. value indicates the value of the match content. The key is a fixed dictionary value.

-

Currently, only resource_name can be used for search. For details, see Table 4.

-
- - - - - - - - - - - - - - - - - - - -
Table 3 tags parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Specifies the tag key. It contains a maximum of 127 Unicode characters and cannot be left blank. (This parameter is not verified in the search process.)

-

values

-

Yes

-

Array

-

Lists the tag values. Each tag value can contain a maximum of 255 Unicode characters. The values are in the OR relationship.

-

If no tag values in the list, the tag key is used for full search. If each value in the list starts with an asterisk (*), fuzzy match is performed based on the part after the asterisk.

-
- - - - - - - - - - - - - - - - - - - -
Table 4 matches parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Specifies the tag key for match.

-

The value can be one of the following:

-
  • resource_name: indicates the resource name.
-

value

-

Yes

-

String

-

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

-
- - -

Response

- - - - - - - - - - - - - - -
Table 5 Response parameters

Parameter

-

Type

-

Description

-

resources

-

Array

-

Lists the load balancers. For details, see Table 6.

-

total_count

-

Integer

-

Specifies the total number of queried records.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 resource parameter description

Parameter

-

Type

-

Description

-

resource_id

-

String

-

Specifies the resource ID.

-

resource_detail

-

Object

-

Specifies the resource details. The value is a resource object, used for extension. The value is left blank by default.

-

tags

-

Array

-

Lists the tags. If there is no tag, an empty array is used by default. For details, see Table 7.

-

resource_name

-

String

-

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

-

super_resource_id

-

String

-

Specifies the parent resource ID.

-
- - - - - - - - - - - - - - - - -
Table 7 tags parameter description

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key. It contains a maximum of 127 Unicode characters and cannot be left blank. (This parameter is not verified in the search process.)

-

value

-

String

-

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

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0006.html b/docs/elb/api-ref/elb_zq_bq_0006.html deleted file mode 100644 index 0bf15a81d..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0006.html +++ /dev/null @@ -1,63 +0,0 @@ - - -

Deleting a Tag from a Load Balancer

-

Function

This API is used to delete a tag with a specific key from a load balancer.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

None

- -

URI

DELETE /v2.0/{project_id}/loadbalancers/{loadbalancer_id}/tags/{key}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-

loadbalancer_id

-

Yes

-

String

-

Specifies the ID of the load balancer from which a tag is to be deleted.

-
- - -

Request

None

- -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0007.html b/docs/elb/api-ref/elb_zq_bq_0007.html deleted file mode 100644 index df577d80a..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0007.html +++ /dev/null @@ -1,129 +0,0 @@ - - -

Adding a Tag to a Listener

-

Function

This API is used to add a tag to a specific listener.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

- -

URI

POST /v2.0/{project_id}/listeners/{listener_id}/tags

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-

listener_id

-

Yes

-

String

-

Specifies the ID of the listener to which a tag is to be added.

-
- - -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tag

-

Yes

-

Object

-

Specifies the tag. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - -
Table 3 tag parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Specifies the tag key.

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

value

-

Yes

-

String

-

Specifies the tag value.

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

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0008.html b/docs/elb/api-ref/elb_zq_bq_0008.html deleted file mode 100644 index 41897c0ec..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0008.html +++ /dev/null @@ -1,165 +0,0 @@ - - -

Batch Adding or Deleting Listener Tags

-

Function

This API is used to batch add tags to or delete tags from a listener.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

- -

URI

POST /v2.0/{project_id}/listeners/{listener_id}/tags/action

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-

listener_id

-

Yes

-

String

-

Specifies the ID of the listener to which tags are to be added or from which tags are to be deleted.

-
- - -

Request

- - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tags

-

Yes

-

Array

-

Lists the tags. For details, see Table 3.

-

action

-

Yes

-

String

-

Specifies the operation identifier.

-

The value can be one of the following:

-
  • create: adds tags to the listener.
  • delete: deletes tags from the listener.
-
- - - - - - - - - - - - - - - - - - - -
Table 3 resource_tag parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Specifies the tag key.

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

value

-

Yes

-

String

-

Specifies the tag value.

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

Response

None

- -

Example Request

- - -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0009.html b/docs/elb/api-ref/elb_zq_bq_0009.html deleted file mode 100644 index 77433fa1b..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0009.html +++ /dev/null @@ -1,122 +0,0 @@ - - -

Querying All Tags of a Listener

-

Function

This API is used to query all tags of one listener.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

None

- -

URI

GET /v2.0/{project_id}/listeners/{listener_id}/tags

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-

listener_id

-

Yes

-

String

-

Specifies the ID of the listener whose tags are to be queried.

-
- - -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

tags

-

Array

-

Lists the tags. For details, see Table 3.

-
- - - - - - - - - - - - - - - - -
Table 3 tags parameter description

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

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

value

-

String

-

Specifies the tag value.

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

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0010.html b/docs/elb/api-ref/elb_zq_bq_0010.html deleted file mode 100644 index 7c4e58619..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0010.html +++ /dev/null @@ -1,120 +0,0 @@ - - -

Querying the Tags of All Listeners

-

Function

This API is used to query the tags of all listeners.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

None

- -

URI

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

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-
- - -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

tags

-

Array

-

Lists the tags, which are aggregated by the tag key. For details, see Table 3.

-

For example, if you have two listeners, the tag key of both listeners is "test", the tag value of listener A is "value1", and the tag value of listener B is "value2", two tags are queried, the key of both tags is "test", and the tag values are ["value1","value2"].

-
- - - - - - - - - - - - - - - - -
Table 3 tags parameter description

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key.

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

values

-

Array

-

Lists the tag values.

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

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0011.html b/docs/elb/api-ref/elb_zq_bq_0011.html deleted file mode 100644 index 3a3f71c98..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0011.html +++ /dev/null @@ -1,350 +0,0 @@ - - -

Querying Listeners by Tag

-

Function

This API is used to query listeners by tag.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

None

- -

URI

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

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

-
- - -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tags

-

No

-

Array

-

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

-

limit

-

No

-

Integer

-

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

-

offset

-

No

-

Integer

-

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

-

action

-

Yes

-

String

-

Identifies the operation. The value can be filter or count.

-
  • filter: indicates pagination query.
  • count: indicates that all listeners meeting the search criteria will be returned.
-

matches

-

No

-

Array

-

Specifies the search criteria. The tag key is the parameter to match, for example, resource_name. value indicates the value of the match content. The key is a fixed dictionary value.

-

Determine whether fuzzy match is required based on different parameters. For example, if the key is resource_name, fuzzy search is used by default. If value is an empty string, exact match is used. If the key is resource_id, exact match is used. Currently, only resource_name can be used for search. For details, see Table 4.

-
- - - - - - - - - - - - - - - - - - - -
Table 3 tags parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Specifies the tag key. It contains a maximum of 127 Unicode characters and cannot be left blank. (This parameter is not verified in the search process.)

-

values

-

Yes

-

Array

-

Lists the tag values. Each tag value can contain a maximum of 255 Unicode characters. The values are in the OR relationship.

-
- - - - - - - - - - - - - - - - - - - -
Table 4 matches parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Specifies the tag key.

-

The value can be one of the following:

-
  • resource_name: indicates the resource name.
-

value

-

Yes

-

String

-

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

-
- - -

Response

- - - - - - - - - - - - - - -
Table 5 Response parameters

Parameter

-

Type

-

Description

-

resources

-

Array

-

Lists the listeners. For details, see Table 6.

-

total_count

-

Integer

-

Specifies the total number of queried records.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 resource parameter description

Parameter

-

Type

-

Description

-

resource_id

-

String

-

Specifies the resource ID.

-

resource_detail

-

Object

-

Specifies the resource details. The value is a resource object, used for extension. The value is left blank by default.

-

tags

-

Array

-

Lists the tags. If there is no tag, an empty array is used by default. For details, see Table 7.

-

resource_name

-

String

-

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

-

super_resource_id

-

String

-

Specifies the parent resource ID.

-
- - - - - - - - - - - - - - - - -
Table 7 tags parameter description

Parameter

-

Type

-

Description

-

key

-

String

-

Specifies the tag key. It contains a maximum of 127 Unicode characters and cannot be left blank. (This parameter is not verified in the search process.)

-

value

-

String

-

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

-
- - -

Example Request

- - -

Example Response

- - -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0012.html b/docs/elb/api-ref/elb_zq_bq_0012.html deleted file mode 100644 index 8885530c9..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0012.html +++ /dev/null @@ -1,62 +0,0 @@ - - -

Deleting a Tag from a Listener

-

Function

This API is used to delete a tag with a specific key from a listener.

-

You can also use this API for dedicated load balancers.

- - -

Constraints

None

- -

URI

DELETE /v2.0/{project_id}/listeners/{listener_id}/tags/{key}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the ID of the project where the tag is used.

-

listener_id

-

Yes

-

String

-

Specifies the ID of the listener from which a tag is to be deleted.

-
- - -

Request

None

- -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0013.html b/docs/elb/api-ref/elb_zq_bq_0013.html deleted file mode 100644 index 9fbe8b2cb..000000000 --- a/docs/elb/api-ref/elb_zq_bq_0013.html +++ /dev/null @@ -1,252 +0,0 @@ - - -

Status Codes

- - - - - - - - - - - - - - - -
Table 1 Normal codes

Status Code

-

Message

-

Description

-

200

-

OK

-

Specifies the normal response code for the GET operation.

-

This code is returned when a response body is returned for the POST operation.

-

204

-

No Content

-

Specifies the normal response code for the DELETE operation.

-

This code is returned when no response body is returned for the POST operation.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Error codes

Status Code

-

Error Code

-

Description

-

Error Message

-

Measure

-

400

-

VPC.1801

-

The ID is incorrect.

-

resource id is invalid/Getting id is invalid.

-

Use a correct resource ID.

-

400

-

VPC.1801

-

An action error occurs.

-

action is invalid.

-

Ensure that the value of action is create or delete.

-

400

-

VPC.1801

-

The key length is invalid.

-

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

-

Input a valid key.

-

400

-

VPC.0007

-

The project ID is incorrect.

-

urlTenantId is not equal token TenantId.

-

Check the project ID.

-

401

-

VPC.0008

-

The token in the request is invalid or the request does not contain the token.

-

Invalid token in the header./Authorization information is wrong.

-

Check whether the token is valid.

-

400

-

VPC.1801

-

The value length is invalid.

-

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

-

Input a valid value.

-

400

-

VPC.1801

-

The key or value contains invalid characters.

-

InvalidInput/Tag value xxx is invalid.

-

Check the validity of the key or value.

-

400

-

VPC.1801

-

The key or value is left blank.

-

Tag xxx can not be null.

-

Check whether the key or value is left blank.

-

400

-

VPC.1801

-

The tag is null.

-

Tag can not be null.

-

Check whether the tag is null.

-

400

-

VPC.1801

-

A resource type error occurs.

-

Resource xxx is invalid.

-

Ensure that the value of resource_type is loadbalancers or listeners.

-

400

-

VPC.1801

-

The total number of tags added at a time exceeds 10.

-

number of tags exceeds max unm of 10.

-

Reduce the number of tags.

-

400

-

VPC.1814

-

The total number of existing tags and newly added tags exceeds 10.

-

Invalid input for operation: resource_id: XXXX, number of tags exceed max num of 10.

-

Reduce the number of tags.

-

400

-

VPC.1814

-

The key values of newly added tags are duplicate.

-

Invalid input for operation: tags key is duplicated.

-

Change the tag values.

-

400

-

VPC.1814

-

The resource ID does not exist.

-

Resource XXX XXX could not be found.

-

Check whether the resource is available.

-

400

-

VPC.1814

-

The specified key to be deleted does not exist, or the key is an empty string.

-

The resource could not be found.

-

Enter a correct key and send the request again.

-

400

-

VPC.1814

-

More than 10 tags are added to a specified resource.

-

Invalid input for operation:resource_id:xxx, number of tags exceeds max num of 10.

-

Each resource supports up to 10 tags.

-

400

-

VPC.1801

-

Tags are duplicate.

-

Tag key is repeated.

-

Delete duplicate tags and resend the request.

-

500

-

-

-

The request format is incorrect.

-

Internal Server Error.

-

Use the correct request body format.

-
- - - - -Parent topic: Tag - - - diff --git a/docs/elb/api-ref/elb_zq_fz_0000.html b/docs/elb/api-ref/elb_zq_fz_0000.html deleted file mode 100644 index f6130b506..000000000 --- a/docs/elb/api-ref/elb_zq_fz_0000.html +++ /dev/null @@ -1,25 +0,0 @@ - - -

Load Balancer

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_fz_0002.html b/docs/elb/api-ref/elb_zq_fz_0002.html deleted file mode 100644 index c0ca04b53..000000000 --- a/docs/elb/api-ref/elb_zq_fz_0002.html +++ /dev/null @@ -1,526 +0,0 @@ - - -

Querying Load Balancers

-

Function

This API is used to query load balancers and display them in a list. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query. Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v2.0/lbaas/loadbalancers

- -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the load balancer from which pagination query starts, that is, the ID of the last load balancer on the previous page.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of load balancers on each page.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

tenant_id

-

No

-

String

-

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

-

-

id

-

No

-

String

-

Specifies the load balancer ID.

-

description

-

No

-

String

-

Provides supplementary information about the load balancer.

-

The value contains a maximum of 255 characters.

-

name

-

No

-

String

-

Specifies the load balancer name.

-

The value contains a maximum of 255 characters.

-

operating_status

-

No

-

String

-

This parameter is reserved, and its value can only be ONLINE.

-

It specifies the operating status of the load balancer.

-

provisioning_status

-

No

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the load balancer.

-

admin_state_up

-

No

-

Boolean

-

This parameter is reserved, and its value can only be true.

-

It specifies the administrative status of the load balancer.

-

vip_address

-

No

-

String

-

Specifies the private IP address of the load balancer.

-

The value contains a maximum of 64 characters.

-

vip_port_id

-

No

-

String

-

Specifies the ID of the port bound to the private IP address of the load balancer.

-

vip_subnet_id

-

No

-

String

-

Specifies the ID of the subnet where the load balancer works.

-

member_address

-

No

-

String

-

Specifies the IP address of the backend server associated with the load balancer.

-

member_device_id

-

No

-

String

-

Specifies the ID of the cloud server used as the backend server associated with the load balancer.

-

vpc_id

-

No

-

String

-

Specifies the ID of the VPC where the load balancer works.

-
- - -

Response

- - - - - - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

loadbalancers

-

Array

-

Lists the load balancers. For details, see Table 3.

-

loadbalancers_links

-

Array

-

Provides links to the previous or next page during pagination query, respectively. This parameter exists only in the response body of pagination query. For details, see Table 6.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 loadbalancer parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-

tenant_id

-

String

-

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

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the load balancer name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the load balancer.

-

The value contains a maximum of 255 characters.

-

vip_subnet_id

-

String

-

Specifies the ID of the subnet where the load balancer works.

-

vip_port_id

-

String

-

Specifies the ID of the port bound to the private IP address of the load balancer.

-

When you create a load balancer, the system automatically creates a port and associates it with a security group. However, the security group will not take effect.

-

provider

-

String

-

Specifies the provider of the load balancer.

-

vip_address

-

String

-

Specifies the private IP address of the load balancer.

-

The value contains a maximum of 64 characters.

-

listeners

-

Array

-

Lists the IDs of listeners added to the load balancer. For details, see Table 4.

-

pools

-

Array

-

Lists the IDs of backend server groups associated with the load balancer. For details, see Table 5.

-

operating_status

-

String

-

This parameter is reserved, and its value can only be ONLINE.

-

It specifies the operating status of the load balancer.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the load balancer.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the load balancer.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

tags

-

Array

-

Lists load balancer tags.

-

created_at

-

String

-

Specifies the time when the load balancer was created.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-

updated_at

-

String

-

Specifies the time when the load balancer was updated.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-
- - - - - - - - - - - - -
Table 4 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated listener.

-
- - - - - - - - - - - - -
Table 5 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - - - - - - - - - - - - - - - -
Table 6 loadbalancers_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page.

-

The value can be next or previous. The value next indicates the Hypertext Reference (href) containing the URL of the next page, and previous indicates the href containing the URL of the previous page.

-
- - -

Example Request

- -

Example Response

- - -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/elb_zq_fz_0004.html b/docs/elb/api-ref/elb_zq_fz_0004.html deleted file mode 100644 index 6f313e745..000000000 --- a/docs/elb/api-ref/elb_zq_fz_0004.html +++ /dev/null @@ -1,498 +0,0 @@ - - -

Querying the Status Tree of a Load Balancer

-

Function

This API is used to query the status tree of a load balancer. You can use this API to query details about the associated listeners, backend server groups, backend servers, health checks, forwarding policies, and forwarding rules, helping you understand the topology of resources associated with the load balancer.

- -

URI

GET /v2.0/lbaas/loadbalancers/{loadbalancer_id}/statuses

- - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-
- -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

statuses

-

Object

-

Specifies the status tree of a load balancer. For details, see Table 3.

-
- - - - - - - - - - - - -
Table 3 statuses parameter description

Parameter

-

Type

-

Description

-

loadbalancer

-

Object

-

Specifies the load balancer. For details, see Table 4.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 loadbalancer parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-

name

-

String

-

Specifies the load balancer name.

-

The value contains a maximum of 255 characters.

-

listeners

-

Array

-

Lists the listeners added to the load balancer. For details of this parameter, see Table 5.

-

pools

-

Array

-

Lists the backend server groups associated with the load balancer. For details of this parameter, see Table 6.

-

operating_status

-

String

-

This field is reserved.

-

It specifies the operating status of the load balancer. The value can be one of the following:

-
  • ONLINE (default): The load balancer is running normally.
  • DEGRADED: This status is displayed only when provisioning_status of a forwarding policy or forwarding rule added to a listener of the load balancer is set to ERROR and the API for querying the load balancer status tree is called.
  • DISABLED: This status is displayed only when admin_state_up of the load balancer is set to false and the API for querying the load balancer status tree is called.
-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the load balancer.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-

name

-

String

-

Specifies the listener name.

-

l7policies

-

Array

-

Lists associated forwarding policies. For details of this parameter, see Table 9.

-

pools

-

Array

-

Lists the backend server groups associated with the listener. For details of this parameter, see Table 6.

-

operating_status

-

String

-

This parameter is reserved, and its value can only be ONLINE.

-

It specifies the operating status of the listener.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the listener.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-

name

-

String

-

Specifies the name of the backend server group.

-

healthmonitor

-

Object

-

Provides health check details of the backend server group. For details of this parameter, see Table 7.

-

members

-

Array

-

Lists the members contained in the backend server group. For details of this parameter, see Table 8.

-

operating_status

-

String

-

This parameter is reserved, and its value can only be ONLINE.

-

It specifies the operating status of the backend server group.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the backend server group.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 healthmonitor parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the health check ID.

-

name

-

String

-

Specifies the health check name.

-

type

-

String

-
  • Specifies the health check protocol.
  • The value can be UDP_CONNECT, TCP, or HTTP.
-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the health check.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 8 members parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

-

address

-

String

-

Specifies the private IP address of the backend server, for example, 192.168.3.11.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server. The port number ranges from 0 to 65535.

-

operating_status

-

String

-

This parameter is reserved. It specifies the operating status of the backend server. The value can be one of the following:

-
  • ONLINE: The backend server is running normally.
  • NO_MONITOR: No health check is configured for the backend server group that the backend server belongs to.
  • DISABLED: The backend server is not available. This status is displayed only when admin_state_up of the backend server, or the backend server group to which it belongs, or the associated load balancer is set to false and the API for querying the load balancer status tree is called.
  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.
- NOTE:

When admin_state_up is set to false and operating_status is set to OFFLINE for a backend server, DISABLED is returned for operating_status of the backend server in the response of this API.

- -

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the backend server.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 l7policies parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding policy ID.

-

name

-

String

-

Specifies the forwarding policy name.

-

rules

-

Array

-

Lists the forwarding rules of the forwarding policy. For details of this parameter, see Table 10.

-

action

-

String

-
  • Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.
  • The value can be REDIRECT_TO_POOL or REDIRECT_TO_LISTENER.
    • REDIRECT_TO_POOL: Requests are forwarded to another backend server group.
    • REDIRECT_TO_LISTENER: Requests are redirected to an HTTPS listener.
    -
-

provisioning_status

-

String

-

This parameter is reserved.

-

It specifies the provisioning status of the forwarding policy. Value options:

-
  • ACTIVE (default): The forwarding policy is normal.
  • ERROR: Another forwarding policy of the same listener has the same forwarding rule.
-
- - - - - - - - - - - - - - - - - - - - -
Table 10 rules parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding rule ID.

-

type

-

String

-
  • Specifies the match type of a forwarding rule.
  • The value can be PATH or HOST_NAME.
    • PATH: matches the path in the request.
    • HOST_NAME: matches the domain name in the request.
    -
-

provisioning_status

-

String

-

This parameter is reserved.

-

It specifies the provisioning status of the forwarding rule. The value can be one of the following:

-
  • ACTIVE (default): The forwarding rule is normal.
  • ERROR: Another forwarding policy of the same listener has the same forwarding rule.
-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/elb_zq_fz_0005.html b/docs/elb/api-ref/elb_zq_fz_0005.html deleted file mode 100644 index 20c19f308..000000000 --- a/docs/elb/api-ref/elb_zq_fz_0005.html +++ /dev/null @@ -1,343 +0,0 @@ - - -

Updating a Load Balancer

-

Function

This API is used to update the name or description of a load balancer.

- -

URI

PUT /v2.0/lbaas/loadbalancers/{loadbalancer_id}

- - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-
- -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

loadbalancer

-

Yes

-

Object

-

Specifies the load balancer. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 loadbalancer parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the load balancer name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the load balancer.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the load balancer.

-

This parameter is reserved. The default value is true.

-
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

loadbalancer

-

Object

-

Specifies the load balancer. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 loadbalancer parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-

tenant_id

-

String

-

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

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the load balancer name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the load balancer.

-

The value contains a maximum of 255 characters.

-

vip_subnet_id

-

String

-

Specifies the ID of the subnet where the load balancer works.

-

vip_port_id

-

String

-

Specifies the ID of the port bound to the private IP address of the load balancer.

-

When you create a load balancer, the system automatically creates a port and associates it with a security group. However, the security group will not take effect.

-

provider

-

String

-

Specifies the provider of the load balancer.

-

vip_address

-

String

-

Specifies the private IP address of the load balancer.

-

The value contains a maximum of 64 characters.

-

listeners

-

Array

-

Lists the IDs of listeners added to the load balancer. For details, see Table 6.

-

pools

-

Array

-

Lists the IDs of backend server groups associated with the load balancer. For details, see Table 7.

-

operating_status

-

String

-

This parameter is reserved, and its value can only be ONLINE.

-

It specifies the operating status of the load balancer.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the load balancer.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the load balancer.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

tags

-

Array

-

Lists load balancer tags.

-

created_at

-

String

-

Specifies the time when the load balancer was created.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-

updated_at

-

String

-

Specifies the time when the load balancer was updated.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-
- - - - - - - - - - - - -
Table 6 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated listener.

-
- - - - - - - - - - - - -
Table 7 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/elb_zq_fz_0006.html b/docs/elb/api-ref/elb_zq_fz_0006.html deleted file mode 100644 index ba33f74d5..000000000 --- a/docs/elb/api-ref/elb_zq_fz_0006.html +++ /dev/null @@ -1,51 +0,0 @@ - - -

Deleting a Load Balancer

-

Function

This API is used to delete a specific load balancer.

- -

Constraints

All listeners added to the load balancer must be deleted before the load balancer is deleted.

- -

URI

DELETE /v2.0/lbaas/loadbalancers/{loadbalancer_id}

- - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

loadbalancer_id

-

Yes

-

String

-

Specifies the load balancer ID.

-
- -

Request

None

- -

Response

None

- -

Example Request

Example request: Deleting a load balancer
DELETE https://{endpoint}/v2.0/lbaas/loadbalancers/90f7c765-0bc9-47c4-8513-4cc0c264c8f8
- - -

Example Response

Example response

-

None

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/elb_zq_hd_0000.html b/docs/elb/api-ref/elb_zq_hd_0000.html deleted file mode 100644 index 7ef87dd31..000000000 --- a/docs/elb/api-ref/elb_zq_hd_0000.html +++ /dev/null @@ -1,27 +0,0 @@ - - -

Backend Server

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_hd_0001.html b/docs/elb/api-ref/elb_zq_hd_0001.html deleted file mode 100644 index 04882b53f..000000000 --- a/docs/elb/api-ref/elb_zq_hd_0001.html +++ /dev/null @@ -1,325 +0,0 @@ - - -

Adding a Backend Server

-

Function

This API is used to add a backend server to a specific backend server group. After a backend server group is added to a listener, traffic is distributed to backend servers in this server group using the specified load balancing algorithm.

- -

Constraints

Two backend servers in a backend server group cannot have the same private IP address or port number.

-

The subnet specified during server creation must be in the same VPC as the subnet from which the private IP address of the load balancer is assigned.

- -

URI

POST /v2.0/lbaas/pools/{pool_id}/members

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-
- - -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

member

-

Yes

-

Object

-

Specifies the backend server. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 member parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the backend server is used.

-

-

The value must be the same as the value of project_id in the token.

-

The value contains a maximum of 255 characters.

-

name

-

No

-

String

-

Specifies the backend server name. The value is an empty character string by default.

-

The value contains a maximum of 255 characters.

-

address

-

Yes

-

String

-

Specifies the private IP address of the backend server. This IP address must be in the subnet specified by subnet_id.

-

This parameter can be set only to the IP address of the primary NIC, for example, 192.168.3.11.

-

The value contains a maximum of 64 characters.

-

protocol_port

-

Yes

-

Integer

-

Specifies the port used by the backend server. The port number ranges from 1 to 65535.

-

subnet_id

-

Yes

-

String

-

Specifies the ID of the subnet where the backend server works.

-

The private IP address of the backend server is in this subnet.

-

Only IPv4 subnets are supported.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server.

-

This parameter is reserved, and the default value is true.

-

weight

-

No

-

Integer

-

Specifies the backend server weight. The value ranges from 0 to 100.

-

If the value is 0, the backend server will not accept new requests. The default value is 1.

-
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

member

-

Object

-

Specifies the backend server. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 member parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

- NOTE:

The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.

- -

tenant_id

-

String

-

Specifies the ID of the project where the backend server is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the backend server name.

-

The value contains a maximum of 255 characters.

-

address

-

String

-

Specifies the private IP address of the backend server. This IP address must be in the subnet specified by subnet_id.

-

This parameter can be set only to the IP address of the primary NIC, for example, 192.168.3.11.

-

The value contains a maximum of 64 characters.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server. The port number ranges from 1 to 65535.

-

subnet_id

-

String

-

Specifies the ID of the subnet where the backend server works. The private IP address of the backend server is in this subnet.

-

IPv6 subnets are not supported.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

weight

-

Integer

-

Specifies the backend server weight. The value ranges from 0 to 100.

-

If the value is 0, the backend server will not accept new requests. The default value is 1.

-

operating_status

-

String

-

Specifies the health check result of the backend server. The value can be one of the following:

-
  • ONLINE: The backend server is running normally.
  • NO_MONITOR: No health check is configured for the backend server group that the backend server belongs to.
  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.
-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/elb_zq_hd_0002.html b/docs/elb/api-ref/elb_zq_hd_0002.html deleted file mode 100644 index ec96ea0e9..000000000 --- a/docs/elb/api-ref/elb_zq_hd_0002.html +++ /dev/null @@ -1,345 +0,0 @@ - - -

Querying Backend Servers

-

Function

This API is used to query backend servers in a specific backend server group. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query. Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v2.0/lbaas/pools/{pool_id}/members

- - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-
- -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the backend server from which pagination query starts, that is, the ID of the last backend server on the previous page. If this parameter is not specified, the first page will be queried.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of backend servers on each page. If this parameter is not set, all backend servers are queried by default.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

String

-

Specifies the backend server ID.

- NOTE:

The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.

- -

tenant_id

-

No

-

String

-

Specifies the ID of the project where the backend server is used.

-

The value contains a maximum of 255 characters.

-

-

name

-

No

-

String

-

Specifies the backend server name.

-

The value contains a maximum of 255 characters.

- NOTE:

The value of this parameter is not the name of server. It is the name automatically generated for the backend server associated with the load balancer.

- -

address

-

No

-

String

-

Specifies the private IP address of the backend server.

-

The value contains a maximum of 64 characters.

-

protocol_port

-

No

-

Integer

-

Specifies the port used by the backend server.

-

subnet_id

-

No

-

String

-

Specifies the ID of the subnet where the backend server works.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server.

-

This parameter is reserved, and the default value is true.

-

weight

-

No

-

Integer

-

Specifies the backend server weight.

-
- - -

Response

- - - - - - - - - - - - - - -
Table 3 Response parameters

Parameter

-

Type

-

Description

-

members

-

Array

-

Lists the backend servers in the backend server group. For details, see Table 4.

-

members_links

-

Array

-

Provides links to the previous or next page during pagination query, respectively.

-

This parameter exists only in the response body of pagination query. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 members parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

- NOTE:

The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.

- -

tenant_id

-

String

-

Specifies the ID of the project where the backend server is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the backend server name.

-

The value contains a maximum of 255 characters.

-

address

-

String

-

Specifies the private IP address of the backend server. This IP address must be in the subnet specified by subnet_id.

-

This parameter can be set only to the IP address of the primary NIC, for example, 192.168.3.11.

-

The value contains a maximum of 64 characters.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server. The port number ranges from 1 to 65535.

-

subnet_id

-

String

-

Specifies the ID of the subnet where the backend server works. The private IP address of the backend server is in this subnet.

-

IPv6 subnets are not supported.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

weight

-

Integer

-

Specifies the backend server weight. The value ranges from 0 to 100.

-

If the value is 0, the backend server will not accept new requests. The default value is 1.

-

operating_status

-

String

-

Specifies the operating status of the load balancer. This parameter is reserved, and its value can only be ONLINE.

-
- - - - - - - - - - - - - - - - -
Table 5 members_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page. The value can be next or previous.

-
  • next: indicates the URL of the next page.
  • previous: indicates the URL of the previous page.
-
- - -

Example Request

- - -

Example Response

- - -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/elb_zq_hd_0003.html b/docs/elb/api-ref/elb_zq_hd_0003.html deleted file mode 100644 index 0ad525adc..000000000 --- a/docs/elb/api-ref/elb_zq_hd_0003.html +++ /dev/null @@ -1,177 +0,0 @@ - - -

Querying Details of a Backend Server

-

Function

This API is used to query details about a backend server.

- -

URI

GET /v2.0/lbaas/pools/{pool_id}/members/{member_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-

member_id

-

Yes

-

String

-

Specifies the backend server ID.

- NOTE:
  • The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.
  • You can obtain this value by calling the API described in Querying Backend Servers.
- -
- - -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

member

-

Object

-

Lists the backend servers. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 member parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

- NOTE:

The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.

- -

tenant_id

-

String

-

Specifies the ID of the project where the backend server is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the backend server name.

-

The value contains a maximum of 255 characters.

-

address

-

String

-

Specifies the private IP address of the backend server. This IP address must be in the subnet specified by subnet_id.

-

This parameter can be set only to the IP address of the primary NIC, for example, 192.168.3.11.

-

The value contains a maximum of 64 characters.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server. The port number ranges from 1 to 65535.

-

subnet_id

-

String

-

Specifies the ID of the subnet where the backend server works. The private IP address of the backend server is in this subnet.

-

IPv6 subnets are not supported.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

weight

-

Integer

-

Specifies the backend server weight. The value ranges from 0 to 100.

-

If the value is 0, the backend server will not accept new requests. The default value is 1.

-

operating_status

-

String

-

Specifies the health check result of the backend server. The value can be one of the following:

-
  • ONLINE: The backend server is running normally.
  • NO_MONITOR: No health check is configured for the backend server group that the backend server belongs to.
  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.
-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/elb_zq_hd_0004.html b/docs/elb/api-ref/elb_zq_hd_0004.html deleted file mode 100644 index 7db844693..000000000 --- a/docs/elb/api-ref/elb_zq_hd_0004.html +++ /dev/null @@ -1,251 +0,0 @@ - - -

Updating a Backend Server

-

Function

This API is used to update a backend server. You can modify its name and weight. You can set a larger weight for backend servers that can receive more traffic.

- -

Constraints

If the provisioning status of the associated load balancer is not ACTIVE, the backend server cannot be updated.

- -

URI

PUT /v2.0/lbaas/pools/{pool_id}/members/{member_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-

member_id

-

Yes

-

String

-

Specifies the backend server ID.

- NOTE:
  • The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.
  • You can obtain this value by calling the API described in Querying Backend Servers.
- -
- - -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

member

-

Yes

-

Object

-

Specifies the backend server. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 member parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the backend server name.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server.

-

This parameter is reserved, and the default value is true.

-

weight

-

No

-

Integer

-

Specifies the backend server weight. The value ranges from 0 to 100.

-

If the value is 0, the backend server will not accept new requests. The default value is 1.

-
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

member

-

Object

-

Specifies the backend server. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 member parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

- NOTE:

The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.

- -

tenant_id

-

String

-

Specifies the ID of the project where the backend server is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the backend server name.

-

The value contains a maximum of 255 characters.

-

address

-

String

-

Specifies the private IP address of the backend server. This IP address must be in the subnet specified by subnet_id.

-

This parameter can be set only to the IP address of the primary NIC, for example, 192.168.3.11.

-

The value contains a maximum of 64 characters.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server. The port number ranges from 1 to 65535.

-

subnet_id

-

String

-

Specifies the ID of the subnet where the backend server works. The private IP address of the backend server is in this subnet.

-

IPv6 subnets are not supported.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

weight

-

Integer

-

Specifies the backend server weight. The value ranges from 0 to 100.

-

If the value is 0, the backend server will not accept new requests. The default value is 1.

-

operating_status

-

String

-

Specifies the health check result of the backend server. The value can be one of the following:

-
  • ONLINE: The backend server is running normally.
  • NO_MONITOR: No health check is configured for the backend server group that the backend server belongs to.
  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.
-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/elb_zq_hd_0005.html b/docs/elb/api-ref/elb_zq_hd_0005.html deleted file mode 100644 index b632b37b5..000000000 --- a/docs/elb/api-ref/elb_zq_hd_0005.html +++ /dev/null @@ -1,62 +0,0 @@ - - -

Removing a Backend Server

-

Function

This API is used to remove a backend server by its ID.

- -

Constraints

After you remove a backend server, new connections to this server will not be established. However, long connections that have been established will be maintained.

- -

URI

DELETE /v2.0/lbaas/pools/{pool_id}/members/{member_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-

member_id

-

Yes

-

String

-

Specifies the backend server ID.

- NOTE:
  • The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.
  • You can obtain this value by calling the API described in Querying Backend Servers.
- -
- - -

Request

None

- -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/elb_zq_hd_0006.html b/docs/elb/api-ref/elb_zq_hd_0006.html deleted file mode 100644 index de9572347..000000000 --- a/docs/elb/api-ref/elb_zq_hd_0006.html +++ /dev/null @@ -1,439 +0,0 @@ - - -

Querying All Backend Servers (Extension API)

-

Function

This API is used to query all backend servers. Filter query and pagination query are supported.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query. Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v2.0/lbaas/members

- -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the backend server from which pagination query starts, that is, the ID of the last backend server on the previous page. If this parameter is not specified, the first page will be queried.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of backend servers on each page. If this parameter is not set, all backend servers are queried by default.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

String

-

Specifies the backend server ID.

- NOTE:

The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.

- -

name

-

No

-

String

-

Specifies the backend server name.

-

The value contains a maximum of 255 characters.

-

address

-

No

-

String

-

Specifies the private IP address of the backend server.

-

The value contains a maximum of 64 characters.

-

protocol_port

-

No

-

Integer

-

Specifies the port used by the backend server.

-

subnet_id

-

No

-

String

-

Specifies the ID of the subnet where the backend server works.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server.

-

This parameter is reserved, and the default value is true.

-

weight

-

No

-

Integer

-

Specifies the backend server weight.

-

loadbalancer_id

-

No

-

String

-

Specifies the backend server ID.

-

operating_status

-

No

-

String

-

Specifies the health check result of the backend server. The value can be one of the following:

-
  • ONLINE: The backend server is running normally.
  • NO_MONITOR: No health check is performed on the backend server.
  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.
-

The default value is ONLINE.

-

members_links

-

No

-

Array

-

Provides links to the previous or next page during pagination query, respectively.

-

This parameter exists only in the response body of pagination query. For details, see Table 5.

-
- - - - - - - - - - - - - - - - -
Table 2 members_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page. The value can be next or previous.

-
  • next: indicates the URL of the next page.
  • previous: indicates the URL of the previous page.
-
- - -

Response

- - - - - - - - - - -
Table 3 Response parameters

Parameter

-

Type

-

Description

-

members

-

Array

-

Lists the backend servers. For details, see Table 4.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 members parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the backend server ID.

- NOTE:

The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.

- -

tenant_id

-

String

-

Specifies the ID of the project where the backend server is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the backend server name.

-

The value contains a maximum of 255 characters.

-

address

-

String

-

Specifies the private IP address of the backend server. This IP address must be in the subnet specified by subnet_id.

-

This parameter can be set only to the IP address of the primary NIC, for example, 192.168.3.11.

-

The value contains a maximum of 64 characters.

-

protocol_port

-

Integer

-

Specifies the port used by the backend server. The port number ranges from 1 to 65535.

-

subnet_id

-

String

-

Specifies the ID of the subnet where the backend server works. The private IP address of the backend server is in this subnet.

-

IPv6 subnets are not supported.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

weight

-

Integer

-

Specifies the backend server weight. The value ranges from 0 to 100.

-

If the value is 0, the backend server will not accept new requests. The default value is 1.

-

operating_status

-

String

-

Specifies the health check result of the backend server. The value can be one of the following:

-
  • ONLINE: The backend server is running normally.
  • NO_MONITOR: No health check is performed on the backend server.
  • OFFLINE: The cloud server used as the backend server is stopped or does not exist.
-

device_id

-

String

-

Specifies the ID of the cloud server used as the backend server. If the cloud server does not exist, this parameter is an empty string.

-

device_owner

-

String

-

Specifies the resource ID and AZ ID of the cloud server used as the backend server, for example, compute:az2.dc2.

-

If no corresponding ECS is available, the value is an empty string.

-

loadbalancer_id

-

String

-

Specifies the backend server ID.

-

members_links

-

Array

-

Provides links to the previous or next page during pagination query, respectively.

-

This parameter exists only in the response body of pagination query. For details, see Table 5.

-

pool_id

-

String

-

Specifies the backend server ID.

-
- - - - - - - - - - - - - - - - -
Table 5 members_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page. The value can be next or previous.

-
  • next: indicates the URL of the next page.
  • previous: indicates the URL of the previous page.
-
- - -

Example Request

- - -

Example Response

- - -

Return Codes

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/elb_zq_hd_0007.html b/docs/elb/api-ref/elb_zq_hd_0007.html deleted file mode 100644 index 083e62e40..000000000 --- a/docs/elb/api-ref/elb_zq_hd_0007.html +++ /dev/null @@ -1,236 +0,0 @@ - - -

Batch Updating Backend Servers

-

Function

This API is used to update backend servers in batches.

- -

Constraints

- -

URI

PUT /v2.0/lbaas/pools/{pool_id}/members

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-
- - -

Request

- - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

members

-

Yes

-

Array

-

Lists the backend servers in the backend server group. If action is set to add or replace, see Table 3 for details about the parameters. If action is set to delete, see Table 4 for details about the parameters.

-

An empty list is supported. If action is set to add, no backend server is added to the backend server group. If action is set to replace, all backend servers are removed from the backend cloud server group. If action is set to delete, no backend server is removed.

-

action

-

No

-

String

-

Specifies the operation type. The value can be add, delete, or replace. The default value is replace.

-
  • add: All backend servers in the request body are added to the backend server group in batches.
  • delete: All backend servers in the request are removed from the backend server group in batches.
  • replace: All backend servers in the backend server group are replaced with those in the request body.
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 members parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the backend server name. The value is an empty character string by default.

-

The value contains a maximum of 255 characters.

-

address

-

Yes

-

String

-

Specifies the private IP address of the backend server. This IP address must be in the subnet specified by subnet_id.

-

This parameter can be set only to the IP address of the primary NIC, for example, 192.168.3.11.

-

The value contains a maximum of 64 characters.

-

protocol_port

-

Yes

-

Integer

-

Specifies the port used by the backend server. The port number ranges from 1 to 65535.

-

subnet_id

-

Yes

-

String

-

Specifies the ID of the subnet where the backend server works. The private IP address of the backend server is in this subnet.

-

IPv6 subnets are not supported.

-

weight

-

No

-

Integer

-

Specifies the backend server weight. The value ranges from 0 to 100.

-

If the value is 0, the backend server will not accept new requests. The default value is 1.

-
- - - - - - - - - - - - - - -
Table 4 members parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

id

-

Yes

-

String

-

Specifies the backend server ID.

- NOTE:
  • The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.
  • You can obtain this value by calling the API described in Querying Backend Servers.
- -
- - -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

If the operation succeeds, 202 Accepted is returned. For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Backend Server - - - diff --git a/docs/elb/api-ref/elb_zq_hz_0000.html b/docs/elb/api-ref/elb_zq_hz_0000.html deleted file mode 100644 index b0282110b..000000000 --- a/docs/elb/api-ref/elb_zq_hz_0000.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Backend Server Group

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_hz_0001.html b/docs/elb/api-ref/elb_zq_hz_0001.html deleted file mode 100644 index 96ceaea07..000000000 --- a/docs/elb/api-ref/elb_zq_hz_0001.html +++ /dev/null @@ -1,542 +0,0 @@ - - -

Adding a Backend Server Group

-

Function

This API is used to add a backend server group. After multiple backend servers are added to a backend server group, requests are distributed among backend servers based on the load balancing algorithm configured for the backend server group and the weight set for each backend server.

- -

Constraints

- -

URI

POST /v2.0/lbaas/pools

- -

Request

- - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool

-

Yes

-

Object

-

Specifies the backend server group. For details, see Table 2.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 pool parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the backend server group is used.

-

-

The value must be the same as the value of project_id in the token.

-

The value contains a maximum of 255 characters.

-

name

-

No

-

String

-

Specifies the name of the backend server group.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the backend server group.

-

The value contains a maximum of 255 characters.

-

protocol

-

Yes

-

String

-

Specifies the protocol that the backend server group uses to receive requests.

-

TCP, UDP, and HTTP are supported.

-

When a backend server group is associated with a listener, the relationships between the protocol used by the listener and the protocol of the backend server group are as follows:

-
  • When the protocol used by the listener is UDP, the protocol of the backend server group must be UDP.
  • When the protocol used by the listener is TCP, the protocol of the backend server group must be TCP.
  • When the protocol used by the listener is HTTP or TERMINATED_HTTPS, the protocol of the backend server group must be HTTP.
-

lb_algorithm

-

Yes

-

String

-

Specifies the load balancing algorithm of the backend server group.

-The value can be one of the following:
  • ROUND_ROBIN: indicates the weighted round robin algorithm.
  • LEAST_CONNECTIONS: indicates the weighted least connections algorithm.
  • SOURCE_IP: indicates the source IP hash algorithm.
- -

When the value is SOURCE_IP, the weights of backend servers in the server group are invalid.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server group.

-

This parameter is reserved, and the default value is true.

-

listener_id

-

No

-

String

-

Specifies the ID of the listener associated with the backend server group.

-

Specify either listener_id or loadbalancer_id, or both of them.

-

loadbalancer_id

-

No

-

String

-

Specifies the ID of the load balancer associated with the backend server group.

-

Specify either listener_id or loadbalancer_id, or both of them.

-

session_persistence

-

No

-

Object

-

Specifies the sticky session timeout duration in minutes. For details, see Table 3.

-

If the value is null, the sticky session feature is disabled.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 session_persistence parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

type

-

Yes

-

String

-

Specifies the sticky session type.

-The value can be one of the following:
  • SOURCE_IP: Requests are distributed based on the client's IP address. Requests from the same IP address are sent to the same backend server.
  • HTTP_COOKIE: When the client sends a request for the first time, the load balancer automatically generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to the backend server that processes the first request.
  • APP_COOKIE: When the client sends a request for the first time, the backend server that receives the request generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to this backend server.
- -

When the protocol of the backend server group is TCP, only SOURCE_IP takes effect. When the protocol of the backend server group is HTTP, only HTTP_COOKIE or APP_COOKIE takes effect.

-

cookie_name

-

No

-

String

-

Specifies the cookie name.

-

This parameter is mandatory when the sticky session type is APP_COOKIE.

-

persistence_timeout

-

No

-

Integer

-

Specifies the sticky session timeout duration in minutes.

-

This parameter is invalid when type is set to APP_COOKIE.

-The value range varies depending on the protocol of the backend server group:
  • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
  • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
- -
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

pool

-

Object

-

Specifies the backend server group. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-

tenant_id

-

String

-

Specifies the ID of the project where the backend server group is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the name of the backend server group.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the backend server group.

-

The value contains a maximum of 255 characters.

-

protocol

-

String

-

Specifies the protocol that the backend server group uses to receive requests.

-

TCP, UDP, and HTTP are supported.

-

When a backend server group is associated with a listener, the relationships between the protocol used by the listener and the protocol of the backend server group are as follows:

-
  • When the protocol used by the listener is UDP, the protocol of the backend server group must be UDP.
  • When the protocol used by the listener is TCP, the protocol of the backend server group must be TCP.
  • When the protocol used by the listener is HTTP or TERMINATED_HTTPS, the protocol of the backend server group must be HTTP.
-

lb_algorithm

-

String

-

Specifies the load balancing algorithm of the backend server group.

-The value can be one of the following:
  • ROUND_ROBIN: indicates the weighted round robin algorithm.
  • LEAST_CONNECTIONS: indicates the weighted least connections algorithm.
  • SOURCE_IP: indicates the source IP hash algorithm. When the value is SOURCE_IP, the weights of backend servers in the server group are invalid.
- -

members

-

Array

-

Lists the IDs of backend servers in the backend server group.

-

healthmonitor_id

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server group.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

listeners

-

Array

-

Lists the IDs of listeners associated with the backend server group.

-

loadbalancers

-

Array

-

Lists the IDs of load balancers associated with the backend server group.

-

session_persistence

-

Object

-

Specifies whether to enable sticky sessions. For details, see Table 9.

-

Once sticky session are enabled, requests from the same client are sent to the same backend server during the session.

-

When sticky sessions are disabled, the value is null.

-
- - - - - - - - - - - - -
Table 6 members parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server.

-
- - - - - - - - - - - - -
Table 7 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - - - - - - - - - - - -
Table 8 loadbalancers parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated load balancer.

-
- - - - - - - - - - - - - - - - - - - - -
Table 9 session_persistence parameter description

Parameter

-

Type

-

Description

-

type

-

String

-

Specifies the sticky session type.

-The value can be one of the following:
  • SOURCE_IP: Requests are distributed based on the client's IP address. Requests from the same IP address are sent to the same backend server.
  • HTTP_COOKIE: When the client sends a request for the first time, the load balancer automatically generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to the backend server that processes the first request.
  • APP_COOKIE: When the client sends a request for the first time, the backend server that receives the request generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to this backend server.
- -

When the protocol of the backend server group is TCP, only SOURCE_IP takes effect. When the protocol of the backend server group is HTTP, only HTTP_COOKIE or APP_COOKIE takes effect.

-

cookie_name

-

String

-

Specifies the cookie name.

-

This parameter is mandatory when the sticky session type is APP_COOKIE.

-

persistence_timeout

-

Integer

-

Specifies the sticky session timeout duration in minutes.

-

This parameter is invalid when type is set to APP_COOKIE.

-
  • Optional value ranges are as follows:
    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
    -
-
- - -

Example Request

- - -

Example Response

- - -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/elb_zq_hz_0003.html b/docs/elb/api-ref/elb_zq_hz_0003.html deleted file mode 100644 index edae7757d..000000000 --- a/docs/elb/api-ref/elb_zq_hz_0003.html +++ /dev/null @@ -1,295 +0,0 @@ - - -

Querying Details of a Backend Server Group

-

Function

This API is used to query details about a backend server group using its ID.

- -

URI

GET /v2.0/lbaas/pools/{pool_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-
- - -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

pool

-

Object

-

Specifies the backend server group. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-

tenant_id

-

String

-

Specifies the ID of the project where the backend server group is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the name of the backend server group.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the backend server group.

-

The value contains a maximum of 255 characters.

-

protocol

-

String

-

Specifies the protocol that the backend server group uses to receive requests.

-

TCP, UDP, and HTTP are supported.

-

When a backend server group is associated with a listener, the relationships between the protocol used by the listener and the protocol of the backend server group are as follows:

-
  • When the protocol used by the listener is UDP, the protocol of the backend server group must be UDP.
  • When the protocol used by the listener is TCP, the protocol of the backend server group must be TCP.
  • When the protocol used by the listener is HTTP or TERMINATED_HTTPS, the protocol of the backend server group must be HTTP.
-

lb_algorithm

-

String

-

Specifies the load balancing algorithm of the backend server group.

-The value can be one of the following:
  • ROUND_ROBIN: indicates the weighted round robin algorithm.
  • LEAST_CONNECTIONS: indicates the weighted least connections algorithm.
  • SOURCE_IP: indicates the source IP hash algorithm. When the value is SOURCE_IP, the weights of backend servers in the server group are invalid.
- -

members

-

Array

-

Lists the IDs of backend servers in the backend server group.

-

healthmonitor_id

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server group.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

listeners

-

Array

-

Lists the IDs of listeners associated with the backend server group.

-

loadbalancers

-

Array

-

Lists the IDs of load balancers associated with the backend server group.

-

session_persistence

-

Object

-

Specifies whether to enable sticky sessions. For details, see Table 9.

-

Once sticky session are enabled, requests from the same client are sent to the same backend server during the session.

-

When sticky sessions are disabled, the value is null.

-
- - - - - - - - - - - - -
Table 4 members parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server.

-
- - - - - - - - - - - - -
Table 5 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - - - - - - - - - - - -
Table 6 loadbalancers parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated load balancer.

-
- - - - - - - - - - - - - - - - - - - - -
Table 7 session_persistence parameter description

Parameter

-

Type

-

Description

-

type

-

String

-

Specifies the sticky session type.

-The value can be one of the following:
  • SOURCE_IP: Requests are distributed based on the client's IP address. Requests from the same IP address are sent to the same backend server.
  • HTTP_COOKIE: When the client sends a request for the first time, the load balancer automatically generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to the backend server that processes the first request.
  • APP_COOKIE: When the client sends a request for the first time, the backend server that receives the request generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to this backend server.
- -

When the protocol of the backend server group is TCP, only SOURCE_IP takes effect. When the protocol of the backend server group is HTTP, only HTTP_COOKIE or APP_COOKIE takes effect.

-

cookie_name

-

String

-

Specifies the cookie name.

-

This parameter is mandatory when the sticky session type is APP_COOKIE.

-

persistence_timeout

-

Integer

-

Specifies the sticky session timeout duration in minutes.

-

This parameter is invalid when type is set to APP_COOKIE.

-
  • Optional value ranges are as follows:
    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
    -
-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/elb_zq_hz_0004.html b/docs/elb/api-ref/elb_zq_hz_0004.html deleted file mode 100644 index ba9639f5b..000000000 --- a/docs/elb/api-ref/elb_zq_hz_0004.html +++ /dev/null @@ -1,475 +0,0 @@ - - -

Updating a Backend Server Group

-

Function

This API is used to update a backend server group.

- -

Constraints

If the provisioning status of the load balancer associated with a backend server group is not ACTIVE, the backend server group cannot be updated.

- -

URI

PUT /v2.0/lbaas/pools/{pool_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-
- - -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool

-

Yes

-

Object

-

Specifies the backend server group. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 pool parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the name of the backend server group.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the backend server group.

-

The value contains a maximum of 255 characters.

-

lb_algorithm

-

No

-

String

-

Specifies the load balancing algorithm of the backend server group.

-Value options:
  • ROUND_ROBIN: indicates the weighted round robin algorithm.
  • LEAST_CONNECTIONS: indicates the weighted least connections algorithm.
  • SOURCE_IP: indicates the source IP hash algorithm.
- -

When the value is SOURCE_IP, the weights of backend servers in the server group are invalid.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the backend server group.

-

This parameter is reserved, and the default value is true.

-

session_persistence

-

No

-

Object

-

Specifies whether to enable the sticky session feature. For details, see Table 10.

-

Once sticky session are enabled, requests from the same client are sent to the same backend server during the session.

-

When sticky sessions are disabled, the value is null.

-
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 session_persistence parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

type

-

No

-

String

-

Specifies the sticky session type.

-Value options:
  • SOURCE_IP: Requests are distributed based on the client's IP address. Requests from the same IP address are sent to the same backend server.
  • HTTP_COOKIE: When the client sends a request for the first time, the load balancer automatically generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to the backend server that processes the first request.
  • APP_COOKIE: When the client sends a request for the first time, the backend server that receives the request generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to this backend server.
- -
  • When the protocol of the backend server group is TCP, only SOURCE_IP takes effect. When the protocol of the backend server group is HTTP, only HTTP_COOKIE or APP_COOKIE takes effect.
-

cookie_name

-

No

-

String

-

Specifies the cookie name.

-

This parameter is mandatory and can be specified when the sticky session type is APP_COOKIE.

-

persistence_timeout

-

No

-

Integer

-

Specifies the sticky session timeout duration in minutes.

-

This parameter is invalid when type is set to APP_COOKIE.

-Value range options are as follows:
  • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
  • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
- -
- - -

Response

- - - - - - - - - - -
Table 5 Parameter description

Parameter

-

Type

-

Description

-

pool

-

Object

-

Specifies the backend server group. For details, see Table 6.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-

tenant_id

-

String

-

Specifies the ID of the project where the backend server group is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the name of the backend server group.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the backend server group.

-

The value contains a maximum of 255 characters.

-

protocol

-

String

-

Specifies the protocol that the backend server group uses to receive requests.

-

TCP, UDP, and HTTP are supported.

-

When a backend server group is associated with a listener, the relationships between the protocol used by the listener and the protocol of the backend server group are as follows:

-
  • When the protocol used by the listener is UDP, the protocol of the backend server group must be UDP.
  • When the protocol used by the listener is TCP, the protocol of the backend server group must be TCP.
  • When the protocol used by the listener is HTTP or TERMINATED_HTTPS, the protocol of the backend server group must be HTTP.
-

lb_algorithm

-

String

-

Specifies the load balancing algorithm of the backend server group.

-The value can be one of the following:
  • ROUND_ROBIN: indicates the weighted round robin algorithm.
  • LEAST_CONNECTIONS: indicates the weighted least connections algorithm.
  • SOURCE_IP: indicates the source IP hash algorithm. When the value is SOURCE_IP, the weights of backend servers in the server group are invalid.
- -

members

-

Array

-

Lists the IDs of backend servers in the backend server group.

-

healthmonitor_id

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server group.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

listeners

-

Array

-

Lists the IDs of listeners associated with the backend server group.

-

loadbalancers

-

Array

-

Lists the IDs of load balancers associated with the backend server group.

-

session_persistence

-

Object

-

Specifies whether to enable sticky sessions. For details, see Table 9.

-

Once sticky session are enabled, requests from the same client are sent to the same backend server during the session.

-

When sticky sessions are disabled, the value is null.

-
- - - - - - - - - - - - -
Table 7 members parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server.

-
- - - - - - - - - - - - -
Table 8 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - - - - - - - - - - - -
Table 9 loadbalancers parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated load balancer.

-
- - - - - - - - - - - - - - - - - - - - -
Table 10 session_persistence parameter description

Parameter

-

Type

-

Description

-

type

-

String

-

Specifies the sticky session type.

-The value can be one of the following:
  • SOURCE_IP: Requests are distributed based on the client's IP address. Requests from the same IP address are sent to the same backend server.
  • HTTP_COOKIE: When the client sends a request for the first time, the load balancer automatically generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to the backend server that processes the first request.
  • APP_COOKIE: When the client sends a request for the first time, the backend server that receives the request generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to this backend server.
- -

When the protocol of the backend server group is TCP, only SOURCE_IP takes effect. When the protocol of the backend server group is HTTP, only HTTP_COOKIE or APP_COOKIE takes effect.

-

cookie_name

-

String

-

Specifies the cookie name.

-

This parameter is mandatory when the sticky session type is APP_COOKIE.

-

persistence_timeout

-

Integer

-

Specifies the sticky session timeout duration in minutes.

-

This parameter is invalid when type is set to APP_COOKIE.

-
  • Optional value ranges are as follows:
    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
    -
-
- - -

Example Request

- - -

Example Response

- - -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/elb_zq_hz_0005.html b/docs/elb/api-ref/elb_zq_hz_0005.html deleted file mode 100644 index ef8384d43..000000000 --- a/docs/elb/api-ref/elb_zq_hz_0005.html +++ /dev/null @@ -1,51 +0,0 @@ - - -

Deleting a Backend Server Group

-

Function

This API is used to delete a backend server group.

- -

Constraints

Before deleting a backend server group, remove all backend servers, delete the health check, and disassociate forwarding policies from the backend server group by changing the value of redirect_pool_id to null. For details, see Updating a Forwarding Policy.

- -

URI

DELETE /v2.0/lbaas/pools/{pool_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-
- - -

Request

None

- -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/elb_zq_jk_0000.html b/docs/elb/api-ref/elb_zq_jk_0000.html deleted file mode 100644 index 15d9e1183..000000000 --- a/docs/elb/api-ref/elb_zq_jk_0000.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Health Check

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_jk_0001.html b/docs/elb/api-ref/elb_zq_jk_0001.html deleted file mode 100644 index 0031918f1..000000000 --- a/docs/elb/api-ref/elb_zq_jk_0001.html +++ /dev/null @@ -1,431 +0,0 @@ - - -

Configuring a Health Check

-

Function

This API is used to configure a health check for a backend server group to check the status of backend servers. If the health check result is OFFLINE, backend servers are considered unhealthy. You need to check the server configuration.

- -

Constraints

The security group must allow access from 100.125.0.0/16. Otherwise, the health check cannot be performed.

- -

URI

POST /v2.0/lbaas/healthmonitors

- -

Request

- - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

healthmonitor

-

Yes

-

Object

-

Specifies the health check. For details, see Table 2.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 healthmonitor parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the health check is performed.

-

-

The value must be the same as the value of project_id in the token.

-

The value contains a maximum of 255 characters.

-

name

-

No

-

String

-

Specifies the health check name.

-

The value contains a maximum of 255 characters.

-

delay

-

Yes

-

Integer

-

Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

-

max_retries

-

Yes

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

max_retries_down

-

No

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE. The value ranges from 1 to 10.

-

pool_id

-

Yes

-

String

-

Specifies the ID of the backend server group.

-

Only one health check can be configured for each backend server group.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the health check.

-

This parameter is reserved, and the default value is true.

-

timeout

-

Yes

-

Integer

-

Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

- NOTE:

You are advised to set the value less than that of parameter delay.

- -

type

-

Yes

-

String

-

Specifies the health check protocol.

-

The value can be TCP, UDP_CONNECT, or HTTP.

-

The relationships between the health check protocol and the protocol used by the backend server group are as follows:

-
  • If the protocol of the backend server group is UDP, the parameter value can only be UDP_CONNECT.
  • If the protocol of the backend server group is TCP, the parameter value can be TCP or HTTP.
  • If the protocol of the backend server group is HTTP, the parameter value can be TCP or HTTP.
-

monitor_port

-

No

-

Integer

-

Specifies the health check port. The port number ranges from 1 to 65535.

-

The value is left blank by default, indicating that the port of the backend server is used as the health check port.

-

domain_name

-

No

-

String

-

Specifies the domain name of HTTP requests during the health check.

-

This parameter is valid only when the value of type is set to HTTP.

-

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

-

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

-

The value contains a maximum of 100 characters.

-

url_path

-

No

-

String

-

Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

-

This parameter is valid only when the value of type is set to HTTP.

-

An example value is /test.

-

The value contains a maximum of 255 characters.

-

expected_codes

-

No

-

String

-

Specifies the expected HTTP status code. The following options are available:

-

A single value, such as 200

-

A list of values, such as 200,202

-

A value range, such as 200-204

-

This parameter is valid only when the value of type is set to HTTP.

-

The value contains a maximum of 64 characters.

- NOTE:

This parameter is reserved.

- -

http_method

-

No

-

String

-

Specifies the HTTP request method. The default value is GET.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, and PATCH.

-

This parameter is valid only when the value of type is set to HTTP.

- NOTE:

This parameter is reserved.

- -
- - -

Response

- - - - - - - - - - -
Table 3 Response parameters

Parameter

-

Type

-

Description

-

healthmonitor

-

Object

-

Specifies the health check. For details, see Table 4.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 healthmonitor parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the health check ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the health check is performed.

-

name

-

String

-

Specifies the health check name.

-

delay

-

Integer

-

Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

-

max_retries

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

max_retries_down

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE. The value ranges from 1 to 10.

-

pools

-

Array

-

Specifies the ID of the backend server group associated with the health check. For details, see Table 5.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the health check.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

timeout

-

Integer

-

Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

- NOTE:

You are advised to set the value less than that of parameter delay.

- -

type

-

String

-

Specifies the health check protocol.

-

The value can be TCP, UDP_CONNECT, or HTTP.

-

The relationships between the value of this parameter and the protocol of the backend server group are as follows:

-
  • If the protocol of the backend server group is UDP, the parameter value can only be UDP_CONNECT.
  • If the protocol of the backend server group is TCP, the parameter value can be TCP or HTTP.
  • If the protocol of the backend server group is HTTP, the parameter value can be TCP or HTTP.
-

monitor_port

-

Integer

-

Specifies the health check port. The port number ranges from 1 to 65535.

-

The value is left blank by default, indicating that the port of the backend server is used as the health check port.

-

expected_codes

-

String

-

Specifies the expected HTTP status code. The following options are available:

-

A single value, such as 200

-

A list of values, such as 200,202

-

A value range, such as 200-204

-

This parameter is valid only when the value of type is set to HTTP.

-

Currently, this parameter is not supported and is fixed at 200.

-

domain_name

-

String

-

Specifies the domain name of HTTP requests during the health check.

-

This parameter is valid only when the value of type is set to HTTP.

-

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

-

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

-

url_path

-

String

-

Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

-

This parameter is valid only when the value of type is set to HTTP.

-

An example value is /test.

-

http_method

-

String

-

Specifies the HTTP request method. The default value is GET.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, and PATCH.

-

This parameter is valid only when the value of type is set to HTTP.

- NOTE:

This parameter is reserved.

- -
- - - - - - - - - - - - -
Table 5 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/elb_zq_jk_0002.html b/docs/elb/api-ref/elb_zq_jk_0002.html deleted file mode 100644 index 3992fbe3e..000000000 --- a/docs/elb/api-ref/elb_zq_jk_0002.html +++ /dev/null @@ -1,487 +0,0 @@ - - -

Querying Health Checks

-

Function

This API is used to query the health checks. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.

- -

URI

GET /v2.0/lbaas/healthmonitors

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query. Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the health check from which pagination query starts, that is, the ID of the last health check on the previous page.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of health checks on each page. If this parameter is not set, all health checks are queried by default.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

String

-

Specifies the health check ID.

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the health check is performed.

-

The value contains a maximum of 255 characters.

-

name

-

No

-

String

-

Specifies the health check name.

-

The value contains a maximum of 255 characters.

-

delay

-

No

-

Integer

-

Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

-

max_retries

-

No

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

max_retries_down

-

No

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE. The value ranges from 1 to 10.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the health check.

-

This parameter is reserved, and the default value is true.

-

timeout

-

No

-

Integer

-

Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

- NOTE:

You are advised to set the value less than that of parameter delay.

- -

type

-

No

-

String

-

Specifies the health check protocol.

-

The value can be TCP, UDP_CONNECT, or HTTP.

-

monitor_port

-

No

-

Integer

-

Specifies the port used for the health check.

-

The value is left blank by default, indicating that the port of the backend server is used as the health check port.

-

expected_codes

-

No

-

String

-

Specifies the expected HTTP status code. The following options are available:

-

A single value, such as 200

-

A list of values, such as 200,202

-

A value range, such as 200-204

-

This parameter is valid only when the value of type is set to HTTP.

-

The value contains a maximum of 64 characters.

- NOTE:

This parameter is reserved.

- -

domain_name

-

No

-

String

-

Specifies the domain name of HTTP requests during the health check.

-

This parameter is valid only when the value of type is set to HTTP.

-

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

-

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

-

The value contains a maximum of 100 characters.

-

url_path

-

No

-

String

-

Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

-

This parameter is valid only when the value of type is set to HTTP.

-

An example value is /test.

-

The value contains a maximum of 255 characters.

-

http_method

-

No

-

String

-

Specifies the HTTP request method. The default value is GET.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, and PATCH.

-

This parameter is valid only when the value of type is set to HTTP.

- NOTE:

This parameter is reserved.

- -
- - -

Response

- - - - - - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

healthmonitors

-

Array

-

Lists the health checks. For details, see Table 3.

-

healthmonitors_links

-

Array

-

Provides links to the previous or next page during pagination query, respectively.

-

This parameter exists only in the response body of pagination query.

-

For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 healthmonitors parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the health check ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the health check is performed.

-

name

-

String

-

Specifies the health check name.

-

The value contains a maximum of 255 characters.

-

delay

-

Integer

-

Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

-

max_retries

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

-

The value ranges from 1 to 10.

-

max_retries_down

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

-

The value ranges from 1 to 10.

-

pools

-

Array

-

Lists the IDs of backend server groups associated with the health check.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the health check.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

timeout

-

Integer

-

Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

- NOTE:

You are advised to set the value less than that of parameter delay.

- -

type

-

String

-

Specifies the health check protocol.

-

The value can be TCP, UDP_CONNECT, or HTTP.

-

monitor_port

-

Integer

-

Specifies the health check port. The port number ranges from 1 to 65535.

-

The value is left blank by default, indicating that the port of the backend server is used as the health check port.

-

expected_codes

-

String

-

Specifies the expected HTTP status code. The following options are available:

-

A single value, such as 200

-

A list of values, such as 200,202

-

A value range, such as 200-204

-

This parameter is valid only when the value of type is set to HTTP.

-

The value contains a maximum of 64 characters.

-

domain_name

-

String

-

Specifies the domain name of HTTP requests during the health check.

-

This parameter is valid only when the value of type is set to HTTP.

-

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

-

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

-

The value contains a maximum of 100 characters.

-

url_path

-

String

-

Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

-

This parameter is valid only when the value of type is set to HTTP.

-

An example value is /test.

-

The value contains a maximum of 255 characters.

-

http_method

-

String

-

Specifies the HTTP request method. The default value is GET.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, and PATCH.

-

This parameter is valid only when the value of type is set to HTTP.

- NOTE:

This parameter is reserved.

- -
- - - - - - - - - - - - -
Table 4 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - - - - - - - - - - - - - - - -
Table 5 healthmonitors_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page.

-

The value can be next or previous. The value next indicates the href containing the URL of the next page, and previous indicates the href containing the URL of the previous page.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/elb_zq_jk_0003.html b/docs/elb/api-ref/elb_zq_jk_0003.html deleted file mode 100644 index 5830712cd..000000000 --- a/docs/elb/api-ref/elb_zq_jk_0003.html +++ /dev/null @@ -1,247 +0,0 @@ - - -

Querying Details of a Health Check

-

Function

This API is used to query details about a health check using its iD.

- -

URI

GET /v2.0/lbaas/healthmonitors/{healthmonitor_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

healthmonitor_id

-

Yes

-

String

-

Specifies the health check ID.

-
- - -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

healthmonitor

-

Object

-

Specifies the health check. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 healthmonitor parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the health check ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the health check is performed.

-

name

-

String

-

Specifies the health check name.

-

delay

-

Integer

-

Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

-

max_retries

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

max_retries_down

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE. The value ranges from 1 to 10.

-

pools

-

Array

-

Specifies the ID of the backend server group associated with the health check. For details, see Table 5.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the health check.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

timeout

-

Integer

-

Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

- NOTE:

You are advised to set the value less than that of parameter delay.

- -

type

-

String

-

Specifies the health check protocol.

-

The value can be TCP, UDP_CONNECT, or HTTP.

-

The relationships between the value of this parameter and the protocol of the backend server group are as follows:

-
  • If the protocol of the backend server group is UDP, the parameter value can only be UDP_CONNECT.
  • If the protocol of the backend server group is TCP, the parameter value can be TCP or HTTP.
  • If the protocol of the backend server group is HTTP, the parameter value can be TCP or HTTP.
-

monitor_port

-

Integer

-

Specifies the health check port. The port number ranges from 1 to 65535.

-

The value is left blank by default, indicating that the port of the backend server is used as the health check port.

-

expected_codes

-

String

-

Specifies the expected HTTP status code. The following options are available:

-

A single value, such as 200

-

A list of values, such as 200,202

-

A value range, such as 200-204

-

This parameter is valid only when the value of type is set to HTTP.

-

Currently, this parameter is not supported and is fixed at 200.

-

domain_name

-

String

-

Specifies the domain name of HTTP requests during the health check.

-

This parameter is valid only when the value of type is set to HTTP.

-

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

-

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

-

url_path

-

String

-

Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

-

This parameter is valid only when the value of type is set to HTTP.

-

An example value is /test.

-

http_method

-

String

-

Specifies the HTTP request method. The default value is GET.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, and PATCH.

-

This parameter is valid only when the value of type is set to HTTP.

- NOTE:

This parameter is reserved.

- -
- - - - - - - - - - - - -
Table 4 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/elb_zq_jk_0004.html b/docs/elb/api-ref/elb_zq_jk_0004.html deleted file mode 100644 index 772fd58b0..000000000 --- a/docs/elb/api-ref/elb_zq_jk_0004.html +++ /dev/null @@ -1,422 +0,0 @@ - - -

Updating a Health Check

-

Function

This API is used to update a health check.

- -

Constraints

If provisioning_status of the load balancer for which the health check is configured is not ACTIVE, the health check cannot be updated.

- -

URI

PUT /v2.0/lbaas/healthmonitors/{healthmonitor_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

healthmonitor_id

-

Yes

-

String

-

Specifies the health check ID.

-
- - -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

healthmonitor

-

Yes

-

Object

-

Specifies the health check. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 healthmonitor parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the health check name.

-

The value contains a maximum of 255 characters.

-

delay

-

No

-

Integer

-

Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

-

max_retries

-

No

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

max_retries_down

-

No

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE. The value ranges from 1 to 10.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the health check.

-

This parameter is reserved, and the default value is true.

-

timeout

-

No

-

Integer

-

Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

- NOTE:

You are advised to set the value less than that of parameter delay.

- -

type

-

No

-

String

-

Specifies the health check protocol.

-

The value can be TCP, UDP_CONNECT, or HTTP.

-

monitor_port

-

No

-

Integer

-

Specifies the health check port. The port number ranges from 1 to 65535.

-

The value is left blank by default, indicating that the port of the backend server is used as the health check port.

-

expected_codes

-

No

-

String

-

Specifies the expected HTTP status code. The following options are available:

-

A single value, such as 200

-

A list of values, such as 200,202

-

A value range, such as 200-204

-

This parameter is valid only when the value of type is set to HTTP.

-

domain_name

-

No

-

String

-

Specifies the domain name of HTTP requests during the health check.

-

This parameter is valid only when the value of type is set to HTTP.

-

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

-

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

-

The value contains a maximum of 100 characters.

-

url_path

-

No

-

String

-

Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

-

This parameter is valid only when the value of type is set to HTTP.

-

An example value is /test.

-

The value contains a maximum of 255 characters.

-

http_method

-

No

-

String

-

Specifies the HTTP request method. The default value is GET.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, and PATCH.

-

This parameter is valid only when the value of type is set to HTTP.

- NOTE:

This parameter is reserved.

- -
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

healthmonitor

-

Object

-

Specifies the health check. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 healthmonitor parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the health check ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the health check is performed.

-

name

-

String

-

Specifies the health check name.

-

delay

-

Integer

-

Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

-

max_retries

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE. The value ranges from 1 to 10.

-

max_retries_down

-

Integer

-

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE. The value ranges from 1 to 10.

-

pools

-

Array

-

Specifies the ID of the backend server group associated with the health check. For details, see Table 5.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the health check.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

timeout

-

Integer

-

Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

- NOTE:

You are advised to set the value less than that of parameter delay.

- -

type

-

String

-

Specifies the health check protocol.

-

The value can be TCP, UDP_CONNECT, or HTTP.

-

The relationships between the value of this parameter and the protocol of the backend server group are as follows:

-
  • If the protocol of the backend server group is UDP, the parameter value can only be UDP_CONNECT.
  • If the protocol of the backend server group is TCP, the parameter value can be TCP or HTTP.
  • If the protocol of the backend server group is HTTP, the parameter value can be TCP or HTTP.
-

monitor_port

-

Integer

-

Specifies the health check port. The port number ranges from 1 to 65535.

-

The value is left blank by default, indicating that the port of the backend server is used as the health check port.

-

expected_codes

-

String

-

Specifies the expected HTTP status code. The following options are available:

-

A single value, such as 200

-

A list of values, such as 200,202

-

A value range, such as 200-204

-

This parameter is valid only when the value of type is set to HTTP.

-

Currently, this parameter is not supported and is fixed at 200.

-

domain_name

-

String

-

Specifies the domain name of HTTP requests during the health check.

-

This parameter is valid only when the value of type is set to HTTP.

-

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

-

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

-

url_path

-

String

-

Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

-

This parameter is valid only when the value of type is set to HTTP.

-

An example value is /test.

-

http_method

-

String

-

Specifies the HTTP request method. The default value is GET.

-

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, and PATCH.

-

This parameter is valid only when the value of type is set to HTTP.

- NOTE:

This parameter is reserved.

- -
- - - - - - - - - - - - -
Table 6 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/elb_zq_jk_0005.html b/docs/elb/api-ref/elb_zq_jk_0005.html deleted file mode 100644 index 50d249fca..000000000 --- a/docs/elb/api-ref/elb_zq_jk_0005.html +++ /dev/null @@ -1,51 +0,0 @@ - - -

Deleting a Health Check

-

Function

This API is used to delete a health check.

- -

Constraints

If provisioning_status of the load balancer for which the health check is configured is not ACTIVE, the health check cannot be deleted.

- -

URI

DELETE /v2.0/lbaas/healthmonitors/{healthmonitor_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

healthmonitor_id

-

Yes

-

String

-

Specifies the health check ID.

-
- - -

Request

None

- -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Health Check - - - diff --git a/docs/elb/api-ref/elb_zq_jt_0000.html b/docs/elb/api-ref/elb_zq_jt_0000.html deleted file mode 100644 index 0dfede6e6..000000000 --- a/docs/elb/api-ref/elb_zq_jt_0000.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Listener

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_jt_0001.html b/docs/elb/api-ref/elb_zq_jt_0001.html deleted file mode 100644 index 24dca7475..000000000 --- a/docs/elb/api-ref/elb_zq_jt_0001.html +++ /dev/null @@ -1,579 +0,0 @@ - - -

Adding a Listener

-

Function

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

- -

Constraints

When protocol is set to TCP and protocol_port to 0, the listener works in IP mode (DR mode).

- -

URI

POST /v2.0/lbaas/listeners

- -

Request

- - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

listener

-

Yes

-

Object

-

Specifies the listener. For details, see Table 2.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 listener parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the listener is used.

-

-

The value must be the same as the value of project_id in the token.

-

The value contains a maximum of 255 characters.

-

name

-

No

-

String

-

Specifies the listener name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the listener.

-

The value contains a maximum of 255 characters.

-

protocol

-

Yes

-

String

-

Specifies the protocol used by the listener.

-

The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

-

protocol_port

-

Yes

-

Integer

-

Specifies the port used by the listener.

-

The port number ranges from 1 to 65535.

- NOTE:

If the protocol used by the listener is UDP, the port number cannot be 4789.

- -

loadbalancer_id

-

Yes

-

String

-

Specifies the ID of the associated load balancer.

-

connection_limit

-

No

-

Integer

-

Specifies the maximum number of connections.

-

The value ranges from -1 to 2147483647. The default value is -1, indicating that there is no restriction on the maximum number of connections.

-

This parameter is reserved.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the listener.

-

This parameter is reserved, and the default value is true.

-

http2_enable

-

No

-

Boolean

-

Specifies whether to use HTTP/2.

-

The value can be true or false.

-
  • true: HTTP/2 is used.
  • false: HTTP/2 is not used.
-

The default value is false.

-

This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

default_pool_id

-

No

-

String

-

Specifies the ID of the associated backend server group.

-

If a request does not match the forwarding policy, the request is forwarded to the default backend server group for processing. If the value is null, the listener has no default backend server group.

-This parameter has the following constraints:
  • Its value cannot be the ID of any backend server group of other listeners.
  • Its value cannot be the ID of any backend server group associated with the forwarding policies set for other listeners.
- -The relationships between the protocol used by the listener and the protocol of the backend server group are as follows:
  • When the protocol used by the listener is TCP, the protocol of the backend server group must be TCP.
  • When the protocol used by the listener is UDP, the protocol of the backend server group must be UDP.
  • When the protocol used by the listener is HTTP or TERMINATED_HTTPS, the protocol of the backend server group must be HTTP.
- -

default_tls_container_ref

-

No

-

String

-

Specifies the ID of the server certificate used by the listener.

-

This parameter is mandatory when protocol is set to TERMINATED_HTTPS.

-

The default value is null when protocol is not set to TERMINATED_HTTPS.

-

The value contains a maximum of 128 characters.

- NOTE:

This parameter is valid only when protocol is set to TERMINATED_HTTPS.

- -

client_ca_tls_container_ref

-

No

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

The default value is null.

-

The value contains a maximum of 128 characters.

- NOTE:

This parameter is valid only when protocol is set to TERMINATED_HTTPS.

- -

sni_container_refs

-

No

-

Array

-

Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener.

-

If the parameter value is an empty list, the SNI feature is disabled.

-

The default value is [].

- NOTE:

This parameter is valid only when protocol is set to TERMINATED_HTTPS.

- -

tls_ciphers_policy

-

No

-

String

-

Specifies the security policy used by the listener. This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

The value can be tls-1-0-inherit, tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0. For details of cipher suites for each security policy, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 tls_ciphers_policy parameter description

Security Policy

-

TLS Version

-

Cipher Suite

-

tls-1-0-inherit

-

TLS 1.2 TLS 1.1 TLS 1.0

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA

-

tls-1-0

-

TLS 1.2 TLS 1.1 TLS 1.0

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA

-

tls-1-1

-

TLS 1.2 TLS 1.1

-

tls-1-2

-

TLS 1.2

-

tls-1-2-strict

-

TLS 1.2

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384

-
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

listener

-

Object

-

Specifies the listener. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the listener is used.

-

name

-

String

-

Specifies the listener name.

-

description

-

String

-

Provides supplementary information about the listener.

-

protocol

-

String

-

Specifies the protocol used by the listener.

-

The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

-

protocol_port

-

Integer

-

Specifies the port used by the listener.

-

The port number ranges from 1 to 65535.

-

loadbalancers

-

Array

-

Specifies the ID of the associated load balancer. For details, see Table 6.

-

connection_limit

-

Integer

-

Specifies the maximum number of connections.

-

The value ranges from -1 to 2147483647. The default value is -1, indicating that there is no restriction on the maximum number of connections.

-

This parameter is reserved.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the listener.

-

This parameter is reserved. The value can be true or false.

-
  • true: The load balancer is enabled.
  • false: The load balancer is disabled.
-

http2_enable

-

Boolean

-

Specifies whether to use HTTP/2.

-

The value can be true or false.

-
  • true: HTTP/2 is used.
  • false: HTTP/2 is not used.
-

This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

default_pool_id

-

String

-

Specifies the ID of the associated backend server group.

-

If a request does not match the forwarding policy, the request is forwarded to the default backend server group for processing. If the value is null, the listener has no default backend server group.

-

default_tls_container_ref

-

String

-

Specifies the ID of the server certificate used by the listener. For details, see Certificate.

-

This parameter is mandatory when protocol is set to TERMINATED_HTTPS.

-

client_ca_tls_container_ref

-

String

-

Specifies the ID of the CA certificate used by the listener. For details, see Certificate.

-

sni_container_refs

-

Array

-

Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener.

-

If the parameter value is an empty list, the SNI feature is disabled.

-

tags

-

Array

-

Tags the listener.

-

created_at

-

String

-

Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

updated_at

-

String

-

Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

tls_ciphers_policy

-

String

-

Specifies the security policy used by the listener. This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

The value can be tls-1-0-inherit, tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0. For details of cipher suites for each security policy, see Table 3.

-
- - - - - - - - - - - - -
Table 6 loadbalancers parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated load balancer.

-
- - -

Example Request

- - -

Example Response

- - -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_zq_jt_0002.html b/docs/elb/api-ref/elb_zq_jt_0002.html deleted file mode 100644 index ea1e37731..000000000 --- a/docs/elb/api-ref/elb_zq_jt_0002.html +++ /dev/null @@ -1,677 +0,0 @@ - - -

Querying Listeners

-

Function

This API is used to query the listeners and display them in a list. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.

-

You can query listeners using information such as listener ID, protocol used by the listener, port used by the listener, or backend server private IP address.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query. Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v2.0/lbaas/listeners

- -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the listener from which pagination query starts, that is, the ID of the last listener on the previous page.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of listeners on each page.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

String

-

Specifies the listener ID.

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the listener is used.

-

-

name

-

No

-

String

-

Specifies the listener name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the listener.

-

The value contains a maximum of 255 characters.

-

loadbalancer_id

-

No

-

String

-

Specifies the ID of the associated load balancer.

-

connection_limit

-

No

-

Integer

-

Specifies the maximum number of connections.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the listener.

-

This parameter is reserved, and the default value is true.

-

default_pool_id

-

No

-

String

-

Specifies the ID of the associated backend server group.

-

http2_enable

-

No

-

Boolean

-

Specifies whether to use HTTP/2.

-

The value can be true or false.

-
  • true: HTTP/2 is used.
  • false: HTTP/2 is not used.
-

default_tls_container_ref

-

No

-

String

-

Specifies the ID of the server certificate used by the listener.

-

The value contains a maximum of 128 characters.

-

client_ca_tls_container_ref

-

No

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

The value contains a maximum of 128 characters.

-

protocol

-

No

-

String

-

Specifies the protocol used by the listener.

-

The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

-

protocol_port

-

No

-

Integer

-

Specifies the port used by the listener.

-

tls_ciphers_policy

-

No

-

String

-

Specifies the security policy used by the listener. This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

The value can be tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict. For details of cipher suites for each security policy, see Table 2.

-

tls_container_id

-

No

-

String

-

Queries the listener associated with the certificate.

-

sni_container_refs

-

No

-

String

-

Queries the listener associated with the SNI certificate.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 tls_ciphers_policy parameter description

Security Policy

-

TLS Version

-

Cipher Suite

-

tls-1-0-inherit

-

TLS 1.2 TLS 1.1 TLS 1.0

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA

-

tls-1-0

-

TLS 1.2 TLS 1.1 TLS 1.0

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA

-

tls-1-1

-

TLS 1.2 TLS 1.1

-

tls-1-2

-

TLS 1.2

-

tls-1-2-strict

-

TLS 1.2

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384

-
- - -

Response

- - - - - - - - - - - - - - -
Table 3 Parameter description

Parameter

-

Type

-

Description

-

listeners

-

Array

-

Lists the listeners. For details, see Table 4.

-

listeners_links

-

Array

-

Provides links to the previous or next page during pagination query, respectively. This parameter exists only in the response body of pagination query. For details, see Table 7.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the listener is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the listener name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the listener.

-

The value contains a maximum of 255 characters.

-

protocol

-

String

-

Specifies the protocol used by the listener.

-

The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

-

protocol_port

-

Integer

-

Specifies the port used by the listener.

-

The port number ranges from 1 to 65535.

-

loadbalancers

-

Array

-

Specifies the ID of the associated load balancer.

-

connection_limit

-

Integer

-

Specifies the maximum number of connections.

-

The value ranges from -1 to 2147483647.

- NOTE:

This parameter is reserved. The default value is -1, indicating that there is no restriction on the maximum number of connections.

- -

admin_state_up

-

Boolean

-

Specifies the administrative status of the listener.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

http2_enable

-

Boolean

-

Specifies whether to use HTTP/2.

-

The value can be true or false.

-
  • true: HTTP/2 will be used.
  • false: HTTP/2 will not be used.
- NOTE:

This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

- -

keepalive_timeout

-

Integer

-

Specifies the idle timeout duration in the unit of second.

-

This parameter applies only to TCP, HTTP, or HTTPS listeners.

-

The value can be one of the following:

-
  • TCP listeners: The value ranges from 10 to 4000, and the default value is 300.
-
  • HTTP or HTTPS listeners: The value ranges from 0 to 4000, and the default value is 60.
-

client_timeout

-

Integer

-

Specifies the request timeout duration in the unit of second.

-

The value ranges from 1 to 300. The default value is 60.

-

This parameter is valid only when protocol is set to HTTP or HTTPS. In other cases, the request body does not contain this parameter. Otherwise, an error is reported. When protocol is set to HTTP or HTTPS, if the request body does not contain this parameter or the value of this parameter is null, the default value is used.

-

member_timeout

-

Integer

-

Specifies the response timeout duration in the unit of second.

-

The value ranges from 1 to 300. The default value is 60.

-

This parameter is valid only when protocol is set to HTTP or HTTPS. In other cases, the request body does not contain this parameter. Otherwise, an error is reported. When protocol is set to HTTP or HTTPS, if the request body does not contain this parameter or the value of this parameter is null, the default value is used.

-

default_pool_id

-

String

-

Specifies the ID of the associated backend server group.

- NOTE:

If a request does not match the forwarding policy, the request is forwarded to the default backend server group for processing. If the value is null, the listener has no default backend server group.

- -

default_tls_container_ref

-

String

-

Specifies the ID of the server certificate used by the listener.

-

This parameter is mandatory when protocol is set to TERMINATED_HTTPS.

-

The value contains a maximum of 128 characters.

-

client_ca_tls_container_ref

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

The value contains a maximum of 128 characters.

-

sni_container_refs

-

Array

-

Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener.

-

tags

-

Array

-

Tags the listener.

-

created_at

-

String

-

Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-

updated_at

-

String

-

Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-

listeners_links

-

Array

-

Provides links to the previous or next page during pagination query, respectively. This parameter exists only in the response body of pagination query.

-

tls_ciphers_policy

-

String

-

Specifies the security policy used by the listener. This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

The value can be tls-1-0-inherit, tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0. For details of cipher suites for each security policy, see Table 6.

-
- - - - - - - - - - - - -
Table 5 loadbalancers parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated load balancer.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 tls_ciphers_policy parameter description

Security Policy

-

TLS Version

-

Cipher Suite

-

tls-1-0-inherit

-

TLS 1.2 TLS 1.1 TLS 1.0

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA

-

tls-1-0

-

TLS 1.2 TLS 1.1 TLS 1.0

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA

-

tls-1-1

-

TLS 1.2 TLS 1.1

-

tls-1-2

-

TLS 1.2

-

tls-1-2-strict

-

TLS 1.2

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384

-
- - - - - - - - - - - - - - - - -
Table 7 listeners_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page.

-

The value can be next or previous. The value next indicates the href containing the URL of the next page, and previous indicates the href containing the URL of the previous page.

-
- - -

Example Request

- - -

Example Response

- - -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_zq_jt_0003.html b/docs/elb/api-ref/elb_zq_jt_0003.html deleted file mode 100644 index 37102f984..000000000 --- a/docs/elb/api-ref/elb_zq_jt_0003.html +++ /dev/null @@ -1,262 +0,0 @@ - - -

Querying Details of a Listener

-

Function

This API is used to query details about a listener using its ID.

- -

URI

GET /v2.0/lbaas/listeners/{listener_id}

- - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-
- -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

listener

-

Object

-

Lists the listeners. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the listener is used.

-

name

-

String

-

Specifies the listener name.

-

description

-

String

-

Provides supplementary information about the listener.

-

protocol

-

String

-

Specifies the protocol used by the listener.

-

The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

-

protocol_port

-

Integer

-

Specifies the port used by the listener.

-

The port number ranges from 1 to 65535.

-

loadbalancers

-

Array

-

Specifies the ID of the associated load balancer. For details, see Table 6.

-

connection_limit

-

Integer

-

Specifies the maximum number of connections.

-

The value ranges from -1 to 2147483647. The default value is -1, indicating that there is no restriction on the maximum number of connections.

-

This parameter is reserved.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the listener.

-

This parameter is reserved. The value can be true or false.

-
  • true: The load balancer is enabled.
  • false: The load balancer is disabled.
-

http2_enable

-

Boolean

-

Specifies whether to use HTTP/2.

-

The value can be true or false.

-
  • true: HTTP/2 is used.
  • false: HTTP/2 is not used.
-

This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

default_pool_id

-

String

-

Specifies the ID of the associated backend server group.

-

If a request does not match the forwarding policy, the request is forwarded to the default backend server group for processing. If the value is null, the listener has no default backend server group.

-

default_tls_container_ref

-

String

-

Specifies the ID of the server certificate used by the listener. For details, see Certificate.

-

This parameter is mandatory when protocol is set to TERMINATED_HTTPS.

-

client_ca_tls_container_ref

-

String

-

Specifies the ID of the CA certificate used by the listener. For details, see Certificate.

-

sni_container_refs

-

Array

-

Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener.

-

If the parameter value is an empty list, the SNI feature is disabled.

-

tags

-

Array

-

Tags the listener.

-

created_at

-

String

-

Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

updated_at

-

String

-

Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

tls_ciphers_policy

-

String

-

Specifies the security policy used by the listener. This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

The value can be tls-1-0-inherit, tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0. For details of cipher suites for each security policy, see Table 3.

-
- - - - - - - - - - - - -
Table 4 loadbalancers parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated load balancer.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_zq_jt_0004.html b/docs/elb/api-ref/elb_zq_jt_0004.html deleted file mode 100644 index 03200fb0f..000000000 --- a/docs/elb/api-ref/elb_zq_jt_0004.html +++ /dev/null @@ -1,470 +0,0 @@ - - -

Updating a Listener

-

Function

This API is used to update a listener, such as listener name, description, associated backend server groups, and server certificates.

- -

Constraints

- -

URI

PUT /v2.0/lbaas/listeners/{listener_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-
- - -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

listener

-

Yes

-

Object

-

Specifies the listener. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 listener parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the listener name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the listener.

-

The value contains a maximum of 255 characters.

-

connection_limit

-

No

-

Integer

-

Specifies the maximum number of connections.

-

The value ranges from -1 to 2147483647.

-

This parameter is reserved. Only the administrator can specify the maximum number of connections.

-

http2_enable

-

No

-

Boolean

-

Specifies whether to use HTTP/2.

-

The value can be true or false.

-
  • true: HTTP/2 is used.
  • false: HTTP/2 is not used.
-

This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

default_pool_id

-

No

-

String

-

Specifies the ID of the associated backend server group.

-

If a request does not match the forwarding policy, the request is forwarded to the default backend server group for processing. If the value is null, the listener has no default backend server group.

-This parameter has the following constraints:
  • Its value cannot be the ID of any backend server group of other listeners.
  • Its value cannot be the ID of any backend server group associated with the forwarding policies set for other listeners.
- -The relationships between the protocol used by the listener and the protocol of the backend server group are as follows:
  • When the protocol used by the listener is TCP, the protocol of the backend server group must be TCP.
  • When the protocol used by the listener is UDP, the protocol of the backend server group must be UDP.
  • When the protocol used by the listener is HTTP or TERMINATED_HTTPS, the protocol of the backend server group must be HTTP.
- -

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the listener.

-

This parameter is reserved, and the default value is true.

-

default_tls_container_ref

-

No

-

String

-

Specifies the ID of the server certificate used by the listener.

-

The value contains a maximum of 128 characters.

- NOTE:

This parameter is valid only when protocol is set to TERMINATED_HTTPS.

- -

client_ca_tls_container_ref

-

No

-

String

-

Specifies the ID of the CA certificate used by the listener.

-

The value contains a maximum of 128 characters.

- NOTE:

This parameter is valid only when protocol is set to TERMINATED_HTTPS.

- -

sni_container_refs

-

No

-

Array

-

Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener.

-

If the parameter value is an empty list, the SNI feature is disabled.

- NOTE:

This parameter is valid only when protocol is set to TERMINATED_HTTPS.

- -

tls_ciphers_policy

-

No

-

String

-

Specifies the security policy used by the listener. This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

The value can be tls-1-0-inherit, tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0. For details of cipher suites for each security policy, see Table 4.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 tls_ciphers_policy parameter description

Security Policy

-

TLS Version

-

Cipher Suite

-

tls-1-0-inherit

-

TLS 1.2 TLS 1.1 TLS 1.0

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA

-

tls-1-0

-

TLS 1.2 TLS 1.1 TLS 1.0

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA

-

tls-1-1

-

TLS 1.2 TLS 1.1

-

tls-1-2

-

TLS 1.2

-

tls-1-2-strict

-

TLS 1.2

-

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384

-
- - -

Response

- - - - - - - - - - -
Table 5 Response parameters

Parameter

-

Type

-

Description

-

listener

-

Object

-

Specifies the listener. For details, see Table 6.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the listener ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the listener is used.

-

name

-

String

-

Specifies the listener name.

-

description

-

String

-

Provides supplementary information about the listener.

-

protocol

-

String

-

Specifies the protocol used by the listener.

-

The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

-

protocol_port

-

Integer

-

Specifies the port used by the listener.

-

The port number ranges from 1 to 65535.

-

loadbalancers

-

Array

-

Specifies the ID of the associated load balancer. For details, see Table 6.

-

connection_limit

-

Integer

-

Specifies the maximum number of connections.

-

The value ranges from -1 to 2147483647. The default value is -1, indicating that there is no restriction on the maximum number of connections.

-

This parameter is reserved.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the listener.

-

This parameter is reserved. The value can be true or false.

-
  • true: The load balancer is enabled.
  • false: The load balancer is disabled.
-

http2_enable

-

Boolean

-

Specifies whether to use HTTP/2.

-

The value can be true or false.

-
  • true: HTTP/2 is used.
  • false: HTTP/2 is not used.
-

This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

default_pool_id

-

String

-

Specifies the ID of the associated backend server group.

-

If a request does not match the forwarding policy, the request is forwarded to the default backend server group for processing. If the value is null, the listener has no default backend server group.

-

default_tls_container_ref

-

String

-

Specifies the ID of the server certificate used by the listener. For details, see Certificate.

-

This parameter is mandatory when protocol is set to TERMINATED_HTTPS.

-

client_ca_tls_container_ref

-

String

-

Specifies the ID of the CA certificate used by the listener. For details, see Certificate.

-

sni_container_refs

-

Array

-

Lists the IDs of SNI certificates (server certificates with a domain name) used by the listener.

-

If the parameter value is an empty list, the SNI feature is disabled.

-

tags

-

Array

-

Tags the listener.

-

created_at

-

String

-

Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

updated_at

-

String

-

Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

tls_ciphers_policy

-

String

-

Specifies the security policy used by the listener. This parameter is valid only when the protocol used by the listener is set to TERMINATED_HTTPS.

-

The value can be tls-1-0-inherit, tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0. For details of cipher suites for each security policy, see Table 3.

-
- - - - - - - - - - - - -
Table 7 loadbalancers parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated load balancer.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_zq_jt_0005.html b/docs/elb/api-ref/elb_zq_jt_0005.html deleted file mode 100644 index 5eb898eef..000000000 --- a/docs/elb/api-ref/elb_zq_jt_0005.html +++ /dev/null @@ -1,52 +0,0 @@ - - -

Deleting a Listener

-

Function

This API is used to delete a listener by ID.

- -

Constraints

All backend server groups associated with the listener must be deleted before the listener is deleted.

-

- -

URI

DELETE /v2.0/lbaas/listeners/{listener_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

listener_id

-

Yes

-

String

-

Specifies the listener ID.

-
- - -

Request

None

- -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Listener - - - diff --git a/docs/elb/api-ref/elb_zq_zf_0000.html b/docs/elb/api-ref/elb_zq_zf_0000.html deleted file mode 100644 index 96b3897b3..000000000 --- a/docs/elb/api-ref/elb_zq_zf_0000.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Forwarding Policy

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_zf_0001.html b/docs/elb/api-ref/elb_zq_zf_0001.html deleted file mode 100644 index 92b26d4df..000000000 --- a/docs/elb/api-ref/elb_zq_zf_0001.html +++ /dev/null @@ -1,485 +0,0 @@ - - -

Adding a Forwarding Policy

-

Function

This API is used to add a forwarding policy. The listener and forwarding policy determine how traffic is forwarded to backend servers.

- - -

Constraints

Currently, only redirects from an HTTP listener to an HTTPS listener are supported. When action is set to REDIRECT_TO_LISTENER, the listener specified by listener_id can only be an HTTP listener, and the listener specified by redirect_listener_id can only be an HTTPS listener.

-

The load balancer of the HTTPS listener to which traffic is redirected must be the same as that of the HTTP listener.

- -

URI

POST /v2.0/lbaas/l7policies

- -

Request

- - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy

-

Yes

-

Object

-

Specifies the forwarding policy. For details, see Table 2.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 l7policy parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the forwarding policy is used.

-

-

The value must be the same as the value of tenant_id in the token.

-

The value contains a maximum of 255 characters.

-

name

-

No

-

String

-

Specifies the forwarding policy name.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding policy.

-

This parameter is reserved, and the default value is true.

-

description

-

No

-

String

-

Provides supplementary information about the forwarding policy.

-

The value contains a maximum of 255 characters.

-

listener_id

-

Yes

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-
  • When action is set to REDIRECT_TO_POOL, forwarding policies can be added to a listener with protocol set to HTTP or TERMINATED_HTTPS.
  • When action is set to REDIRECT_TO_LISTENER, forwarding policies can be added to a listener with protocol set to HTTP.
-

action

-

Yes

-

String

-

Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

-

The value can be one of the following:

-
  • REDIRECT_TO_POOL: Requests are forwarded to the backend server group specified by redirect_pool_id.
  • REDIRECT_TO_LISTENER: Requests are redirected from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.
-

redirect_pool_id

-

No

-

String

-

Specifies the ID of the backend server group to which traffic is forwarded. The default value is null.

-

This parameter is mandatory when action is set to REDIRECT_TO_POOL.

-

This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.

-

The backend server group must meet the following requirements:

-
  • Cannot be the default backend server group of the listener.
  • Cannot be the backend server group used by forwarding policies of other listeners.
-

redirect_listener_id

-

No

-

String

-

Specifies the ID of the listener to which the traffic is redirected. The default value is null.

-

This parameter cannot be specified when action is set to REDIRECT_TO_POOL.

-

This parameter is mandatory when action is set to REDIRECT_TO_LISTENER, and the listener must meet the following requirements:

-
  • Can only be an HTTPS listener.
  • Can only be a listener of the same load balancer.
-

redirect_url

-

No

-

String

-

Specifies the URL to which traffic is redirected. The default value is null.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

position

-

No

-

Integer

-

Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

-

This parameter is reserved.

-

rules

-

No

-

Array

-

Lists the forwarding rules of the forwarding policy. For details, see Table 3.

-

The list contains a maximum of two rules, and the type parameter of each rule must be unique.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 rules parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule.

-

This parameter is reserved, and the default value is true.

-

type

-

Yes

-

String

-

Specifies the match type of a forwarding rule.

-

The value range varies depending on the protocol of the backend server group:

-
  • HOST_NAME: matches the domain name in the request.
  • PATH: matches the path in the request.
-

The match type of forwarding rules in a forwarding policy must be unique.

-

compare_type

-

Yes

-

String

-

Specifies the match mode. The options are as follows:

-

When type is set to HOST_NAME, the value of this parameter can only be the following:

-
  • EQUAL_TO: indicates exact match.
-

When type is set to PATH, the value of this parameter can be one of the following:

-
  • REGEX: indicates regular expression match.
  • STARTS_WITH: indicates prefix match.
  • EQUAL_TO: indicates exact match.
-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported.

-

The value can be true or false. The default value is false.

-

This parameter is reserved.

-

key

-

No

-

String

-

Specifies the key of the match content. The default value is null.

-

This parameter is reserved.

-

value

-

Yes

-

String

-

-

Specifies the value of the match content. The value cannot contain spaces.

-
  • When type is set to HOST_NAME, the value can contain a maximum of 100 characters that contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit.
  • When type is set to PATH, the value can contain a maximum of 128 characters. When compare_type is set to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|\/()[]{}
-
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

l7policy

-

Object

-

Specifies the forwarding policy. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 l7policy parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding policy ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding policy is used.

-

name

-

String

-

Specifies the forwarding policy name.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding policy.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

description

-

String

-

Provides supplementary information about the forwarding policy.

-

listener_id

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

action

-

String

-

Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

-

The value can be one of the following:

-
  • REDIRECT_TO_POOL: Requests are forwarded to the backend server group specified by redirect_pool_id.
  • REDIRECT_TO_LISTENER: Requests are redirected from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.
-

redirect_pool_id

-

String

-

Specifies the ID of the backend server group to which traffic is forwarded.

-

redirect_listener_id

-

String

-

Specifies the ID of the listener to which the traffic is redirected.

-

redirect_url

-

String

-

Specifies the URL to which traffic is redirected.

-

This parameter is reserved.

-

rules

-

Array

-

Lists the forwarding rules of the forwarding policy. For details, see Table 6.

-

position

-

Integer

-

Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

-

This parameter is reserved.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding policy.

-
- - - - - - - - - - - - -
Table 6 rules parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Lists the IDs of the forwarding rules in the forwarding policy.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/elb_zq_zf_0002.html b/docs/elb/api-ref/elb_zq_zf_0002.html deleted file mode 100644 index 495a65022..000000000 --- a/docs/elb/api-ref/elb_zq_zf_0002.html +++ /dev/null @@ -1,489 +0,0 @@ - - -

Querying Forwarding Policies

-

Function

This API is used to query the forwarding policies. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query. Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v2.0/lbaas/l7policies

- -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the forwarding policy from which pagination query starts, that is, the ID of the last forwarding policy on the previous page.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of forwarding policies on each page. If this parameter is not set, all forwarding policies are queried by default.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

String

-

Specifies the forwarding policy ID.

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the forwarding policy is used.

-

The value contains a maximum of 255 characters.

-

-

name

-

No

-

String

-

Specifies the forwarding policy name.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding policy.

-

This parameter is reserved, and the default value is true.

-

description

-

No

-

String

-

Provides supplementary information about the forwarding policy.

-

The value contains a maximum of 255 characters.

-

listener_id

-

No

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

action

-

No

-

String

-

Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

-

The value can be one of the following:

-
  • REDIRECT_TO_POOL: Requests are forwarded to the backend server group specified by redirect_pool_id.
  • REDIRECT_TO_LISTENER: Requests are redirected from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.
-

redirect_pool_id

-

No

-

String

-

Specifies the ID of the backend server group to which traffic is forwarded.

-

redirect_listener_id

-

No

-

String

-

Specifies the ID of the listener to which the traffic is redirected.

-

redirect_url

-

No

-

String

-

Specifies the URL to which traffic is redirected.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

position

-

No

-

Integer

-

Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

-

This parameter is reserved.

-

provisioning_status

-

No

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding policy.

-

display_all_rules

-

No

-

Boolean

-

Specifies whether to display all forwarding rules added to the forwarding policy.

-

Value options:

-

false: Forwarding rules will not be displayed, and only IDs are displayed.

-

true: Forwarding rules will be displayed.

-
- - -

Response

- - - - - - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

l7policies

-

Array

-

Lists the forwarding policies. For details, see Table 3.

-

l7policies_links

-

Array

-

Provides links to the previous or next page during pagination query, respectively.

-

This parameter exists only in the response body of pagination query.

-

For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 l7policy parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding policy ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding policy is used.

-

name

-

String

-

Specifies the forwarding policy name.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding policy.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

description

-

String

-

Provides supplementary information about the forwarding policy.

-

listener_id

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

action

-

String

-

Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

-

The value can be one of the following:

-
  • REDIRECT_TO_POOL: Requests are forwarded to the backend server group specified by redirect_pool_id.
  • REDIRECT_TO_LISTENER: Requests are redirected from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.
-

redirect_pool_id

-

String

-

Specifies the ID of the backend server group to which traffic is forwarded.

-

redirect_listener_id

-

String

-

Specifies the ID of the listener to which the traffic is redirected.

-

redirect_url

-

String

-

Specifies the URL to which traffic is redirected.

-

This parameter is reserved.

-

rules

-

Array

-

Lists the forwarding rules of the forwarding policy. For details, see Table 6.

-

position

-

Integer

-

Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

-

This parameter is reserved.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding policy.

-
- - - - - - - - - - - - -
Table 4 rules parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Lists the IDs of the forwarding rules in the forwarding policy.

-
- - - - - - - - - - - - - - - - -
Table 5 l7policies_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page.

-

The value can be next or previous. The value next indicates the href containing the URL of the next page, and previous indicates the href containing the URL of the previous page.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/elb_zq_zf_0003.html b/docs/elb/api-ref/elb_zq_zf_0003.html deleted file mode 100644 index 8f28ca231..000000000 --- a/docs/elb/api-ref/elb_zq_zf_0003.html +++ /dev/null @@ -1,219 +0,0 @@ - - -

Querying Details of a Forwarding Policy

-

Function

This API is used to query details about a forwarding policy.

- -

URI

GET /v2.0/lbaas/l7policies/{l7policy_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-
- - -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Type

-

Description

-

l7policy

-

Object

-

Specifies the forwarding policy. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 l7policy parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding policy ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding policy is used.

-

name

-

String

-

Specifies the forwarding policy name.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding policy.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

description

-

String

-

Provides supplementary information about the forwarding policy.

-

listener_id

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

action

-

String

-

Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

-

The value can be one of the following:

-
  • REDIRECT_TO_POOL: Requests are forwarded to the backend server group specified by redirect_pool_id.
  • REDIRECT_TO_LISTENER: Requests are redirected from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.
-

redirect_pool_id

-

String

-

Specifies the ID of the backend server group to which traffic is forwarded.

-

redirect_listener_id

-

String

-

Specifies the ID of the listener to which the traffic is redirected.

-

redirect_url

-

String

-

Specifies the URL to which traffic is redirected.

-

This parameter is reserved.

-

rules

-

Array

-

Lists the forwarding rules of the forwarding policy. For details, see Table 6.

-

position

-

Integer

-

Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

-

This parameter is reserved.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding policy.

-
- - - - - - - - - - - - -
Table 4 rules parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Lists the IDs of the forwarding rules in the forwarding policy.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/elb_zq_zf_0004.html b/docs/elb/api-ref/elb_zq_zf_0004.html deleted file mode 100644 index db9223408..000000000 --- a/docs/elb/api-ref/elb_zq_zf_0004.html +++ /dev/null @@ -1,322 +0,0 @@ - - -

Updating a Forwarding Policy

-

Function

This API is used to update a forwarding policy. You can select another backend server group or redirect to another HTTPS listener.

- -

URI

PUT /v2.0/lbaas/l7policies/{l7policy_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

Object

-

Specifies the forwarding policy ID.

-
- - -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy

-

Yes

-

Object

-

Specifies the forwarding policy. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 l7policy parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the forwarding policy name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the forwarding policy.

-

The value contains a maximum of 255 characters.

-

redirect_pool_id

-

No

-

String

-

Specifies the ID of the backend server group to which traffic is forwarded. The default value is null.

-

This parameter is mandatory when action is set to REDIRECT_TO_POOL.

-

This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.

-

The backend server group must meet the following requirements:

-
  • Cannot be the default backend server group of the listener.
  • Cannot be the backend server group used by forwarding policies of other listeners.
-

redirect_listener_id

-

No

-

String

-

Specifies the ID of the listener to which the traffic is redirected. The default value is null.

-

This parameter is mandatory when action is set to REDIRECT_TO_LISTENER.

-

This parameter cannot be specified when action is set to REDIRECT_TO_POOL. The listener must meet the following requirements:

-
  • Can only be an HTTPS listener.
  • Can only be a listener of the same load balancer.
-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding policy.

-

This parameter is reserved, and the default value is true.

-
- - -

Response

- - - - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy

-

Yes

-

Object

-

Specifies the forwarding policy. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 l7policy parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding policy ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding policy is used.

-

name

-

String

-

Specifies the forwarding policy name.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding policy.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

description

-

String

-

Provides supplementary information about the forwarding policy.

-

listener_id

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

action

-

String

-

Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

-

The value can be one of the following:

-
  • REDIRECT_TO_POOL: Requests are forwarded to the backend server group specified by redirect_pool_id.
  • REDIRECT_TO_LISTENER: Requests are redirected from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.
-

redirect_pool_id

-

String

-

Specifies the ID of the backend server group to which traffic is forwarded.

-

redirect_listener_id

-

String

-

Specifies the ID of the listener to which the traffic is redirected.

-

redirect_url

-

String

-

Specifies the URL to which traffic is redirected.

-

This parameter is reserved.

-

rules

-

Array

-

Lists the forwarding rules of the forwarding policy. For details, see Table 6.

-

position

-

Integer

-

Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

-

This parameter is reserved.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding policy.

-
- - - - - - - - - - - - -
Table 6 rules parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Lists the IDs of the forwarding rules in the forwarding policy.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/elb_zq_zf_0005.html b/docs/elb/api-ref/elb_zq_zf_0005.html deleted file mode 100644 index 8f7152871..000000000 --- a/docs/elb/api-ref/elb_zq_zf_0005.html +++ /dev/null @@ -1,49 +0,0 @@ - - -

Deleting a Forwarding Policy

-

Function

This API is used to delete a specific forwarding policy.

- -

URI

DELETE /v2.0/lbaas/l7policies/{l7policy_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

Object

-

Specifies the forwarding policy ID.

-
- - -

Request

None

- -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/elb_zq_zg_0000.html b/docs/elb/api-ref/elb_zq_zg_0000.html deleted file mode 100644 index 70f5ecbe6..000000000 --- a/docs/elb/api-ref/elb_zq_zg_0000.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Forwarding Rule

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_zg_0001.html b/docs/elb/api-ref/elb_zq_zg_0001.html deleted file mode 100644 index 7056ff6ae..000000000 --- a/docs/elb/api-ref/elb_zq_zg_0001.html +++ /dev/null @@ -1,297 +0,0 @@ - - -

Adding a Forwarding Rule

-

Function

This API is used to add a forwarding rule. After you add a forwarding rule, the load balancer matches the domain name and path in the request and distributes the traffic to the backend server group specified by redirect_pool_id of the associated forwarding policy.

- -

Constraints

The match type of forwarding rules in a forwarding policy must be unique.

- -

URI

POST /v2.0/lbaas/l7policies/{l7policy_id}/rules

- - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-
- -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

rule

-

Yes

-

Object

-

Specifies the forwarding rule. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 rule parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the forwarding rule is used.

-

-

The value must be the same as the value of project_id in the token.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule.

-

This parameter is reserved, and the default value is true.

-

type

-

Yes

-

String

-

Specifies the match type of a forwarding rule.

-

The value can be one of the following:

-
  • HOST_NAME: matches the domain name in the request.
  • PATH: matches the path in the request.
-

The match type of forwarding rules in a forwarding policy must be unique.

-

compare_type

-

Yes

-

String

-

Specifies the match mode. The options are as follows:

-

When type is set to HOST_NAME, the value of this parameter can only be the following:

-
  • EQUAL_TO: indicates exact match.
-

When type is set to PATH, the value of this parameter can be one of the following:

-
  • REGEX: indicates regular expression match.
  • STARTS_WITH: indicates prefix match.
  • EQUAL_TO: indicates exact match.
-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported.

-

The value can be true or false. The default value is false.

-

This parameter is reserved.

-

key

-

No

-

String

-

Specifies the key of the match content. The default value is null.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

value

-

Yes

-

String

-

Specifies the value of the match content. The value cannot contain spaces.

-

The value contains a maximum of 128 characters.

-
  • When type is set to HOST_NAME, the value can contain a maximum of 100 characters that contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit.
  • When type is set to PATH, the value can contain a maximum of 128 characters. When compare_type is set to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:| \/()[]{}
-
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

rule

-

Object

-

Specifies the forwarding rule. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 rule parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding rule ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding rule is used.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding rule.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

type

-

String

-

Specifies the match type of a forwarding rule.

-

The value can be one of the following:

-
  • HOST_NAME: matches the domain name in the request.
  • PATH: matches the path in the request.
-

compare_type

-

String

-

Specifies the match mode. The options are as follows:

-

When type is set to HOST_NAME, the value of this parameter can only be the following:

-
  • EQUAL_TO: indicates exact match.
-

When type is set to PATH, the value of this parameter can be one of the following:

-
  • REGEX: indicates regular expression match.
  • STARTS_WITH: indicates prefix match.
  • EQUAL_TO: indicates exact match.
-

invert

-

Boolean

-

Specifies whether reverse matching is supported.

-

The value can be true or false. The default value is false.

-

This parameter is reserved.

-

key

-

String

-

Specifies the key of the match content. The default value is null.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

value

-

String

-

Specifies the value of the match content.

-

The value contains a maximum of 128 characters.

-
  • When type is set to HOST_NAME, the value can contain a maximum of 100 characters that contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit.
  • When type is set to PATH, the value can contain a maximum of 128 characters. When compare_type is set to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:| \/()[]{}
-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding rule.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/elb_zq_zg_0002.html b/docs/elb/api-ref/elb_zq_zg_0002.html deleted file mode 100644 index ef6056ea6..000000000 --- a/docs/elb/api-ref/elb_zq_zg_0002.html +++ /dev/null @@ -1,369 +0,0 @@ - - -

Querying Forwarding Rules

-

Function

This API is used to query forwarding rules. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query. Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v2.0/lbaas/l7policies/{l7policy_id}/rules

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-
- - -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the forwarding rule from which pagination query starts, that is, the ID of the last forwarding rule on the previous page.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of forwarding rules on each page. If this parameter is not set, all forwarding rules are queried by default.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

String

-

Specifies the forwarding rule ID.

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the forwarding rule is used.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule.

-

This parameter is reserved, and the default value is true.

-

type

-

No

-

String

-

Specifies the match type of a forwarding rule.

-

The value can be one of the following:

-
  • HOST_NAME: matches the domain name in the request.
  • PATH: matches the path in the request.
-

The match type of forwarding rules in a forwarding policy must be unique.

-

compare_type

-

No

-

String

-

Specifies the match mode. The options are as follows:

-

When type is set to HOST_NAME, the value of this parameter can only be the following:

-
  • EQUAL_TO: indicates exact match.
-

When type is set to PATH, the value of this parameter can be one of the following:

-
  • REGEX: indicates regular expression match.
  • STARTS_WITH: indicates prefix match.
  • EQUAL_TO: indicates exact match.
-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported.

-

The value can be true or false. The default value is false.

-

This parameter is reserved.

-

key

-

No

-

String

-

Specifies the key of the match content. The default value is null.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

value

-

No

-

String

-

-

Specifies the value of the match content.

-

The value contains a maximum of 128 characters.

-
  • When type is set to HOST_NAME, the value can contain a maximum of 100 characters that contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit.
  • When type is set to PATH, the value can contain a maximum of 128 characters. When compare_type is set to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:| \/()[]{}
-

provisioning_status

-

No

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding rule.

-
- - -

Response

- - - - - - - - - - - - - - -
Table 3 Response parameters

Parameter

-

Type

-

Description

-

rules

-

Array

-

Lists the forwarding rules. For details, see Table 4.

-

rules_links

-

Array

-

Provides links to the previous or next page during pagination query, respectively.

-

This parameter exists only in the response body of pagination query.

-

For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 rules parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding rule ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding rule is used.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding rule.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

type

-

String

-

Specifies the match type of a forwarding rule.

-

The value can be one of the following:

-
  • HOST_NAME: matches the domain name in the request.
  • PATH: matches the path in the request.
-

compare_type

-

String

-

Specifies the match mode. The options are as follows:

-

When type is set to HOST_NAME, the value of this parameter can only be the following:

-
  • EQUAL_TO: indicates exact match.
-

When type is set to PATH, the value of this parameter can be one of the following:

-
  • REGEX: indicates regular expression match.
  • STARTS_WITH: indicates prefix match.
  • EQUAL_TO: indicates exact match.
-

invert

-

Boolean

-

Specifies whether reverse matching is supported.

-

The value can be true or false. The default value is false.

-

This parameter is reserved.

-

key

-

String

-

Specifies the key of the match content. The default value is null.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

value

-

String

-

Specifies the value of the match content.

-

The value contains a maximum of 128 characters.

-
  • When type is set to HOST_NAME, the value can contain a maximum of 100 characters that contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit.
  • When type is set to PATH, the value can contain a maximum of 128 characters. When compare_type is set to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:| \/()[]{}
-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding rule.

-
- - - - - - - - - - - - - - - - -
Table 5 rules_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page.

-

The value can be next or previous. The value next indicates the href containing the URL of the next page, and previous indicates the href containing the URL of the previous page.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/elb_zq_zg_0003.html b/docs/elb/api-ref/elb_zq_zg_0003.html deleted file mode 100644 index c403d9a06..000000000 --- a/docs/elb/api-ref/elb_zq_zg_0003.html +++ /dev/null @@ -1,180 +0,0 @@ - - -

Querying Details of a Forwarding Rule

-

Function

This API is used to query details about a forwarding rule using its ID.

- -

URI

GET /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}

- - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-

l7rule_id

-

Yes

-

String

-

Specifies the forwarding rule ID.

-
- -

Request

None

- -

Response

- - - - - - - - - - -
Table 2 Response parameters

Parameter

-

Type

-

Description

-

rule

-

Object

-

Specifies the forwarding rule. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 rule parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding rule ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding rule is used.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding rule.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

type

-

String

-

Specifies the match type of a forwarding rule.

-

The value can be one of the following:

-
  • HOST_NAME: matches the domain name in the request.
  • PATH: matches the path in the request.
-

compare_type

-

String

-

Specifies the match mode. The options are as follows:

-

When type is set to HOST_NAME, the value of this parameter can only be the following:

-
  • EQUAL_TO: indicates exact match.
-

When type is set to PATH, the value of this parameter can be one of the following:

-
  • REGEX: indicates regular expression match.
  • STARTS_WITH: indicates prefix match.
  • EQUAL_TO: indicates exact match.
-

invert

-

Boolean

-

Specifies whether reverse matching is supported.

-

The value can be true or false. The default value is false.

-

This parameter is reserved.

-

key

-

String

-

Specifies the key of the match content. The default value is null.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

value

-

String

-

Specifies the value of the match content.

-

The value contains a maximum of 128 characters.

-
  • When type is set to HOST_NAME, the value can contain a maximum of 100 characters that contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit.
  • When type is set to PATH, the value can contain a maximum of 128 characters. When compare_type is set to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:| \/()[]{}
-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding rule.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/elb_zq_zg_0004.html b/docs/elb/api-ref/elb_zq_zg_0004.html deleted file mode 100644 index 654ed2d54..000000000 --- a/docs/elb/api-ref/elb_zq_zg_0004.html +++ /dev/null @@ -1,279 +0,0 @@ - - -

Updating a Forwarding Rule

-

Function

This API is used to update a forwarding rule. You can change the mode that how traffic is distributed by updating the forwarding rule.

- -

URI

PUT /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}

- - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-

l7rule_id

-

Yes

-

String

-

Specifies the forwarding rule ID.

-
- -

Request

- - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

rule

-

Yes

-

Object

-

Specifies the forwarding rule. For details, see Table 3.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 rule parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

compare_type

-

No

-

String

-

Specifies the match mode. The options are as follows:

-

When type is set to HOST_NAME, the value of this parameter can only be the following:

-
  • EQUAL_TO: indicates exact match.
-

When type is set to PATH, the value of this parameter can be one of the following:

-
  • REGEX: indicates regular expression match.
  • STARTS_WITH: indicates prefix match.
  • EQUAL_TO: indicates exact match.
-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule.

-

This parameter is reserved, and the default value is true.

-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported.

-

The value can be true or false. The default value is false.

-

This parameter is reserved.

-

key

-

No

-

String

-

Specifies the key of the match content. The default value is null.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

value

-

No

-

String

-

Specifies the value of the match content. The value cannot contain spaces.

-

The value contains a maximum of 128 characters.

-
  • When type is set to HOST_NAME, the value can contain a maximum of 100 characters that contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit.
  • When type is set to PATH, the value can contain a maximum of 128 characters. When compare_type is set to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:| \/()[]{}
-
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

rule

-

Object

-

Specifies the forwarding rule. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 rule parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding rule ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding rule is used.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding rule.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

type

-

String

-

Specifies the match type of a forwarding rule.

-

The value can be one of the following:

-
  • HOST_NAME: matches the domain name in the request.
  • PATH: matches the path in the request.
-

compare_type

-

String

-

Specifies the match mode. The options are as follows:

-

When type is set to HOST_NAME, the value of this parameter can only be the following:

-
  • EQUAL_TO: indicates exact match.
-

When type is set to PATH, the value of this parameter can be one of the following:

-
  • REGEX: indicates regular expression match.
  • STARTS_WITH: indicates prefix match.
  • EQUAL_TO: indicates exact match.
-

invert

-

Boolean

-

Specifies whether reverse matching is supported.

-

The value can be true or false. The default value is false.

-

This parameter is reserved.

-

key

-

String

-

Specifies the key of the match content. The default value is null.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

value

-

String

-

Specifies the value of the match content.

-

The value contains a maximum of 128 characters.

-
  • When type is set to HOST_NAME, the value can contain a maximum of 100 characters that contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit.
  • When type is set to PATH, the value can contain a maximum of 128 characters. When compare_type is set to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:| \/()[]{}
-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding rule.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/elb_zq_zg_0005.html b/docs/elb/api-ref/elb_zq_zg_0005.html deleted file mode 100644 index 249409782..000000000 --- a/docs/elb/api-ref/elb_zq_zg_0005.html +++ /dev/null @@ -1,58 +0,0 @@ - - -

Deleting a Forwarding Rule

-

Function

This API is used to delete a specific forwarding rule.

- -

URI

DELETE /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}

- - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy_id

-

Yes

-

String

-

Specifies the forwarding policy ID.

-

l7rule_id

-

Yes

-

String

-

Specifies the forwarding rule ID.

-
- - -

Request

None

- -

Response

None

- -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Forwarding Rule - - - diff --git a/docs/elb/api-ref/elb_zq_zs_0000.html b/docs/elb/api-ref/elb_zq_zs_0000.html deleted file mode 100644 index 4a7e7c3aa..000000000 --- a/docs/elb/api-ref/elb_zq_zs_0000.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Certificate

- - - - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/elb_zq_zs_0001.html b/docs/elb/api-ref/elb_zq_zs_0001.html deleted file mode 100644 index 940b870bb..000000000 --- a/docs/elb/api-ref/elb_zq_zs_0001.html +++ /dev/null @@ -1,256 +0,0 @@ - - -

Creating a Certificate

-

Function

This API is used to create a certificate. After a certificate is bound to a listener, the load balancer authenticates the client using this certificate, and backend servers can establish secure and reliable HTTP connections with the client.

- -

URI

POST /v2.0/lbaas/certificates

- -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the certificate is used.

-

-

The value must be the same as the value of project_id in the token.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is reserved, and the default value is true.

-

name

-

No

-

String

-

Specifies the certificate name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the certificate.

-

The value contains a maximum of 255 characters.

-

type

-

No

-

String

-

Specifies the certificate type. The default value is server.

-The value can be one of the following:
  • server: indicates the server certificate.
  • client: indicates the CA certificate.
- -

domain

-

No

-

String

-

Specifies the domain name associated with the server certificate. The default value is null.

-

The value contains a maximum of 100 characters.

-

The value can be one of the following:

-
  • A common domain name contains 0 to 100 characters and consists of several labels separated by dots (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit.
  • In addition to the requirements for common domain names, a wildcard domain name can start with an asterisk (*).
- NOTE:

This parameter is valid only when type is set to server.

- -

private_key

-

No

-

String

-

Specifies the private key of the server certificate. The value must be PEM encoded.

-
  • This parameter will be ignored if type is set to client. A CA server can still be created and used normally. This parameter will be left blank even if you enter a private key that is not PEM encoded.
  • This parameter is valid and mandatory only when type is set to server. If you enter an invalid private key, an error is returned.
-

certificate

-

Yes

-

String

-

Specifies the public key of the server certificate or CA certificate used to authenticate the client. The value of parameter type determines whether a public key or CA certificate is required.

-

The public key is in PEM format.

-
- - -

Response

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the certificate ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the certificate is used.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

name

-

String

-

Specifies the certificate name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the certificate.

-

The value contains a maximum of 255 characters.

-

type

-

String

-

Specifies the certificate type.

-The value can be one of the following:
  • server: indicates the server certificate.
  • client: indicates the CA certificate.
- -

domain

-

String

-

Specifies the domain name associated with the server certificate.

-

The value contains a maximum of 100 characters.

-

private_key

-

String

-

Specifies the private key of the server certificate in PEM format.

-

certificate

-

String

-

Specifies the public key of the server certificate or CA certificate used to authenticate the client. The value of parameter type determines whether a public key or CA certificate is required. Both types of certificates are in PEM format.

-

expire_time

-

String

-

Specifies the time when the certificate expires.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

create_time

-

String

-

Specifies the time when the certificate was created.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

update_time

-

String

-

Specifies the time when the certificate was updated.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/elb_zq_zs_0002.html b/docs/elb/api-ref/elb_zq_zs_0002.html deleted file mode 100644 index 50623a416..000000000 --- a/docs/elb/api-ref/elb_zq_zs_0002.html +++ /dev/null @@ -1,479 +0,0 @@ - - -

Querying Certificates

-

Function

This API is used to query all the certificates. Filter query and pagination query are supported. Unless otherwise specified, exact match is applied.

- -

Constraints

Parameters marker, limit, and page_reverse are used for pagination query. Parameters marker and page_reverse take effect only when they are used together with parameter limit.

- -

URI

GET /v2.0/lbaas/certificates

- -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the certificate from which pagination query starts, that is, the ID of the last certificate on the previous page.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of certificates on each page. If this parameter is not set, all certificates are queried by default.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

String

-

Specifies the certificate ID.

-

name

-

No

-

String

-

Specifies the certificate name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the certificate.

-

The value contains a maximum of 255 characters.

-

type

-

No

-

String

-

Specifies the certificate type. The default value is server.

-The value can be one of the following:
  • server: indicates the server certificate.
  • client: indicates the CA certificate.
- -

domain

-

No

-

String

-

Specifies the domain name associated with the server certificate. The default value is null.

-

The value contains a maximum of 100 characters.

-

The value can be one of the following:

-
  • A common domain name contains 0 to 100 characters and consists of several labels separated by dots (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit.
  • In addition to the requirements for common domain names, a wildcard domain name can start with an asterisk (*).
  • This parameter is valid only when type is set to server.
-

private_key

-

No

-

String

-		Specifies the private key of the server certificate. The value must be PEM encoded.
  • This parameter will be ignored if type is set to client. A CA server can still be created and used normally. This parameter will be left blank even if you enter a private key that is not PEM encoded.
  • This parameter is valid and mandatory only when type is set to server. If you enter an invalid private key, an error is returned.
-

certificate

-

No

-

String

-

Specifies the public key of the server certificate or CA certificate used to authenticate the client. The value of parameter type determines whether a public key or CA certificate is required. Both types of certificates are in PEM format.

-

create_time

-

No

-

String

-

Specifies the time when the certificate was created.

-

The UTC time is in YYYY-MM-DD HH:MM:SS format.

-

update_time

-

No

-

String

-

Specifies the time when the certificate was updated.

-

The UTC time is in YYYY-MM-DD HH:MM:SS format.

-
- - -

Response

- - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Type

-

Description

-

certificates

-

Array

-

Lists the certificates. For details, see Table 3.

-

instance_num

-

Integer

-

Specifies the number of certificates.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 certificates parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the certificate ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the certificate is used.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

name

-

String

-

Specifies the certificate name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the certificate.

-

The value contains a maximum of 255 characters.

-

type

-

String

-

Specifies the certificate type.

-The value can be one of the following:
  • server: indicates the server certificate.
  • client: indicates the CA certificate.
- -

domain

-

String

-

Specifies the domain name associated with the server certificate.

-

The value contains a maximum of 100 characters.

-

private_key

-

String

-

Specifies the private key of the server certificate in PEM format.

-

certificate

-

String

-

Specifies the public key of the server certificate or CA certificate used to authenticate the client. The value of parameter type determines whether a public key or CA certificate is required. Both types of certificates are in PEM format.

-

expire_time

-

String

-

Specifies the time when the certificate expires.

-

The UTC time is in YYYY-MM-DD HH:MM:SS format.

-

create_time

-

String

-

Specifies the time when the certificate was created.

-

The UTC time is in YYYY-MM-DD HH:MM:SS format.

-

update_time

-

String

-

Specifies the time when the certificate was updated.

-

The UTC time is in YYYY-MM-DD HH:MM:SS format.

-
- - -

Example Request

- - -

Example Response

- - -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/elb_zq_zs_0003.html b/docs/elb/api-ref/elb_zq_zs_0003.html deleted file mode 100644 index ac583771d..000000000 --- a/docs/elb/api-ref/elb_zq_zs_0003.html +++ /dev/null @@ -1,214 +0,0 @@ - - -

Querying Details of a Certificate

-

Function

This API is used to query details about a certificate.

- -

URI

GET /v2.0/lbaas/certificates/{certificate_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

certificate_id

-

Yes

-

String

-

Specifies the certificate ID.

-
- - -

Request

None

- -

Response

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the certificate ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the certificate is used.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

name

-

String

-

Specifies the certificate name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the certificate.

-

The value contains a maximum of 255 characters.

-

type

-

String

-

Specifies the certificate type.

-The value can be one of the following:
  • server: indicates the server certificate.
  • client: indicates the CA certificate.
- -

domain

-

String

-

Specifies the domain name associated with the server certificate.

-

The value contains a maximum of 100 characters.

-

private_key

-

String

-

Specifies the private key of the server certificate in PEM format.

-

certificate

-

String

-

Specifies the public key of the server certificate or CA certificate used to authenticate the client. The value of parameter type determines whether a public key or CA certificate is required. Both types of certificates are in PEM format.

-

expire_time

-

String

-

Specifies the time when the certificate expires.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

create_time

-

String

-

Specifies the time when the certificate was created.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

update_time

-

String

-

Specifies the time when the certificate was updated.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/elb_zq_zs_0004.html b/docs/elb/api-ref/elb_zq_zs_0004.html deleted file mode 100644 index 7eed0d468..000000000 --- a/docs/elb/api-ref/elb_zq_zs_0004.html +++ /dev/null @@ -1,326 +0,0 @@ - - -

Updating a Certificate

-

Function

This API is used to update a certificate.

- -

URI

PUT /v2.0/lbaas/certificates/{certificate_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

certificate_id

-

Yes

-

String

-

Specifies the certificate ID.

-
- - -

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is reserved, and the default value is true.

-

name

-

No

-

String

-

Specifies the certificate name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the certificate.

-

The value contains a maximum of 255 characters.

-

domain

-

No

-

String

-

Specifies the domain name associated with the server certificate. The default value is null.

-

The value contains a maximum of 100 characters.

-

The value can be one of the following:

-
  • A common domain name contains 0 to 100 characters and consists of several labels separated by dots (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit.
  • In addition to the requirements for common domain names, a wildcard domain name can start with an asterisk (*).
- NOTE:

This parameter is valid only when type is set to server.

- -

private_key

-

No

-

String

-

Specifies the private key of the server certificate. The value must be PEM encoded.

-
  • This parameter will be ignored if type is set to client. A CA server can still be created and used normally. This parameter will be left blank even if you enter a private key that is not PEM encoded.
  • This parameter is valid and mandatory only when type is set to server. If you enter an invalid private key, an error is returned.
-

certificate

-

No

-

String

-

Specifies the public key of the server certificate or CA certificate used to authenticate the client. The value of parameter type determines whether a public key or CA certificate is required.

-

The public key is in PEM format.

-
- - -

Response

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the certificate ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the certificate is used.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the certificate.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

name

-

String

-

Specifies the certificate name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the certificate.

-

The value contains a maximum of 255 characters.

-

type

-

String

-

Specifies the certificate type.

-The value can be one of the following:
  • server: indicates the server certificate.
  • client: indicates the CA certificate.
- -

domain

-

String

-

Specifies the domain name associated with the server certificate.

-

The value contains a maximum of 100 characters.

-

private_key

-

String

-

Specifies the private key of the server certificate in PEM format.

-

certificate

-

String

-

Specifies the public key of the server certificate or CA certificate used to authenticate the client. The value of parameter type determines whether a public key or CA certificate is required. Both types of certificates are in PEM format.

-

expire_time

-

String

-

Specifies the time when the certificate expires.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

create_time

-

String

-

Specifies the time when the certificate was created.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

update_time

-

String

-

Specifies the time when the certificate was updated.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/elb_zq_zs_0005.html b/docs/elb/api-ref/elb_zq_zs_0005.html deleted file mode 100644 index 2a63856d6..000000000 --- a/docs/elb/api-ref/elb_zq_zs_0005.html +++ /dev/null @@ -1,53 +0,0 @@ - - -

Deleting a Certificate

-

Function

This API is used to delete a specific certificate.

- -

Constraints

If the target certificate is used by a listener, the certificate cannot be deleted, and 409 code will be displayed.

- -

URI

DELETE /v2.0/lbaas/certificates/{certificate_id}

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

certificate_id

-

Yes

-

String

-

Specifies the certificate ID.

-
- - -

Request

- -

Response

- -

Example Request

- -

Example Response

- -

Status Code

For details, see Status Codes.

- - - - -Parent topic: Certificate - - - diff --git a/docs/elb/api-ref/en-us_image_0294158472.png b/docs/elb/api-ref/en-us_image_0294158472.png deleted file mode 100644 index c55acabcb..000000000 Binary files a/docs/elb/api-ref/en-us_image_0294158472.png and /dev/null differ diff --git a/docs/elb/api-ref/en-us_topic_0000001088310753.html b/docs/elb/api-ref/en-us_topic_0000001088310753.html deleted file mode 100644 index f346bd8c6..000000000 --- a/docs/elb/api-ref/en-us_topic_0000001088310753.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

API Call Precaution

-

By default, load balancers created in the eu-nl region are dedicated load balancers. APIs for dedicated load balancers are only available in this region. Shared load balancers and dedicated load balancers are called elastic load balancers collectively.

- - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/en-us_topic_0000001088335195.html b/docs/elb/api-ref/en-us_topic_0000001088335195.html deleted file mode 100644 index 202053247..000000000 --- a/docs/elb/api-ref/en-us_topic_0000001088335195.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

API Call Precaution

-

By default, load balancers created in the eu-de region are shared load balancers. APIs for shared load balancers are only available in this region. Shared load balancers and dedicated load balancers are called elastic load balancers collectively.

- - - -Parent topic: Shared Load Balancer APIs - - - diff --git a/docs/elb/api-ref/en-us_topic_0000001124568811.html b/docs/elb/api-ref/en-us_topic_0000001124568811.html deleted file mode 100644 index d4e96a711..000000000 --- a/docs/elb/api-ref/en-us_topic_0000001124568811.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

API Call Precaution

-

Classic load balancers are not supported in the eu-nl region.

- - - -Parent topic: Classic Load Balancer APIs - - - diff --git a/docs/elb/api-ref/en-us_topic_0000001127879251.html b/docs/elb/api-ref/en-us_topic_0000001127879251.html deleted file mode 100644 index eec29e9c8..000000000 --- a/docs/elb/api-ref/en-us_topic_0000001127879251.html +++ /dev/null @@ -1,129 +0,0 @@ - - -

Creating a Dedicated Load Balancer and Binding a New EIP to It

-

Scenarios

Call APIs to create a dedicated load balancer and bind a new EIP to it.

- -

Prerequisites

You have created a VPC and a subnet.

- -

Procedure

  1. Query the subnet you have created.
    1. Send GET https://{vpc_endpoint}/v1/{project_id}/subnets. project_id indicates the project ID.
    2. Add X-Auth-Token to the request header.
    3. Check the response.
      • The request is successful if the following response is displayed:
        {
-    "subnets": [
-	{
-            "id": "0535759e-8104-49d9-902c-a05185a94bdf", // Subnet ID
-            "name": "subnet-001", // Subnet name
-            "description": "",
-            "cidr": "172.16.66.0/24", //IPv4 address range
-            "dnsList": [
-                "100.125.4.6"
-            ],
-            "status": "ACTIVE",
-            "vpc_id": "44789a9f-3e80-451a-ac03-0818f99b6cdd", // VPC ID
-            "ipv6_enable": true,
-            "gateway_ip_v6": "2001:db8:a583:37c::1",
-            "cidr_v6": "2001:db8:a583:37c::/64",
-            "gateway_ip": "172.16.66.1",
-            "dhcp_enable": true,
-            "primary_dns": "100.125.4.6",
-            "availability_zone": "eu-de-01", //AZ of the subnet
-            "neutron_network_id": "0535759e-8104-49d9-902c-a05185a94bdf", // Network ID
-            "neutron_subnet_id": "1492f0ba-cfce-4e2c-86f7-561d757dfeee", // IPv4 subnet ID
-            "neutron_subnet_id_v6": "3c052475-b50b-49b9-abb1-558bad45e592",
-            "extra_dhcp_opts": [
-                {
-                    "opt_value": "8760h",
-                    "opt_name": "addresstime"
-                }
-            ]
-        }
-    ]
-}
-
        -
      • If the request is abnormal, locate the fault by referring to HTTP Status Codes for Dedicated Load Balancers.
      -
    -
  2. Create a dedicated load balancer and bind a new EIP to it.
    1. Send POST https://{elb_endpoint}/v3/{project_id}/elb/loadbalancers. project_id indicates the project ID.
    2. Add X-Auth-Token to the request header.
    3. Ensure that the following parameters, including publicip, are passed in the request body:
      {
-	"loadbalancer": {
-            "vpc_id": "e5a892ff-3c33-44ef-ada5-b713eb1f7a8b",
-            "availability_zone_list": [
-                "br-iaas-odin1a"
-            ],
-            "admin_state_up": true,
-            "vip_subnet_cidr_id": "1800b6b8-a69f-4719-813d-24d62aaf32bd",
-            "name": "elb-ipv4",
-            "publicip": {
-               "network_type": "5_bgp",
-               "bandwidth": {
-                   "size": 2,
-                   "share_type": "PER",
-                   "charge_mode": "bandwidth",
-                   "name": "elb_eip_bandwidth"
-               }
-          }
-    }
-}
-
      -
    4. Check the response.
      • The request is successful if the following response is displayed:
        {
-    "request_id": "21177eb184c52c5a4540c78dc7fdaee4",
-    "loadbalancer": {
-        "id": "a2556f92-3310-4173-a6d1-0b2d0bb68478",
-        "project_id": "060576782980d5762f9ec014dd2f1148",
-        "name": "elb-ipv4",
-        "description": "",
-        "vip_port_id": "fff961a9-4514-4469-84d4-a2bc4fbdfbeb",
-        "vip_address": "192.168.0.162",
-        "admin_state_up": true,
-        "provisioning_status": "ACTIVE",
-        "operating_status": "ONLINE",
-        "listeners": [],
-        "pools": [],
-        "tags": [],
-        "provider": "vlb",
-        "created_at": "2021-02-23T08:50:19Z",
-        "updated_at": "2021-02-23T08:50:19Z",
-        "vpc_id": "e5a892ff-3c33-44ef-ada5-b713eb1f7a8b",
-        "enterprise_project_id": "0",
-        "availability_zone_list": [
-            "br-iaas-odin1a"
-        ],
-        "ipv6_vip_address": null,
-        "ipv6_vip_virsubnet_id": null,
-        "ipv6_vip_port_id": null,
-        "ipv6_bandwidth": null,
-        "publicips": [
-            {
-                "publicip_id": "12cba100-764e-476c-bf3f-8aba98782cf5",
-                "publicip_address": "10.246.173.188",
-                "ip_version": 4
-            }
-        ],
-        "elb_virsubnet_ids": [
-            "4df3e391-5ebf-4300-b614-cf5a4e793666"
-        ],
-        "elb_virsubnet_type": "dualstack",
-        "ip_target_enable": false,
-        "frozen_scene": null,
-        "eips": [
-            {
-                "eip_id": "12cba100-764e-476c-bf3f-8aba98782cf5",
-                "eip_address": "10.246.173.188",
-                "ip_version": 4
-            }
-        ],
-        "guaranteed": true,
-        "billing_info": null,
-        "l4_flavor_id": null,
-        "l4_scale_flavor_id": null,
-        "l7_flavor_id": null,
-        "l7_scale_flavor_id": null,
-        "vip_subnet_cidr_id": "1800b6b8-a69f-4719-813d-24d62aaf32bd"
-    }
-}
        -
      • If the request is abnormal, locate the fault by referring to HTTP Status Codes for Dedicated Load Balancers.
      -
    -
- - - - -Parent topic: Examples - - - diff --git a/docs/elb/api-ref/en-us_topic_0022480177.html b/docs/elb/api-ref/en-us_topic_0022480177.html deleted file mode 100644 index 436dd8616..000000000 --- a/docs/elb/api-ref/en-us_topic_0022480177.html +++ /dev/null @@ -1,8 +0,0 @@ - - -

API Usage Guidelines

-

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

-

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

-

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

- - diff --git a/docs/elb/api-ref/en-us_topic_0096561504.html b/docs/elb/api-ref/en-us_topic_0096561504.html deleted file mode 100644 index 99d894341..000000000 --- a/docs/elb/api-ref/en-us_topic_0096561504.html +++ /dev/null @@ -1,254 +0,0 @@ - - -

Querying Load Balancers

-

Function

This API is used to query load balancers and display them in a list.

- -

URI

GET /v1.0/{project_id}/elbaas/loadbalancers

- - - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Specifies the project ID.

-
- - -

Request

- - -

Response

- - -

Status Codes

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/en-us_topic_0096561535.html b/docs/elb/api-ref/en-us_topic_0096561535.html deleted file mode 100644 index 31a1b3475..000000000 --- a/docs/elb/api-ref/en-us_topic_0096561535.html +++ /dev/null @@ -1,570 +0,0 @@ - - -

Creating a Load Balancer

-

Function

This API is used to create a private network load balancer. After the load balancer is created, its details, such as load balancer ID, IP address, and subnet ID, are returned.

-

To create a public network load balancer, you also need to call the API for assigning an EIP and associate this IP address to the port bound to the IP address of the private network load balancer.

- -

URI

POST /v2.0/lbaas/loadbalancers

- -

Request

- - - - - - - - - - - - -
Table 1 Request parameters

Parameter

-

Mandatory

-

Type

-

Description

-

loadbalancer

-

Yes

-

Object

-

Specifies the load balancer. For details, see Table 2.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 loadbalancer parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Specifies the load balancer name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the load balancer.

-

The value contains a maximum of 255 characters.

-

tenant_id

-

No

-

String

-

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

-

The value contains a maximum of 255 characters.

-

The value must be the same as the value of project_id in the token.

-

vip_subnet_id

-

Yes

-

String

-

Specifies the ID of the subnet where the load balancer works. You can obtain the value by calling the API for querying subnets {VPC endpoint}/v2.0/subnets} using the GET method.

-

The private IP address of the load balancer is in this subnet.

-

Only IPv4 subnets are supported. IPv6 subnets are not supported.

-

provider

-

No

-

String

-

Specifies the provider of the load balancer.

-

The value can only be vlb.

-

vip_address

-

No

-

String

-

Specifies the private IP address of the load balancer.

-

This IP address must be the one in the subnet specified by vip_subnet_id. If this parameter is not specified, an IP address is automatically assigned to the load balancer from the subnet specified by vip_subnet_id.

-

The value contains a maximum of 64 characters.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the load balancer.

-

This parameter is reserved. The default value is true.

-
- - -

Response

- - - - - - - - - - -
Table 3 Response parameters

Parameter

-

Type

-

Description

-

loadbalancer

-

Object

-

Specifies the load balancer. For details, see Table 4.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 loadbalancer parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-

tenant_id

-

String

-

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

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the load balancer name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the load balancer.

-

The value contains a maximum of 255 characters.

-

vip_subnet_id

-

String

-

Specifies the ID of the subnet where the load balancer works.

-

vip_port_id

-

String

-

Specifies the ID of the port bound to the private IP address of the load balancer.

-

When you create a load balancer, the system automatically creates a port and associates it with a security group. However, the security group will not take effect.

-

provider

-

String

-

Specifies the provider of the load balancer.

-

vip_address

-

String

-

Specifies the private IP address of the load balancer.

-

The value contains a maximum of 64 characters.

-

listeners

-

Array

-

Lists the IDs of listeners added to the load balancer. For details, see Table 5.

-

pools

-

Array

-

Lists the IDs of backend server groups associated with the load balancer. For details, see Table 6.

-

operating_status

-

String

-

This parameter is reserved, and its value can only be ONLINE.

-

It specifies the operating status of the load balancer.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the load balancer.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the load balancer.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

tags

-

Array

-

Lists load balancer tags.

-

created_at

-

String

-

Specifies the time when the load balancer was created.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-

updated_at

-

String

-

Specifies the time when the load balancer was updated.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-
- - - - - - - - - - - - -
Table 5 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated listener.

-
- - - - - - - - - - - - -
Table 6 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - -

Example Request

- - -

Example Response

- - -

After the preceding steps are complete, the load balancer has the capability of accessing the public network. You can access the load balancer using 139.9.204.183, the value of parameter public_ip_address.

-

Status Codes

See HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/en-us_topic_0096561547.html b/docs/elb/api-ref/en-us_topic_0096561547.html deleted file mode 100644 index cf5017352..000000000 --- a/docs/elb/api-ref/en-us_topic_0096561547.html +++ /dev/null @@ -1,459 +0,0 @@ - - -

Querying Backend Server Groups

-

Request

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Request parameters

Parameter

-

Mandatory

-

Type

-

Description

-

marker

-

No

-

String

-

Specifies the ID of the backend server group from which pagination query starts, that is, the ID of the last backend server group on the previous page. If this parameter is not specified, the first page will be queried.

-

This parameter must be used together with limit.

-

limit

-

No

-

Integer

-

Specifies the number of backend server groups on each page.

-

page_reverse

-

No

-

Boolean

-

Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link.

-

This parameter must be used together with limit.

-

id

-

No

-

String

-

Specifies the ID of the backend server group.

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the backend server group is used.

-

-

The value contains a maximum of 255 characters.

-

name

-

No

-

String

-

Specifies the backend server group name.

-

The value contains a maximum of 255 characters.

-

description

-

No

-

String

-

Provides supplementary information about the backend server group.

-

The value contains a maximum of 255 characters.

-

healthmonitor_id

-

No

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

loadbalancer_id

-

No

-

String

-

Specifies the ID of the load balancer associated with the backend server group.

-

protocol

-

No

-

String

-

Specifies the protocol that the backend server group uses to receive requests.

-

TCP, UDP, and HTTP are supported.

-

lb_algorithm

-

No

-

String

-

Specifies the load balancing algorithm of the backend server group.

-The value options are as follows:
  • ROUND_ROBIN: indicates the weighted round robin algorithm.
  • LEAST_CONNECTIONS: indicates the weighted least connections algorithm.
  • SOURCE_IP: indicates the source IP hash algorithm.
- -

When the value is SOURCE_IP, the weights of backend servers in the server group are invalid. For details about parameter weight, see Table 2.

-

member_address

-

No

-

String

-

Lists the IDs of backend servers in the backend server group.

-

member_device_id

-

No

-

String

-

Specifies the ID of the ECS corresponding to the backend server in the backend server group.

-
- - -

Response

- - - - - - - - - - - - - - -
Table 2 Parameter description

Parameter

-

Type

-

Description

-

pools

-

Array

-

Lists the backend server groups. For details, see Table 3.

-

pools_links

-

List

-

Provides links to the previous or next page during pagination query, respectively.

-

This parameter exists only in the response body of pagination query. For details, see Table 8.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the backend server group.

-

tenant_id

-

String

-

Specifies the ID of the project where the backend server group is used.

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the backend server group name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the backend server group.

-

The value contains a maximum of 255 characters.

-

protocol

-

String

-

Specifies the protocol that the backend server group uses to receive requests.

-

TCP, UDP, and HTTP are supported.

-

lb_algorithm

-

String

-

Specifies the load balancing algorithm of the backend server group.

-The value options are as follows:
  • ROUND_ROBIN: indicates the weighted round robin algorithm.
  • LEAST_CONNECTIONS: indicates the weighted least connections algorithm.
  • SOURCE_IP: indicates the source IP hash algorithm.
- -

When the value is SOURCE_IP, the weights of backend servers in the server group are invalid.

-

members

-

Array

-

Lists the IDs of backend servers in the backend server group.

-

healthmonitor_id

-

String

-

Specifies the ID of the health check configured for the backend server group.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the backend server group.

-

This parameter is reserved. The default value is true.

-

listeners

-

Array

-

Lists the IDs of listeners associated with the backend server group.

-

loadbalancers

-

String

-

Lists the IDs of load balancers associated with the backend server group.

-

session_persistence

-

Object

-

Specifies whether to enable the sticky session feature. For details, see Table 7.

-

Once the sticky session feature is enabled, requests from the same client are sent to the same backend server within the specified period.

-

When this feature is disabled, the parameter value is null.

-
- - - - - - - - - - - - -
Table 4 members parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server.

-
- - - - - - - - - - - - -
Table 5 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - - - - - - - - - - - -
Table 6 loadbalancers parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated load balancer.

-
- - - - - - - - - - - - - - - - - - - - -
Table 7 session_persistence parameter description

Parameter

-

Type

-

Description

-

type

-

String

-

Specifies the sticky session type.

-The value can be one of the following:
  • SOURCE_IP: Requests are distributed based on the client's IP address. Requests from the same IP address are sent to the same backend server.
  • HTTP_COOKIE: When the client sends a request for the first time, the load balancer automatically generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to the backend server that processes the first request.
  • APP_COOKIE: When the client sends a request for the first time, the backend server that receives the request generates a cookie and inserts the cookie into the response message. Subsequent requests are sent to this backend server.
- -

When the protocol of the backend server group is TCP, only SOURCE_IP takes effect. When the protocol of the backend server group is HTTP, only HTTP_COOKIE or APP_COOKIE takes effect.

-

cookie_name

-

String

-

Specifies the cookie name.

-

This parameter is mandatory when the sticky session type is APP_COOKIE.

-

persistence_timeout

-

Integer

-

Specifies the sticky session timeout duration in minutes.

-

This parameter is invalid when type is set to APP_COOKIE.

-
  • Optional value ranges are as follows:
    • When the protocol of the backend server group is TCP or UDP, the value ranges from 1 to 60.
    • When the protocol of the backend server group is HTTP or HTTPS, the value ranges from 1 to 1440.
    -
-
- - - - - - - - - - - - - - - - -
Table 8 pools_links parameter description

Parameter

-

Type

-

Description

-

href

-

String

-

Provides links to the previous or next page during pagination query, respectively.

-

rel

-

String

-

Specifies the prompt of the previous or next page. The value can be next or previous.

-
  • next: indicates the URL of the next page.
  • previous: indicates the URL of the previous page.
-
- - -

Example Request

- - - -

Status Codes

See HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Backend Server Group - - - diff --git a/docs/elb/api-ref/en-us_topic_0141008271.html b/docs/elb/api-ref/en-us_topic_0141008271.html deleted file mode 100644 index b40c7d814..000000000 --- a/docs/elb/api-ref/en-us_topic_0141008271.html +++ /dev/null @@ -1,209 +0,0 @@ - - -

Querying Details of a Load Balancer

-

Response

- - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Type

-

Description

-

loadbalancer

-

Object

-

Specifies the load balancer. For details, see Table 2.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 loadbalancer parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the load balancer ID.

-

tenant_id

-

String

-

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

-

The value contains a maximum of 255 characters.

-

name

-

String

-

Specifies the load balancer name.

-

The value contains a maximum of 255 characters.

-

description

-

String

-

Provides supplementary information about the load balancer.

-

The value contains a maximum of 255 characters.

-

vip_subnet_id

-

String

-

Specifies the ID of the subnet where the load balancer works.

-

vip_port_id

-

String

-

Specifies the ID of the port bound to the private IP address of the load balancer.

-

provider

-

String

-

Specifies the provider of the load balancer.

-

vip_address

-

String

-

Specifies the private IP address of the load balancer.

-

The value contains a maximum of 64 characters.

-

listeners

-

Array

-

Lists the IDs of listeners added to the load balancer. For details, see Table 3.

-

pools

-

Array

-

Lists the IDs of backend server groups associated with the load balancer. For details, see Table 4.

-

operating_status

-

String

-

Specifies the operating status of the load balancer.

-

The value can be ONLINE, OFFLINE, DEGRADED, DISABLED, or NO_MONITOR.

-

This parameter is reserved. The default value is ONLINE.

-

The value contains a maximum of 16 characters.

-

provisioning_status

-

String

-

Specifies the provisioning status of the load balancer.

-

The value can be ACTIVE, PENDING_CREATE, or ERROR.

-

This parameter is reserved. The default value is ACTIVE.

-

The value contains a maximum of 16 characters.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the load balancer.

-

This parameter is reserved. The default value is true.

-

tags

-

Array

-

Lists the tags added to the load balancer.

-

created_at

-

String

-

Specifies the time when the load balancer was created.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-

updated_at

-

String

-

Specifies the time when the load balancer was updated.

-

The UTC time is in YYYY-MM-DDTHH:MM:SS format.

-

The value contains a maximum of 19 characters.

-
- - - - - - - - - - - - -
Table 3 listeners parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated listener.

-
- - - - - - - - - - - - -
Table 4 pools parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the ID of the associated backend server group.

-
- - -

Status Codes

See HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Load Balancer - - - diff --git a/docs/elb/api-ref/errorcode.html b/docs/elb/api-ref/errorcode.html deleted file mode 100644 index da8cd9f52..000000000 --- a/docs/elb/api-ref/errorcode.html +++ /dev/null @@ -1,207 +0,0 @@ - - -

HTTP Status Codes for Dedicated Load Balancers

-

The following code descriptions are only suitable for dedicated load balancers.

- - - - - - - - - - - - - - - - - - - -

Status Code

-

Type

-

Description

-

200

-

OK

-

Normal response to GET and PUT requests.

-

201

-

Created

-

Normal response to POST requests.

-

204

-

No Content

-

Normal response to DELETE requests.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Module

-

Status Code

-

Type

-

Error Code

-

Possible Cause

-

Public

-

400

-

Bad request

-

ELB.8902

-

Malformed request URI or body.

-

Invalid admin _state_up value.

-

Invalid parameters.

-

Batch operations are not allowed.

-

Failed to verify the parameters.

-

Incorrect request method, for example, updating attributes that can be specified during creation only.

-

The network is not external (the value of router:external is set to false).

-

The IaaS OpenStack network port has no floating IP address bound.

-

The requested floating IP address is not in the IP address range of the external network.

-

Invalid fixed IP address.

-

The router port does not have a fixed IP address.

-

The subnet for the router interface must have a gateway IP address.

-

401

-

Unauthorized

-

SYS.0401

-

Authentication required.

-

403

-

-

Forbidden

-

-

ELB.8903

-

The URI does not exist.

-

The resource cannot be found.

-

SYS.0403

-

Authentication required.

-

404

-

Not Found

-

ELB.8904

-

The URI does not exist.

-

The resource cannot be found.

-

The port UUID is not valid.

-

409

-

Conflict

-

ELB.8907

-

The port is already in use.

-

The IP address is already in use.

-

The IP address pool cannot contain gateway and broadcast addresses.

-

The requested floating IP address is already in use.

-

The internal IaaS OpenStack network port and fixed IP address are already associated with another floating IP addresses.

-

ELB.8905

-

The quota is used up.

-

500

-

Internal server error

-

ELB.8906

-

Internal IaaS OpenStack network error.

-

Load balancer

-

400

-

Bad request

-

ELB.8931

-

The subnet IP version is not the same.

-

ELB.8932

-

IPv6 subnets are not supported, but the value of ipv6_vip_virsubnet_id is not null.

-

Backend server

-

400

-

Bad request

-

ELB.8933

-

IPv6 subnets are not supported, but backend servers use IPv6 addresses.

-
- - - - -Parent topic: Common Parameters - - - diff --git a/docs/elb/api-ref/l7.html b/docs/elb/api-ref/l7.html deleted file mode 100644 index 92b26d4df..000000000 --- a/docs/elb/api-ref/l7.html +++ /dev/null @@ -1,485 +0,0 @@ - - -

Adding a Forwarding Policy

-

Function

This API is used to add a forwarding policy. The listener and forwarding policy determine how traffic is forwarded to backend servers.

- - -

Constraints

Currently, only redirects from an HTTP listener to an HTTPS listener are supported. When action is set to REDIRECT_TO_LISTENER, the listener specified by listener_id can only be an HTTP listener, and the listener specified by redirect_listener_id can only be an HTTPS listener.

-

The load balancer of the HTTPS listener to which traffic is redirected must be the same as that of the HTTP listener.

- -

URI

POST /v2.0/lbaas/l7policies

- -

Request

- - - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

l7policy

-

Yes

-

Object

-

Specifies the forwarding policy. For details, see Table 2.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 l7policy parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

tenant_id

-

No

-

String

-

Specifies the ID of the project where the forwarding policy is used.

-

-

The value must be the same as the value of tenant_id in the token.

-

The value contains a maximum of 255 characters.

-

name

-

No

-

String

-

Specifies the forwarding policy name.

-

The value contains a maximum of 255 characters.

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding policy.

-

This parameter is reserved, and the default value is true.

-

description

-

No

-

String

-

Provides supplementary information about the forwarding policy.

-

The value contains a maximum of 255 characters.

-

listener_id

-

Yes

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-
  • When action is set to REDIRECT_TO_POOL, forwarding policies can be added to a listener with protocol set to HTTP or TERMINATED_HTTPS.
  • When action is set to REDIRECT_TO_LISTENER, forwarding policies can be added to a listener with protocol set to HTTP.
-

action

-

Yes

-

String

-

Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

-

The value can be one of the following:

-
  • REDIRECT_TO_POOL: Requests are forwarded to the backend server group specified by redirect_pool_id.
  • REDIRECT_TO_LISTENER: Requests are redirected from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.
-

redirect_pool_id

-

No

-

String

-

Specifies the ID of the backend server group to which traffic is forwarded. The default value is null.

-

This parameter is mandatory when action is set to REDIRECT_TO_POOL.

-

This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER.

-

The backend server group must meet the following requirements:

-
  • Cannot be the default backend server group of the listener.
  • Cannot be the backend server group used by forwarding policies of other listeners.
-

redirect_listener_id

-

No

-

String

-

Specifies the ID of the listener to which the traffic is redirected. The default value is null.

-

This parameter cannot be specified when action is set to REDIRECT_TO_POOL.

-

This parameter is mandatory when action is set to REDIRECT_TO_LISTENER, and the listener must meet the following requirements:

-
  • Can only be an HTTPS listener.
  • Can only be a listener of the same load balancer.
-

redirect_url

-

No

-

String

-

Specifies the URL to which traffic is redirected. The default value is null.

-

This parameter is reserved.

-

The value contains a maximum of 255 characters.

-

position

-

No

-

Integer

-

Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

-

This parameter is reserved.

-

rules

-

No

-

Array

-

Lists the forwarding rules of the forwarding policy. For details, see Table 3.

-

The list contains a maximum of two rules, and the type parameter of each rule must be unique.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 rules parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

admin_state_up

-

No

-

Boolean

-

Specifies the administrative status of the forwarding rule.

-

This parameter is reserved, and the default value is true.

-

type

-

Yes

-

String

-

Specifies the match type of a forwarding rule.

-

The value range varies depending on the protocol of the backend server group:

-
  • HOST_NAME: matches the domain name in the request.
  • PATH: matches the path in the request.
-

The match type of forwarding rules in a forwarding policy must be unique.

-

compare_type

-

Yes

-

String

-

Specifies the match mode. The options are as follows:

-

When type is set to HOST_NAME, the value of this parameter can only be the following:

-
  • EQUAL_TO: indicates exact match.
-

When type is set to PATH, the value of this parameter can be one of the following:

-
  • REGEX: indicates regular expression match.
  • STARTS_WITH: indicates prefix match.
  • EQUAL_TO: indicates exact match.
-

invert

-

No

-

Boolean

-

Specifies whether reverse matching is supported.

-

The value can be true or false. The default value is false.

-

This parameter is reserved.

-

key

-

No

-

String

-

Specifies the key of the match content. The default value is null.

-

This parameter is reserved.

-

value

-

Yes

-

String

-

-

Specifies the value of the match content. The value cannot contain spaces.

-
  • When type is set to HOST_NAME, the value can contain a maximum of 100 characters that contain only letters, digits, hyphens (-), and periods (.), and must start with a letter or digit.
  • When type is set to PATH, the value can contain a maximum of 128 characters. When compare_type is set to STARTS_WITH or EQUAL_TO, the value must start with a slash (/) and can contain only letters, digits, and special characters _~';@^-%#&$.*+?,=!:|\/()[]{}
-
- - -

Response

- - - - - - - - - - -
Table 4 Response parameters

Parameter

-

Type

-

Description

-

l7policy

-

Object

-

Specifies the forwarding policy. For details, see Table 5.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 l7policy parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Specifies the forwarding policy ID.

-

tenant_id

-

String

-

Specifies the ID of the project where the forwarding policy is used.

-

name

-

String

-

Specifies the forwarding policy name.

-

admin_state_up

-

Boolean

-

Specifies the administrative status of the forwarding policy.

-

This parameter is reserved. The value can be true or false.

-
  • true: Enabled
  • false: Disabled
-

description

-

String

-

Provides supplementary information about the forwarding policy.

-

listener_id

-

String

-

Specifies the ID of the listener to which the forwarding policy is added.

-

action

-

String

-

Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

-

The value can be one of the following:

-
  • REDIRECT_TO_POOL: Requests are forwarded to the backend server group specified by redirect_pool_id.
  • REDIRECT_TO_LISTENER: Requests are redirected from the HTTP listener specified by listener_id to the HTTPS listener specified by redirect_listener_id.
-

redirect_pool_id

-

String

-

Specifies the ID of the backend server group to which traffic is forwarded.

-

redirect_listener_id

-

String

-

Specifies the ID of the listener to which the traffic is redirected.

-

redirect_url

-

String

-

Specifies the URL to which traffic is redirected.

-

This parameter is reserved.

-

rules

-

Array

-

Lists the forwarding rules of the forwarding policy. For details, see Table 6.

-

position

-

Integer

-

Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

-

This parameter is reserved.

-

provisioning_status

-

String

-

This parameter is reserved, and its value can only be ACTIVE.

-

It specifies the provisioning status of the forwarding policy.

-
- - - - - - - - - - - - -
Table 6 rules parameter description

Parameter

-

Type

-

Description

-

id

-

String

-

Lists the IDs of the forwarding rules in the forwarding policy.

-
- - -

Example Request

- -

Example Response

- -

Status Code

For details, see HTTP Status Codes of Shared Load Balancers.

- - - - -Parent topic: Forwarding Policy - - - diff --git a/docs/elb/api-ref/public_sys-resources/ExpandCollapse.js b/docs/elb/api-ref/public_sys-resources/ExpandCollapse.js deleted file mode 100644 index 3f1b7db00..000000000 --- a/docs/elb/api-ref/public_sys-resources/ExpandCollapse.js +++ /dev/null @@ -1 +0,0 @@ -var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";var href="";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(href.substring(href.lastIndexOf("#")+1))}}catch(a){}}; \ No newline at end of file diff --git a/docs/elb/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/elb/api-ref/public_sys-resources/caution_3.0-en-us.png deleted file mode 100644 index 60f607621..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/caution_3.0-en-us.png and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/commonltr.css b/docs/elb/api-ref/public_sys-resources/commonltr.css deleted file mode 100644 index c5480b0ab..000000000 --- a/docs/elb/api-ref/public_sys-resources/commonltr.css +++ /dev/null @@ -1 +0,0 @@ -body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/elb/api-ref/public_sys-resources/commonltr_print.css b/docs/elb/api-ref/public_sys-resources/commonltr_print.css deleted file mode 100644 index a59823141..000000000 --- a/docs/elb/api-ref/public_sys-resources/commonltr_print.css +++ /dev/null @@ -1 +0,0 @@ -body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/elb/api-ref/public_sys-resources/commonrtl.css b/docs/elb/api-ref/public_sys-resources/commonrtl.css deleted file mode 100644 index 947a9a033..000000000 --- a/docs/elb/api-ref/public_sys-resources/commonrtl.css +++ /dev/null @@ -1,2 +0,0 @@ -.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 -*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/elb/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/elb/api-ref/public_sys-resources/danger_3.0-en-us.png deleted file mode 100644 index 47a9c7235..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/danger_3.0-en-us.png and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/delta.gif b/docs/elb/api-ref/public_sys-resources/delta.gif deleted file mode 100644 index 0d1b1f674..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/delta.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/deltaend.gif b/docs/elb/api-ref/public_sys-resources/deltaend.gif deleted file mode 100644 index cc7da0fc8..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/deltaend.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/elb/api-ref/public_sys-resources/icon-arrowdn.gif deleted file mode 100644 index 84eec9be2..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/icon-arrowdn.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/elb/api-ref/public_sys-resources/icon-arrowrt.gif deleted file mode 100644 index 39583d168..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/icon-arrowrt.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/icon-caution.gif b/docs/elb/api-ref/public_sys-resources/icon-caution.gif deleted file mode 100644 index 079c79b26..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/icon-caution.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/icon-danger.gif b/docs/elb/api-ref/public_sys-resources/icon-danger.gif deleted file mode 100644 index 079c79b26..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/icon-danger.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/icon-huawei.gif b/docs/elb/api-ref/public_sys-resources/icon-huawei.gif deleted file mode 100644 index a31d60f89..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/icon-huawei.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/icon-note.gif b/docs/elb/api-ref/public_sys-resources/icon-note.gif deleted file mode 100644 index 31be2b039..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/icon-note.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/icon-notice.gif b/docs/elb/api-ref/public_sys-resources/icon-notice.gif deleted file mode 100644 index 409070650..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/icon-notice.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/icon-tip.gif b/docs/elb/api-ref/public_sys-resources/icon-tip.gif deleted file mode 100644 index c47bae05c..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/icon-tip.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/icon-warning.gif b/docs/elb/api-ref/public_sys-resources/icon-warning.gif deleted file mode 100644 index 079c79b26..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/icon-warning.gif and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/elb/api-ref/public_sys-resources/note_3.0-en-us.png deleted file mode 100644 index 57a0e1f53..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/note_3.0-en-us.png and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/elb/api-ref/public_sys-resources/notice_3.0-en-us.png deleted file mode 100644 index fa4b64990..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/notice_3.0-en-us.png and /dev/null differ diff --git a/docs/elb/api-ref/public_sys-resources/popup.js b/docs/elb/api-ref/public_sys-resources/popup.js deleted file mode 100644 index 5305962bc..000000000 --- a/docs/elb/api-ref/public_sys-resources/popup.js +++ /dev/null @@ -1 +0,0 @@ -var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!=null){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(tooltipTxt){if(document.body==null){return}if(i==0){return}clickFlag=true;var text=eval("jsonData."+tooltipTxt);var bodyWidth=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var st=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){st=0}var leftPos=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=text;dhtmlgoodies_tooltip.style.left=leftPos+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+st+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=leftPos+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+st+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var tooltipWidth=dhtmlgoodies_tooltip.offsetWidth;if(tooltipWidthbodyWidth){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((leftPos+tooltipWidth)-bodyWidth))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((leftPos+tooltipWidth)-bodyWidth)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if(dhtmlgoodies_tooltip!=null&&dhtmlgoodies_tooltip.style!=null){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!=null&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!=null&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/elb/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/elb/api-ref/public_sys-resources/warning_3.0-en-us.png deleted file mode 100644 index def5c3565..000000000 Binary files a/docs/elb/api-ref/public_sys-resources/warning_3.0-en-us.png and /dev/null differ diff --git a/docs/elb/api-ref/topic_300000000.html b/docs/elb/api-ref/topic_300000000.html deleted file mode 100644 index a1d77cc09..000000000 --- a/docs/elb/api-ref/topic_300000000.html +++ /dev/null @@ -1,16 +0,0 @@ - - -

Quota

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000001.html b/docs/elb/api-ref/topic_300000001.html deleted file mode 100644 index 504ccbc88..000000000 --- a/docs/elb/api-ref/topic_300000001.html +++ /dev/null @@ -1,16 +0,0 @@ - - -

AZ

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000002.html b/docs/elb/api-ref/topic_300000002.html deleted file mode 100644 index 02ce27844..000000000 --- a/docs/elb/api-ref/topic_300000002.html +++ /dev/null @@ -1,18 +0,0 @@ - - -

Load Balancer Flavor

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000003.html b/docs/elb/api-ref/topic_300000003.html deleted file mode 100644 index 2664c3857..000000000 --- a/docs/elb/api-ref/topic_300000003.html +++ /dev/null @@ -1,26 +0,0 @@ - - -

Load Balancer

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000004.html b/docs/elb/api-ref/topic_300000004.html deleted file mode 100644 index 207128d20..000000000 --- a/docs/elb/api-ref/topic_300000004.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Certificate

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000005.html b/docs/elb/api-ref/topic_300000005.html deleted file mode 100644 index 094dd2c35..000000000 --- a/docs/elb/api-ref/topic_300000005.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Listener

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000006.html b/docs/elb/api-ref/topic_300000006.html deleted file mode 100644 index ba4d4ee07..000000000 --- a/docs/elb/api-ref/topic_300000006.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Backend Server Group

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000007.html b/docs/elb/api-ref/topic_300000007.html deleted file mode 100644 index 0d7cf9f58..000000000 --- a/docs/elb/api-ref/topic_300000007.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Backend Server

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000008.html b/docs/elb/api-ref/topic_300000008.html deleted file mode 100644 index d7b2c959e..000000000 --- a/docs/elb/api-ref/topic_300000008.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Health Check

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000009.html b/docs/elb/api-ref/topic_300000009.html deleted file mode 100644 index 78565f394..000000000 --- a/docs/elb/api-ref/topic_300000009.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Forwarding Policy

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/docs/elb/api-ref/topic_300000010.html b/docs/elb/api-ref/topic_300000010.html deleted file mode 100644 index d14b311ed..000000000 --- a/docs/elb/api-ref/topic_300000010.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Forwarding Rule

-

- - - - - -Parent topic: Dedicated Load Balancer APIs - - - diff --git a/metadata.yaml b/metadata.yaml index 4e54db7f2..0bf9436e0 100644 --- a/metadata.yaml +++ b/metadata.yaml @@ -425,20 +425,20 @@ categories: type: umn pdf_name: eip-umn repository: docs/elastic-ip - # - service_title: Elastic Load Balancing - # service_type: elb - # docs: - # - html_location: docs/elb/api-ref - # rst_location: api-ref/source - # title: API Reference - # type: api-ref - # pdf_name: elb-api-ref - # - html_location: docs/elb/umn - # rst_location: umn/source - # title: User Guide - # type: umn - # pdf_name: elb-umn - # repository: docs/elastic-load-balancing + - service_title: Elastic Load Balancing + service_type: elb + docs: + - html_location: docs/elb/api-ref + rst_location: api-ref/source + title: API Reference + type: api-ref + pdf_name: elb-api-ref + - html_location: docs/elb/umn + rst_location: umn/source + title: User Guide + type: umn + pdf_name: elb-umn + repository: docs/elastic-load-balancing - service_title: NAT Gateway service_type: natgw docs: