diff --git a/docs/elb/api-ref/ALL_META.TXT.json b/docs/elb/api-ref/ALL_META.TXT.json index 1e2f5797e..a318efc59 100644 --- a/docs/elb/api-ref/ALL_META.TXT.json +++ b/docs/elb/api-ref/ALL_META.TXT.json @@ -862,7 +862,7 @@ "node_id":"elb_zq_zg_0003.xml", "product_code":"elb", "code":"46", - "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 ", + "des":"This API is used to query details about a forwarding rule by ID.GET /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}NoneExample request: Querying details of a forwa", "doc_type":"api", "kw":"Querying Details of a Forwarding Rule,Forwarding Rule,API Reference", "search_title":"", @@ -1471,7 +1471,7 @@ "node_id":"listapiversions.xml", "product_code":"elb", "code":"78", - "des":"This API is used to query all available ELB API versions.GET /versionsNoneStatus code: 200Querying API versionsStatus code: 200Successful request.{\n \"versions\" : [ {\n ", + "des":"This API is used to query all available ELB API versions.GET /versionsNoneStatus code: 200Querying API versionsStatus code: 200Successful request.See Error Codes.", "doc_type":"api", "kw":"Querying API Versions,API Version,API Reference", "search_title":"", @@ -1671,7 +1671,7 @@ "node_id":"createloadbalancer.xml", "product_code":"elb", "code":"88", - "des":"This API is used to create a dedicated load balancer. When you create a dedicated load balancer, note the following:Specify vip_subnet_cidr_id if you want to bind a priva", + "des":"This API is used to create a dedicated load balancer. When you create a load balancer, note the following:Specify vip_subnet_cidr_id if you want to bind a private IPv4 ad", "doc_type":"api", "kw":"Creating a Load Balancer,Load Balancer,API Reference", "search_title":"", @@ -2591,7 +2591,7 @@ "node_id":"createhealthmonitor.xml", "product_code":"elb", "code":"134", - "des":"This API is used to configure a health check.The security groups must have rules that allow traffic to 100.125.0.0/16. If you want to use UDP for health checks, ensure th", + "des":"This API is used to configure a health check.The security groups must have rules that allow traffic to 100.125.0.0/16.If you want to use UDP for health checks, ensure tha", "doc_type":"api", "kw":"Configuring a Health Check,Health Check,API Reference", "search_title":"", @@ -2851,7 +2851,7 @@ "node_id":"createl7rule.xml", "product_code":"elb", "code":"147", - "des":"This API is used to add a forwarding rule.If the action of 17policy is set to Redirect to another listener, 17rule cannot be created.POST /v3/{project_id}/elb/l7policies/", + "des":"This API is used to add a forwarding rule.If the action of l7policy is set to Redirect to another listener, 17rule cannot be created.POST /v3/{project_id}/elb/l7policies/", "doc_type":"api", "kw":"Adding a Forwarding Rule,Forwarding Rule,API Reference", "search_title":"", @@ -3805,7 +3805,7 @@ { "uri":"ErrorCode.html", "node_id":"errorcode_1.xml", - "product_code":"elb", + "product_code":"", "code":"197", "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", @@ -3813,9 +3813,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"elb", - "opensource":"true" + "opensource":"true", + "documenttype":"api" } ], "title":"Error Codes", @@ -3902,7 +3901,7 @@ "node_id":"elb_fl_0005.xml", "product_code":"elb", "code":"202", - "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", + "des":"API v2.0 enables 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", "search_title":"", diff --git a/docs/elb/api-ref/BatchDeleteIpList.html b/docs/elb/api-ref/BatchDeleteIpList.html index 192ab74ed..0009edc86 100644 --- a/docs/elb/api-ref/BatchDeleteIpList.html +++ b/docs/elb/api-ref/BatchDeleteIpList.html @@ -1,7 +1,7 @@

Deleting IP Addresses from an IP Address Group

-

Function

This API is used to delete IP addresses from an IP address group.

+

Function

This API is used to delete IP addresses from an IP address group.

URI

POST /v3/{project_id}/elb/ipgroups/{ipgroup_id}/iplist/batch-delete

@@ -132,121 +132,121 @@

Response Parameters

Status code: 200

-
Table 6 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

ipgroup

+

ipgroup

IpGroup object

+

IpGroup object

Shows IP address information.

+

Shows IP address information.

request_id

+

request_id

String

+

String

Specifies the request ID. The value is automatically generated.

+

Specifies the request ID. The value is automatically generated.

-
Table 7 IpGroup

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 IpGroup

Parameter

Type

+

Type

Description

+

Description

created_at

+

created_at

String

+

String

Specifies the time when the IP address group was created.

+

Specifies the time when the IP address group was created.

description

+

description

String

+

String

Specifies the time when the IP address group was updated.

+

Specifies the time when the IP address group was updated.

id

+

id

String

+

String

Specifies the ID of the IP address group.

+

Specifies the ID of the IP address group.

ip_list

+

ip_list

Array of IpInfo objects

+

Array of IpInfo objects

Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

+

Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

Array Length: 0 - 300

listeners

+

listeners

Array of ListenerRef objects

+

Array of ListenerRef objects

Lists the IDs of listeners with which the IP address group is associated.

+

Lists the IDs of listeners with which the IP address group is associated.

name

+

name

String

+

String

Specifies the IP address group name.

+

Specifies the IP address group name.

project_id

+

project_id

String

+

String

Specifies the project ID of the IP address group.

+

Specifies the project ID of the IP address group.

updated_at

+

updated_at

String

+

String

Specifies the time when the IP address group was updated.

+

Specifies the time when the IP address group was updated.

-
Table 8 IpInfo

Parameter

+
- - - - - - - - @@ -255,19 +255,19 @@
Table 8 IpInfo

Parameter

Type

+

Type

Description

+

Description

ip

+

ip

String

+

String

Specifies the IP addresses in the IP address group.

+

Specifies the IP addresses in the IP address group.

description

+

description

String

+

String

Provides remarks about the IP address group.

+

Provides remarks about the IP address group.

Minimum: 0

Maximum: 255

-
Table 9 ListenerRef

Parameter

+
- - - - - diff --git a/docs/elb/api-ref/BatchUpdatePoliciesPriority.html b/docs/elb/api-ref/BatchUpdatePoliciesPriority.html index bb886672a..698f91316 100644 --- a/docs/elb/api-ref/BatchUpdatePoliciesPriority.html +++ b/docs/elb/api-ref/BatchUpdatePoliciesPriority.html @@ -1,7 +1,7 @@

Batch Updating Forwarding Policy Priorities

-

Function

This API is used to batch update the priorities of forwarding policies.

+

Function

This API is used to batch update the priorities of forwarding policies.

Constraints

This API is only used to update the priorities of forwarding policies added to a listener of a dedicated load balancer when action is set to REDIRECT_TO_POOL.

@@ -104,7 +104,8 @@
-
Table 9 ListenerRef

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Specifies the listener ID.

+

Specifies the listener ID.

Integer

Specifies the forwarding policy priority. A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener. This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

+

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

+

This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

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

  • If enhance_l7policy_enable is not enabled, forwarding policies are automatically prioritized based on the original policy sorting logic. The priorities of domain names are independent from each other. For the same domain name, the priorities are sorted in the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If the matching types are the same, the longer the URL is, the higher the priority is. 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 be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to be created because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, specify a value or adjust the priorities of existing forwarding policies. If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default.

    @@ -120,19 +121,19 @@

    Response Parameters

    Status code: 202

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - - diff --git a/docs/elb/api-ref/CLASS.TXT.json b/docs/elb/api-ref/CLASS.TXT.json index ae08b4f86..e5018e076 100644 --- a/docs/elb/api-ref/CLASS.TXT.json +++ b/docs/elb/api-ref/CLASS.TXT.json @@ -405,7 +405,7 @@ "code":"45" }, { - "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 ", + "desc":"This API is used to query details about a forwarding rule by ID.GET /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}NoneExample request: Querying details of a forwa", "product_code":"elb", "title":"Querying Details of a Forwarding Rule", "uri":"elb_zq_zg_0003.html", @@ -693,7 +693,7 @@ "code":"77" }, { - "desc":"This API is used to query all available ELB API versions.GET /versionsNoneStatus code: 200Querying API versionsStatus code: 200Successful request.{\n \"versions\" : [ {\n ", + "desc":"This API is used to query all available ELB API versions.GET /versionsNoneStatus code: 200Querying API versionsStatus code: 200Successful request.See Error Codes.", "product_code":"elb", "title":"Querying API Versions", "uri":"ListApiVersions.html", @@ -783,7 +783,7 @@ "code":"87" }, { - "desc":"This API is used to create a dedicated load balancer. When you create a dedicated load balancer, note the following:Specify vip_subnet_cidr_id if you want to bind a priva", + "desc":"This API is used to create a dedicated load balancer. When you create a load balancer, note the following:Specify vip_subnet_cidr_id if you want to bind a private IPv4 ad", "product_code":"elb", "title":"Creating a Load Balancer", "uri":"CreateLoadBalancer.html", @@ -1197,7 +1197,7 @@ "code":"133" }, { - "desc":"This API is used to configure a health check.The security groups must have rules that allow traffic to 100.125.0.0/16. If you want to use UDP for health checks, ensure th", + "desc":"This API is used to configure a health check.The security groups must have rules that allow traffic to 100.125.0.0/16.If you want to use UDP for health checks, ensure tha", "product_code":"elb", "title":"Configuring a Health Check", "uri":"CreateHealthMonitor.html", @@ -1314,7 +1314,7 @@ "code":"146" }, { - "desc":"This API is used to add a forwarding rule.If the action of 17policy is set to Redirect to another listener, 17rule cannot be created.POST /v3/{project_id}/elb/l7policies/", + "desc":"This API is used to add a forwarding rule.If the action of l7policy is set to Redirect to another listener, 17rule cannot be created.POST /v3/{project_id}/elb/l7policies/", "product_code":"elb", "title":"Adding a Forwarding Rule", "uri":"CreateL7Rule.html", @@ -1765,7 +1765,7 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"elb", + "product_code":"", "title":"Error Codes", "uri":"ErrorCode.html", "doc_type":"api", @@ -1809,7 +1809,7 @@ "code":"201" }, { - "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", + "desc":"API v2.0 enables 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", diff --git a/docs/elb/api-ref/CreateCertificate.html b/docs/elb/api-ref/CreateCertificate.html index 2e2e7a397..08a6b06f0 100644 --- a/docs/elb/api-ref/CreateCertificate.html +++ b/docs/elb/api-ref/CreateCertificate.html @@ -1,327 +1,344 @@

    Creating a Certificate

    -

    Function

    This API is used to create an SSL certificate for HTTPS listeners.

    +

    Function

    This API is used to create an SSL certificate for HTTPS listeners.

    -

    URI

    POST /v3/{project_id}/elb/certificates

    +

    URI

    POST /v3/{project_id}/elb/certificates

    -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    request_id

    +

    request_id

    String

    +

    String

    Specifies the backend server.

    +

    Specifies the backend server.

    Table 1 Path Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Specifies the project ID.

    +

    Specifies the project ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    Specifies the token used for IAM authentication.

    +

    Specifies the token used for IAM authentication.

    -
    Table 3 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    certificate

    +

    certificate

    Yes

    +

    Yes

    CreateCertificateOption object

    +

    CreateCertificateOption object

    Specifies the certificate.

    +

    Specifies the certificate.

    -
    Table 4 CreateCertificateOption

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    admin_state_up

    +

    admin_state_up

    No

    +

    No

    Boolean

    +

    Boolean

    Specifies the administrative status of the certificate.

    -

    This parameter is unsupported. Please do not use it.

    +

    Specifies the administrative status of the certificate.

    +

    This parameter is unsupported. Please do not use it.

    certificate

    +

    certificate

    Yes

    +

    Yes

    String

    +

    String

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

    -

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

    +

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

    +

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

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Provides supplementary information about the certificate.

    -

    Minimum: 0

    -

    Maximum: 255

    +

    Provides supplementary information about the certificate.

    +

    Minimum: 0

    +

    Maximum: 255

    domain

    +

    domain

    No

    +

    No

    String

    +

    String

    Specifies the domain names used by the server certificate.

    -

    Note the following when using domain names:

    -
    • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.
    • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com
    • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com
    • This parameter will take effect only when **type** is set to **server**.
    • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.
    • SNI certificates of a shared load balancer's listener can have up to 30 domain names.
    -

    Default: ""

    -

    Minimum: 0

    -

    Maximum: 10000

    +

    Specifies the domain names used by the server certificate.

    +

    Note the following when using domain names:

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

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

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

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

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

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

      +
    +

    Default: ""

    +

    Minimum: 0

    +

    Maximum: 10000

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Specifies the certificate name.

    -

    Minimum: 0

    -

    Maximum: 255

    +

    Specifies the certificate name.

    +

    Minimum: 0

    +

    Maximum: 255

    private_key

    +

    private_key

    No

    +

    No

    String

    +

    String

    Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

    -
    • This parameter is valid and mandatory only when type is set to server.
    • This parameter will be ignored even if type is set to client. The value must be PEM encoded and will not take effect.
    +

    Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

    +
    • This parameter is valid and mandatory only when type is set to server.

      +
    • This parameter will be ignored even if type is set to client. The value must be PEM encoded and will not take effect.

      +

    project_id

    +

    project_id

    No

    +

    No

    String

    +

    String

    • This parameter is valid and mandatory only when type is set to server.
    -

    Minimum: 1

    -

    Maximum: 32

    +
    • This parameter is valid and mandatory only when type is set to server.

      +
    +

    Minimum: 1

    +

    Maximum: 32

    type

    +

    type

    No

    +

    No

    String

    +

    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.

    +

    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

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Specifies the ID of the enterprise project that the certificate belongs to.

    -

    This parameter is unsupported. Please do not use it.

    +

    Specifies the ID of the enterprise project that the certificate belongs to.

    +

    This parameter is unsupported. Please do not use it.

    -

    Response Parameters

    Status code: 201

    +

    Response Parameters

    Status code: 201

    -
    Table 5 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    request_id

    +

    request_id

    String

    +

    String

    Specifies the request ID. The value is automatically generated.

    +

    Specifies the request ID. The value is automatically generated.

    certificate

    +

    certificate

    CertificateInfo object

    +

    CertificateInfo object

    Specifies the certificate.

    +

    Specifies the certificate.

    -
    Table 6 CertificateInfo

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    admin_state_up

    +

    admin_state_up

    Boolean

    +

    Boolean

    Specifies the administrative status of the certificate.

    -

    This parameter is unsupported. Please do not use it.

    +

    Specifies the administrative status of the certificate.

    +

    This parameter is unsupported. Please do not use it.

    certificate

    +

    certificate

    String

    +

    String

    Specifies the certificate content. The value must be PEM encoded.

    +

    Specifies the certificate content. The value must be PEM encoded.

    description

    +

    description

    String

    +

    String

    Provides supplementary information about the certificate.

    -

    Minimum: 1

    -

    Maximum: 255

    +

    Provides supplementary information about the certificate.

    +

    Minimum: 1

    +

    Maximum: 255

    domain

    +

    domain

    String

    +

    String

    Specifies the domain names used by the server certificate.

    -

    Note the following when using domain names:

    -
    • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.
    • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com
    • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com
    • This parameter will take effect only when **type** is set to **server**.
    • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.
    • SNI certificates of a shared load balancer's listener can have up to 30 domain names.
    -

    Minimum: 1

    -

    Maximum: 10000

    +

    Specifies the domain names used by the server certificate.

    +

    Note the following when using domain names:

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

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

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

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

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

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

      +
    +

    Minimum: 1

    +

    Maximum: 10000

    id

    +

    id

    String

    +

    String

    Specifies the certificate ID.

    +

    Specifies the certificate ID.

    name

    +

    name

    String

    +

    String

    Specifies the certificate name.

    -

    Minimum: 1

    -

    Maximum: 255

    +

    Specifies the certificate name.

    +

    Minimum: 1

    +

    Maximum: 255

    private_key

    +

    private_key

    String

    +

    String

    Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

    -
    • This parameter is valid and mandatory only when type is set to server.
    • This parameter will be ignored even if type is set to client. A CA certificate can still be created and used normally.
    +

    Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

    +
    • This parameter is valid and mandatory only when type is set to server.

      +
    • This parameter will be ignored even if type is set to client. A CA certificate can still be created and used normally.

      +

    type

    +

    type

    String

    +

    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.

    +

    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

    +

    created_at

    String

    +

    String

    Specifies the time when the certificate was created.

    +

    Specifies the time when the certificate was created.

    updated_at

    +

    updated_at

    String

    +

    String

    Specifies the time when the certificate was updated.

    +

    Specifies the time when the certificate was updated.

    expire_time

    +

    expire_time

    String

    +

    String

    Specifies the time when the certificate expires.

    +

    Specifies the time when the certificate expires.

    project_id

    +

    project_id

    String

    +

    String

    Specifies the project ID of the certificate.

    +

    Specifies the project ID of the certificate.

    -

    Example Requests

    Creating a server certificate

    -
    POST https://{elb_endponit}/v3/{project_id}/elb/certificates
    +

    Example Requests

    Creating a server certificate

    +
    POST https://{elb_endponit}/v3/{project_id}/elb/certificates
     
     {
       "certificate" : {
    @@ -332,9 +349,9 @@
       }
     }
    -

    Example Responses

    Status code: 201

    -

    Normal response to POST requests.

    -
    {
    +

    Example Responses

    Status code: 201

    +

    Normal response to POST requests.

    +
    {
       "certificate" : {
         "private_key" : "-----BEGIN PRIVATE KEY-----MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPetB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rMMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXtCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2ChlZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08kEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/HlfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQBZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKrciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9MEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7AlekrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CTXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kxGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dtJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLriWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBUxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAdXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4VhafI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9ojHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIukfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd3fy+1rCUwzOp9LSjtJYf4ege-----END PRIVATE KEY-----",
         "description" : "",
    @@ -352,23 +369,23 @@
       "request_id" : "98414965-856c-4be3-8a33-3e08432a222e"
     }
    -

    Status Codes

    -
    - @@ -252,7 +255,8 @@ -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    201

    +

    201

    Normal response to POST requests.

    +

    Normal response to POST requests.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/elb/api-ref/CreateHealthMonitor.html b/docs/elb/api-ref/CreateHealthMonitor.html index 30ab90d61..e0c9aa3b4 100644 --- a/docs/elb/api-ref/CreateHealthMonitor.html +++ b/docs/elb/api-ref/CreateHealthMonitor.html @@ -1,9 +1,10 @@

    Configuring a Health Check

    -

    Function

    This API is used to configure a health check.

    +

    Function

    This API is used to configure a health check.

    -

    Constraints

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

    +

    Constraints

    The security groups must have rules that allow traffic to 100.125.0.0/16.

    +

    If you want to use UDP for health checks, ensure that the protocol of the backend server group is UDP.

    URI

    POST /v3/{project_id}/elb/healthmonitors

    @@ -134,7 +135,8 @@
  • A list of values that are separated with commas (,), for example, 200, 202

  • A value range, for example, 200-204

  • -

    The default value is 200. Multiple status codes can be queried in the format of expected_codes=xxx&expected_codes=xxx.

    +

    The default value is 200.

    +

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

    Minimum: 1

    Maximum: 64

    @@ -225,7 +227,8 @@

    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.

    +

    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

    String

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

    +

    Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.

    +

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

    Default: /

    Minimum: 1

    Maximum: 80

    @@ -264,162 +268,164 @@

    Response Parameters

    Status code: 201

    -
    Table 5 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    request_id

    +

    request_id

    String

    +

    String

    Specifies the request ID. The value is automatically generated.

    +

    Specifies the request ID. The value is automatically generated.

    healthmonitor

    +

    healthmonitor

    HealthMonitor object

    +

    HealthMonitor object

    Specifies the health check.

    +

    Specifies the health check.

    -
    Table 6 HealthMonitor

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -456,19 +463,19 @@
    Table 6 HealthMonitor

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    admin_state_up

    +

    admin_state_up

    Boolean

    +

    Boolean

    Specifies the administrative status of the health check.

    +

    Specifies the administrative status of the health check.

    • true(default) indicates that the health check is enabled.

    • false indicates that the health check is disabled.

    delay

    +

    delay

    Integer

    +

    Integer

    Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

    +

    Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

    Minimum: 1

    Maximum: 50

    domain_name

    +

    domain_name

    String

    +

    String

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

    +

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

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

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

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

    expected_codes

    +

    expected_codes

    String

    +

    String

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

    +

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

    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

    -

    The default value is 200. Multiple status codes can be queried in the format of expected_codes=xxx&expected_codes=xxx.

    +

    The default value is 200.

    +

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

    http_method

    +

    http_method

    String

    +

    String

    Specifies the HTTP method. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. The default value is GET.

    +

    Specifies the HTTP method. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. The default value is GET.

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

    This parameter is unsupported. Please do not use it.

    id

    +

    id

    String

    +

    String

    Specifies the health check ID.

    +

    Specifies the health check ID.

    max_retries

    +

    max_retries

    Integer

    +

    Integer

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

    +

    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

    +

    max_retries_down

    Integer

    +

    Integer

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

    +

    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, and the default value is 3.

    Minimum: 1

    Maximum: 10

    monitor_port

    +

    monitor_port

    Integer

    +

    Integer

    Specifies the port used for the health check. If this parameter is left blank, a port of the backend server will be used by default. The port number ranges from 1 to 65535.

    +

    Specifies the port used for the health check. If this parameter is left blank, a port of the backend server will be used by default. The port number ranges from 1 to 65535.

    Minimum: 1

    Maximum: 65535

    name

    +

    name

    String

    +

    String

    Specifies the health check name.

    +

    Specifies the health check name.

    pools

    +

    pools

    Array of PoolRef objects

    +

    Array of PoolRef objects

    Lists the IDs of backend server groups for which the health check is configured. Only one ID will be returned.

    +

    Lists the IDs of backend server groups for which the health check is configured. Only one ID will be returned.

    project_id

    +

    project_id

    String

    +

    String

    Specifies the project ID.

    +

    Specifies the project ID.

    timeout

    +

    timeout

    Integer

    +

    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.

    +

    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

    +

    type

    String

    +

    String

    Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, or HTTPS.

    +

    Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, or HTTPS.

    Note:

    • If the protocol of the backend server is QUIC, the value can only be UDP_CONNECT.

    • If the protocol of the backend server is UDP, the value can only be UDP_CONNECT.

      @@ -429,26 +435,27 @@

    url_path

    +

    url_path

    String

    +

    String

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

    +

    Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.

    +

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

    created_at

    +

    created_at

    String

    +

    String

    Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

    +

    Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

    updated_at

    +

    updated_at

    String

    +

    String

    Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

    +

    Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

    -
    Table 7 PoolRef

    Parameter

    +
    - - - - - diff --git a/docs/elb/api-ref/CreateIpGroup.html b/docs/elb/api-ref/CreateIpGroup.html index a084a1caf..7a53162f9 100644 --- a/docs/elb/api-ref/CreateIpGroup.html +++ b/docs/elb/api-ref/CreateIpGroup.html @@ -1,7 +1,7 @@

    Creating an IP Address Group

    -

    Function

    This API is used to create an IP address group. The IP address can contain IP addresses or CIDR blocks. 0.0.0.0 will be considered the same as 0.0.0.0/32. If you enter both 0.0.0.0 and 0.0.0.0/32, only one will be kept. 0:0:0:0:0:0:0:1 will be considered the same as ::1 and ::1/128. If you enter 0:0:0:0:0:0:0:1, ::1 and ::1/128, only one will be kept.

    +

    Function

    This API is used to create an IP address group. The IP address can contain IP addresses or CIDR blocks. 0.0.0.0 will be considered the same as 0.0.0.0/32. If you enter both 0.0.0.0 and 0.0.0.0/32, only one will be kept. 0:0:0:0:0:0:0:1 will be considered the same as ::1 and ::1/128. If you enter 0:0:0:0:0:0:0:1, ::1 and ::1/128, only one will be kept.

    URI

    POST /v3/{project_id}/elb/ipgroups

    @@ -177,121 +177,121 @@

    Response Parameters

    Status code: 201

    -
    Table 7 PoolRef

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Specifies the ID of the backend server group.

    +

    Specifies the ID of the backend server group.

    Table 6 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    ipgroup

    +

    ipgroup

    IpGroup object

    +

    IpGroup object

    Specifies the response body for creating an IP address group.

    +

    Specifies the response body for creating an IP address group.

    request_id

    +

    request_id

    String

    +

    String

    Specifies the request ID. The value is automatically generated.

    +

    Specifies the request ID. The value is automatically generated.

    -
    Table 7 IpGroup

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 7 IpGroup

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    created_at

    +

    created_at

    String

    +

    String

    Specifies the time when the IP address group was created.

    +

    Specifies the time when the IP address group was created.

    description

    +

    description

    String

    +

    String

    Specifies the time when the IP address group was updated.

    +

    Specifies the time when the IP address group was updated.

    id

    +

    id

    String

    +

    String

    Specifies the ID of the IP address group.

    +

    Specifies the ID of the IP address group.

    ip_list

    +

    ip_list

    Array of IpInfo objects

    +

    Array of IpInfo objects

    Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

    +

    Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

    Array Length: 0 - 300

    listeners

    +

    listeners

    Array of ListenerRef objects

    +

    Array of ListenerRef objects

    Lists the IDs of listeners with which the IP address group is associated.

    +

    Lists the IDs of listeners with which the IP address group is associated.

    name

    +

    name

    String

    +

    String

    Specifies the IP address group name.

    +

    Specifies the IP address group name.

    project_id

    +

    project_id

    String

    +

    String

    Specifies the project ID of the IP address group.

    +

    Specifies the project ID of the IP address group.

    updated_at

    +

    updated_at

    String

    +

    String

    Specifies the time when the IP address group was updated.

    +

    Specifies the time when the IP address group was updated.

    -
    Table 8 IpInfo

    Parameter

    +
    - - - - - - - - @@ -300,19 +300,19 @@
    Table 8 IpInfo

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    ip

    +

    ip

    String

    +

    String

    Specifies the IP addresses in the IP address group.

    +

    Specifies the IP addresses in the IP address group.

    description

    +

    description

    String

    +

    String

    Provides remarks about the IP address group.

    +

    Provides remarks about the IP address group.

    Minimum: 0

    Maximum: 255

    -
    Table 9 ListenerRef

    Parameter

    +
    - - - - - diff --git a/docs/elb/api-ref/CreateL7Policy.html b/docs/elb/api-ref/CreateL7Policy.html index 9929adc84..21aeb2674 100644 --- a/docs/elb/api-ref/CreateL7Policy.html +++ b/docs/elb/api-ref/CreateL7Policy.html @@ -1,7 +1,7 @@

    Adding a Forwarding Policy

    -

    Function

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

    +

    Function

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

    Constraints

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

    @@ -170,7 +170,8 @@
    - - @@ -312,7 +315,8 @@ - @@ -619,45 +623,45 @@

    Response Parameters

    Status code: 201

    -
    Table 9 ListenerRef

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Specifies the listener ID.

    +

    Specifies the listener ID.

    Integer

    Specifies the forwarding policy priority. A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener. This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

    +

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

    +

    This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

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

    • If enhance_l7policy_enable is not enabled, forwarding policies are automatically prioritized based on the original policy sorting logic. The priorities of domain names are independent from each other. For the same domain name, the priorities are sorted in the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If the matching types are the same, the longer the URL is, the higher the priority is. 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 be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to be created because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, specify a value or adjust the priorities of existing forwarding policies. If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default.

      @@ -212,7 +213,8 @@

    String

    Specifies the ID of the backend server group to which the requests are forwarded. This parameter is valid only when action is set to REDIRECT_TO_POOL. Note:

    +

    Specifies the ID of the backend server group to which the requests are forwarded. This parameter is valid only when action is set to REDIRECT_TO_POOL.

    +

    Note:

    • If action is set to REDIRECT_TO_POOL, specify either redirect_pool_id or redirect_pools_config. If both are specified, only redirect_pools_config takes effect.

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

    @@ -277,9 +279,10 @@

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

    +

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

    +

    Note:

    • The entire list will be replaced if you update it.

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

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

    Integer

    Specifies the weight of the backend server group. The value ranges from 0 to 100.

    +

    Specifies the weight of the backend server group.

    +

    The value ranges from 0 to 100.

    Table 10 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 10 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    request_id

    +

    request_id

    String

    +

    String

    Specifies the request ID. The value is automatically generated.

    +

    Specifies the request ID. The value is automatically generated.

    l7policy

    +

    l7policy

    L7Policy object

    +

    L7Policy object

    Specifies the forwarding policy.

    +

    Specifies the forwarding policy.

    -
    Table 11 L7Policy

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -834,104 +839,105 @@
    Table 11 L7Policy

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    action

    +

    action

    String

    +

    String

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

    +

    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_URL: Requests will be redirected to another URL.

      @@ -670,59 +674,60 @@

    admin_state_up

    +

    admin_state_up

    Boolean

    +

    Boolean

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

    +

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

    This parameter is unsupported. Please do not use it.

    description

    +

    description

    String

    +

    String

    Provides supplementary information about the forwarding policy.

    +

    Provides supplementary information about the forwarding policy.

    id

    +

    id

    String

    +

    String

    Specifies the forwarding policy ID.

    +

    Specifies the forwarding policy ID.

    listener_id

    +

    listener_id

    String

    +

    String

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

    +

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

    name

    +

    name

    String

    +

    String

    Specifies the forwarding policy name.

    +

    Specifies the forwarding policy name.

    Minimum: 1

    Maximum: 255

    position

    +

    position

    Integer

    +

    Integer

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

    +

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

    This parameter is unsupported. Please do not use it.

    Minimum: 1

    Maximum: 100

    priority

    +

    priority

    Integer

    +

    Integer

    Specifies the forwarding policy priority. A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener. This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

    +

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

    +

    This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

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

    • If enhance_l7policy_enable is not enabled, forwarding policies are automatically prioritized based on the original policy sorting logic. The priorities of domain names are independent from each other. For the same domain name, the priorities are sorted in the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If the matching types are the same, the longer the URL is, the higher the priority is. 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 be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to be created because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, specify a value or adjust the priorities of existing forwarding policies. If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default.

      @@ -730,45 +735,45 @@

      This parameter is invalid for shared load balancers.

    project_id

    +

    project_id

    String

    +

    String

    Specifies the project ID of the forwarding policy.

    +

    Specifies the project ID of the forwarding policy.

    provisioning_status

    +

    provisioning_status

    String

    +

    String

    Specifies the provisioning status of the forwarding policy.

    +

    Specifies the provisioning status of the forwarding policy.

    The value can be ACTIVE or ERROR.

    • ACTIVE (default): The forwarding policy is provisioned successfully.

    redirect_pool_id

    +

    redirect_pool_id

    String

    +

    String

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

    +

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

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

    • If both redirect_pools_config and redirect_pool_id are specified, redirect_pools_config will take effect.

    redirect_pools_config

    +

    redirect_pools_config

    Array of CreateRedirectPoolsConfig objects

    +

    Array of CreateRedirectPoolsConfig objects

    Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL.

    +

    Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL.

    redirect_listener_id

    +

    redirect_listener_id

    String

    +

    String

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

    +

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

    Note:

    • The listener's protocol must be HTTPS or TERMINATED_HTTPS.

    • A listener added to another load balancer is not allowed.

      @@ -776,27 +781,27 @@

    redirect_url

    +

    redirect_url

    String

    +

    String

    Specifies the URL to which requests are forwarded.

    +

    Specifies the URL to which requests are forwarded.

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

    This parameter is unsupported. Please do not use it.

    rules

    +

    rules

    Array of RuleRef objects

    +

    Array of RuleRef objects

    Lists the forwarding rules in the forwarding policy.

    +

    Lists the forwarding rules in the forwarding policy.

    redirect_url_config

    +

    redirect_url_config

    RedirectUrlConfig object

    +

    RedirectUrlConfig object

    Specifies the URL to which requests are forwarded.

    +

    Specifies the URL to which requests are forwarded.

    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.

    This parameter is mandatory when action is set to REDIRECT_TO_URL. It cannot be specified if the value of action is not REDIRECT_TO_URL.

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

    @@ -805,28 +810,28 @@

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

    fixed_response_config

    +

    fixed_response_config

    FixtedResponseConfig object

    +

    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.

    +

    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.

    This parameter is mandatory when action is set to FIXED_RESPONSE. It cannot be specified if the value of action is not FIXED_RESPONSE.

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

    created_at

    +

    created_at

    String

    +

    String

    Specifies the time when the forwarding policy was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

    +

    Specifies the time when the forwarding policy was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

    updated_at

    +

    updated_at

    String

    +

    String

    Specifies the time when the forwarding policy was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

    +

    Specifies the time when the forwarding policy was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

    -
    Table 12 CreateRedirectPoolsConfig

    Parameter

    +
    - - - - - - - -
    Table 12 CreateRedirectPoolsConfig

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    pool_id

    +

    pool_id

    String

    +

    String

    Specifies the ID of the backend server group.

    +

    Specifies the ID of the backend server group.

    weight

    +

    weight

    Integer

    +

    Integer

    Specifies the weight of the backend server group. The value ranges from 0 to 100.

    +

    Specifies the weight of the backend server group.

    +

    The value ranges from 0 to 100.

    -
    Table 13 RuleRef

    Parameter

    +
    - - - - -
    Table 13 RuleRef

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Specifies the forwarding rule ID.

    +

    Specifies the forwarding rule ID.

    -
    Table 14 RedirectUrlConfig

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 14 RedirectUrlConfig

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    protocol

    +

    protocol

    String

    +

    String

    Specifies the protocol for redirection.

    +

    Specifies the protocol for redirection.

    The value can be HTTP, HTTPS, or ${protocol}. The default value is ${protocol}, indicating that the protocol of the request will be used.

    Minimum: 1

    Maximum: 36

    host

    +

    host

    String

    +

    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.

    +

    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

    +

    port

    String

    +

    String

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

    +

    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

    +

    path

    String

    +

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

    +

    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

    +

    query

    String

    +

    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.

    +

    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.example.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.example.com:8080/elb?type=loadbalancer&name=my_name.

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

    Default: ${query}

    @@ -939,11 +945,11 @@

    Maximum: 128

    status_code

    +

    status_code

    String

    +

    String

    Specifies the status code returned after the requests are redirected.

    +

    Specifies the status code returned after the requests are redirected.

    The value can be 301, 302, 303, 307, or 308.

    Minimum: 1

    Maximum: 16

    @@ -953,38 +959,38 @@
    -
    Table 15 FixtedResponseConfig

    Parameter

    +
    - - - - - - - - - - - diff --git a/docs/elb/api-ref/CreateL7Rule.html b/docs/elb/api-ref/CreateL7Rule.html index c76f80549..72d0778ae 100644 --- a/docs/elb/api-ref/CreateL7Rule.html +++ b/docs/elb/api-ref/CreateL7Rule.html @@ -1,9 +1,9 @@

    Adding a Forwarding Rule

    -

    Function

    This API is used to add a forwarding rule.

    +

    Function

    This API is used to add a forwarding rule.

    -

    Constraints

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

    +

    Constraints

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

    URI

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

    @@ -175,7 +175,9 @@
  • METHOD: An HTTP request method will be used for matching.

  • HEADER: The request header will be used for matching.

  • QUERY_STRING: A query string will be used for matching.

    -
  • SOURCE_IP: The source IP address will be used for matching. Note: If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

    +
  • SOURCE_IP: The source IP address will be used for matching.

    +

    Note:

    +

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

  • @@ -254,79 +256,79 @@

    Response Parameters

    Status code: 201

    -
    Table 15 FixtedResponseConfig

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    status_code

    +

    status_code

    String

    +

    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.

    +

    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

    +

    content_type

    String

    +

    String

    Specifies the format of the response body.

    +

    Specifies the format of the response body.

    The value can be text/plain, text/css, text/html, application/javascript, or application/json.

    Minimum: 0

    Maximum: 32

    message_body

    +

    message_body

    String

    +

    String

    Specifies the content of the response message body.

    +

    Specifies the content of the response message body.

    Minimum: 0

    Maximum: 1024

    Table 6 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    request_id

    +

    request_id

    String

    +

    String

    Specifies the request ID. The value is automatically generated.

    +

    Specifies the request ID. The value is automatically generated.

    rule

    +

    rule

    L7Rule object

    +

    L7Rule object

    Specifies the forwarding rule.

    +

    Specifies the forwarding rule.

    -
    Table 7 L7Rule

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -401,19 +404,19 @@
    Table 7 L7Rule

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    admin_state_up

    +

    admin_state_up

    Boolean

    +

    Boolean

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

    +

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

    This parameter is unsupported. Please do not use it.

    compare_type

    +

    compare_type

    String

    +

    String

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

    +

    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, the value can be REGEX, STARTS_WITH, or EQUAL_TO.

    key

    +

    key

    String

    +

    String

    Specifies the key of the match content. This parameter will not take effect if type is set to HOST_NAME or PATH.

    +

    Specifies the key of the match content. This parameter will not take effect if type is set to HOST_NAME or PATH.

    Minimum: 1

    Maximum: 255

    project_id

    +

    project_id

    String

    +

    String

    Specifies the project ID.

    +

    Specifies the project ID.

    type

    +

    type

    String

    +

    String

    Specifies the type of the forwarding rule. The value can be one of the following:

    +

    Specifies the type of the forwarding rule. 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.

    • METHOD: An HTTP request method will be used for matching.

      @@ -338,11 +340,11 @@

      If type is set to HOST_NAME, PATH, METHOD, and SOURCE_IP, only one forwarding rule can be created for each type. If type is set to HEADER and QUERY_STRING, multiple forwarding rules can be created for each type.

    value

    +

    value

    String

    +

    String

    Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. This parameter will take effect only when conditions is left blank.

    +

    Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. This parameter will take effect only when conditions is left blank.

    • 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 _~';@^-%#&$.*+?,=!:|/()[]{}

    • If type is set to METHOD, SOURCE_IP, HEADER, or QUERY_STRING, this parameter will not take effect, and condition_pair will be used to specify the key and value.

      @@ -351,49 +353,50 @@

      Maximum: 128

    provisioning_status

    +

    provisioning_status

    String

    +

    String

    Specifies the provisioning status of the forwarding rule.

    +

    Specifies the provisioning status of the forwarding rule.

    The value can only be ACTIVE (default), PENDING_CREATE, or ERROR.

    This parameter is unsupported. Please do not use it.

    invert

    +

    invert

    Boolean

    +

    Boolean

    Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but will not take effect.

    +

    Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but will not take effect.

    id

    +

    id

    String

    +

    String

    Specifies the forwarding policy ID.

    +

    Specifies the forwarding policy ID.

    conditions

    +

    conditions

    Array of RuleCondition objects

    +

    Array of RuleCondition 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.

    +

    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.

    created_at

    +

    created_at

    String

    +

    String

    Specifies the time when the forwarding rule was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

    +

    Specifies the time when the forwarding rule was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

    updated_at

    +

    updated_at

    String

    +

    String

    Specifies the time when the forwarding rule was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

    +

    Specifies the time when the forwarding rule was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

    -
    Table 8 RuleCondition

    Parameter

    +
    - - - - - - - - - @@ -263,7 +266,7 @@
    Table 8 RuleCondition

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    String

    +

    String

    Specifies the key of match item.

    +

    Specifies the key of match item.

    • If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, this parameter is left blank.

    • If type is set to HEADER, key indicates the name of the HTTP header parameter. The value can contain 1 to 40 characters, including letters, digits, hyphens (-), and underscores (_).

    • If type is set to QUERY_STRING, key indicates the name of the query parameter. The value is case sensitive and can contain 1 to 128 characters. Spaces, square brackets ([ ]), curly brackets ({ }), angle brackets (< >), backslashes (), double quotation marks (" "), pound signs (#), ampersands (&), vertical bars (|), percent signs (%), and tildes (~) are not supported.

      @@ -423,11 +426,11 @@

      Maximum: 128

    value

    +

    value

    String

    +

    String

    Specifies the value of the match item.

    +

    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 _~';@^-%#&$.*+?,=!:|/()[]{}

    • If type is set to HEADER, key indicates the name of the HTTP header parameter, and value indicates the value of the HTTP header parameter. The value can contain 1 to 128 characters. Asterisks (*) and question marks (?) are allowed, but spaces and double quotation marks are not allowed. An asterisk can match zero or more characters, and a question mark can match 1 character.

      diff --git a/docs/elb/api-ref/CreateListener.html b/docs/elb/api-ref/CreateListener.html index fb6336f37..f4a32f561 100644 --- a/docs/elb/api-ref/CreateListener.html +++ b/docs/elb/api-ref/CreateListener.html @@ -1,7 +1,7 @@

      Adding a Listener

      -

      Function

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

      +

      Function

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

      Constraints

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

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

        @@ -152,7 +152,8 @@

    Boolean

    Specifies whether to use 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 still use HTTP/1.x by default.

    -

    This parameter is available only for HTTPS listeners. If you configure this parameter for listeners with other protocols, it will not take effect.

    +

    This parameter is available only for HTTPS listeners.

    +

    If you configure this parameter for listeners with other protocols, it will not take effect.

    insert_headers

    @@ -170,7 +171,9 @@

    String

    Specifies the ID of the load balancer that the listener is added to. Note: A listener can be added to only one load balancer.

    +

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

    +

    Note:

    +

    A listener can be added to only one load balancer.

    Minimum: 1

    Maximum: 36

    String

    Specifies the security policy used by the listener.

    -

    Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

    +

    Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

    Note:

    • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

    • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

      @@ -537,139 +540,140 @@

      Response Parameters

      Status code: 201

      -
      Table 8 Response body parameters

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      request_id

      +

      request_id

      String

      +

      String

      Specifies the request ID. The value is automatically generated.

      +

      Specifies the request ID. The value is automatically generated.

      listener

      +

      listener

      Listener object

      +

      Listener object

      Specifies the listener.

      +

      Specifies the listener.

      -
      Table 9 Listener

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      admin_state_up

      +

      admin_state_up

      Boolean

      +

      Boolean

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

      +

      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

      +

      client_ca_tls_container_ref

      String

      +

      String

      Specifies the ID of the CA certificate used by the listener. This parameter is available only when type is set to client.

      +

      Specifies the ID of the CA certificate used by the listener. This parameter is available only when type is set to client.

      connection_limit

      +

      connection_limit

      Integer

      +

      Integer

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

      +

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

      This parameter is unsupported. Please do not use it.

      created_at

      +

      created_at

      String

      +

      String

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

      +

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

      default_pool_id

      +

      default_pool_id

      String

      +

      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.

      +

      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

      +

      default_tls_container_ref

      String

      +

      String

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

      +

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

      description

      +

      description

      String

      +

      String

      Provides supplementary information about the listener.

      +

      Provides supplementary information about the listener.

      http2_enable

      +

      http2_enable

      Boolean

      +

      Boolean

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

      -

      This parameter is available only for HTTPS listeners. If you configure this parameter for listeners with other protocols, it will not take effect.

      +

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

      +

      This parameter is available only for HTTPS listeners.

      +

      If you configure this parameter for listeners with other protocols, it will not take effect.

      id

      +

      id

      String

      +

      String

      Specifies the listener ID.

      +

      Specifies the listener ID.

      insert_headers

      +

      insert_headers

      ListenerInsertHeaders object

      +

      ListenerInsertHeaders object

      Specifies the HTTP header fields that can transmit required information to backend servers. For example, the X-Forwarded-ELB-IP header field can transmit the EIP of the load balancer to backend servers.

      +

      Specifies the HTTP header fields that can transmit required information to backend servers. For example, the X-Forwarded-ELB-IP header field can transmit the EIP of the load balancer to backend servers.

      loadbalancers

      +

      loadbalancers

      Array of LoadBalancerRef objects

      +

      Array of LoadBalancerRef objects

      Specifies the ID of the load balancer that the listener is added to. A listener can be added to only one load balancer.

      +

      Specifies the ID of the load balancer that the listener is added to. A listener can be added to only one load balancer.

      name

      +

      name

      String

      +

      String

      Specifies the listener name.

      +

      Specifies the listener name.

      project_id

      +

      project_id

      String

      +

      String

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

      +

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

      protocol

      +

      protocol

      String

      +

      String

      Specifies the protocol used by the listener.

      +

      Specifies the protocol used by the listener.

      The value can be TCP, HTTP, UDP, HTTPS or TERMINATED_HTTPS.

      Note:

      • Protocol used by HTTPS listeners added to a shared load balancer can only be set to TERMINATED_HTTPS. If HTTPS is passed, the value will be automatically changed to TERMINATED_HTTPS.

        @@ -677,55 +681,55 @@

      protocol_port

      +

      protocol_port

      Integer

      +

      Integer

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

      +

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

      Minimum: 1

      Maximum: 65535

      sni_container_refs

      +

      sni_container_refs

      Array of strings

      +

      Array of strings

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

      +

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

      Note:

      • The domain names of all SNI certificates must be unique.

      • The total number of domain names of all SNI certificates cannot exceed 30.

      sni_match_algo

      +

      sni_match_algo

      String

      +

      String

      Specifies how wildcard domain name matches with the SNI certificates used by the listener.

      +

      Specifies how wildcard domain name matches with the SNI certificates used by the listener.

      longest_suffix indicates longest suffix match. wildcard indicates wildcard match.

      The default value is wildcard.

      tags

      +

      tags

      Array of Tag objects

      +

      Array of Tag objects

      Lists the tags.

      +

      Lists the tags.

      updated_at

      +

      updated_at

      String

      +

      String

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

      +

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

      tls_ciphers_policy

      +

      tls_ciphers_policy

      String

      +

      String

      Specifies the security policy used by the listener.

      -

      Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

      +

      Specifies the security policy used by the listener.

      +

      Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

      Note:

      • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

      • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

        @@ -733,11 +737,11 @@

      security_policy_id

      +

      security_policy_id

      String

      +

      String

      Specifies the ID of the custom security policy.

      +

      Specifies the ID of the custom security policy.

      Note:

      • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

      • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

        @@ -745,33 +749,33 @@

      enable_member_retry

      +

      enable_member_retry

      Boolean

      +

      Boolean

      Specifies whether to enable health check retries for backend servers. The value can be true (enable health check retries) or false (disable health check retries). The default value is true.

      +

      Specifies whether to enable health check retries for backend servers. The value can be true (enable health check retries) or false (disable health check retries). The default value is true.

      Note:

      • If a shared load balancer is associated, this parameter is available only when protocol is set to HTTP or TERMINATED_HTTPS.

      • If a dedicated load balancer is associated, this parameter is available only when protocol is set to HTTP or HTTPS.

      keepalive_timeout

      +

      keepalive_timeout

      Integer

      +

      Integer

      Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

      +

      Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

      • 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 1 to 4000, and the default value is 60.

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

      client_timeout

      +

      client_timeout

      Integer

      +

      Integer

      Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

      +

      Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

      • If the client fails to send a request header to the load balancer within the timeout duration, the request will be interrupted.

      • If the interval between two consecutive request bodies reaching the load balancer is greater than the timeout duration, the connection will be disconnected.

      @@ -779,27 +783,27 @@

      This parameter is available only for HTTP and HTTPS listeners.

      member_timeout

      +

      member_timeout

      Integer

      +

      Integer

      Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

      +

      Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

      The value ranges from 1 to 300, and the default value is 60.

      This parameter is available only for HTTP and HTTPS listeners.

      ipgroup

      +

      ipgroup

      ListenerIpGroup object

      +

      ListenerIpGroup object

      Specifies the IP address group associated with the listener.

      +

      Specifies the IP address group associated with the listener.

      transparent_client_ip_enable

      +

      transparent_client_ip_enable

      Boolean

      +

      Boolean

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

      +

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

      • TCP or UDP listeners of shared load balancers: The value can be true or false, and the default value is false if this parameter is not passed.

      • HTTP or HTTPS listeners of shared load balancers: The value can only be true, and the default value is true if this parameter is not passed.

      • All listeners of dedicated load balancers: The value can only be true, and the default value is true if this parameter is not passed.

        @@ -811,11 +815,11 @@

      enhance_l7policy_enable

      +

      enhance_l7policy_enable

      Boolean

      +

      Boolean

      Specifies whether to enable advanced forwarding. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

      +

      Specifies whether to enable advanced forwarding. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

      • If this function is enabled, action can be set to REDIRECT_TO_URL (requests will be redirected to another URL) or Fixed_RESPONSE (a fixed response body will be returned to clients).

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

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

        @@ -827,11 +831,11 @@

        Default: false

      quic_config

      +

      quic_config

      ListenerQuicConfig object

      +

      ListenerQuicConfig object

      Specifies the QUIC configuration for the current listener. This parameter is valid only when protocol is set to HTTPS.

      +

      Specifies the QUIC configuration for the current listener. This parameter is valid only when protocol is set to HTTPS.

      For a TCP/UDP/HTTP/QUIC listener, if this parameter is not left blank, an error will be reported.

      NOTE:

      The client sends a normal HTTP request that contains information indicating that the QUIC protocol is supported.

      @@ -844,43 +848,43 @@
      -
      Table 10 ListenerInsertHeaders

      Parameter

      +
      - - - - - - - - - - - - - - @@ -888,47 +892,47 @@
      Table 10 ListenerInsertHeaders

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      X-Forwarded-ELB-IP

      +

      X-Forwarded-ELB-IP

      Boolean

      +

      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.

      +

      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

      +

      X-Forwarded-Port

      Boolean

      +

      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.

      +

      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

      +

      X-Forwarded-For-Port

      Boolean

      +

      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.

      +

      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

      +

      X-Forwarded-Host

      Boolean

      +

      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.

      +

      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

      +
      - - - - -
      Table 11 LoadBalancerRef

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Specifies the load balancer ID.

      +

      Specifies the load balancer ID.

      -
      Table 12 Tag

      Parameter

      +
      - - - - - - - - @@ -937,39 +941,39 @@
      Table 12 Tag

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      key

      +

      key

      String

      +

      String

      Specifies the tag key.

      +

      Specifies the tag key.

      Minimum: 1

      Maximum: 36

      value

      +

      value

      String

      +

      String

      Specifies the tag value.

      +

      Specifies the tag value.

      Minimum: 0

      Maximum: 43

      -
      Table 13 ListenerIpGroup

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      ipgroup_id

      +

      ipgroup_id

      String

      +

      String

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

      +

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

      This parameter is mandatory when you create the IP address group and is optional when you update the IP address group.

      The specified IP address group must exist, and the value cannot be null.

      enable_ipgroup

      +

      enable_ipgroup

      Boolean

      +

      Boolean

      Specifies whether to enable access control.

      +

      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

      +

      type

      String

      +

      String

      Specifies how access to the listener is controlled.

      +

      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.

      @@ -979,27 +983,32 @@
      -
      Table 14 ListenerQuicConfig

      Parameter

      +
      - - - - - - - - diff --git a/docs/elb/api-ref/CreateLoadBalancer.html b/docs/elb/api-ref/CreateLoadBalancer.html index ec7c0f6ca..652b12d67 100644 --- a/docs/elb/api-ref/CreateLoadBalancer.html +++ b/docs/elb/api-ref/CreateLoadBalancer.html @@ -1,1069 +1,1158 @@

      Creating a Load Balancer

      -

      Function

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

      -
      • Specify vip_subnet_cidr_id if you want to bind a private IPv4 address to the dedicated load balancer.
      • Specify publicip and either vpc_id or vip_subnet_cidr_id if you want to bind a new IPv4 EIP to the dedicated load balancer.
      • Specify publicip_ids and either vpc_id or vip_subnet_cidr_id if you want to bind an existing IPv4 EIP to the dedicated load balancer.
      • Specify ipv6_vip_virsubnet_id if you want to bind a private IPv6 address to the dedicated load balancer.
      • Specify both ipv6_vip_virsubnet_id and ipv6_bandwidth if you want to bind a public IPv6 address to the dedicated load balancer.
      • You cannot bind an existing and unoccupied private IPv4 address, IPv6 address, or public IPv6 address to the dedicated load balancer.
      -

      You cannot bind IPv6 addresses to a dedicated load balancer.

      +

      Function

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

      +
      • Specify vip_subnet_cidr_id if you want to bind a private IPv4 address to the load balancer.

        +
      • Specify publicip and either vpc_id or vip_subnet_cidr_id if you want to bind a new IPv4 EIP to the load balancer.

        +
      • Specify publicip_ids and either vpc_id or vip_subnet_cidr_id if you want to bind an existing IPv4 EIP to the load balancer.

        +
      • Specify ipv6_vip_virsubnet_id if you want to bind a private IPv6 address to the load balancer.

        +
      • Specify both ipv6_vip_virsubnet_id and ipv6_bandwidth if you want to bind a public IPv6 address to the load balancer.

        +
      • You cannot bind an existing and unoccupied private IPv4 address, IPv6 address, or public IPv6 address to the load balancer.

        +
      • Load balancers are billed by fixed specifications or elastic specifications you have selected when you create the load balancer. For details, see the descriptions about parameters l4_flavor_id and l7_flavor_id.

        +
      +

      Dedicated load balancers with IPv6 addresses are not supported.

      -

      Constraints

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

      -
      • vpc_id, vip_subnet_cidr_id, and ipv6_vip_virsubnet_id cannot be left blank at the same time.
      • ip_target_enable specifies whether to enable IP as a Backend Server. If you enable this function for a dedicated load balancer, you can associate servers in a VPC connected through a VPC peering connection, in a VPC connected through a cloud connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using server IP addresses.
      • admin_state_up must be set to true.
      • provider must be set to vlb.
      • elb_virsubnet_ids indicates the subnets that support IPv4/IPv6 dual stack or only IPv4 subnets. If only IPv4 subnets are supported, ipv6_vip_virsubnet_id must be left blank.
      • If you bind an EIP to the load balancer during creation, you cannot unbind it from the load balancer by calling the API after the load balancer is created. Instead, you can unbind the EIP only on the ELB console. Locate the dedicated load balancer in the load balancer list and click More > Unbind EIP in the Operation column.
      • publicip_ids and publicip cannot be specified at the same time. Set either publicip_ids to bind an existing EIP to the load balancer, or publicip to bind a new EIP to the load balancer, or neither of them.
      • If you want to add the load balancer to a shared bandwidth, you must specify the ID of the shared bandwidth. If you want the load balancer to use a new dedicated bandwidth, charge_mode, share_type, and size are required.
      +

      Constraints

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

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

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

        +
      • admin_state_up must be set to true.

        +
      • provider must be set to vlb.

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

        +
      • If you bind an EIP to the load balancer during creation, you cannot unbind it from the load balancer by calling the API after the load balancer is created. Instead, you can unbind the EIP only on the ELB console. Locate the dedicated load balancer in the load balancer list and click More > Unbind EIP in the Operation column.

        +
      • publicip_ids and publicip cannot be specified at the same time. Set either publicip_ids to bind an existing EIP to the load balancer, or publicip to bind a new EIP to the load balancer, or neither of them.

        +
      • If you want to add the load balancer to a shared bandwidth, you must specify the ID of the shared bandwidth. If you want the load balancer to use a new dedicated bandwidth, charge_mode, share_type, and size are required.

        +
      -

      URI

      POST /v3/{project_id}/elb/loadbalancers

      +

      URI

      POST /v3/{project_id}/elb/loadbalancers

      -
      Table 14 ListenerQuicConfig

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      quic_listener_id

      +

      quic_listener_id

      String

      +

      String

      Specifies the ID of the QUIC listener. This parameter is mandatory for creation and is optional for update. The specified quic_listener_id must exist. The listener protocol must be QUIC and cannot be set to null, otherwise, it will conflict with enable_quic_upgrade.

      +

      Specifies the ID of the QUIC listener.

      +

      This parameter is mandatory for creation and is optional for update.

      +

      The specified quic_listener_id must exist. The listener protocol must be QUIC and cannot be set to null, otherwise, it will conflict with enable_quic_upgrade.

      QUIC protocol is not supported.

      enable_quic_upgrade

      +

      enable_quic_upgrade

      Boolean

      +

      Boolean

      Specifies whether to enable QUIC upgrade. True: QUIC upgrade is enabled. False: QUIC upgrade is disabled. HTTPS listeners can be upgraded to QUIC listeners.

      +

      Specifies whether to enable QUIC upgrade.

      +

      True: QUIC upgrade is enabled.

      +

      False: QUIC upgrade is disabled.

      +

      HTTPS listeners can be upgraded to QUIC listeners.

      QUIC protocol is not supported.

      Table 1 Path Parameters

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the project ID of the load balancer.

      -

      Minimum: 0

      -

      Maximum: 36

      +

      Specifies the project ID of the load balancer.

      +

      Minimum: 0

      +

      Maximum: 36

      -

      Request Parameters

      -
      Table 2 Request header parameters

      Parameter

      +

      Request Parameters

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      X-Auth-Token

      No

      +

      No

      String

      +

      String

      Specifies the token used for IAM authentication.

      -

      Minimum: 0

      -

      Maximum: 4096

      +

      Specifies the token used for IAM authentication.

      +

      Minimum: 0

      +

      Maximum: 4096

      -
      Table 3 Request body parameters

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      loadbalancer

      +

      loadbalancer

      Yes

      +

      Yes

      CreateLoadBalancerOption object

      +

      CreateLoadBalancerOption object

      Specifies the load balancer.

      +

      Specifies the load balancer.

      -
      Table 4 CreateLoadBalancerOption

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      No

      +

      No

      String

      +

      String

      Specifies the project ID.

      -

      Minimum: 1

      -

      Maximum: 32

      +

      Specifies the project ID.

      +

      Minimum: 1

      +

      Maximum: 32

      name

      +

      name

      No

      +

      No

      String

      +

      String

      Specifies the load balancer name.

      -

      Minimum: 0

      -

      Maximum: 255

      +

      Specifies the load balancer name.

      +

      Minimum: 0

      +

      Maximum: 255

      description

      +

      description

      No

      +

      No

      String

      +

      String

      Provides supplementary information about the load balancer.

      -

      Minimum: 0

      -

      Maximum: 255

      +

      Provides supplementary information about the load balancer.

      +

      Minimum: 0

      +

      Maximum: 255

      vip_address

      +

      vip_address

      No

      +

      No

      String

      +

      String

      Specifies the private IPv4 address bound to the load balancer. The IP address must be from the IPv4 subnet where the load balancer resides and should not be occupied by other services.

      -

      Note:

      -
      • vip_subnet_cidr_id is also required if vip_address is passed.
      • If only vip_subnet_cidr_id is passed, the system will automatically assign a private IPv4 address to the load balancer.
      • If both vip_address and vip_subnet_cidr_id are not passed, no private IPv4 address will be assigned, and the value of vip_address will be null.
      +

      Specifies the private IPv4 address bound to the load balancer. The IP address must be from the IPv4 subnet where the load balancer resides and should not be occupied by other services.

      +

      Note:

      +
      • vip_subnet_cidr_id is also required if vip_address is passed.

        +
      • If only vip_subnet_cidr_id is passed, the system will automatically assign a private IPv4 address to the load balancer.

        +
      • If both vip_address and vip_subnet_cidr_id are not passed, no private IPv4 address will be assigned, and the value of vip_address will be null.

        +

      vip_subnet_cidr_id

      +

      vip_subnet_cidr_id

      No

      +

      No

      String

      +

      String

      Specifies the ID of the IPv4 subnet where the load balancer resides. This parameter is mandatory if you need to create a load balancer with a private IPv4 address.

      -

      You can query parameter neutron_subnet_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

      -

      Note:

      -
      • vpc_id, vip_subnet_cidr_id and ipv6_vip_virsubnet_id cannot be left blank at the same time. The subnet specified by vip_subnet_cidr_id and the subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id.
      • The subnet specified by vip_subnet_cidr_id must be in the VPC specified by vpc_id if both vpc_id and vip_subnet_cidr_id are passed.
      -

      Minimum: 1

      -

      Maximum: 36

      +

      Specifies the ID of the IPv4 subnet where the load balancer resides. This parameter is mandatory if you need to create a load balancer with a private IPv4 address.

      +

      You can query parameter neutron_subnet_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

      +

      Note:

      +
      • vpc_id, vip_subnet_cidr_id and ipv6_vip_virsubnet_id cannot be left blank at the same time. The subnet specified by vip_subnet_cidr_id and the subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id.

        +
      • The subnet specified by vip_subnet_cidr_id must be in the VPC specified by vpc_id if both vpc_id and vip_subnet_cidr_id are passed.

        +
      +

      Minimum: 1

      +

      Maximum: 36

      ipv6_vip_virsubnet_id

      +

      ipv6_vip_virsubnet_id

      No

      +

      No

      String

      +

      String

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

      -

      Note:

      -
      • vpc_id, vip_subnet_cidr_id and ipv6_vip_virsubnet_id cannot be left blank at the same time. The subnet specified by vip_subnet_cidr_id and the subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id.
      • IPv6 must have been enabled for the IPv6 subnet where the load balancer resides.
      +

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

      +

      Note:

      +
      • vpc_id, vip_subnet_cidr_id and ipv6_vip_virsubnet_id cannot be left blank at the same time. The subnet specified by vip_subnet_cidr_id and the subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id.

        +
      • IPv6 must have been enabled for the IPv6 subnet where the load balancer resides.

        +

      provider

      +

      provider

      No

      +

      No

      String

      +

      String

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

      -

      Minimum: 1

      -

      Maximum: 255

      +

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

      +

      Minimum: 1

      +

      Maximum: 255

      l4_flavor_id

      +

      l4_flavor_id

      No

      +

      No

      String

      +

      String

      Specifies the ID of a flavor at Layer 4.

      -

      Note:

      -
      • If neither **l4_flavor_id** nor **l7_flavor_id** is specified, the default flavor is used. The default flavor varies depending on the sites.
      -

      Minimum: 1

      -

      Maximum: 36

      +

      Specifies the ID of a flavor at Layer 4.

      +

      Note:

      +
      • If neither l4_flavor_id nor l7_flavor_id is specified, the default flavor is used. The default flavor varies depending on the sites.

        +
      • If this parameter is set to the ID defined by L4_elastic_max, the load balancer uses the elastic specifications.

        +
      +

      Minimum: 1

      +

      Maximum: 36

      l7_flavor_id

      +

      l7_flavor_id

      No

      +

      No

      String

      +

      String

      Specifies the ID of a flavor at Layer 7.

      -

      Note:

      -
      • If neither **l4_flavor_id** nor **l7_flavor_id** is specified, the default flavor is used. The default flavor varies depending on the sites.
      -

      Minimum: 1

      -

      Maximum: 36

      +

      Specifies the ID of a flavor at Layer 7.

      +

      Note:

      +
      • If neither l4_flavor_id nor l7_flavor_id is specified, the default flavor is used. The default flavor varies depending on the sites.

        +
      • If this parameter is set to the ID defined by L7_elastic_max, the load balancer uses the elastic specifications.

        +
      +

      Minimum: 1

      +

      Maximum: 36

      guaranteed

      +

      guaranteed

      No

      +

      No

      Boolean

      +

      Boolean

      Specifies whether the load balancer is a dedicated load balancer.

      -
      • true (default): The load balancer is a dedicated load balancer.
      • false: The load balancer is a shared load balancer.
      -

      Currently, the value can only be true. If the value is set to false, 400 Bad Request will be returned.

      +

      Specifies whether the load balancer is a dedicated load balancer.

      +
      • true (default): The load balancer is a dedicated load balancer.

        +
      • false: The load balancer is a shared load balancer.

        +
      +

      Currently, the value can only be true. If the value is set to false, 400 Bad Request will be returned.

      vpc_id

      +

      vpc_id

      No

      +

      No

      String

      +

      String

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

      -

      vpc_id, vip_subnet_cidr_id and ipv6_vip_virsubnet_id cannot be left blank at the same time. The subnet specified by vip_subnet_cidr_id and the subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id.

      +

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

      +

      vpc_id, vip_subnet_cidr_id and ipv6_vip_virsubnet_id cannot be left blank at the same time. The subnet specified by vip_subnet_cidr_id and the subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id.

      availability_zone_list

      +

      availability_zone_list

      Yes

      +

      Yes

      Array of strings

      +

      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.

      +

      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

      +

      enterprise_project_id

      No

      +

      No

      String

      +

      String

      Specifies the ID of the enterprise project that the load balancer belongs to. 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, and 0 will be returned.

      -

      This parameter is unsupported. Please do not use it.

      +

      Specifies the ID of the enterprise project that the load balancer belongs to. 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, and 0 will be returned.

      +

      This parameter is unsupported. Please do not use it.

      tags

      +

      tags

      No

      +

      No

      Array of Tag objects

      +

      Array of Tag objects

      Lists the tags added to the load balancer.

      -

      Example: "tags":[{"key":"my_tag","value":"my_tag_value"}]

      +

      Lists the tags added to the load balancer.

      +

      Example: "tags":[{"key":"my_tag","value":"my_tag_value"}]

      admin_state_up

      +

      admin_state_up

      No

      +

      No

      Boolean

      +

      Boolean

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

      -

      This parameter is unsupported. Please do not use it.

      +

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

      +

      This parameter is unsupported. Please do not use it.

      ipv6_bandwidth

      +

      ipv6_bandwidth

      No

      +

      No

      BandwidthRef object

      +

      BandwidthRef object

      Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

      +

      Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

      publicip_ids

      +

      publicip_ids

      No

      +

      No

      Array of strings

      +

      Array of strings

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

      +

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

      publicip

      +

      publicip

      No

      +

      No

      CreateLoadBalancerPublicIpOption object

      +

      CreateLoadBalancerPublicIpOption object

      Specifies the new EIP that will be bound to the load balancer.

      +

      Specifies the new EIP that will be bound to the load balancer.

      elb_virsubnet_ids

      +

      elb_virsubnet_ids

      No

      +

      No

      Array of strings

      +

      Array of strings

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

      -

      If this parameter is not specified, select subnets as follows:

      -
      • If IPv6 is enabled for a load balancer, the ID of subnet specified in ipv6_vip_virsubnet_id will be used.
      • If IPv4 is enabled for a load balancer, the ID of subnet specified in vip_subnet_cidr_id will be used.
      • If only pubilc network is available for a load balancer, the ID of any subnet in the VPC where the load balancer resides will be used. Subnets with more IP addresses are preferred.
      -

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

      +

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

      +

      If this parameter is not specified, select subnets as follows:

      +
      • If IPv6 is enabled for a load balancer, the ID of subnet specified in ipv6_vip_virsubnet_id will be used.

        +
      • If IPv4 is enabled for a load balancer, the ID of subnet specified in vip_subnet_cidr_id will be used.

        +
      • If only public network is available for a load balancer, the ID of any subnet in the VPC where the load balancer resides will be used. Subnets with more IP addresses are preferred.

        +
      +

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

      ip_target_enable

      +

      ip_target_enable

      No

      +

      No

      Boolean

      +

      Boolean

      Specifies whether to enable IP as a Backend Server.

      -

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

      -

      This function is supported only by dedicated load balancers.

      -

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

      -

      The value can only be update to true.

      +

      Specifies whether to enable IP as a Backend Server.

      +

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

      +

      This function is supported only by dedicated load balancers.

      +

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

      +

      The value can only be update to true.

      deletion_protection_enable

      +

      deletion_protection_enable

      No

      +

      No

      Boolean

      +

      Boolean

      Specifies whether to enable deletion protection for the load balancer.

      -
      • true: Enable deletion protection.
      • false (default): Disable deletion protection.
      -
      NOTE:

      Disable deletion protection for all your resources before deleting your account.

      +

      Specifies whether to enable deletion protection for the load balancer.

      +
      • true: Enable deletion protection.

        +
      • false (default): Disable deletion protection.

        +
      +
      NOTE:

      Disable deletion protection for all your resources before deleting your account.

      waf_failure_action

      +

      waf_failure_action

      No

      +

      No

      String

      +

      String

      Specifies traffic distributing policies when the WAF is faulty.

      -
      • discard: Traffic will not be distributed.
      • forward: Traffic will be distributed to the default backend servers.
      -

      Note: This parameter takes effect only when WAF is enabled for the load balancer.

      -

      This parameter is unsupported. Please do not use it.

      -

      Default: forward

      -

      Minimum: 0

      -

      Maximum: 36

      +

      Specifies traffic distributing policies when the WAF is faulty.

      +
      • discard: Traffic will not be distributed.

        +
      • forward: Traffic will be distributed to the default backend servers.

        +
      +

      Note: This parameter takes effect only when WAF is enabled for the load balancer.

      +

      This parameter is unsupported. Please do not use it.

      +

      Default: forward

      +

      Minimum: 0

      +

      Maximum: 36

      +

      charge_mode

      +

      No

      +

      String

      +

      Specifies the charge mode when creating a load balancer.

      +

      Value options:

      +
      • flavor: billed by the fixed specification you select.

        +
      • lcu: billed by how many LCUs you have used.

        +
      +

      Constraints:

      +

      You are not recommended to specify this parameter. The charge mode will be selected based on the value you have specified for l4_flavor_id or l7_flavor_id.

      +

      Note:

      +
      • If this parameter is not specified during the creation of a shared load balancer, flavor is selected by default.

        +
      • If you create a dedicated load balancer, this parameter is ignored. The charge mode will be selected based on the value you have specified for l4_flavor_id or l7_flavor_id.

        +
      +

      Minimum: 1

      +

      Maximum: 255

      -
      Table 5 Tag

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      key

      +

      key

      No

      +

      No

      String

      +

      String

      Specifies the tag key.

      -

      Minimum: 1

      -

      Maximum: 36

      +

      Specifies the tag key.

      +

      Minimum: 1

      +

      Maximum: 36

      value

      +

      value

      No

      +

      No

      String

      +

      String

      Specifies the tag value.

      -

      Minimum: 0

      -

      Maximum: 43

      +

      Specifies the tag value.

      +

      Minimum: 0

      +

      Maximum: 43

      -
      Table 6 BandwidthRef

      Parameter

      +
      - - - - - - -
      Table 6 BandwidthRef

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      Yes

      +

      Yes

      String

      +

      String

      Specifies the shared bandwidth ID.

      +

      Specifies the shared bandwidth ID.

      -
      Table 7 CreateLoadBalancerPublicIpOption

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      ip_version

      +

      ip_version

      No

      +

      No

      Integer

      +

      Integer

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

      -

      Default: 4

      +

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

      +

      Default: 4

      network_type

      +

      network_type

      Yes

      +

      Yes

      String

      +

      String

      Specifies the EIP type. The default value is 5_bgp. For more information, see the API for assigning an EIP in the Virtual Private Cloud API Reference.

      -

      Minimum: 1

      -

      Maximum: 36

      +

      Specifies the EIP type. The default value is 5_bgp. For more information, see the API for assigning an EIP in the Virtual Private Cloud API Reference.

      +

      Minimum: 1

      +

      Maximum: 36

      billing_info

      +

      billing_info

      No

      +

      No

      String

      +

      String

      Provides billing information about the EIP.

      -

      This parameter is unsupported. Please do not use it.

      -

      Minimum: 1

      -

      Maximum: 1024

      +

      Provides billing information about the EIP.

      +

      This parameter is unsupported. Please do not use it.

      +

      Minimum: 1

      +

      Maximum: 1024

      description

      +

      description

      No

      +

      No

      String

      +

      String

      Provides supplementary information about the EIP.

      -

      Minimum: 1

      -

      Maximum: 255

      +

      Provides supplementary information about the EIP.

      +

      Minimum: 1

      +

      Maximum: 255

      bandwidth

      +

      bandwidth

      Yes

      +

      Yes

      CreateLoadBalancerBandwidthOption object

      +

      CreateLoadBalancerBandwidthOption object

      bandwidth

      +

      bandwidth

      -
      Table 8 CreateLoadBalancerBandwidthOption

      Parameter

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

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      name

      +

      name

      No

      +

      No

      String

      +

      String

      Specifies the bandwidth name.

      -

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

      -

      Note:

      -
      • This parameter is mandatory if share_type is set to PER.
      • This parameter will be ignored if the bandwidth reference has a specific ID.
      -

      Minimum: 1

      -

      Maximum: 64

      +

      Specifies the bandwidth name.

      +

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

      +

      Note:

      +
      • This parameter is mandatory if share_type is set to PER.

        +
      • This parameter will be ignored if the bandwidth reference has a specific ID.

        +
      +

      Minimum: 1

      +

      Maximum: 64

      size

      +

      size

      No

      +

      No

      Integer

      +

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

      +

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

      +

      charge_mode

      No

      +

      No

      String

      +

      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.

      -

      Minimum: 1

      -

      Maximum: 36

      +

      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.

      +

      Minimum: 1

      +

      Maximum: 36

      share_type

      +

      share_type

      No

      +

      No

      String

      +

      String

      Specifies the bandwidth type.

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

      Note:

      -
      • This parameter is mandatory when id is set to null. It will be ignored if the value of id is not null.
      • The bandwidth ID must be specified if the bandwidth type is set to WHOLE.
      • The bandwidth type cannot be WHOLE for IPv6 EIPs.
      +

      Specifies the bandwidth type.

      +
      • PER: indicates dedicated bandwidth.

        +
      • WHOLE: indicates shared bandwidth.

        +
      +

      Note:

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

        +
      • The bandwidth ID must be specified if the bandwidth type is set to WHOLE.

        +
      • The bandwidth type cannot be WHOLE for IPv6 EIPs.

        +

      billing_info

      +

      billing_info

      No

      +

      No

      String

      +

      String

      Specifies bandwidth billing information.

      -

      This parameter is unsupported. Please do not use it.

      -

      Minimum: 1

      -

      Maximum: 1024

      +

      Specifies bandwidth billing information.

      +

      This parameter is unsupported. Please do not use it.

      +

      Minimum: 1

      +

      Maximum: 1024

      id

      +

      id

      No

      +

      No

      String

      +

      String

      Specifies the ID of the shared bandwidth to which the IP address bound to the load balancer is added.

      -

      Note:

      -
      • The value is the bandwidth ID when share_type is set to WHOLE.
      -

      Minimum: 1

      -

      Maximum: 36

      +

      Specifies the ID of the shared bandwidth to which the IP address bound to the load balancer is added.

      +

      Note:

      +
      • The value is the bandwidth ID when share_type is set to WHOLE.

        +
      +

      Minimum: 1

      +

      Maximum: 36

      -

      Response Parameters

      Status code: 201

      +

      Response Parameters

      Status code: 201

      -
      Table 9 Response body parameters

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      loadbalancer

      +

      loadbalancer

      LoadBalancer object

      +

      LoadBalancer object

      Specifies the load balancer. (This parameter is returned when the billing mode of the load balancer is pay-per-use.)

      +

      Specifies the load balancer.

      request_id

      +

      request_id

      String

      +

      String

      Specifies the request ID. The value is automatically generated.

      -

      Minimum: 0

      -

      Maximum: 36

      +

      Specifies the request ID. The value is automatically generated.

      +

      Minimum: 0

      +

      Maximum: 36

      -
      Table 10 LoadBalancer

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Specifies the load balancer ID.

      +

      Specifies the load balancer ID.

      description

      +

      description

      String

      +

      String

      Provides supplementary information about the load balancer.

      -

      Minimum: 1

      -

      Maximum: 255

      +

      Provides supplementary information about the load balancer.

      +

      Minimum: 1

      +

      Maximum: 255

      provisioning_status

      +

      provisioning_status

      String

      +

      String

      Specifies the provisioning status of the load balancer. The value can be one of the following:

      -
      • ACTIVE: The load balancer is successfully provisioned.
      • PENDING_DELETE: The load balancer is being deleted.
      +

      Specifies the provisioning status of the load balancer. The value can be one of the following:

      +
      • ACTIVE: The load balancer is successfully provisioned.

        +
      • PENDING_DELETE: The load balancer is being deleted.

        +

      admin_state_up

      +

      admin_state_up

      Boolean

      +

      Boolean

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

      +

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

      provider

      +

      provider

      String

      +

      String

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

      +

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

      pools

      +

      pools

      Array of PoolRef objects

      +

      Array of PoolRef objects

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

      +

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

      listeners

      +

      listeners

      Array of ListenerRef objects

      +

      Array of ListenerRef objects

      Lists the IDs of listeners added to the load balancer.

      +

      Lists the IDs of listeners added to the load balancer.

      operating_status

      +

      operating_status

      String

      +

      String

      Specifies the operating status of the load balancer. The value can only be ONLINE, indicating that the load balancer is running normally.

      +

      Specifies the operating status of the load balancer. The value can only be ONLINE, indicating that the load balancer is running normally.

      name

      +

      name

      String

      +

      String

      Specifies the load balancer name.

      +

      Specifies the load balancer name.

      project_id

      +

      project_id

      String

      +

      String

      Specifies the project ID of the load balancer.

      +

      Specifies the project ID of the load balancer.

      vip_subnet_cidr_id

      +

      vip_subnet_cidr_id

      String

      +

      String

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

      +

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

      vip_address

      +

      vip_address

      String

      +

      String

      Specifies the private IPv4 address bound to the load balancer.

      +

      Specifies the private IPv4 address bound to the load balancer.

      vip_port_id

      +

      vip_port_id

      String

      +

      String

      Specifies the ID of the port bound to the private IPv4 address of the load balancer.

      -

      The default security group associated with the port will take effect only after at least one backend server is associated with load balancer.

      +

      Specifies the ID of the port bound to the private IPv4 address of the load balancer.

      +

      The default security group associated with the port will take effect only after at least one backend server is associated with load balancer.

      tags

      +

      tags

      Array of Tag objects

      +

      Array of Tag objects

      Lists the tags added to the load balancer.

      +

      Lists the tags added to the load balancer.

      created_at

      +

      created_at

      String

      +

      String

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

      +

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

      updated_at

      +

      updated_at

      String

      +

      String

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

      +

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

      guaranteed

      +

      guaranteed

      Boolean

      +

      Boolean

      Specifies whether the load balancer is a dedicated load balancer.

      -
      • true (default): The load balancer is a dedicated load balancer.
      • false: The load balancer is a shared load balancer.
      +

      Specifies whether the load balancer is a dedicated load balancer.

      +
      • true (default): The load balancer is a dedicated load balancer.

        +
      • false: The load balancer is a shared load balancer.

        +

      vpc_id

      +

      vpc_id

      String

      +

      String

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

      +

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

      eips

      +

      eips

      Array of EipInfo objects

      +

      Array of EipInfo objects

      Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

      -

      This parameter has the same meaning as publicips.

      +

      Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

      +

      This parameter has the same meaning as publicips.

      ipv6_vip_address

      +

      ipv6_vip_address

      String

      +

      String

      Specifies the IPv6 address bound to the load balancer.

      +

      Specifies the IPv6 address bound to the load balancer.

      ipv6_vip_virsubnet_id

      +

      ipv6_vip_virsubnet_id

      String

      +

      String

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

      +

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

      ipv6_vip_port_id

      +

      ipv6_vip_port_id

      String

      +

      String

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

      +

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

      availability_zone_list

      +

      availability_zone_list

      Array of strings

      +

      Array of strings

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

      +

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

      enterprise_project_id

      +

      enterprise_project_id

      String

      +

      String

      Specifies the enterprise project ID.

      -

      If this parameter is not passed during resource creation, "0" will be returned, and the resource belongs to the default enterprise project.

      -

      "0" is not a valid enterprise project ID and cannot be used in the APIs for creating, updating the load balancer, or querying details of the load balancer.

      -

      This parameter is unsupported. Please do not use it.

      +

      Specifies the enterprise project ID.

      +

      If this parameter is not passed during resource creation, "0" will be returned, and the resource belongs to the default enterprise project.

      +

      "0" is not a valid enterprise project ID and cannot be used in the APIs for creating, updating the load balancer, or querying details of the load balancer.

      +

      This parameter is unsupported. Please do not use it.

      billing_info

      +

      billing_info

      String

      +

      String

      Provides resource billing information.

      -

      This parameter is unsupported. Please do not use it.

      -

      Minimum: 1

      -

      Maximum: 1024

      +

      Provides resource billing information.

      +

      This parameter is unsupported. Please do not use it.

      +

      Minimum: 1

      +

      Maximum: 1024

      l4_flavor_id

      +

      l4_flavor_id

      String

      +

      String

      Specifies the ID of a flavor at Layer 4.

      -

      Minimum: 1

      -

      Maximum: 255

      +

      Specifies the ID of a flavor at Layer 4.

      +

      Minimum: 1

      +

      Maximum: 255

      l4_scale_flavor_id

      +

      l4_scale_flavor_id

      String

      +

      String

      Specifies the ID of the reserved flavor at Layer 4.

      -

      This parameter is unsupported. Please do not use it.

      -

      Minimum: 1

      -

      Maximum: 255

      +

      Specifies the ID of the reserved flavor at Layer 4.

      +

      This parameter is unsupported. Please do not use it.

      +

      Minimum: 1

      +

      Maximum: 255

      l7_flavor_id

      +

      l7_flavor_id

      String

      +

      String

      Specifies the ID of a flavor at Layer 7.

      -

      Minimum: 1

      -

      Maximum: 255

      +

      Specifies the ID of a flavor at Layer 7.

      +

      Minimum: 1

      +

      Maximum: 255

      l7_scale_flavor_id

      +

      l7_scale_flavor_id

      String

      +

      String

      Specifies the ID of the reserved flavor at Layer 7.

      -

      This parameter is unsupported. Please do not use it.

      -

      Minimum: 1

      -

      Maximum: 255

      +

      Specifies the ID of the reserved flavor at Layer 7.

      +

      This parameter is unsupported. Please do not use it.

      +

      Minimum: 1

      +

      Maximum: 255

      publicips

      +

      publicips

      Array of PublicIpInfo objects

      +

      Array of PublicIpInfo objects

      Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

      -

      This parameter has the same meaning as eips.

      +

      Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

      +

      This parameter has the same meaning as eips.

      elb_virsubnet_ids

      +

      elb_virsubnet_ids

      Array of strings

      +

      Array of strings

      Lists the IDs of subnets on the downstream plane.

      +

      Lists the IDs of subnets on the downstream plane.

      elb_virsubnet_type

      +

      elb_virsubnet_type

      String

      +

      String

      Specifies the type of the subnet on the downstream plane.

      -
      • ipv4: IPv4 subnet
      • dualstack: subnet that supports IPv4/IPv6 dual stack
      -

      "dualstack" is not supported.

      +

      Specifies the type of the subnet on the downstream plane.

      +
      • ipv4: IPv4 subnet

        +
      • dualstack: subnet that supports IPv4/IPv6 dual stack

        +
      +

      "dualstack" is not supported.

      ip_target_enable

      +

      ip_target_enable

      Boolean

      +

      Boolean

      Specifies whether to enable IP as a Backend Server.

      -

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

      -

      This function is supported only by dedicated load balancers.

      -

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

      -

      The value can only be update to true.

      +

      Specifies whether to enable IP as a Backend Server.

      +

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

      +

      This function is supported only by dedicated load balancers.

      +

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

      +

      The value can only be update to true.

      frozen_scene

      +

      frozen_scene

      String

      +

      String

      Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,).

      -

      This parameter is unsupported. Please do not use it.

      +

      Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,).

      +

      This parameter is unsupported. Please do not use it.

      ipv6_bandwidth

      +

      ipv6_bandwidth

      BandwidthRef object

      +

      BandwidthRef object

      Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

      +

      Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

      deletion_protection_enable

      +

      deletion_protection_enable

      Boolean

      +

      Boolean

      Specifies whether deletion protection is enabled.

      -
      • false: Deletion protection is not enabled.
      • true: Deletion protection is enabled.
      -
      NOTE:

      Disable deletion protection for all your resources before deleting your account.

      +

      Specifies whether deletion protection is enabled.

      +
      • false: Deletion protection is not enabled.

        +
      • true: Deletion protection is enabled.

        +
      +
      NOTE:

      Disable deletion protection for all your resources before deleting your account.

      -

      This parameter is returned only when deletion protection is enabled at the site.

      +

      This parameter is returned only when deletion protection is enabled at the site.

      public_border_group

      +

      public_border_group

      String

      +

      String

      Specifies the AZ group to which the load balancer belongs.

      +

      Specifies the AZ group to which the load balancer belongs.

      waf_failure_action

      +

      waf_failure_action

      String

      +

      String

      Specifies traffic distributing policies when the WAF is faulty.

      -
      • discard: Traffic will not be distributed.
      • forward: Traffic will be distributed to the default backend servers.
      -

      Note: This parameter takes effect only when WAF is enabled for the load balancer.

      -

      This parameter is unsupported. Please do not use it.

      +

      Specifies traffic distributing policies when the WAF is faulty.

      +
      • discard: Traffic will not be distributed.

        +
      • forward: Traffic will be distributed to the default backend servers.

        +
      +

      Note: This parameter takes effect only when WAF is enabled for the load balancer.

      +

      This parameter is unsupported. Please do not use it.

      +

      charge_mode

      +

      String

      +

      Specifies the charge mode when creating a load balancer.

      +

      Value options:

      +
      • flavor: billed by the fixed specification you select.

        +
      • lcu: billed by how many LCUs you have used.

        +
      -
      Table 11 PoolRef

      Parameter

      +
      - - - - -
      Table 11 PoolRef

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Specifies the ID of the backend server group.

      +

      Specifies the ID of the backend server group.

      -
      Table 12 ListenerRef

      Parameter

      +
      - - - - -
      Table 12 ListenerRef

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Specifies the listener ID.

      +

      Specifies the listener ID.

      -
      Table 13 Tag

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      key

      +

      key

      String

      +

      String

      Specifies the tag key.

      -

      Minimum: 1

      -

      Maximum: 36

      +

      Specifies the tag key.

      +

      Minimum: 1

      +

      Maximum: 36

      value

      +

      value

      String

      +

      String

      Specifies the tag value.

      -

      Minimum: 0

      -

      Maximum: 43

      +

      Specifies the tag value.

      +

      Minimum: 0

      +

      Maximum: 43

      -
      Table 14 EipInfo

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      eip_id

      +

      eip_id

      String

      +

      String

      eip_id

      +

      eip_id

      eip_address

      +

      eip_address

      String

      +

      String

      eip_address

      +

      eip_address

      ip_version

      +

      ip_version

      Integer

      +

      Integer

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

      +

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

      -
      Table 15 PublicIpInfo

      Parameter

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

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      publicip_id

      +

      publicip_id

      String

      +

      String

      Specifies the EIP ID.

      +

      Specifies the EIP ID.

      publicip_address

      +

      publicip_address

      String

      +

      String

      Specifies the IP address.

      +

      Specifies the IP address.

      ip_version

      +

      ip_version

      Integer

      +

      Integer

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

      +

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

      -
      Table 16 BandwidthRef

      Parameter

      +
      - - - - -
      Table 16 BandwidthRef

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Specifies the shared bandwidth ID.

      +

      Specifies the shared bandwidth ID.

      -

      Example Requests

      • Example 1: Creating a load balancer with a private IPv4 address
        POST https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
        +

        Example Requests

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

          +
          POST https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
           
           {
             "loadbalancer" : {
          @@ -1074,7 +1163,8 @@
               "availability_zone_list" : [ "AZ1" ]
             }
           }
          -
        • Example 2: Creating a load balancer with an IPv4 EIP
          POST https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
          +
        • Example 2: Creating a load balancer with an IPv4 EIP

          +
          POST https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers
           
           {
             "loadbalancer" : {
          @@ -1095,9 +1185,9 @@
           }
        -

        Example Responses

        Status code: 201

        -

        Normal response to POST requests.

        -
        {
        +

        Example Responses

        Status code: 201

        +

        Normal response to POST requests.

        +
        {
           "request_id" : "6c63d0ac-7beb-451d-a3e0-a066beaea316",
           "loadbalancer" : {
             "id" : "cce5318e-c79a-4f68-94a2-9fb285c6efbe",
        @@ -1148,23 +1238,23 @@
           }
         }
        -

        Status Codes

        -

        Status Code

        +

        Status Codes

        +
        - - -

        Status Code

        Description

        +

        Description

        201

        +

        201

        Normal response to POST requests.

        +

        Normal response to POST requests.

        -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/elb/api-ref/CreateLogtank.html b/docs/elb/api-ref/CreateLogtank.html index caf162ad2..45afe8cb4 100644 --- a/docs/elb/api-ref/CreateLogtank.html +++ b/docs/elb/api-ref/CreateLogtank.html @@ -1,7 +1,7 @@

        Creating a Log

        -

        Function

        This API is used to create a log.

        +

        Function

        This API is used to create a log.

        URI

        POST /v3/{project_id}/elb/logtanks

        @@ -124,73 +124,73 @@

        Response Parameters

        Status code: 201

        -
        Table 5 Response body parameters

        Parameter

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

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        logtank

        +

        logtank

        Logtank object

        +

        Logtank object

        Provides supplementary information.

        +

        Provides supplementary information.

        request_id

        +

        request_id

        String

        +

        String

        Specifies the request ID. The value is automatically generated.

        +

        Specifies the request ID. The value is automatically generated.

        -
        Table 6 Logtank

        Parameter

        +
        - - - - - - - - - - - - - - - - - diff --git a/docs/elb/api-ref/CreateMember.html b/docs/elb/api-ref/CreateMember.html index 71065edd4..e40d60050 100644 --- a/docs/elb/api-ref/CreateMember.html +++ b/docs/elb/api-ref/CreateMember.html @@ -1,7 +1,7 @@

        Adding a Backend Server

        -

        Function

        This API is used to add a backend server.

        +

        Function

        This API is used to add a backend server.

        Constraints

        When you add backend servers, note the following:

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

          @@ -190,208 +190,208 @@

        Response Parameters

        Status code: 201

        -
        Table 6 Logtank

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        id

        +

        id

        String

        +

        String

        Specifies the log ID.

        +

        Specifies the log ID.

        project_id

        +

        project_id

        String

        +

        String

        Specifies the ID of a load balancer.

        +

        Specifies the ID of a load balancer.

        loadbalancer_id

        +

        loadbalancer_id

        String

        +

        String

        Specifies the ID of a load balancer.

        +

        Specifies the ID of a load balancer.

        log_group_id

        +

        log_group_id

        String

        +

        String

        Specifies the log group ID.

        +

        Specifies the log group ID.

        log_topic_id

        +

        log_topic_id

        String

        +

        String

        Specifies the log topic ID.

        +

        Specifies the log topic ID.

        Table 5 Response body parameters

        Parameter

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

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        request_id

        +

        request_id

        String

        +

        String

        Specifies the request ID. The value is automatically generated.

        +

        Specifies the request ID. The value is automatically generated.

        member

        +

        member

        Member object

        +

        Member object

        Specifies the backend server.

        +

        Specifies the backend server.

        -
        Table 6 Member

        Parameter

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

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        id

        +

        id

        String

        +

        String

        Specifies the backend server ID.

        +

        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

        +

        name

        String

        +

        String

        Specifies the backend server name.

        +

        Specifies the backend server name.

        project_id

        +

        project_id

        String

        +

        String

        Specifies the project ID of the backend server.

        +

        Specifies the project ID of the backend server.

        admin_state_up

        +

        admin_state_up

        Boolean

        +

        Boolean

        Specifies the administrative status of the backend server. The value can be true or false.

        +

        Specifies the administrative status of the backend server. The value can be true or false.

        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.

        subnet_cidr_id

        +

        subnet_cidr_id

        String

        +

        String

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

        +

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

        This parameter can be left blank, indicating that IP as a Backend Server has been enabled for the load balancer. In this case, IP addresses of these servers must be IPv4 addresses, and the protocol of the backend server group must be TCP, HTTP, or HTTPS.

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

        protocol_port

        +

        protocol_port

        Integer

        +

        Integer

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

        +

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

        Minimum: 1

        Maximum: 65535

        weight

        +

        weight

        Integer

        +

        Integer

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

        +

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

        The value ranges from 0 to 100, and the default value is 1. The larger the weight is, the higher proportion of requests the backend server receives. If the weight is set to 0, the backend server will not accept new requests.

        If lb_algorithm is set to SOURCE_IP, this parameter will not take effect.

        Minimum: 0

        Maximum: 100

        address

        +

        address

        String

        +

        String

        Specifies the private IP address bound to the backend server.

        +

        Specifies the private IP address bound to the backend server.

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

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

        ip_version

        +

        ip_version

        String

        +

        String

        Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6), depending on the value of address returned by the system.

        +

        Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6), depending on the value of address returned by the system.

        operating_status

        +

        operating_status

        String

        +

        String

        Specifies the health status of the backend server if listener_id under status is not specified. The value can be one of the following:

        +

        Specifies the health status of the backend server if listener_id under status is not specified. 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.

        status

        +

        status

        Array of MemberStatus objects

        +

        Array of MemberStatus objects

        Specifies the health status of the backend server if listener_id is specified.

        +

        Specifies the health status of the backend server if listener_id is specified.

        loadbalancer_id

        +

        loadbalancer_id

        String

        +

        String

        Specifies the ID of the load balancer with which the backend server is associated.

        +

        Specifies the ID of the load balancer with which the backend server is associated.

        This parameter is unsupported. Please do not use it.

        loadbalancers

        +

        loadbalancers

        Array of ResourceID objects

        +

        Array of ResourceID objects

        Specifies the IDs of the load balancers associated with the backend server.

        +

        Specifies the IDs of the load balancers associated with the backend server.

        This parameter is unsupported. Please do not use it.

        created_at

        +

        created_at

        String

        +

        String

        Specifies the time when a backend server was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

        +

        Specifies the time when a backend server was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

        updated_at

        +

        updated_at

        String

        +

        String

        Specifies the time when a backend server was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

        +

        Specifies the time when a backend server was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

        member_type

        +

        member_type

        String

        +

        String

        Specifies the type of the backend server. Values:

        +

        Specifies the type of the backend server. Values:

        • ip: IP as Backend servers

        • instance: ECSs used as backend servers

        instance_id

        +

        instance_id

        String

        +

        String

        Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address.

        +

        Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address.

        -
        Table 7 MemberStatus

        Parameter

        +
        - - - - - - - -
        Table 7 MemberStatus

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        listener_id

        +

        listener_id

        String

        +

        String

        Specifies the listener ID.

        +

        Specifies the listener ID.

        operating_status

        +

        operating_status

        String

        +

        String

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

        +

        Specifies the health 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.

          @@ -402,19 +402,19 @@
        -
        Table 8 ResourceID

        Parameter

        +
        - - - - - diff --git a/docs/elb/api-ref/CreatePool.html b/docs/elb/api-ref/CreatePool.html index 175e98590..b1830e4c4 100644 --- a/docs/elb/api-ref/CreatePool.html +++ b/docs/elb/api-ref/CreatePool.html @@ -1,7 +1,7 @@

        Creating a Backend Server Group

        -

        Function

        This API is used to create 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.

        @@ -237,7 +237,8 @@
      • Only backend servers in the VPC or IP as Backend servers can be added.

      • type must be set to instance.

      • -

        If vpc_id is not specified: vpc_id is determined by the VPC where the backend server works.

        +

        If vpc_id is not specified:

        +

        vpc_id is determined by the VPC where the backend server works.

        Minimum: 0

        Maximum: 36

        @@ -282,7 +283,10 @@
        - -
        Table 8 ResourceID

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        id

        +

        id

        String

        +

        String

        Specifies the resource ID.

        +

        Specifies the resource ID.

        String

        Specifies the cookie name. The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.). Note: This parameter will take effect only when type is set to APP_COOKIE. Otherwise, an error will be returned.

        +

        Specifies the cookie name.

        +

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

        +

        Note:

        +

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

        type

        @@ -291,7 +295,8 @@

        String

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

        +

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

        +

        Note:

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

        • If the backend server group protocol is QUIC, sticky session must be enabled with type set to SOURCE_IP.

          @@ -356,74 +361,74 @@

          Response Parameters

          Status code: 201

          -
          Table 7 Response body parameters

          Parameter

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

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          request_id

          +

          request_id

          String

          +

          String

          Specifies the request ID. The value is automatically generated.

          +

          Specifies the request ID. The value is automatically generated.

          pool

          +

          pool

          Pool object

          +

          Pool object

          Specifies the backend server group.

          +

          Specifies the backend server group.

          -
          Table 8 Pool

          Parameter

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

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          admin_state_up

          +

          admin_state_up

          Boolean

          +

          Boolean

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

          +

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

          This parameter is unsupported. Please do not use it.

          description

          +

          description

          String

          +

          String

          Provides supplementary information about the backend server group.

          +

          Provides supplementary information about the backend server group.

          healthmonitor_id

          +

          healthmonitor_id

          String

          +

          String

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

          +

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

          id

          +

          id

          String

          +

          String

          Specifies the backend server group ID.

          +

          Specifies the backend server group ID.

          lb_algorithm

          +

          lb_algorithm

          String

          +

          String

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

          +

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

          The value can be one of the following:

          • ROUND_ROBIN: weighted round robin

          • LEAST_CONNECTIONS: weighted least connections

            @@ -436,46 +441,46 @@

          listeners

          +

          listeners

          Array of ListenerRef objects

          +

          Array of ListenerRef objects

          Specifies the IDs of the listeners with which the backend server group is associated.

          +

          Specifies the IDs of the listeners with which the backend server group is associated.

          loadbalancers

          +

          loadbalancers

          Array of LoadBalancerRef objects

          +

          Array of LoadBalancerRef objects

          Specifies the IDs of the load balancers with which the backend server group is associated.

          +

          Specifies the IDs of the load balancers with which the backend server group is associated.

          members

          +

          members

          Array of MemberRef objects

          +

          Array of MemberRef objects

          Specifies the IDs of the backend servers in the backend server group.

          +

          Specifies the IDs of the backend servers in the backend server group.

          name

          +

          name

          String

          +

          String

          Specifies the backend server group name.

          +

          Specifies the backend server group name.

          project_id

          +

          project_id

          String

          +

          String

          Specifies the project ID.

          +

          Specifies the project ID.

          protocol

          +

          protocol

          String

          +

          String

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

          +

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

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

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

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

            @@ -485,34 +490,34 @@

          session_persistence

          +

          session_persistence

          SessionPersistence object

          +

          SessionPersistence object

          Specifies the sticky session.

          +

          Specifies the sticky session.

          ip_version

          +

          ip_version

          String

          +

          String

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

          +

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

          IPv6 is unsupported. Only v4 will be returned.

          slow_start

          +

          slow_start

          SlowStart object

          +

          SlowStart object

          Specifies slow start details. 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.

          +

          Specifies slow start details. 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.

          member_deletion_protection_enable

          +

          member_deletion_protection_enable

          Boolean

          +

          Boolean

          Specifies whether to enable removal protection.

          +

          Specifies whether to enable removal protection.

          • true: Enable removal protection.

          • false: Disable removal protection.

          @@ -520,34 +525,34 @@

          created_at

          +

          created_at

          String

          +

          String

          Specifies the time when a backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

          +

          Specifies the time when a backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

          updated_at

          +

          updated_at

          String

          +

          String

          Specifies the time when when a backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

          +

          Specifies the time when when a backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

          vpc_id

          +

          vpc_id

          String

          +

          String

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

          +

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

          type

          +

          type

          String

          +

          String

          Specifies the type of the backend server group.

          +

          Specifies the type of the backend server group.

          Values:

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

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

            @@ -559,94 +564,97 @@
          -
          Table 9 ListenerRef

          Parameter

          +
          - - - - -
          Table 9 ListenerRef

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Specifies the listener ID.

          +

          Specifies the listener ID.

          -
          Table 10 LoadBalancerRef

          Parameter

          +
          - - - - -
          Table 10 LoadBalancerRef

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Specifies the load balancer ID.

          +

          Specifies the load balancer ID.

          -
          Table 11 MemberRef

          Parameter

          +
          - - - - -
          Table 11 MemberRef

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Specifies the backend server ID.

          +

          Specifies the backend server ID.

          -
          Table 12 SessionPersistence

          Parameter

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

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          cookie_name

          +

          cookie_name

          String

          +

          String

          Specifies the cookie name. The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.). Note: This parameter will take effect only when type is set to APP_COOKIE.

          +

          Specifies the cookie name.

          +

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

          +

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

          type

          +

          type

          String

          +

          String

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

          +

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

          +

          Note:

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

          • If the backend server group protocol is QUIC, sticky session must be enabled with type set to SOURCE_IP.

          persistence_timeout

          +

          persistence_timeout

          Integer

          +

          Integer

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

          +

          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, UDP, or QUIC, 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.

          @@ -656,30 +664,30 @@
          -
          Table 13 SlowStart

          Parameter

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

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          enable

          +

          enable

          Boolean

          +

          Boolean

          Specifies whether to enable slow start.

          +

          Specifies whether to enable slow start.

          • true: Enable slow start.

          • false: Disable slow start.

          Default: false

          duration

          +

          duration

          Integer

          +

          Integer

          Specifies the slow start duration, in seconds.

          +

          Specifies the slow start duration, in seconds.

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

          Minimum: 30

          Maximum: 1200

          diff --git a/docs/elb/api-ref/CreateSecurityPolicy.html b/docs/elb/api-ref/CreateSecurityPolicy.html index c1b941909..89990fce0 100644 --- a/docs/elb/api-ref/CreateSecurityPolicy.html +++ b/docs/elb/api-ref/CreateSecurityPolicy.html @@ -1,7 +1,7 @@

          Creating a Custom Security Policy

          -

          Function

          This API is used to create a custom security policy. If you need a custom security policy, you need to specify security_policy_id when you add an HTTPS listener to your load balancer.

          +

          Function

          This API is used to create a custom security policy. If you need a custom security policy, you need to specify security_policy_id when you add an HTTPS listener to your load balancer.

          URI

          POST /v3/{project_id}/elb/security-policies

          @@ -113,7 +113,8 @@

          String

          Specifies the enterprise project ID. This parameter is unsupported. Please do not use it.

          +

          Specifies the enterprise project ID.

          +

          This parameter is unsupported. Please do not use it.

          protocols

          @@ -131,7 +132,8 @@

          Array of strings

          Lists the cipher suites supported by the custom security policy. The following cipher suites are supported: 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,CAMELLIA128-SHA,DES-CBC3-SHA,CAMELLIA256-SHA,ECDHE-RSA-CHACHA20-POLY1305,ECDHE-ECDSA-CHACHA20-POLY1305,TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256,TLS_AES_128_CCM_SHA256,TLS_AES_128_CCM_8_SHA256

          +

          Lists the cipher suites supported by the custom security policy. The following cipher suites are supported:

          +

          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,CAMELLIA128-SHA,DES-CBC3-SHA,CAMELLIA256-SHA,ECDHE-RSA-CHACHA20-POLY1305,ECDHE-ECDSA-CHACHA20-POLY1305,TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256,TLS_AES_128_CCM_SHA256,TLS_AES_128_CCM_8_SHA256

          Note:

          • The protocol and cipher suite must match. At least one cipher suite must match the protocol.

          • You can match the protocol and cipher suite based on system security policy.

            @@ -144,120 +146,120 @@

            Response Parameters

            Status code: 201

            -
            Table 5 Response body parameters

            Parameter

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

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            security_policy

            +

            security_policy

            SecurityPolicy object

            +

            SecurityPolicy object

            Lists the security policies.

            +

            Lists the security policies.

            request_id

            +

            request_id

            String

            +

            String

            Specifies the request ID. The value is automatically generated.

            +

            Specifies the request ID. The value is automatically generated.

            -
            Table 6 SecurityPolicy

            Parameter

            +
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            Table 6 SecurityPolicy

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            id

            +

            id

            String

            +

            String

            Specifies the ID of the custom security policy.

            +

            Specifies the ID of the custom security policy.

            project_id

            +

            project_id

            String

            +

            String

            Specifies the project ID of the custom security policy.

            +

            Specifies the project ID of the custom security policy.

            name

            +

            name

            String

            +

            String

            Specifies the name of the custom security policy.

            +

            Specifies the name of the custom security policy.

            description

            +

            description

            String

            +

            String

            Provides supplementary information about the custom security policy.

            +

            Provides supplementary information about the custom security policy.

            listeners

            +

            listeners

            Array of ListenerRef objects

            +

            Array of ListenerRef objects

            Specifies the listeners that use the custom security policies.

            +

            Specifies the listeners that use the custom security policies.

            protocols

            +

            protocols

            Array of strings

            +

            Array of strings

            Lists the TLS protocols supported by the custom security policy.

            +

            Lists the TLS protocols supported by the custom security policy.

            ciphers

            +

            ciphers

            Array of strings

            +

            Array of strings

            Lists the cipher suites supported by the custom security policy.

            +

            Lists the cipher suites supported by the custom security policy.

            created_at

            +

            created_at

            String

            +

            String

            Specifies the time when the custom security policy was created.

            +

            Specifies the time when the custom security policy was created.

            updated_at

            +

            updated_at

            String

            +

            String

            Specifies the time when the custom security policy was updated.

            +

            Specifies the time when the custom security policy was updated.

            -
            Table 7 ListenerRef

            Parameter

            +
            - - - - - diff --git a/docs/elb/api-ref/DeleteCertificate.html b/docs/elb/api-ref/DeleteCertificate.html index 04892e8de..23f53434a 100644 --- a/docs/elb/api-ref/DeleteCertificate.html +++ b/docs/elb/api-ref/DeleteCertificate.html @@ -1,7 +1,7 @@

            Deleting a Certificate

            -

            Function

            This API is used to delete an SSL 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.

            diff --git a/docs/elb/api-ref/DeleteHealthMonitor.html b/docs/elb/api-ref/DeleteHealthMonitor.html index 657c79dca..db5d8fd74 100644 --- a/docs/elb/api-ref/DeleteHealthMonitor.html +++ b/docs/elb/api-ref/DeleteHealthMonitor.html @@ -1,7 +1,7 @@

            Deleting a Health Check

            -

            Function

            This API is used to delete 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.

            diff --git a/docs/elb/api-ref/DeleteIpGroup.html b/docs/elb/api-ref/DeleteIpGroup.html index 5bddca341..1a5ad9e7d 100644 --- a/docs/elb/api-ref/DeleteIpGroup.html +++ b/docs/elb/api-ref/DeleteIpGroup.html @@ -1,7 +1,7 @@

            Deleting an IP Address Group

            -

            Function

            This API is used to delete an IP address group.

            +

            Function

            This API is used to delete an IP address group.

            URI

            DELETE /v3/{project_id}/elb/ipgroups/{ipgroup_id}

            diff --git a/docs/elb/api-ref/DeleteL7Policy.html b/docs/elb/api-ref/DeleteL7Policy.html index f8b033fc1..05ad998ea 100644 --- a/docs/elb/api-ref/DeleteL7Policy.html +++ b/docs/elb/api-ref/DeleteL7Policy.html @@ -1,7 +1,7 @@

            Deleting a Forwarding Policy

            -

            Function

            This API is used to delete a forwarding policy.

            +

            Function

            This API is used to delete a forwarding policy.

            URI

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

            diff --git a/docs/elb/api-ref/DeleteL7Rule.html b/docs/elb/api-ref/DeleteL7Rule.html index e370875bb..0f8f6fba7 100644 --- a/docs/elb/api-ref/DeleteL7Rule.html +++ b/docs/elb/api-ref/DeleteL7Rule.html @@ -1,7 +1,7 @@

            Deleting a Forwarding Rule

            -

            Function

            This API is used to delete 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}

            diff --git a/docs/elb/api-ref/DeleteListener.html b/docs/elb/api-ref/DeleteListener.html index 83ca9897c..667d5490c 100644 --- a/docs/elb/api-ref/DeleteListener.html +++ b/docs/elb/api-ref/DeleteListener.html @@ -1,7 +1,7 @@

            Deleting a Listener

            -

            Function

            This API is used to delete a listener.

            +

            Function

            This API is used to delete a listener.

            Constraints

            Before you delete a listener, delete associated backend server groups or remove all backend servers in the default backend server group, and delete all forwarding policies.

            diff --git a/docs/elb/api-ref/DeleteLoadBalancer.html b/docs/elb/api-ref/DeleteLoadBalancer.html index e633e4cd1..bcd3b8fca 100644 --- a/docs/elb/api-ref/DeleteLoadBalancer.html +++ b/docs/elb/api-ref/DeleteLoadBalancer.html @@ -1,7 +1,7 @@

            Deleting a Load Balancer

            -

            Function

            This API is used to delete 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.

            diff --git a/docs/elb/api-ref/DeleteLogtank.html b/docs/elb/api-ref/DeleteLogtank.html index 38176e9f2..4b952aaba 100644 --- a/docs/elb/api-ref/DeleteLogtank.html +++ b/docs/elb/api-ref/DeleteLogtank.html @@ -1,7 +1,7 @@

            Deleting a Log

            -

            Function

            This API is used to delete a log.

            +

            Function

            This API is used to delete a log.

            URI

            DELETE /v3/{project_id}/elb/logtanks/{logtank_id}

            diff --git a/docs/elb/api-ref/DeleteMember.html b/docs/elb/api-ref/DeleteMember.html index f5d8b5f37..228c5bd88 100644 --- a/docs/elb/api-ref/DeleteMember.html +++ b/docs/elb/api-ref/DeleteMember.html @@ -1,7 +1,7 @@

            Removing a Backend Server

            -

            Function

            This API is used to remove a backend server.

            +

            Function

            This API is used to remove a backend server.

            Constraints

            After you remove a backend server, new connections to this server will not be established. However, persistent connections that have been established will be maintained.

            diff --git a/docs/elb/api-ref/DeletePool.html b/docs/elb/api-ref/DeletePool.html index ee7fcd1ef..4c2ceb472 100644 --- a/docs/elb/api-ref/DeletePool.html +++ b/docs/elb/api-ref/DeletePool.html @@ -1,7 +1,7 @@

            Deleting a Backend Server Group

            -

            Function

            This API is used to delete 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.

            diff --git a/docs/elb/api-ref/DeleteSecurityPolicy.html b/docs/elb/api-ref/DeleteSecurityPolicy.html index b671a666f..a210968b8 100644 --- a/docs/elb/api-ref/DeleteSecurityPolicy.html +++ b/docs/elb/api-ref/DeleteSecurityPolicy.html @@ -1,7 +1,7 @@

            Deleting a Custom Security Policy

            -

            Function

            This API is used to delete a custom security policy.

            +

            Function

            This API is used to delete a custom security policy.

            Constraints

            A custom security policy that has been used by a listener cannot be deleted.

            diff --git a/docs/elb/api-ref/ErrorCode.html b/docs/elb/api-ref/ErrorCode.html index eb61a44ef..d000dd578 100644 --- a/docs/elb/api-ref/ErrorCode.html +++ b/docs/elb/api-ref/ErrorCode.html @@ -1,7 +1,7 @@

            Error Codes

            -
            +
            Table 7 ListenerRef

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            id

            +

            id

            String

            +

            String

            Specifies the listener ID.

            +

            Specifies the listener ID.

            + + + + + +

            Status Code

            Error Codes

            @@ -1050,6 +1050,17 @@

            400

            ELB.8934

            +

            The number of available IP addresses in the subnet on the downstream plane is insufficient.

            +

            The elb_virsubnet_ids %s is expected to use %s ipv4 addresses but only %s ipv4 addresses are available, Please reselect.

            +

            Check your request based on the error message.

            +

            400

            +

            ELB.8938

            The ip member just support when pool's protocol is %s.

            diff --git a/docs/elb/api-ref/ListApiVersions.html b/docs/elb/api-ref/ListApiVersions.html index d60660967..c302211b2 100644 --- a/docs/elb/api-ref/ListApiVersions.html +++ b/docs/elb/api-ref/ListApiVersions.html @@ -1,7 +1,7 @@

            Querying API Versions

            -

            Function

            This API is used to query all available ELB API versions.

            +

            Function

            This API is used to query all available ELB API versions.

            URI

            GET /versions

            @@ -9,46 +9,46 @@

            Response Parameters

            Status code: 200

            -
            Table 1 Response body parameters

            Parameter

            +
            - - - - -
            Table 1 Response body parameters

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            versions

            +

            versions

            Array of ApiVersionInfo objects

            +

            Array of ApiVersionInfo objects

            Lists the available API versions.

            +

            Lists the available API versions.

            -
            Table 2 ApiVersionInfo

            Parameter

            +
            - - - - - - - -
            Table 2 ApiVersionInfo

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            id

            +

            id

            String

            +

            String

            Specifies the API version.

            +

            Specifies the API version.

            The value can be v3, v2, or v2.0 in ascending order.

            status

            +

            status

            String

            +

            String

            Specifies the status of the API version.

            +

            Specifies the status of the API version.

            The values are as follows:

            • CURRENT: current version

            • STABLE: stable version

              @@ -66,13 +66,18 @@

              Example Responses

              Status code: 200

              Successful request.

              -
              • {
                +
                {
                   "versions" : [ {
                     "id" : "v3",
                     "status" : "CURRENT"
                +  }, {
                +    "id" : "v2",
                +    "status" : "STABLE"
                +  }, {
                +    "id" : "v2.0",
                +    "status" : "STABLE"
                   } ]
                 }
                -

              Status Codes

              Status Code

              diff --git a/docs/elb/api-ref/ListAvailabilityZones.html b/docs/elb/api-ref/ListAvailabilityZones.html index dd1344fc9..e3c365a02 100644 --- a/docs/elb/api-ref/ListAvailabilityZones.html +++ b/docs/elb/api-ref/ListAvailabilityZones.html @@ -1,7 +1,7 @@

              Querying AZs

              -

              Function

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

              +

              Function

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

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

              • In special scenarios, dedicated load balancers must be created in specific AZs. In the returned one or more sets of AZs, you can select as many AZs as you want as long as the selected AZs are in the same set. For example, if two sets [az1,az2] and [az2,az3] are returned, you can select az1 and az2 or az2 and az3, but cannot select az1 and az3.

              @@ -80,73 +80,74 @@

              Response Parameters

              Status code: 200

              -
              Table 4 Response body parameters

              Parameter

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

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              request_id

              +

              request_id

              String

              +

              String

              Specifies the request ID. The value is automatically generated.

              +

              Specifies the request ID. The value is automatically generated.

              availability_zones

              +

              availability_zones

              Array<Array<AvailabilityZone>>

              +

              Array<Array<AvailabilityZone>>

              Specifies the AZs that are available during load balancer creation. For example, in [az1,az2] and [az2,az3] sets, you can select az1 and az2 or az2 and az3, but cannot select az1 and az3.

              +

              Specifies the AZs that are available during load balancer creation.

              +

              For example, in [az1,az2] and [az2,az3] sets, you can select az1 and az2 or az2 and az3, but cannot select az1 and az3.

              -
              Table 5 AvailabilityZone

              Parameter

              +
              - - - - - - - - - - - - - - - - - diff --git a/docs/elb/api-ref/ListCertificates.html b/docs/elb/api-ref/ListCertificates.html index 090a52d03..5ce62429a 100644 --- a/docs/elb/api-ref/ListCertificates.html +++ b/docs/elb/api-ref/ListCertificates.html @@ -1,349 +1,366 @@

              Querying Certificates

              -

              Function

              This API is used to query all SSL certificates.

              +

              Function

              This API is used to query all SSL certificates.

              -

              Constraints

              This API has the following 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.
              +

              Constraints

              This API has the following 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

              +

              URI

              GET /v3/{project_id}/elb/certificates

              -
              Table 5 AvailabilityZone

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              code

              +

              code

              String

              +

              String

              Specifies the AZ code.

              +

              Specifies the AZ code.

              state

              +

              state

              String

              +

              String

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

              +

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

              protocol

              +

              protocol

              Array of strings

              +

              Array of strings

              Specifies the type of the flavor that is not sold out. L4 indicates the flavor at Layer 4 (flavor for network load balancing). L7 indicates the flavor at Layer 7 (flavor for application load balancing).

              +

              Specifies the type of the flavor that is not sold out. L4 indicates the flavor at Layer 4 (flavor for network load balancing). L7 indicates the flavor at Layer 7 (flavor for application load balancing).

              public_border_group

              +

              public_border_group

              String

              +

              String

              Specifies the AZ group, for example, center.

              +

              Specifies the AZ group, for example, center.

              category

              +

              category

              Integer

              +

              Integer

              Specifies the AZ code. 0 indicates center. 21 indicates homezone.

              +

              Specifies the AZ code. 0 indicates center. 21 indicates homezone.

              Table 1 Path Parameters

              Parameter

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

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              project_id

              +

              project_id

              Yes

              +

              Yes

              String

              +

              String

              Specifies the project ID.

              +

              Specifies the project ID.

              -
              Table 2 Query Parameters

              Parameter

              +
              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              Table 2 Query Parameters

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              marker

              +

              marker

              No

              +

              No

              String

              +

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

              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

              +

              limit

              No

              +

              No

              Integer

              +

              Integer

              Specifies the number of records on each page.

              -

              Minimum: 0

              -

              Maximum: 2000

              -

              Default: 2000

              +

              Specifies the number of records on each page.

              +

              Minimum: 0

              +

              Maximum: 2000

              +

              Default: 2000

              page_reverse

              +

              page_reverse

              No

              +

              No

              Boolean

              +

              Boolean

              Specifies whether to use reverse query. Values:

              -
              • true: Query the previous page.
              • false (default): Query the next page.
              -

              Note:

              -
              • This parameter must be used together with limit.
              • If page_reverse is set to true and you want to query the previous page, set the value of marker to the value of previous_marker.
              +

              Specifies whether to use reverse query. Values:

              +
              • true: Query the previous page.

                +
              • false (default): Query the next page.

                +
              +

              Note:

              +
              • This parameter must be used together with limit.

                +
              • If page_reverse is set to true and you want to query the previous page, set the value of marker to the value of previous_marker.

                +

              id

              +

              id

              No

              +

              No

              Array

              +

              Array of strings

              Specifies a certificate ID.

              -

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

              +

              Specifies a certificate ID.

              +

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

              name

              +

              name

              No

              +

              No

              Array

              +

              Array of strings

              Specifies the certificate name.

              -

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

              +

              Specifies the certificate name.

              +

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

              description

              +

              description

              No

              +

              No

              Array

              +

              Array of strings

              Provides supplementary information about the certificate.

              -

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

              +

              Provides supplementary information about the certificate.

              +

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

              admin_state_up

              +

              admin_state_up

              No

              +

              No

              Boolean

              +

              Boolean

              Specifies the administrative status of the certificate.

              -

              This parameter is unsupported. Please do not use it.

              +

              Specifies the administrative status of the certificate.

              +

              This parameter is unsupported. Please do not use it.

              domain

              +

              domain

              No

              +

              No

              Array

              +

              Array of strings

              Specifies the domain names used by the server certificate.

              -

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

              +

              Specifies the domain names used by the server certificate.

              +

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

              type

              +

              type

              No

              +

              No

              Array

              +

              Array of strings

              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.

              +

              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

              +

              Request Parameters

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

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              X-Auth-Token

              +

              X-Auth-Token

              Yes

              +

              Yes

              String

              +

              String

              Specifies the token used for IAM authentication.

              +

              Specifies the token used for IAM authentication.

              -

              Response Parameters

              Status code: 200

              +

              Response Parameters

              Status code: 200

              -
              Table 4 Response body parameters

              Parameter

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

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              request_id

              +

              request_id

              String

              +

              String

              Specifies the request ID. The value is automatically generated.

              +

              Specifies the request ID. The value is automatically generated.

              page_info

              +

              page_info

              PageInfo object

              +

              PageInfo object

              Shows pagination information about certificates.

              +

              Shows pagination information about certificates.

              certificates

              +

              certificates

              Array of CertificateInfo objects

              +

              Array of CertificateInfo objects

              Lists the certificates.

              +

              Lists the certificates.

              -
              Table 5 PageInfo

              Parameter

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

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              previous_marker

              +

              previous_marker

              String

              +

              String

              Specifies the ID of the first record in the pagination query result.

              +

              Specifies the ID of the first record in the pagination query result.

              next_marker

              +

              next_marker

              String

              +

              String

              Specifies the ID of the last record in the pagination query result.

              +

              Specifies the ID of the last record in the pagination query result.

              current_count

              +

              current_count

              Integer

              +

              Integer

              Specifies the number of records.

              +

              Specifies the number of records.

              -
              Table 6 CertificateInfo

              Parameter

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

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              admin_state_up

              +

              admin_state_up

              Boolean

              +

              Boolean

              Specifies the administrative status of the certificate.

              -

              This parameter is unsupported. Please do not use it.

              +

              Specifies the administrative status of the certificate.

              +

              This parameter is unsupported. Please do not use it.

              certificate

              +

              certificate

              String

              +

              String

              Specifies the certificate content. The value must be PEM encoded.

              +

              Specifies the certificate content. The value must be PEM encoded.

              description

              +

              description

              String

              +

              String

              Provides supplementary information about the certificate.

              -

              Minimum: 1

              -

              Maximum: 255

              +

              Provides supplementary information about the certificate.

              +

              Minimum: 1

              +

              Maximum: 255

              domain

              +

              domain

              String

              +

              String

              Specifies the domain names used by the server certificate.

              -

              Note the following when using domain names:

              -
              • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.
              • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com
              • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com
              • This parameter will take effect only when **type** is set to **server**.
              • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.
              • SNI certificates of a shared load balancer's listener can have up to 30 domain names.
              -

              Minimum: 1

              -

              Maximum: 10000

              +

              Specifies the domain names used by the server certificate.

              +

              Note the following when using domain names:

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

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

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

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

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

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

                +
              +

              Minimum: 1

              +

              Maximum: 10000

              id

              +

              id

              String

              +

              String

              Specifies the certificate ID.

              +

              Specifies the certificate ID.

              name

              +

              name

              String

              +

              String

              Specifies the certificate name.

              -

              Minimum: 1

              -

              Maximum: 255

              +

              Specifies the certificate name.

              +

              Minimum: 1

              +

              Maximum: 255

              private_key

              +

              private_key

              String

              +

              String

              Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

              -
              • This parameter is valid and mandatory only when type is set to server.
              • This parameter will be ignored even if type is set to client. A CA certificate can still be created and used normally.
              +

              Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

              +
              • This parameter is valid and mandatory only when type is set to server.

                +
              • This parameter will be ignored even if type is set to client. A CA certificate can still be created and used normally.

                +

              type

              +

              type

              String

              +

              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.

              +

              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

              +

              created_at

              String

              +

              String

              Specifies the time when the certificate was created.

              +

              Specifies the time when the certificate was created.

              updated_at

              +

              updated_at

              String

              +

              String

              Specifies the time when the certificate was updated.

              +

              Specifies the time when the certificate was updated.

              expire_time

              +

              expire_time

              String

              +

              String

              Specifies the time when the certificate expires.

              +

              Specifies the time when the certificate expires.

              project_id

              +

              project_id

              String

              +

              String

              Specifies the project ID of the certificate.

              +

              Specifies the project ID of the certificate.

              -

              Example Requests

              GET https://{ELB_Endpoint}/v3/{project_id}/elb/certificates
              +

              Example Requests

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

              Example Responses

              Status code: 200

              -

              Successful request.

              -
              {
              +

              Example Responses

              Status code: 200

              +

              Successful request.

              +
              {
                 "certificates" : [ {
                   "id" : "5494a835d88f40ff940554992f2f04d4",
                   "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
              @@ -391,23 +408,23 @@
                 "request_id" : "a27e7ae6-d901-4ec2-8e66-b8a1413819ad"
               }
              -

              Status Codes

              -

              Status Code

              +

              Status Codes

              +
              - - -

              Status Code

              Description

              +

              Description

              200

              +

              200

              Successful request.

              +

              Successful request.

              -

              Error Codes

              See Error Codes.

              +

              Error Codes

              See Error Codes.

              diff --git a/docs/elb/api-ref/ListFlavors.html b/docs/elb/api-ref/ListFlavors.html index c8eba7001..9745c07f9 100644 --- a/docs/elb/api-ref/ListFlavors.html +++ b/docs/elb/api-ref/ListFlavors.html @@ -1,344 +1,372 @@

              Querying Flavors

              -

              Function

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

              +

              Function

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

              -

              Constraints

              This API has the following 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.
              +

              Constraints

              This API has the following 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

              +

              URI

              GET /v3/{project_id}/elb/flavors

              -
              Table 1 Path Parameters

              Parameter

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

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              project_id

              +

              project_id

              Yes

              +

              Yes

              String

              +

              String

              Specifies the project ID.

              +

              Specifies the project ID.

              -
              Table 2 Query Parameters

              Parameter

              +
              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              Table 2 Query Parameters

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              marker

              +

              marker

              No

              +

              No

              String

              +

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

              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

              +

              limit

              No

              +

              No

              Integer

              +

              Integer

              Specifies the number of records on each page.

              -

              Minimum: 0

              -

              Maximum: 2000

              -

              Default: 2000

              +

              Specifies the number of records on each page.

              +

              Minimum: 0

              +

              Maximum: 2000

              +

              Default: 2000

              page_reverse

              +

              page_reverse

              No

              +

              No

              Boolean

              +

              Boolean

              Specifies whether to use reverse query. Values:

              -
              • true: Query the previous page.
              • false (default): Query the next page.
              -

              Note:

              -
              • This parameter must be used together with limit.
              • If page_reverse is set to true and you want to query the previous page, set the value of marker to the value of previous_marker.
              +

              Specifies whether to use reverse query. Values:

              +
              • true: Query the previous page.

                +
              • false (default): Query the next page.

                +
              +

              Note:

              +
              • This parameter must be used together with limit.

                +
              • If page_reverse is set to true and you want to query the previous page, set the value of marker to the value of previous_marker.

                +

              id

              +

              id

              No

              +

              No

              Array

              +

              Array of strings

              Specifies the flavor ID.

              -

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

              +

              Specifies the flavor ID.

              +

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

              name

              +

              name

              No

              +

              No

              Array

              +

              Array of strings

              Specifies the flavor name.

              -

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

              +

              Specifies the flavor name.

              +

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

              type

              +

              type

              No

              +

              No

              Array

              +

              Array of strings

              Specifies the flavor type. The value can be one of the following:

              -
              • L4: a Layer-4 flavor.
              • L7: a Layer-7 flavor.
              -

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

              +

              Specifies the flavor type. The value can be one of the following:

              +
              • L4: a Layer-4 flavor.

                +
              • L7: a Layer-7 flavor.

                +
              • L4_elastic_max: the maximum elastic flavor at Layer 4.

                +
              • L7_elastic_max: the maximum elastic flavor at Layer 7.

                +
              • L4_elastic indicates minimum elastic flavor at Layer 4. This parameter has been discarded. Please do not use it.

                +
              • L7_elastic indicates minimum elastic flavor at Layer 7. This parameter has been discarded. Please do not use it.

                +
              +

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

              shared

              +

              shared

              No

              +

              No

              Boolean

              +

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

              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

              +

              Request Parameters

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

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              X-Auth-Token

              +

              X-Auth-Token

              Yes

              +

              Yes

              String

              +

              String

              Specifies the token used for IAM authentication.

              +

              Specifies the token used for IAM authentication.

              -

              Response Parameters

              Status code: 200

              +

              Response Parameters

              Status code: 200

              -
              Table 4 Response body parameters

              Parameter

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

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              flavors

              +

              flavors

              Array of Flavor objects

              +

              Array of Flavor objects

              Lists the flavors.

              +

              Lists the flavors.

              page_info

              +

              page_info

              PageInfo object

              +

              PageInfo object

              Shows pagination information about the load balancer flavors.

              +

              Shows pagination information about the load balancer flavors.

              request_id

              +

              request_id

              String

              +

              String

              Specifies the request ID. The value is automatically generated.

              +

              Specifies the request ID. The value is automatically generated.

              -
              Table 5 Flavor

              Parameter

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

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              id

              +

              id

              String

              +

              String

              Specifies the flavor ID.

              +

              Specifies the flavor ID.

              info

              +

              info

              FlavorInfo object

              +

              FlavorInfo object

              Specifies the flavor metrics.

              +

              Specifies the flavor metrics.

              name

              +

              name

              String

              +

              String

              Specifies the flavor name.

              +

              Specifies the flavor name.

              shared

              +

              shared

              Boolean

              +

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

              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.

                +

              project_id

              +

              project_id

              String

              +

              String

              Specifies the project ID.

              +

              Specifies the project ID.

              type

              +

              type

              String

              +

              String

              Specifies the flavor type. The value can be one of the following:

              -
              • L4: a Layer-4 flavor.
              • L7: a Layer-7 flavor.
              -

              Minimum: 1

              -

              Maximum: 32

              +

              Specifies the flavor type. The value can be one of the following:

              +
              • L4: a Layer-4 flavor.

                +
              • L7: a Layer-7 flavor.

                +
              • L4_elastic_max: the maximum elastic flavor at Layer 4.

                +
              • L7_elastic_max: the maximum elastic flavor at Layer 7.

                +
              • L4_elastic indicates minimum elastic flavor at Layer 4. This parameter has been discarded. Please do not use it.

                +
              • L7_elastic indicates minimum elastic flavor at Layer 7. This parameter has been discarded. Please do not use it.

                +
              +

              Minimum: 1

              +

              Maximum: 32

              flavor_sold_out

              +

              flavor_sold_out

              Boolean

              +

              Boolean

              Specifies whether the flavor is unavailable.

              -
              • true indicates the flavor is unavailable. Load balancers with this flavor cannot be created.
              • false indicates the flavor is available. Load balancers with this flavor can be created.
              +

              Specifies whether the flavor is unavailable.

              +
              • true indicates the flavor is unavailable. Load balancers with this flavor cannot be created.

                +
              • false indicates the flavor is available. Load balancers with this flavor can be created.

                +
              -
              Table 6 FlavorInfo

              Parameter

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

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              connection

              +

              connection

              Integer

              +

              Integer

              Specifies the number of concurrent connections per second.

              +

              Specifies the number of concurrent connections per second.

              cps

              +

              cps

              Integer

              +

              Integer

              Specifies the number of new connections per second.

              +

              Specifies the number of new connections per second.

              qps

              +

              qps

              Integer

              +

              Integer

              Specifies the number of requests per second. This parameter is available only for load balancers at Layer 7.

              +

              Specifies the number of requests per second. This parameter is available only for load balancers at Layer 7.

              bandwidth

              +

              bandwidth

              Integer

              +

              Integer

              Specifies the bandwidth.

              +

              Specifies the bandwidth.

              lcu

              +

              lcu

              Integer

              +

              Integer

              Specifies the number of LCUs in the flavor. An LCU measures the dimensions on which a dedicated load balancer routes the traffic. The higher value indicates better perfromance.

              +

              Specifies the number of LCUs in the flavor.

              +

              An LCU measures the dimensions on which a dedicated load balancer routes the traffic. The higher value indicates better performance.

              https_cps

              +

              https_cps

              Integer

              +

              Integer

              Specifies the number of new HTTPS connections. This parameter is available only for load balancers at Layer 7.

              +

              Specifies the number of new HTTPS connections. This parameter is available only for load balancers at Layer 7.

              -
              Table 7 PageInfo

              Parameter

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

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              previous_marker

              +

              previous_marker

              String

              +

              String

              Specifies the ID of the first record in the pagination query result.

              +

              Specifies the ID of the first record in the pagination query result.

              next_marker

              +

              next_marker

              String

              +

              String

              Specifies the ID of the last record in the pagination query result.

              +

              Specifies the ID of the last record in the pagination query result.

              current_count

              +

              current_count

              Integer

              +

              Integer

              Specifies the number of records.

              +

              Specifies the number of records.

              -

              Example Requests

              Querying load balancer flavors on each page

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

              Example Requests

              Querying load balancer flavors on each page

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

              Example Responses

              Status code: 200

              -

              Successful request.

              -
              {
              +

              Example Responses

              Status code: 200

              +

              Successful request.

              +
              {
                 "request_id" : "b36bff1e331f195a3b8934a490fbcbf0",
                 "flavors" : [ {
                   "shared" : true,
              @@ -375,23 +403,23 @@
                 }
               }
              -

              Status Codes

              -
              - - - - - - - - - - - -

              Status Code

              +

              Status Codes

              +
              - - -

              Status Code

              Description

              +

              Description

              200

              +

              200

              Successful request.

              +

              Successful request.

              -

              Error Codes

              See Error Codes.

              +

              Error Codes

              See Error Codes.

              diff --git a/docs/elb/api-ref/ListHealthMonitors.html b/docs/elb/api-ref/ListHealthMonitors.html index 13d4e50e9..b53cc1504 100644 --- a/docs/elb/api-ref/ListHealthMonitors.html +++ b/docs/elb/api-ref/ListHealthMonitors.html @@ -1,7 +1,7 @@

              Querying Health Checks

              -

              Function

              This API is used to query all health checks.

              +

              Function

              This API is used to query all health checks.

              Constraints

              This API has the following constraints:

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

                @@ -89,7 +89,7 @@

              No

              Array

              +

              Array of strings

              Specifies the health check ID.

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

              @@ -99,7 +99,7 @@

              No

              Array

              +

              Array of integers

              Specifies the port used for the health check.

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

              @@ -109,7 +109,7 @@

              No

              Array

              +

              Array of strings

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

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

              @@ -120,7 +120,7 @@

              No

              Array

              +

              Array of strings

              Specifies the health check name.

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

              @@ -130,7 +130,7 @@

              No

              Array

              +

              Array of integers

              Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

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

              @@ -140,7 +140,7 @@

              No

              Array

              +

              Array of integers

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

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

              @@ -160,7 +160,7 @@

              No

              Array

              +

              Array of integers

              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.

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

              @@ -179,7 +179,7 @@

              No

              Array

              +

              Array of strings

              Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, or HTTPS.

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

              @@ -189,7 +189,7 @@

              No

              Array

              +

              Array of strings

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

              The value options are as follows:

              @@ -197,14 +197,15 @@
            • A list of values that are separated with commas (,), for example, 200, 202

            • A value range, for example, 200-204

            • -

              The default value is 200. Multiple status codes can be queried in the format of expected_codes=xxx&expected_codes=xxx.

              +

              The default value is 200.

              +

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

              url_path

              No

              Array

              +

              Array of strings

              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.

              @@ -214,7 +215,7 @@

              No

              Array

              +

              Array of strings

              Specifies the HTTP method.

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

              @@ -226,7 +227,7 @@

              No

              Array

              +

              Array of strings

              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.

                @@ -266,202 +267,204 @@

                Response Parameters

                Status code: 200

                -
                Table 4 Response body parameters

                Parameter

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

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                request_id

                +

                request_id

                String

                +

                String

                Specifies the request ID. The value is automatically generated.

                +

                Specifies the request ID. The value is automatically generated.

                page_info

                +

                page_info

                PageInfo object

                +

                PageInfo object

                Shows pagination information.

                +

                Shows pagination information.

                healthmonitors

                +

                healthmonitors

                Array of HealthMonitor objects

                +

                Array of HealthMonitor objects

                Specifies the health check.

                +

                Specifies the health check.

                -
                Table 5 PageInfo

                Parameter

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

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                previous_marker

                +

                previous_marker

                String

                +

                String

                Specifies the ID of the first record in the pagination query result.

                +

                Specifies the ID of the first record in the pagination query result.

                next_marker

                +

                next_marker

                String

                +

                String

                Specifies the ID of the last record in the pagination query result.

                +

                Specifies the ID of the last record in the pagination query result.

                current_count

                +

                current_count

                Integer

                +

                Integer

                Specifies the number of records.

                +

                Specifies the number of records.

                -
                Table 6 HealthMonitor

                Parameter

                +
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -498,19 +502,19 @@
                Table 6 HealthMonitor

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                admin_state_up

                +

                admin_state_up

                Boolean

                +

                Boolean

                Specifies the administrative status of the health check.

                +

                Specifies the administrative status of the health check.

                • true(default) indicates that the health check is enabled.

                • false indicates that the health check is disabled.

                delay

                +

                delay

                Integer

                +

                Integer

                Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

                +

                Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

                Minimum: 1

                Maximum: 50

                domain_name

                +

                domain_name

                String

                +

                String

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

                +

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

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

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

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

                expected_codes

                +

                expected_codes

                String

                +

                String

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

                +

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

                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

                -

                The default value is 200. Multiple status codes can be queried in the format of expected_codes=xxx&expected_codes=xxx.

                +

                The default value is 200.

                +

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

                http_method

                +

                http_method

                String

                +

                String

                Specifies the HTTP method. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. The default value is GET.

                +

                Specifies the HTTP method. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. The default value is GET.

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

                This parameter is unsupported. Please do not use it.

                id

                +

                id

                String

                +

                String

                Specifies the health check ID.

                +

                Specifies the health check ID.

                max_retries

                +

                max_retries

                Integer

                +

                Integer

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

                +

                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

                +

                max_retries_down

                Integer

                +

                Integer

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

                +

                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, and the default value is 3.

                Minimum: 1

                Maximum: 10

                monitor_port

                +

                monitor_port

                Integer

                +

                Integer

                Specifies the port used for the health check. If this parameter is left blank, a port of the backend server will be used by default. The port number ranges from 1 to 65535.

                +

                Specifies the port used for the health check. If this parameter is left blank, a port of the backend server will be used by default. The port number ranges from 1 to 65535.

                Minimum: 1

                Maximum: 65535

                name

                +

                name

                String

                +

                String

                Specifies the health check name.

                +

                Specifies the health check name.

                pools

                +

                pools

                Array of PoolRef objects

                +

                Array of PoolRef objects

                Lists the IDs of backend server groups for which the health check is configured. Only one ID will be returned.

                +

                Lists the IDs of backend server groups for which the health check is configured. Only one ID will be returned.

                project_id

                +

                project_id

                String

                +

                String

                Specifies the project ID.

                +

                Specifies the project ID.

                timeout

                +

                timeout

                Integer

                +

                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.

                +

                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

                +

                type

                String

                +

                String

                Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, or HTTPS.

                +

                Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, or HTTPS.

                Note:

                • If the protocol of the backend server is QUIC, the value can only be UDP_CONNECT.

                • If the protocol of the backend server is UDP, the value can only be UDP_CONNECT.

                  @@ -471,26 +474,27 @@

                url_path

                +

                url_path

                String

                +

                String

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

                +

                Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.

                +

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

                created_at

                +

                created_at

                String

                +

                String

                Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                +

                Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                updated_at

                +

                updated_at

                String

                +

                String

                Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                +

                Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                -
                Table 7 PoolRef

                Parameter

                +
                - - - - - diff --git a/docs/elb/api-ref/ListIpGroups.html b/docs/elb/api-ref/ListIpGroups.html index 85fb0700f..ce5ff1e76 100644 --- a/docs/elb/api-ref/ListIpGroups.html +++ b/docs/elb/api-ref/ListIpGroups.html @@ -1,7 +1,7 @@

                Querying IP Address Groups

                -

                Function

                This API is used to query IP address groups.

                +

                Function

                This API is used to query IP address groups.

                Constraints

                This API has the following constraints:

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

                  @@ -89,7 +89,7 @@
                - @@ -98,7 +98,7 @@ - @@ -107,7 +107,7 @@ - @@ -116,7 +116,7 @@ - @@ -151,128 +151,128 @@

                Response Parameters

                Status code: 200

                -
                Table 7 PoolRef

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                id

                +

                id

                String

                +

                String

                Specifies the ID of the backend server group.

                +

                Specifies the ID of the backend server group.

                No

                Array

                +

                Array of strings

                Specifies the ID of the IP address group.

                No

                Array

                +

                Array of strings

                Specifies the name of the IP address group.

                No

                Array

                +

                Array of strings

                Provides supplementary information about the IP address group.

                No

                Array

                +

                Array of strings

                Lists the IP addresses in the IP address group. Multiple IP addresses are separated with commas.

                Table 4 Response body parameters

                Parameter

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

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                ipgroups

                +

                ipgroups

                Array of IpGroup objects

                +

                Array of IpGroup objects

                Lists the returned IP address groups.

                +

                Lists the returned IP address groups.

                request_id

                +

                request_id

                String

                +

                String

                Specifies the request ID. The value is automatically generated.

                +

                Specifies the request ID. The value is automatically generated.

                page_info

                +

                page_info

                PageInfo object

                +

                PageInfo object

                Shows pagination information.

                +

                Shows pagination information.

                -
                Table 5 IpGroup

                Parameter

                +
                - - - - - - - - - - - - - - - - - - - - - - - - - -
                Table 5 IpGroup

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                created_at

                +

                created_at

                String

                +

                String

                Specifies the time when the IP address group was created.

                +

                Specifies the time when the IP address group was created.

                description

                +

                description

                String

                +

                String

                Specifies the time when the IP address group was updated.

                +

                Specifies the time when the IP address group was updated.

                id

                +

                id

                String

                +

                String

                Specifies the ID of the IP address group.

                +

                Specifies the ID of the IP address group.

                ip_list

                +

                ip_list

                Array of IpInfo objects

                +

                Array of IpInfo objects

                Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

                +

                Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

                Array Length: 0 - 300

                listeners

                +

                listeners

                Array of ListenerRef objects

                +

                Array of ListenerRef objects

                Lists the IDs of listeners with which the IP address group is associated.

                +

                Lists the IDs of listeners with which the IP address group is associated.

                name

                +

                name

                String

                +

                String

                Specifies the IP address group name.

                +

                Specifies the IP address group name.

                project_id

                +

                project_id

                String

                +

                String

                Specifies the project ID of the IP address group.

                +

                Specifies the project ID of the IP address group.

                updated_at

                +

                updated_at

                String

                +

                String

                Specifies the time when the IP address group was updated.

                +

                Specifies the time when the IP address group was updated.

                -
                Table 6 IpInfo

                Parameter

                +
                - - - - - - - - @@ -281,52 +281,52 @@
                Table 6 IpInfo

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                ip

                +

                ip

                String

                +

                String

                Specifies the IP addresses in the IP address group.

                +

                Specifies the IP addresses in the IP address group.

                description

                +

                description

                String

                +

                String

                Provides remarks about the IP address group.

                +

                Provides remarks about the IP address group.

                Minimum: 0

                Maximum: 255

                -
                Table 7 ListenerRef

                Parameter

                +
                - - - - -
                Table 7 ListenerRef

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                id

                +

                id

                String

                +

                String

                Specifies the listener ID.

                +

                Specifies the listener ID.

                -
                Table 8 PageInfo

                Parameter

                +
                - - - - - - - - - - - diff --git a/docs/elb/api-ref/ListL7Policies.html b/docs/elb/api-ref/ListL7Policies.html index 9464c3ac0..9cb7a5189 100644 --- a/docs/elb/api-ref/ListL7Policies.html +++ b/docs/elb/api-ref/ListL7Policies.html @@ -1,7 +1,7 @@

                Querying Forwarding Policies

                -

                Function

                This API is used to query all forwarding policies.

                +

                Function

                This API is used to query all forwarding policies.

                Constraints

                This API has the following constraints:

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

                  @@ -89,7 +89,7 @@
                - - - - - - - - - - - -
                Table 8 PageInfo

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                previous_marker

                +

                previous_marker

                String

                +

                String

                Specifies the ID of the first record in the pagination query result.

                +

                Specifies the ID of the first record in the pagination query result.

                next_marker

                +

                next_marker

                String

                +

                String

                Specifies the ID of the last record in the pagination query result.

                +

                Specifies the ID of the last record in the pagination query result.

                current_count

                +

                current_count

                Integer

                +

                Integer

                Specifies the number of records.

                +

                Specifies the number of records.

                No

                Array

                +

                Array of strings

                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.

                  @@ -103,7 +103,7 @@

                No

                Array

                +

                Array of strings

                Specifies the forwarding policy ID.

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

                @@ -113,7 +113,7 @@

                No

                Array

                +

                Array of strings

                Specifies the forwarding policy name.

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

                @@ -123,7 +123,7 @@

                No

                Array

                +

                Array of strings

                Provides supplementary information about the forwarding policy.

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

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

                No

                Array

                +

                Array of strings

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

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

                @@ -153,7 +153,7 @@

                No

                Array

                +

                Array of integers

                Specifies the forwarding policy priority.

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

                @@ -164,7 +164,7 @@

                No

                Array

                +

                Array of strings

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

                • REDIRECT_TO_POOL: Requests are forwarded to another backend server group.

                  @@ -179,7 +179,7 @@

                No

                Array

                +

                Array of strings

                Specifies the URL to which requests will be forwarded. The URL must be in the format of protocol://host:port/path?query.

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

                @@ -190,7 +190,7 @@

                No

                Array

                +

                Array of strings

                Specifies the ID of the backend server group to which requests will be forwarded.

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

                @@ -200,7 +200,7 @@

                No

                Array

                +

                Array of strings

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

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

                @@ -210,7 +210,7 @@

                No

                Array

                +

                Array of strings

                Specifies the provisioning status of the forwarding policy.

                • ACTIVE: The forwarding policy is provisioned successfully.

                  @@ -235,7 +235,7 @@

                No

                Array

                +

                Array of integers

                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.

                @@ -271,85 +271,85 @@

                Response Parameters

                Status code: 200

                -
                Table 4 Response body parameters

                Parameter

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

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                request_id

                +

                request_id

                String

                +

                String

                Specifies the request ID. The value is automatically generated.

                +

                Specifies the request ID. The value is automatically generated.

                page_info

                +

                page_info

                PageInfo object

                +

                PageInfo object

                Shows pagination information.

                +

                Shows pagination information.

                l7policies

                +

                l7policies

                Array of L7Policy objects

                +

                Array of L7Policy objects

                Lists the forwarding policies.

                +

                Lists the forwarding policies.

                -
                Table 5 PageInfo

                Parameter

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

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                previous_marker

                +

                previous_marker

                String

                +

                String

                Specifies the ID of the first record in the pagination query result.

                +

                Specifies the ID of the first record in the pagination query result.

                next_marker

                +

                next_marker

                String

                +

                String

                Specifies the ID of the last record in the pagination query result.

                +

                Specifies the ID of the last record in the pagination query result.

                current_count

                +

                current_count

                Integer

                +

                Integer

                Specifies the number of records.

                +

                Specifies the number of records.

                -
                Table 6 L7Policy

                Parameter

                +
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -526,104 +527,105 @@
                Table 6 L7Policy

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                action

                +

                action

                String

                +

                String

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

                +

                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_URL: Requests will be redirected to another URL.

                  @@ -362,59 +362,60 @@

                admin_state_up

                +

                admin_state_up

                Boolean

                +

                Boolean

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

                +

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

                This parameter is unsupported. Please do not use it.

                description

                +

                description

                String

                +

                String

                Provides supplementary information about the forwarding policy.

                +

                Provides supplementary information about the forwarding policy.

                id

                +

                id

                String

                +

                String

                Specifies the forwarding policy ID.

                +

                Specifies the forwarding policy ID.

                listener_id

                +

                listener_id

                String

                +

                String

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

                +

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

                name

                +

                name

                String

                +

                String

                Specifies the forwarding policy name.

                +

                Specifies the forwarding policy name.

                Minimum: 1

                Maximum: 255

                position

                +

                position

                Integer

                +

                Integer

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

                +

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

                This parameter is unsupported. Please do not use it.

                Minimum: 1

                Maximum: 100

                priority

                +

                priority

                Integer

                +

                Integer

                Specifies the forwarding policy priority. A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener. This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

                +

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

                +

                This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

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

                • If enhance_l7policy_enable is not enabled, forwarding policies are automatically prioritized based on the original policy sorting logic. The priorities of domain names are independent from each other. For the same domain name, the priorities are sorted in the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If the matching types are the same, the longer the URL is, the higher the priority is. 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 be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to be created because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, specify a value or adjust the priorities of existing forwarding policies. If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default.

                  @@ -422,45 +423,45 @@

                  This parameter is invalid for shared load balancers.

                project_id

                +

                project_id

                String

                +

                String

                Specifies the project ID of the forwarding policy.

                +

                Specifies the project ID of the forwarding policy.

                provisioning_status

                +

                provisioning_status

                String

                +

                String

                Specifies the provisioning status of the forwarding policy.

                +

                Specifies the provisioning status of the forwarding policy.

                The value can be ACTIVE or ERROR.

                • ACTIVE (default): The forwarding policy is provisioned successfully.

                redirect_pool_id

                +

                redirect_pool_id

                String

                +

                String

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

                +

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

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

                • If both redirect_pools_config and redirect_pool_id are specified, redirect_pools_config will take effect.

                redirect_pools_config

                +

                redirect_pools_config

                Array of CreateRedirectPoolsConfig objects

                +

                Array of CreateRedirectPoolsConfig objects

                Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL.

                +

                Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL.

                redirect_listener_id

                +

                redirect_listener_id

                String

                +

                String

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

                +

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

                Note:

                • The listener's protocol must be HTTPS or TERMINATED_HTTPS.

                • A listener added to another load balancer is not allowed.

                  @@ -468,27 +469,27 @@

                redirect_url

                +

                redirect_url

                String

                +

                String

                Specifies the URL to which requests are forwarded.

                +

                Specifies the URL to which requests are forwarded.

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

                This parameter is unsupported. Please do not use it.

                rules

                +

                rules

                Array of RuleRef objects

                +

                Array of RuleRef objects

                Lists the forwarding rules in the forwarding policy.

                +

                Lists the forwarding rules in the forwarding policy.

                redirect_url_config

                +

                redirect_url_config

                RedirectUrlConfig object

                +

                RedirectUrlConfig object

                Specifies the URL to which requests are forwarded.

                +

                Specifies the URL to which requests are forwarded.

                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.

                This parameter is mandatory when action is set to REDIRECT_TO_URL. It cannot be specified if the value of action is not REDIRECT_TO_URL.

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

                @@ -497,28 +498,28 @@

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

                fixed_response_config

                +

                fixed_response_config

                FixtedResponseConfig object

                +

                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.

                +

                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.

                This parameter is mandatory when action is set to FIXED_RESPONSE. It cannot be specified if the value of action is not FIXED_RESPONSE.

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

                created_at

                +

                created_at

                String

                +

                String

                Specifies the time when the forwarding policy was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                +

                Specifies the time when the forwarding policy was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                updated_at

                +

                updated_at

                String

                +

                String

                Specifies the time when the forwarding policy was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                +

                Specifies the time when the forwarding policy was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                -
                Table 7 CreateRedirectPoolsConfig

                Parameter

                +
                - - - - - - - -
                Table 7 CreateRedirectPoolsConfig

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                pool_id

                +

                pool_id

                String

                +

                String

                Specifies the ID of the backend server group.

                +

                Specifies the ID of the backend server group.

                weight

                +

                weight

                Integer

                +

                Integer

                Specifies the weight of the backend server group. The value ranges from 0 to 100.

                +

                Specifies the weight of the backend server group.

                +

                The value ranges from 0 to 100.

                -
                Table 8 RuleRef

                Parameter

                +
                - - - - -
                Table 8 RuleRef

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                id

                +

                id

                String

                +

                String

                Specifies the forwarding rule ID.

                +

                Specifies the forwarding rule ID.

                -
                Table 9 RedirectUrlConfig

                Parameter

                +
                - - - - - - - - - - - - - - - - - - - -
                Table 9 RedirectUrlConfig

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                protocol

                +

                protocol

                String

                +

                String

                Specifies the protocol for redirection.

                +

                Specifies the protocol for redirection.

                The value can be HTTP, HTTPS, or ${protocol}. The default value is ${protocol}, indicating that the protocol of the request will be used.

                Minimum: 1

                Maximum: 36

                host

                +

                host

                String

                +

                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.

                +

                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

                +

                port

                String

                +

                String

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

                +

                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

                +

                path

                String

                +

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

                +

                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

                +

                query

                String

                +

                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.

                +

                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.example.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.example.com:8080/elb?type=loadbalancer&name=my_name.

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

                Default: ${query}

                @@ -631,11 +633,11 @@

                Maximum: 128

                status_code

                +

                status_code

                String

                +

                String

                Specifies the status code returned after the requests are redirected.

                +

                Specifies the status code returned after the requests are redirected.

                The value can be 301, 302, 303, 307, or 308.

                Minimum: 1

                Maximum: 16

                @@ -645,38 +647,38 @@
                -
                Table 10 FixtedResponseConfig

                Parameter

                +
                - - - - - - - - - - - diff --git a/docs/elb/api-ref/ListL7Rules.html b/docs/elb/api-ref/ListL7Rules.html index c65e2df51..69a4a8ba4 100644 --- a/docs/elb/api-ref/ListL7Rules.html +++ b/docs/elb/api-ref/ListL7Rules.html @@ -1,7 +1,7 @@

                Querying Forwarding Rules

                -

                Function

                This API is used to query all forwarding rules.

                +

                Function

                This API is used to query all forwarding rules.

                Constraints

                This API has the following constraints:

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

                  @@ -98,7 +98,7 @@
                - - - - - - -
                Table 10 FixtedResponseConfig

                Parameter

                Type

                +

                Type

                Description

                +

                Description

                status_code

                +

                status_code

                String

                +

                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.

                +

                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

                +

                content_type

                String

                +

                String

                Specifies the format of the response body.

                +

                Specifies the format of the response body.

                The value can be text/plain, text/css, text/html, application/javascript, or application/json.

                Minimum: 0

                Maximum: 32

                message_body

                +

                message_body

                String

                +

                String

                Specifies the content of the response message body.

                +

                Specifies the content of the response message body.

                Minimum: 0

                Maximum: 1024

                No

                Array

                +

                Array of strings

                Specifies the forwarding rule ID.

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

                @@ -108,7 +108,7 @@

                No

                Array

                +

                Array of strings

                Specifies how requests are matched with the domain names or URL. Values:

                • EQUAL_TO: exact match.

                  @@ -122,7 +122,7 @@

                No

                Array

                +

                Array of strings

                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.

                @@ -152,7 +152,7 @@

                No

                Array

                +

                Array of strings

                Specifies the value of the match content.

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

                @@ -162,7 +162,7 @@

                No

                Array

                +

                Array of strings

                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.

                @@ -173,7 +173,7 @@

                No

                Array

                +

                Array of strings

                Specifies the match type. The value can be HOST_NAME or PATH.

                The type of forwarding rules for the same forwarding policy cannot be the same.

                @@ -184,7 +184,7 @@

                No

                Array

                +

                Array of strings

                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.

                  @@ -224,119 +224,119 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 4 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  page_info

                  +

                  page_info

                  PageInfo object

                  +

                  PageInfo object

                  Shows pagination information.

                  +

                  Shows pagination information.

                  rules

                  +

                  rules

                  Array of L7Rule objects

                  +

                  Array of L7Rule objects

                  Lists the forwarding rules.

                  +

                  Lists the forwarding rules.

                  -
                  Table 5 PageInfo

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  previous_marker

                  +

                  previous_marker

                  String

                  +

                  String

                  Specifies the ID of the first record in the pagination query result.

                  +

                  Specifies the ID of the first record in the pagination query result.

                  next_marker

                  +

                  next_marker

                  String

                  +

                  String

                  Specifies the ID of the last record in the pagination query result.

                  +

                  Specifies the ID of the last record in the pagination query result.

                  current_count

                  +

                  current_count

                  Integer

                  +

                  Integer

                  Specifies the number of records.

                  +

                  Specifies the number of records.

                  -
                  Table 6 L7Rule

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -411,19 +412,19 @@
                  Table 6 L7Rule

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

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

                  +

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

                  This parameter is unsupported. Please do not use it.

                  compare_type

                  +

                  compare_type

                  String

                  +

                  String

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

                  +

                  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, the value can be REGEX, STARTS_WITH, or EQUAL_TO.

                  key

                  +

                  key

                  String

                  +

                  String

                  Specifies the key of the match content. This parameter will not take effect if type is set to HOST_NAME or PATH.

                  +

                  Specifies the key of the match content. This parameter will not take effect if type is set to HOST_NAME or PATH.

                  Minimum: 1

                  Maximum: 255

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  type

                  +

                  type

                  String

                  +

                  String

                  Specifies the type of the forwarding rule. The value can be one of the following:

                  +

                  Specifies the type of the forwarding rule. 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.

                  • METHOD: An HTTP request method will be used for matching.

                    @@ -348,11 +348,11 @@

                    If type is set to HOST_NAME, PATH, METHOD, and SOURCE_IP, only one forwarding rule can be created for each type. If type is set to HEADER and QUERY_STRING, multiple forwarding rules can be created for each type.

                  value

                  +

                  value

                  String

                  +

                  String

                  Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. This parameter will take effect only when conditions is left blank.

                  +

                  Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. This parameter will take effect only when conditions is left blank.

                  • 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 _~';@^-%#&$.*+?,=!:|/()[]{}

                  • If type is set to METHOD, SOURCE_IP, HEADER, or QUERY_STRING, this parameter will not take effect, and condition_pair will be used to specify the key and value.

                    @@ -361,49 +361,50 @@

                    Maximum: 128

                  provisioning_status

                  +

                  provisioning_status

                  String

                  +

                  String

                  Specifies the provisioning status of the forwarding rule.

                  +

                  Specifies the provisioning status of the forwarding rule.

                  The value can only be ACTIVE (default), PENDING_CREATE, or ERROR.

                  This parameter is unsupported. Please do not use it.

                  invert

                  +

                  invert

                  Boolean

                  +

                  Boolean

                  Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but will not take effect.

                  +

                  Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but will not take effect.

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the forwarding policy ID.

                  +

                  Specifies the forwarding policy ID.

                  conditions

                  +

                  conditions

                  Array of RuleCondition objects

                  +

                  Array of RuleCondition 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.

                  +

                  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.

                  created_at

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when the forwarding rule was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when the forwarding rule was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when the forwarding rule was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when the forwarding rule was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  -
                  Table 7 RuleCondition

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -365,179 +367,180 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 7 RuleCondition

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  key

                  +

                  key

                  String

                  +

                  String

                  Specifies the key of match item.

                  +

                  Specifies the key of match item.

                  • If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, this parameter is left blank.

                  • If type is set to HEADER, key indicates the name of the HTTP header parameter. The value can contain 1 to 40 characters, including letters, digits, hyphens (-), and underscores (_).

                  • If type is set to QUERY_STRING, key indicates the name of the query parameter. The value is case sensitive and can contain 1 to 128 characters. Spaces, square brackets ([ ]), curly brackets ({ }), angle brackets (< >), backslashes (), double quotation marks (" "), pound signs (#), ampersands (&), vertical bars (|), percent signs (%), and tildes (~) are not supported.

                    @@ -433,11 +434,11 @@

                    Maximum: 128

                  value

                  +

                  value

                  String

                  +

                  String

                  Specifies the value of the match item.

                  +

                  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 _~';@^-%#&$.*+?,=!:|/()[]{}

                  • If type is set to HEADER, key indicates the name of the HTTP header parameter, and value indicates the value of the HTTP header parameter. The value can contain 1 to 128 characters. Asterisks (*) and question marks (?) are allowed, but spaces and double quotation marks are not allowed. An asterisk can match zero or more characters, and a question mark can match 1 character.

                    diff --git a/docs/elb/api-ref/ListListeners.html b/docs/elb/api-ref/ListListeners.html index 9e6d1b790..c0071cce6 100644 --- a/docs/elb/api-ref/ListListeners.html +++ b/docs/elb/api-ref/ListListeners.html @@ -1,7 +1,7 @@

                    Querying Listeners

                    -

                    Function

                    This API is used to query listeners.

                    +

                    Function

                    This API is used to query listeners.

                    Constraints

                    This API has the following constraints:

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

                      @@ -89,7 +89,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the port used by the listener.

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

                  @@ -99,7 +99,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the protocol used by the listener.

                  The value can be TCP, HTTP, UDP, HTTPS or TERMINATED_HTTPS.

                  @@ -111,7 +111,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Provides supplementary information about the listener.

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

                  @@ -121,7 +121,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -131,7 +131,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -151,7 +151,7 @@

                  No

                  Array

                  +

                  Array of integers

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

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

                  @@ -162,7 +162,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -172,7 +172,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the listener ID.

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

                  @@ -182,7 +182,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the name of the listener added to the load balancer.

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

                  @@ -195,14 +195,15 @@

                  Boolean

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

                  -

                  This parameter is available only for HTTPS listeners. If you configure this parameter for listeners with other protocols, it will not take effect.

                  +

                  This parameter is available only for HTTPS listeners.

                  +

                  If you configure this parameter for listeners with other protocols, it will not take effect.

                  loadbalancer_id

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -212,7 +213,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the security policy used by the listener.

                  Multiple security policies can be queried in the format of tls_ciphers_policy=xxx&tls_ciphers_policy=xxx.

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

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -232,7 +233,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -242,7 +243,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

                    @@ -266,7 +267,7 @@

                  No

                  Array

                  +

                  Array of integers

                  Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

                  The value ranges from 1 to 300.

                  @@ -277,7 +278,7 @@

                  No

                  Array

                  +

                  Array of integers

                  Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

                  • If the client fails to send a request header to the load balancer within the timeout duration, the request will be interrupted.

                    @@ -291,7 +292,7 @@

                  No

                  Array

                  +

                  Array of integers

                  Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

                  • For TCP listeners, the value ranges from 10 to 4000.

                    @@ -330,9 +331,10 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the backend server ID. 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_instance_id=xxx&member_instance_id=xxx.

                  +

                  Specifies the backend server ID. 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_instance_id=xxx&member_instance_id=xxx.

                  Table 4 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  page_info

                  +

                  page_info

                  PageInfo object

                  +

                  PageInfo object

                  Shows pagination information about listeners.

                  +

                  Shows pagination information about listeners.

                  listeners

                  +

                  listeners

                  Array of Listener objects

                  +

                  Array of Listener objects

                  Lists the listeners.

                  +

                  Lists the listeners.

                  -
                  Table 5 PageInfo

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  previous_marker

                  +

                  previous_marker

                  String

                  +

                  String

                  Specifies the ID of the first record in the pagination query result.

                  +

                  Specifies the ID of the first record in the pagination query result.

                  next_marker

                  +

                  next_marker

                  String

                  +

                  String

                  Specifies the ID of the last record in the pagination query result.

                  +

                  Specifies the ID of the last record in the pagination query result.

                  current_count

                  +

                  current_count

                  Integer

                  +

                  Integer

                  Specifies the number of records.

                  +

                  Specifies the number of records.

                  -
                  Table 6 Listener

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 6 Listener

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

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

                  +

                  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

                  +

                  client_ca_tls_container_ref

                  String

                  +

                  String

                  Specifies the ID of the CA certificate used by the listener. This parameter is available only when type is set to client.

                  +

                  Specifies the ID of the CA certificate used by the listener. This parameter is available only when type is set to client.

                  connection_limit

                  +

                  connection_limit

                  Integer

                  +

                  Integer

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

                  +

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

                  This parameter is unsupported. Please do not use it.

                  created_at

                  +

                  created_at

                  String

                  +

                  String

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

                  +

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

                  default_pool_id

                  +

                  default_pool_id

                  String

                  +

                  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.

                  +

                  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

                  +

                  default_tls_container_ref

                  String

                  +

                  String

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

                  +

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

                  description

                  +

                  description

                  String

                  +

                  String

                  Provides supplementary information about the listener.

                  +

                  Provides supplementary information about the listener.

                  http2_enable

                  +

                  http2_enable

                  Boolean

                  +

                  Boolean

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

                  -

                  This parameter is available only for HTTPS listeners. If you configure this parameter for listeners with other protocols, it will not take effect.

                  +

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

                  +

                  This parameter is available only for HTTPS listeners.

                  +

                  If you configure this parameter for listeners with other protocols, it will not take effect.

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the listener ID.

                  +

                  Specifies the listener ID.

                  insert_headers

                  +

                  insert_headers

                  ListenerInsertHeaders object

                  +

                  ListenerInsertHeaders object

                  Specifies the HTTP header fields that can transmit required information to backend servers. For example, the X-Forwarded-ELB-IP header field can transmit the EIP of the load balancer to backend servers.

                  +

                  Specifies the HTTP header fields that can transmit required information to backend servers. For example, the X-Forwarded-ELB-IP header field can transmit the EIP of the load balancer to backend servers.

                  loadbalancers

                  +

                  loadbalancers

                  Array of LoadBalancerRef objects

                  +

                  Array of LoadBalancerRef objects

                  Specifies the ID of the load balancer that the listener is added to. A listener can be added to only one load balancer.

                  +

                  Specifies the ID of the load balancer that the listener is added to. A listener can be added to only one load balancer.

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the listener name.

                  +

                  Specifies the listener name.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

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

                  +

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

                  protocol

                  +

                  protocol

                  String

                  +

                  String

                  Specifies the protocol used by the listener.

                  +

                  Specifies the protocol used by the listener.

                  The value can be TCP, HTTP, UDP, HTTPS or TERMINATED_HTTPS.

                  Note:

                  • Protocol used by HTTPS listeners added to a shared load balancer can only be set to TERMINATED_HTTPS. If HTTPS is passed, the value will be automatically changed to TERMINATED_HTTPS.

                    @@ -545,55 +548,55 @@

                  protocol_port

                  +

                  protocol_port

                  Integer

                  +

                  Integer

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

                  +

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

                  Minimum: 1

                  Maximum: 65535

                  sni_container_refs

                  +

                  sni_container_refs

                  Array of strings

                  +

                  Array of strings

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

                  +

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

                  Note:

                  • The domain names of all SNI certificates must be unique.

                  • The total number of domain names of all SNI certificates cannot exceed 30.

                  sni_match_algo

                  +

                  sni_match_algo

                  String

                  +

                  String

                  Specifies how wildcard domain name matches with the SNI certificates used by the listener.

                  +

                  Specifies how wildcard domain name matches with the SNI certificates used by the listener.

                  longest_suffix indicates longest suffix match. wildcard indicates wildcard match.

                  The default value is wildcard.

                  tags

                  +

                  tags

                  Array of Tag objects

                  +

                  Array of Tag objects

                  Lists the tags.

                  +

                  Lists the tags.

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

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

                  +

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

                  tls_ciphers_policy

                  +

                  tls_ciphers_policy

                  String

                  +

                  String

                  Specifies the security policy used by the listener.

                  -

                  Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

                  +

                  Specifies the security policy used by the listener.

                  +

                  Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

                  Note:

                  • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

                  • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

                    @@ -601,11 +604,11 @@

                  security_policy_id

                  +

                  security_policy_id

                  String

                  +

                  String

                  Specifies the ID of the custom security policy.

                  +

                  Specifies the ID of the custom security policy.

                  Note:

                  • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

                  • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

                    @@ -613,33 +616,33 @@

                  enable_member_retry

                  +

                  enable_member_retry

                  Boolean

                  +

                  Boolean

                  Specifies whether to enable health check retries for backend servers. The value can be true (enable health check retries) or false (disable health check retries). The default value is true.

                  +

                  Specifies whether to enable health check retries for backend servers. The value can be true (enable health check retries) or false (disable health check retries). The default value is true.

                  Note:

                  • If a shared load balancer is associated, this parameter is available only when protocol is set to HTTP or TERMINATED_HTTPS.

                  • If a dedicated load balancer is associated, this parameter is available only when protocol is set to HTTP or HTTPS.

                  keepalive_timeout

                  +

                  keepalive_timeout

                  Integer

                  +

                  Integer

                  Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

                  +

                  Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

                  • 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 1 to 4000, and the default value is 60.

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

                  client_timeout

                  +

                  client_timeout

                  Integer

                  +

                  Integer

                  Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

                  +

                  Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

                  • If the client fails to send a request header to the load balancer within the timeout duration, the request will be interrupted.

                  • If the interval between two consecutive request bodies reaching the load balancer is greater than the timeout duration, the connection will be disconnected.

                  @@ -647,27 +650,27 @@

                  This parameter is available only for HTTP and HTTPS listeners.

                  member_timeout

                  +

                  member_timeout

                  Integer

                  +

                  Integer

                  Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

                  +

                  Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

                  The value ranges from 1 to 300, and the default value is 60.

                  This parameter is available only for HTTP and HTTPS listeners.

                  ipgroup

                  +

                  ipgroup

                  ListenerIpGroup object

                  +

                  ListenerIpGroup object

                  Specifies the IP address group associated with the listener.

                  +

                  Specifies the IP address group associated with the listener.

                  transparent_client_ip_enable

                  +

                  transparent_client_ip_enable

                  Boolean

                  +

                  Boolean

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

                  +

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

                  • TCP or UDP listeners of shared load balancers: The value can be true or false, and the default value is false if this parameter is not passed.

                  • HTTP or HTTPS listeners of shared load balancers: The value can only be true, and the default value is true if this parameter is not passed.

                  • All listeners of dedicated load balancers: The value can only be true, and the default value is true if this parameter is not passed.

                    @@ -679,11 +682,11 @@

                  enhance_l7policy_enable

                  +

                  enhance_l7policy_enable

                  Boolean

                  +

                  Boolean

                  Specifies whether to enable advanced forwarding. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

                  +

                  Specifies whether to enable advanced forwarding. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

                  • If this function is enabled, action can be set to REDIRECT_TO_URL (requests will be redirected to another URL) or Fixed_RESPONSE (a fixed response body will be returned to clients).

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

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

                    @@ -695,11 +698,11 @@

                    Default: false

                  quic_config

                  +

                  quic_config

                  ListenerQuicConfig object

                  +

                  ListenerQuicConfig object

                  Specifies the QUIC configuration for the current listener. This parameter is valid only when protocol is set to HTTPS.

                  +

                  Specifies the QUIC configuration for the current listener. This parameter is valid only when protocol is set to HTTPS.

                  For a TCP/UDP/HTTP/QUIC listener, if this parameter is not left blank, an error will be reported.

                  NOTE:

                  The client sends a normal HTTP request that contains information indicating that the QUIC protocol is supported.

                  @@ -712,43 +715,43 @@
                  -
                  Table 7 ListenerInsertHeaders

                  Parameter

                  +
                  - - - - - - - - - - - - - - @@ -756,47 +759,47 @@
                  Table 7 ListenerInsertHeaders

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  X-Forwarded-ELB-IP

                  +

                  X-Forwarded-ELB-IP

                  Boolean

                  +

                  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.

                  +

                  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

                  +

                  X-Forwarded-Port

                  Boolean

                  +

                  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.

                  +

                  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

                  +

                  X-Forwarded-For-Port

                  Boolean

                  +

                  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.

                  +

                  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

                  +

                  X-Forwarded-Host

                  Boolean

                  +

                  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.

                  +

                  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

                  +
                  - - - - -
                  Table 8 LoadBalancerRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the load balancer ID.

                  +

                  Specifies the load balancer ID.

                  -
                  Table 9 Tag

                  Parameter

                  +
                  - - - - - - - - @@ -805,39 +808,39 @@
                  Table 9 Tag

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  key

                  +

                  key

                  String

                  +

                  String

                  Specifies the tag key.

                  +

                  Specifies the tag key.

                  Minimum: 1

                  Maximum: 36

                  value

                  +

                  value

                  String

                  +

                  String

                  Specifies the tag value.

                  +

                  Specifies the tag value.

                  Minimum: 0

                  Maximum: 43

                  -
                  Table 10 ListenerIpGroup

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 10 ListenerIpGroup

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  ipgroup_id

                  +

                  ipgroup_id

                  String

                  +

                  String

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

                  +

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

                  This parameter is mandatory when you create the IP address group and is optional when you update the IP address group.

                  The specified IP address group must exist, and the value cannot be null.

                  enable_ipgroup

                  +

                  enable_ipgroup

                  Boolean

                  +

                  Boolean

                  Specifies whether to enable access control.

                  +

                  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

                  +

                  type

                  String

                  +

                  String

                  Specifies how access to the listener is controlled.

                  +

                  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.

                  @@ -847,27 +850,32 @@
                  -
                  Table 11 ListenerQuicConfig

                  Parameter

                  +
                  - - - - - - - - diff --git a/docs/elb/api-ref/ListLoadBalancers.html b/docs/elb/api-ref/ListLoadBalancers.html index 96b62939d..1cb37d865 100644 --- a/docs/elb/api-ref/ListLoadBalancers.html +++ b/docs/elb/api-ref/ListLoadBalancers.html @@ -1,7 +1,7 @@

                  Querying Load Balancers

                  -

                  Function

                  This API is used to query all load balancers.

                  +

                  Function

                  This API is used to query all load balancers.

                  Constraints

                  This API has the following constraints:

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

                    @@ -91,7 +91,7 @@
                  - - - - - - - - - - - - - - - - @@ -269,7 +283,7 @@ - - - - - - - - - - - @@ -415,333 +431,333 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 11 ListenerQuicConfig

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  quic_listener_id

                  +

                  quic_listener_id

                  String

                  +

                  String

                  Specifies the ID of the QUIC listener. This parameter is mandatory for creation and is optional for update. The specified quic_listener_id must exist. The listener protocol must be QUIC and cannot be set to null, otherwise, it will conflict with enable_quic_upgrade.

                  +

                  Specifies the ID of the QUIC listener.

                  +

                  This parameter is mandatory for creation and is optional for update.

                  +

                  The specified quic_listener_id must exist. The listener protocol must be QUIC and cannot be set to null, otherwise, it will conflict with enable_quic_upgrade.

                  QUIC protocol is not supported.

                  enable_quic_upgrade

                  +

                  enable_quic_upgrade

                  Boolean

                  +

                  Boolean

                  Specifies whether to enable QUIC upgrade. True: QUIC upgrade is enabled. False: QUIC upgrade is disabled. HTTPS listeners can be upgraded to QUIC listeners.

                  +

                  Specifies whether to enable QUIC upgrade.

                  +

                  True: QUIC upgrade is enabled.

                  +

                  False: QUIC upgrade is disabled.

                  +

                  HTTPS listeners can be upgraded to QUIC listeners.

                  QUIC protocol is not supported.

                  No

                  Array

                  +

                  Array of strings

                  Specifies the load balancer ID.

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

                  @@ -101,7 +101,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the load balancer name.

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

                  @@ -111,7 +111,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Provides supplementary information about the load balancer.

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

                  @@ -131,7 +131,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the provisioning status of the load balancer.

                  • ACTIVE: The load balancer is successfully provisioned.

                    @@ -144,7 +144,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the operating status of the load balancer.

                  • ONLINE: The load balancer is working normally.

                    @@ -169,7 +169,7 @@

                  No

                  Array

                  +

                  Array of strings

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

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

                  @@ -179,7 +179,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of the port bound to the private IPv4 address of the load balancer.

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

                  @@ -189,7 +189,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

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

                  No

                  Array

                  +

                  Array of strings

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

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

                  @@ -209,7 +209,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -219,7 +219,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -229,7 +229,7 @@

                  No

                  Array

                  +

                  Array of strings

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

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

                  @@ -239,9 +239,16 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the IPv4 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 } ]

                  +

                  Specifies the IPv4 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.

                  • If eip_id is used as the query condition, the format is eips=eip_id=xxx&eips=eip_id=xxx.

                  • If eip_address is used as the query condition, the format is eips=eip_address=xxx&eips=eip_address=xxx.

                    @@ -254,13 +261,20 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the IPv4 EIP bound to the load balancer. The following is an example: "publicips": [ { "publicip_id": "e9b72a9d-4275-455e-a724-853504e4d9c6", "publicip_address": "88.88.14.122", "ip_version": 4 } ]

                  +

                  Specifies the IPv4 EIP bound to the load balancer. The following is an example:

                  +

                  "publicips": [

                  +

                  {

                  +

                  "publicip_id": "e9b72a9d-4275-455e-a724-853504e4d9c6",

                  +

                  "publicip_address": "88.88.14.122",

                  +

                  "ip_version": 4

                  +

                  }

                  +

                  ]

                  Multiple EIPs can be queried.

                  • If publicip_id is used as the query condition, the format is publicips=publicip_id=xxx&publicips=publicip_id=xxx.

                  • If publicip_address is used as the query condition, the format is *publicips=publicip_address=xxx&publicips=publicip_address=xxx.

                    -
                  • If publicip_address is used as the query condition, the format is publicips=ip_version=xxx&publicips=ip_version=xxx.

                    +
                  • If ip_version is used as the query condition, the format is publicips=ip_version=xxx&publicips=ip_version=xxx.

                  Note that this parameter has the same meaning as eips.

                  No

                  Array

                  +

                  Array of strings

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

                  Multiple AZs can be queried in the format of availability_zone_list=xxx&availability_zone_list=xxx.

                  @@ -279,7 +293,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of a flavor at Layer 4.

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

                  @@ -289,7 +303,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of the elastic flavor at Layer 4, which is reserved for now.

                  Multiple flavors can be queried in the format of l4_scale_flavor_id=xxx&l4_scale_flavor_id=xxx.

                  @@ -300,7 +314,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of a flavor at Layer 7.

                  Multiple flavors can be queried in the format of l7_flavor_id=xxx&l7_flavor_id=xxx.

                  @@ -310,16 +324,18 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of the elastic flavor at Layer 7. Multiple flavors can be queried in the format of l7_scale_flavor_id=xxx&l7_scale_flavor_id=xxx. This parameter is unsupported. Please do not use it.

                  +

                  Specifies the ID of the elastic flavor at Layer 7.

                  +

                  Multiple flavors can be queried in the format of l7_scale_flavor_id=xxx&l7_scale_flavor_id=xxx.

                  +

                  This parameter is unsupported. Please do not use it.

                  member_device_id

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of the cloud server that is associated with the load balancer as a backend server. This is a query parameter and will not be included in the response.

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

                  @@ -329,7 +345,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the private IP address of the cloud server that is associated with the load balancer as a backend server. This is a query parameter and will not be included in the response.

                  Multiple private IP addresses can be queried in the format of member_address=xxx&member_address=xxx.

                  @@ -339,7 +355,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

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

                  No

                  Array

                  +

                  Array of integers

                  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.

                  @@ -375,13 +391,13 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the type of the subnet on the downstream plane.

                  • ipv4: IPv4 subnet

                  • dualstack: subnet that supports IPv4/IPv6 dual stack

                  -

                  Multiple values query can be queried in the format of elb_virsubnet_type=ipv4&elb_virsubnet_type=dualstack.

                  +

                  Multiple values can be queried in the format of elb_virsubnet_type=ipv4&elb_virsubnet_type=dualstack.

                  "dualstack" is not supported.

                  Table 4 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  loadbalancers

                  +

                  loadbalancers

                  Array of LoadBalancer objects

                  +

                  Array of LoadBalancer objects

                  Lists the load balancers.

                  +

                  Lists the load balancers.

                  page_info

                  +

                  page_info

                  PageInfo object

                  +

                  PageInfo object

                  Shows pagination information about load balancers.

                  +

                  Shows pagination information about load balancers.

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  -
                  Table 5 LoadBalancer

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 5 LoadBalancer

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the load balancer ID.

                  +

                  Specifies the load balancer ID.

                  description

                  +

                  description

                  String

                  +

                  String

                  Provides supplementary information about the load balancer.

                  +

                  Provides supplementary information about the load balancer.

                  Minimum: 1

                  Maximum: 255

                  provisioning_status

                  +

                  provisioning_status

                  String

                  +

                  String

                  Specifies the provisioning status of the load balancer. The value can be one of the following:

                  +

                  Specifies the provisioning status of the load balancer. The value can be one of the following:

                  • ACTIVE: The load balancer is successfully provisioned.

                  • PENDING_DELETE: The load balancer is being deleted.

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

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

                  +

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

                  provider

                  +

                  provider

                  String

                  +

                  String

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

                  +

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

                  pools

                  +

                  pools

                  Array of PoolRef objects

                  +

                  Array of PoolRef objects

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

                  +

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

                  listeners

                  +

                  listeners

                  Array of ListenerRef objects

                  +

                  Array of ListenerRef objects

                  Lists the IDs of listeners added to the load balancer.

                  +

                  Lists the IDs of listeners added to the load balancer.

                  operating_status

                  +

                  operating_status

                  String

                  +

                  String

                  Specifies the operating status of the load balancer. The value can only be ONLINE, indicating that the load balancer is running normally.

                  +

                  Specifies the operating status of the load balancer. The value can only be ONLINE, indicating that the load balancer is running normally.

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the load balancer name.

                  +

                  Specifies the load balancer name.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID of the load balancer.

                  +

                  Specifies the project ID of the load balancer.

                  vip_subnet_cidr_id

                  +

                  vip_subnet_cidr_id

                  String

                  +

                  String

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

                  +

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

                  vip_address

                  +

                  vip_address

                  String

                  +

                  String

                  Specifies the private IPv4 address bound to the load balancer.

                  +

                  Specifies the private IPv4 address bound to the load balancer.

                  vip_port_id

                  +

                  vip_port_id

                  String

                  +

                  String

                  Specifies the ID of the port bound to the private IPv4 address of the load balancer.

                  +

                  Specifies the ID of the port bound to the private IPv4 address of the load balancer.

                  The default security group associated with the port will take effect only after at least one backend server is associated with load balancer.

                  tags

                  +

                  tags

                  Array of Tag objects

                  +

                  Array of Tag objects

                  Lists the tags added to the load balancer.

                  +

                  Lists the tags added to the load balancer.

                  created_at

                  +

                  created_at

                  String

                  +

                  String

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

                  +

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

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

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

                  +

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

                  guaranteed

                  +

                  guaranteed

                  Boolean

                  +

                  Boolean

                  Specifies whether the load balancer is a dedicated load balancer.

                  +

                  Specifies whether the load balancer is a dedicated load balancer.

                  • true (default): The load balancer is a dedicated load balancer.

                  • false: The load balancer is a shared load balancer.

                  vpc_id

                  +

                  vpc_id

                  String

                  +

                  String

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

                  +

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

                  eips

                  +

                  eips

                  Array of EipInfo objects

                  +

                  Array of EipInfo objects

                  Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                  +

                  Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                  This parameter has the same meaning as publicips.

                  ipv6_vip_address

                  +

                  ipv6_vip_address

                  String

                  +

                  String

                  Specifies the IPv6 address bound to the load balancer.

                  +

                  Specifies the IPv6 address bound to the load balancer.

                  ipv6_vip_virsubnet_id

                  +

                  ipv6_vip_virsubnet_id

                  String

                  +

                  String

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

                  +

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

                  ipv6_vip_port_id

                  +

                  ipv6_vip_port_id

                  String

                  +

                  String

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

                  +

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

                  availability_zone_list

                  +

                  availability_zone_list

                  Array of strings

                  +

                  Array of strings

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

                  +

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

                  enterprise_project_id

                  +

                  enterprise_project_id

                  String

                  +

                  String

                  Specifies the enterprise project ID.

                  +

                  Specifies the enterprise project ID.

                  If this parameter is not passed during resource creation, "0" will be returned, and the resource belongs to the default enterprise project.

                  "0" is not a valid enterprise project ID and cannot be used in the APIs for creating, updating the load balancer, or querying details of the load balancer.

                  This parameter is unsupported. Please do not use it.

                  billing_info

                  +

                  billing_info

                  String

                  +

                  String

                  Provides resource billing information.

                  +

                  Provides resource billing information.

                  This parameter is unsupported. Please do not use it.

                  Minimum: 1

                  Maximum: 1024

                  l4_flavor_id

                  +

                  l4_flavor_id

                  String

                  +

                  String

                  Specifies the ID of a flavor at Layer 4.

                  +

                  Specifies the ID of a flavor at Layer 4.

                  Minimum: 1

                  Maximum: 255

                  l4_scale_flavor_id

                  +

                  l4_scale_flavor_id

                  String

                  +

                  String

                  Specifies the ID of the reserved flavor at Layer 4.

                  +

                  Specifies the ID of the reserved flavor at Layer 4.

                  This parameter is unsupported. Please do not use it.

                  Minimum: 1

                  Maximum: 255

                  l7_flavor_id

                  +

                  l7_flavor_id

                  String

                  +

                  String

                  Specifies the ID of a flavor at Layer 7.

                  +

                  Specifies the ID of a flavor at Layer 7.

                  Minimum: 1

                  Maximum: 255

                  l7_scale_flavor_id

                  +

                  l7_scale_flavor_id

                  String

                  +

                  String

                  Specifies the ID of the reserved flavor at Layer 7.

                  +

                  Specifies the ID of the reserved flavor at Layer 7.

                  This parameter is unsupported. Please do not use it.

                  Minimum: 1

                  Maximum: 255

                  publicips

                  +

                  publicips

                  Array of PublicIpInfo objects

                  +

                  Array of PublicIpInfo objects

                  Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                  +

                  Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                  This parameter has the same meaning as eips.

                  elb_virsubnet_ids

                  +

                  elb_virsubnet_ids

                  Array of strings

                  +

                  Array of strings

                  Lists the IDs of subnets on the downstream plane.

                  +

                  Lists the IDs of subnets on the downstream plane.

                  elb_virsubnet_type

                  +

                  elb_virsubnet_type

                  String

                  +

                  String

                  Specifies the type of the subnet on the downstream plane.

                  +

                  Specifies the type of the subnet on the downstream plane.

                  • ipv4: IPv4 subnet

                  • dualstack: subnet that supports IPv4/IPv6 dual stack

                  "dualstack" is not supported.

                  ip_target_enable

                  +

                  ip_target_enable

                  Boolean

                  +

                  Boolean

                  Specifies whether to enable IP as a Backend Server.

                  +

                  Specifies whether to enable IP as a Backend Server.

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

                  This function is supported only by dedicated load balancers.

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

                  The value can only be update to true.

                  frozen_scene

                  +

                  frozen_scene

                  String

                  +

                  String

                  Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,).

                  +

                  Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,).

                  This parameter is unsupported. Please do not use it.

                  ipv6_bandwidth

                  +

                  ipv6_bandwidth

                  BandwidthRef object

                  +

                  BandwidthRef object

                  Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

                  +

                  Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

                  deletion_protection_enable

                  +

                  deletion_protection_enable

                  Boolean

                  +

                  Boolean

                  Specifies whether deletion protection is enabled.

                  +

                  Specifies whether deletion protection is enabled.

                  • false: Deletion protection is not enabled.

                  • true: Deletion protection is enabled.

                  @@ -750,18 +766,18 @@

                  This parameter is returned only when deletion protection is enabled at the site.

                  public_border_group

                  +

                  public_border_group

                  String

                  +

                  String

                  Specifies the AZ group to which the load balancer belongs.

                  +

                  Specifies the AZ group to which the load balancer belongs.

                  waf_failure_action

                  +

                  waf_failure_action

                  String

                  +

                  String

                  Specifies traffic distributing policies when the WAF is faulty.

                  +

                  Specifies traffic distributing policies when the WAF is faulty.

                  • discard: Traffic will not be distributed.

                  • forward: Traffic will be distributed to the default backend servers.

                  @@ -769,70 +785,81 @@

                  This parameter is unsupported. Please do not use it.

                  -
                  - -
                  - - - - - - -
                  Table 6 PoolRef

                  Parameter

                  -

                  Type

                  -

                  Description

                  -

                  id

                  +

                  charge_mode

                  String

                  +

                  String

                  Specifies the ID of the backend server group.

                  +

                  Specifies the charge mode when creating a load balancer.

                  +

                  Value options:

                  +
                  • flavor: billed by the fixed specification you select.

                    +
                  • lcu: billed by how many LCUs you have used.

                    +
                  -
                  Table 7 ListenerRef

                  Parameter

                  +
                  - - - - -
                  Table 6 PoolRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the listener ID.

                  +

                  Specifies the ID of the backend server group.

                  -
                  Table 8 Tag

                  Parameter

                  +
                  - - - - - + + +
                  Table 7 ListenerRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  key

                  +

                  id

                  String

                  +

                  String

                  Specifies the tag key.

                  +

                  Specifies the listener ID.

                  +
                  +
                  + +
                  + + + + + + + - - - @@ -841,118 +868,118 @@
                  Table 8 Tag

                  Parameter

                  +

                  Type

                  +

                  Description

                  +

                  key

                  +

                  String

                  +

                  Specifies the tag key.

                  Minimum: 1

                  Maximum: 36

                  value

                  +

                  value

                  String

                  +

                  String

                  Specifies the tag value.

                  +

                  Specifies the tag value.

                  Minimum: 0

                  Maximum: 43

                  -
                  Table 9 EipInfo

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 9 EipInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  eip_id

                  +

                  eip_id

                  String

                  +

                  String

                  eip_id

                  +

                  eip_id

                  eip_address

                  +

                  eip_address

                  String

                  +

                  String

                  eip_address

                  +

                  eip_address

                  ip_version

                  +

                  ip_version

                  Integer

                  +

                  Integer

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

                  +

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

                  -
                  Table 10 PublicIpInfo

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 10 PublicIpInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  publicip_id

                  +

                  publicip_id

                  String

                  +

                  String

                  Specifies the EIP ID.

                  +

                  Specifies the EIP ID.

                  publicip_address

                  +

                  publicip_address

                  String

                  +

                  String

                  Specifies the IP address.

                  +

                  Specifies the IP address.

                  ip_version

                  +

                  ip_version

                  Integer

                  +

                  Integer

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

                  +

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

                  -
                  Table 11 BandwidthRef

                  Parameter

                  +
                  - - - - -
                  Table 11 BandwidthRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the shared bandwidth ID.

                  +

                  Specifies the shared bandwidth ID.

                  -
                  Table 12 PageInfo

                  Parameter

                  +
                  - - - - - - - - - - - diff --git a/docs/elb/api-ref/ListLogtanks.html b/docs/elb/api-ref/ListLogtanks.html index 8cd9017ee..21bf5be81 100644 --- a/docs/elb/api-ref/ListLogtanks.html +++ b/docs/elb/api-ref/ListLogtanks.html @@ -1,7 +1,7 @@

                  Querying Logs

                  -

                  Function

                  This API is used to query logs.

                  +

                  Function

                  This API is used to query logs.

                  Constraints

                  This API has the following constraints:

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

                    @@ -89,7 +89,7 @@
                  - - - - -
                  Table 12 PageInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  previous_marker

                  +

                  previous_marker

                  String

                  +

                  String

                  Specifies the ID of the first record in the pagination query result.

                  +

                  Specifies the ID of the first record in the pagination query result.

                  next_marker

                  +

                  next_marker

                  String

                  +

                  String

                  Specifies the ID of the last record in the pagination query result.

                  +

                  Specifies the ID of the last record in the pagination query result.

                  current_count

                  +

                  current_count

                  Integer

                  +

                  Integer

                  Specifies the number of records.

                  +

                  Specifies the number of records.

                  No

                  Array

                  +

                  Array of strings

                  Specifies the enterprise project ID.

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

                  @@ -100,7 +100,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of the log tank.

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

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

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of a load balancer.

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

                  @@ -120,7 +120,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the log group ID.

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

                  @@ -130,7 +130,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the log topic ID.

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

                  @@ -166,113 +166,113 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 4 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  logtanks

                  +

                  logtanks

                  Array of Logtank objects

                  +

                  Array of Logtank objects

                  Provides supplementary information.

                  +

                  Provides supplementary information.

                  page_info

                  +

                  page_info

                  PageInfo object

                  +

                  PageInfo object

                  Specifies pagination information about the load balancer.

                  +

                  Specifies pagination information about the load balancer.

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  -
                  Table 5 Logtank

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - -
                  Table 5 Logtank

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the log ID.

                  +

                  Specifies the log ID.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the ID of a load balancer.

                  +

                  Specifies the ID of a load balancer.

                  loadbalancer_id

                  +

                  loadbalancer_id

                  String

                  +

                  String

                  Specifies the ID of a load balancer.

                  +

                  Specifies the ID of a load balancer.

                  log_group_id

                  +

                  log_group_id

                  String

                  +

                  String

                  Specifies the log group ID.

                  +

                  Specifies the log group ID.

                  log_topic_id

                  +

                  log_topic_id

                  String

                  +

                  String

                  Specifies the log topic ID.

                  +

                  Specifies the log topic ID.

                  -
                  Table 6 PageInfo

                  Parameter

                  +
                  - - - - - - - - - - - diff --git a/docs/elb/api-ref/ListMembers.html b/docs/elb/api-ref/ListMembers.html index a50811d6b..6bc347d02 100644 --- a/docs/elb/api-ref/ListMembers.html +++ b/docs/elb/api-ref/ListMembers.html @@ -1,7 +1,7 @@

                  Querying Backend Servers

                  -

                  Function

                  This API is used to query all backend servers.

                  +

                  Function

                  This API is used to query all backend servers.

                  Constraints

                  This API has the following constraints:

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

                    @@ -98,7 +98,7 @@
                  - - - - - - - - - @@ -206,11 +206,12 @@ - @@ -218,7 +219,7 @@ -
                  Table 6 PageInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  previous_marker

                  +

                  previous_marker

                  String

                  +

                  String

                  Specifies the ID of the first record in the pagination query result.

                  +

                  Specifies the ID of the first record in the pagination query result.

                  next_marker

                  +

                  next_marker

                  String

                  +

                  String

                  Specifies the ID of the last record in the pagination query result.

                  +

                  Specifies the ID of the last record in the pagination query result.

                  current_count

                  +

                  current_count

                  Integer

                  +

                  Integer

                  Specifies the number of records.

                  +

                  Specifies the number of records.

                  No

                  Array

                  +

                  Array of strings

                  Specifies the backend server name.

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

                  @@ -108,7 +108,7 @@

                  No

                  Array

                  +

                  Array of integers

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

                  The value ranges from 0 to 100. The larger the weight is, the higher proportion of requests the backend server receives. If the weight is set to 0, the backend server will not accept new requests.

                  @@ -129,7 +129,7 @@

                  No

                  Array

                  +

                  Array of strings

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

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

                  @@ -139,7 +139,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the IP address bound to the backend server.

                  Multiple IP addresses can be queried in the format of address=xxx&address=xxx.

                  @@ -149,7 +149,7 @@

                  No

                  Array

                  +

                  Array of integers

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

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

                  @@ -159,7 +159,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the backend server ID.

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

                  @@ -169,7 +169,7 @@

                  No

                  Array

                  +

                  Array of strings

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

                  • ONLINE: The backend server is running normally.

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

                  No

                  Array

                  +

                  Array of strings

                  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.

                    @@ -197,7 +197,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6).

                  No

                  Array

                  +

                  Array of strings

                  Specifies the type of the backend server. Values:

                  • ip: IP as Backend servers

                    -
                  • instance: ECSs used as backend servers Multiple values can be queried in the format of member_type=xxx&member_type=xxx.

                    +
                  • instance: ECSs used as backend servers

                    +

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

                  No

                  Array

                  +

                  Array of strings

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

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

                  @@ -254,248 +255,248 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 4 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  page_info

                  +

                  page_info

                  PageInfo object

                  +

                  PageInfo object

                  Shows pagination information.

                  +

                  Shows pagination information.

                  members

                  +

                  members

                  Array of Member objects

                  +

                  Array of Member objects

                  Lists the backend servers.

                  +

                  Lists the backend servers.

                  -
                  Table 5 PageInfo

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  previous_marker

                  +

                  previous_marker

                  String

                  +

                  String

                  Specifies the ID of the first record in the pagination query result.

                  +

                  Specifies the ID of the first record in the pagination query result.

                  next_marker

                  +

                  next_marker

                  String

                  +

                  String

                  Specifies the ID of the last record in the pagination query result.

                  +

                  Specifies the ID of the last record in the pagination query result.

                  current_count

                  +

                  current_count

                  Integer

                  +

                  Integer

                  Specifies the number of records.

                  +

                  Specifies the number of records.

                  -
                  Table 6 Member

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the backend server ID.

                  +

                  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

                  +

                  name

                  String

                  +

                  String

                  Specifies the backend server name.

                  +

                  Specifies the backend server name.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID of the backend server.

                  +

                  Specifies the project ID of the backend server.

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

                  Specifies the administrative status of the backend server. The value can be true or false.

                  +

                  Specifies the administrative status of the backend server. The value can be true or false.

                  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.

                  subnet_cidr_id

                  +

                  subnet_cidr_id

                  String

                  +

                  String

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

                  +

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

                  This parameter can be left blank, indicating that IP as a Backend Server has been enabled for the load balancer. In this case, IP addresses of these servers must be IPv4 addresses, and the protocol of the backend server group must be TCP, HTTP, or HTTPS.

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

                  protocol_port

                  +

                  protocol_port

                  Integer

                  +

                  Integer

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

                  +

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

                  Minimum: 1

                  Maximum: 65535

                  weight

                  +

                  weight

                  Integer

                  +

                  Integer

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

                  +

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

                  The value ranges from 0 to 100, and the default value is 1. The larger the weight is, the higher proportion of requests the backend server receives. If the weight is set to 0, the backend server will not accept new requests.

                  If lb_algorithm is set to SOURCE_IP, this parameter will not take effect.

                  Minimum: 0

                  Maximum: 100

                  address

                  +

                  address

                  String

                  +

                  String

                  Specifies the private IP address bound to the backend server.

                  +

                  Specifies the private IP address bound to the backend server.

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

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

                  ip_version

                  +

                  ip_version

                  String

                  +

                  String

                  Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6), depending on the value of address returned by the system.

                  +

                  Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6), depending on the value of address returned by the system.

                  operating_status

                  +

                  operating_status

                  String

                  +

                  String

                  Specifies the health status of the backend server if listener_id under status is not specified. The value can be one of the following:

                  +

                  Specifies the health status of the backend server if listener_id under status is not specified. 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.

                  status

                  +

                  status

                  Array of MemberStatus objects

                  +

                  Array of MemberStatus objects

                  Specifies the health status of the backend server if listener_id is specified.

                  +

                  Specifies the health status of the backend server if listener_id is specified.

                  loadbalancer_id

                  +

                  loadbalancer_id

                  String

                  +

                  String

                  Specifies the ID of the load balancer with which the backend server is associated.

                  +

                  Specifies the ID of the load balancer with which the backend server is associated.

                  This parameter is unsupported. Please do not use it.

                  loadbalancers

                  +

                  loadbalancers

                  Array of ResourceID objects

                  +

                  Array of ResourceID objects

                  Specifies the IDs of the load balancers associated with the backend server.

                  +

                  Specifies the IDs of the load balancers associated with the backend server.

                  This parameter is unsupported. Please do not use it.

                  created_at

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when a backend server was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when a backend server was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when a backend server was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when a backend server was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  member_type

                  +

                  member_type

                  String

                  +

                  String

                  Specifies the type of the backend server. Values:

                  +

                  Specifies the type of the backend server. Values:

                  • ip: IP as Backend servers

                  • instance: ECSs used as backend servers

                  instance_id

                  +

                  instance_id

                  String

                  +

                  String

                  Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address.

                  +

                  Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address.

                  -
                  Table 7 MemberStatus

                  Parameter

                  +
                  - - - - - - - -
                  Table 7 MemberStatus

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  listener_id

                  +

                  listener_id

                  String

                  +

                  String

                  Specifies the listener ID.

                  +

                  Specifies the listener ID.

                  operating_status

                  +

                  operating_status

                  String

                  +

                  String

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

                  +

                  Specifies the health 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.

                    @@ -506,19 +507,19 @@
                  -
                  Table 8 ResourceID

                  Parameter

                  +
                  - - - - - diff --git a/docs/elb/api-ref/ListPools.html b/docs/elb/api-ref/ListPools.html index a3c787ef0..c6ad88c41 100644 --- a/docs/elb/api-ref/ListPools.html +++ b/docs/elb/api-ref/ListPools.html @@ -1,7 +1,7 @@

                  Querying Backend Server Groups

                  -

                  Function

                  This API is used to query all backend server groups.

                  +

                  Function

                  This API is used to query all backend server groups.

                  Constraints

                  This API has the following constraints:

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

                    @@ -89,7 +89,7 @@
                  - - - - - - - - - - - - - - - @@ -260,7 +261,7 @@ -
                  Table 8 ResourceID

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the resource ID.

                  +

                  Specifies the resource ID.

                  No

                  Array

                  +

                  Array of strings

                  Provides supplementary information about the backend server group.

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

                  @@ -109,7 +109,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -119,7 +119,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of the backend server group.

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

                  @@ -129,7 +129,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the backend server group name.

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

                  @@ -139,7 +139,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of the load balancer with which the backend server group is associated.

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

                  @@ -149,7 +149,7 @@

                  No

                  Array

                  +

                  Array of strings

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

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

                  @@ -159,7 +159,7 @@

                  No

                  Array

                  +

                  Array of strings

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

                  The value can be one of the following:

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

                  No

                  Array

                  +

                  Array of strings

                  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.

                    @@ -189,7 +189,7 @@

                  No

                  Array

                  +

                  Array of strings

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

                  Multiple versions can be queried in the format of ip_version=xxx&ip_version=xxx.

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

                  No

                  Array

                  +

                  Array of strings

                  Specifies the private IP address bound to the backend server. This is a query parameter and will not be included in the response.

                  Multiple IP addresses can be queried in the format of member_address=xxx&member_address=xxx.

                  @@ -209,7 +209,7 @@

                  No

                  Array

                  +

                  Array of strings

                  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.

                  @@ -232,7 +232,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the IDs of the associated listeners, including the listeners associated through forwarding policies.

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

                  @@ -242,16 +242,17 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the backend server ID. 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_instance_id=xxx&member_instance_id=xxx.

                  +

                  Specifies the backend server ID. 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_instance_id=xxx&member_instance_id=xxx.

                  vpc_id

                  No

                  Array

                  +

                  Array of strings

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

                  No

                  Array

                  +

                  Array of strings

                  Specifies the type of the backend server group.

                  Values:

                  @@ -300,114 +301,114 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 4 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  page_info

                  +

                  page_info

                  PageInfo object

                  +

                  PageInfo object

                  Shows pagination information.

                  +

                  Shows pagination information.

                  pools

                  +

                  pools

                  Array of Pool objects

                  +

                  Array of Pool objects

                  Lists the backend server groups.

                  +

                  Lists the backend server groups.

                  -
                  Table 5 PageInfo

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  previous_marker

                  +

                  previous_marker

                  String

                  +

                  String

                  Specifies the ID of the first record in the pagination query result.

                  +

                  Specifies the ID of the first record in the pagination query result.

                  next_marker

                  +

                  next_marker

                  String

                  +

                  String

                  Specifies the ID of the last record in the pagination query result.

                  +

                  Specifies the ID of the last record in the pagination query result.

                  current_count

                  +

                  current_count

                  Integer

                  +

                  Integer

                  Specifies the number of records.

                  +

                  Specifies the number of records.

                  -
                  Table 6 Pool

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 6 Pool

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

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

                  +

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

                  This parameter is unsupported. Please do not use it.

                  description

                  +

                  description

                  String

                  +

                  String

                  Provides supplementary information about the backend server group.

                  +

                  Provides supplementary information about the backend server group.

                  healthmonitor_id

                  +

                  healthmonitor_id

                  String

                  +

                  String

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

                  +

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

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the backend server group ID.

                  +

                  Specifies the backend server group ID.

                  lb_algorithm

                  +

                  lb_algorithm

                  String

                  +

                  String

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

                  +

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

                  The value can be one of the following:

                  • ROUND_ROBIN: weighted round robin

                  • LEAST_CONNECTIONS: weighted least connections

                    @@ -420,46 +421,46 @@

                  listeners

                  +

                  listeners

                  Array of ListenerRef objects

                  +

                  Array of ListenerRef objects

                  Specifies the IDs of the listeners with which the backend server group is associated.

                  +

                  Specifies the IDs of the listeners with which the backend server group is associated.

                  loadbalancers

                  +

                  loadbalancers

                  Array of LoadBalancerRef objects

                  +

                  Array of LoadBalancerRef objects

                  Specifies the IDs of the load balancers with which the backend server group is associated.

                  +

                  Specifies the IDs of the load balancers with which the backend server group is associated.

                  members

                  +

                  members

                  Array of MemberRef objects

                  +

                  Array of MemberRef objects

                  Specifies the IDs of the backend servers in the backend server group.

                  +

                  Specifies the IDs of the backend servers in the backend server group.

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the backend server group name.

                  +

                  Specifies the backend server group name.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  protocol

                  +

                  protocol

                  String

                  +

                  String

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

                  +

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

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

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

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

                    @@ -469,34 +470,34 @@

                  session_persistence

                  +

                  session_persistence

                  SessionPersistence object

                  +

                  SessionPersistence object

                  Specifies the sticky session.

                  +

                  Specifies the sticky session.

                  ip_version

                  +

                  ip_version

                  String

                  +

                  String

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

                  +

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

                  IPv6 is unsupported. Only v4 will be returned.

                  slow_start

                  +

                  slow_start

                  SlowStart object

                  +

                  SlowStart object

                  Specifies slow start details. 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.

                  +

                  Specifies slow start details. 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.

                  member_deletion_protection_enable

                  +

                  member_deletion_protection_enable

                  Boolean

                  +

                  Boolean

                  Specifies whether to enable removal protection.

                  +

                  Specifies whether to enable removal protection.

                  • true: Enable removal protection.

                  • false: Disable removal protection.

                  @@ -504,34 +505,34 @@

                  created_at

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when a backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when a backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when when a backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when when a backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  vpc_id

                  +

                  vpc_id

                  String

                  +

                  String

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

                  +

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

                  type

                  +

                  type

                  String

                  +

                  String

                  Specifies the type of the backend server group.

                  +

                  Specifies the type of the backend server group.

                  Values:

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

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

                    @@ -543,94 +544,97 @@
                  -
                  Table 7 ListenerRef

                  Parameter

                  +
                  - - - - -
                  Table 7 ListenerRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the listener ID.

                  +

                  Specifies the listener ID.

                  -
                  Table 8 LoadBalancerRef

                  Parameter

                  +
                  - - - - -
                  Table 8 LoadBalancerRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the load balancer ID.

                  +

                  Specifies the load balancer ID.

                  -
                  Table 9 MemberRef

                  Parameter

                  +
                  - - - - -
                  Table 9 MemberRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the backend server ID.

                  +

                  Specifies the backend server ID.

                  -
                  Table 10 SessionPersistence

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 10 SessionPersistence

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  cookie_name

                  +

                  cookie_name

                  String

                  +

                  String

                  Specifies the cookie name. The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.). Note: This parameter will take effect only when type is set to APP_COOKIE.

                  +

                  Specifies the cookie name.

                  +

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

                  +

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

                  type

                  +

                  type

                  String

                  +

                  String

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

                  +

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

                  +

                  Note:

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

                  • If the backend server group protocol is QUIC, sticky session must be enabled with type set to SOURCE_IP.

                  persistence_timeout

                  +

                  persistence_timeout

                  Integer

                  +

                  Integer

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

                  +

                  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, UDP, or QUIC, 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.

                  @@ -640,30 +644,30 @@
                  -
                  Table 11 SlowStart

                  Parameter

                  +
                  - - - - - - - - - - @@ -81,74 +81,78 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 11 SlowStart

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  enable

                  +

                  enable

                  Boolean

                  +

                  Boolean

                  Specifies whether to enable slow start.

                  +

                  Specifies whether to enable slow start.

                  • true: Enable slow start.

                  • false: Disable slow start.

                  Default: false

                  duration

                  +

                  duration

                  Integer

                  +

                  Integer

                  Specifies the slow start duration, in seconds.

                  +

                  Specifies the slow start duration, in seconds.

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

                  Minimum: 30

                  Maximum: 1200

                  diff --git a/docs/elb/api-ref/ListQuotaDetails.html b/docs/elb/api-ref/ListQuotaDetails.html index 711f053c5..8e4c27b8e 100644 --- a/docs/elb/api-ref/ListQuotaDetails.html +++ b/docs/elb/api-ref/ListQuotaDetails.html @@ -1,7 +1,7 @@

                  Querying Quota Usage

                  -

                  Function

                  This API is used to query the current quotas and used quotas of resources related to a dedicated load balancer in a specific project.

                  +

                  Function

                  This API is used to query the current quotas and used quotas of resources related to a dedicated load balancer in a specific project.

                  URI

                  GET /v3/{project_id}/elb/quotas/details

                  @@ -42,12 +42,12 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the resource type. The value can be loadbalancer, listener, ipgroup, pool, member, healthmonitor, l7policy, certificate,** security_policy**,members_per_pool, ipgroup_bindings, or ipgroup_max_length.

                  +

                  Specifies the resource type. The value can be loadbalancer, listener, ipgroup, pool, member, healthmonitor, l7policy, certificate, security_policy, members_per_pool, ipgroup_bindings, ipgroup_max_length, ipgroups_per_listener, free_instance_listeners_per_loadbalancer, free_instance_members_per_pool, listeners_per_loadbalancer, listeners_per_pool, pools_per_l7policy, l7policies_per_listener, or condition_per_policy.

                  members_per_pool indicates the maximum number of backend servers that can be added to a backend server group.

                  -

                  ipgroup_bindings indicates the maximum number of listeners that can be bound to a ipgroup.

                  -

                  ipgroup_max_length indicates the maximum number of ip addresses that can be added to a ipgroup.

                  +

                  ipgroup_bindings indicates the maximum number of listeners that can be associated with an IP address group.

                  +

                  ipgroup_max_length indicates the maximum number of IP addresses that can be added to an IP address group.

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

                  Table 4 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  quotas

                  +

                  quotas

                  Array of QuotaInfo objects

                  +

                  Array of QuotaInfo objects

                  Specifies the resource quotas.

                  +

                  Specifies the resource quotas.

                  -
                  Table 5 QuotaInfo

                  Parameter

                  +
                  - - - - - - - - - - - - - - @@ -207,6 +211,11 @@ "used" : 2, "quota_limit" : 50, "unit" : "count" + }, { + "quota_key" : "ipgroups_per_listener", + "used" : 2, + "quota_limit" : 50, + "unit" : "count" }, { "quota_key" : "member", "used" : 3022, @@ -232,6 +241,31 @@ "used" : 100, "quota_limit" : -1, "unit" : "count" + }, { + "quota_key" : "free_instance_listeners_per_loadbalancer", + "used" : 148, + "quota_limit" : 2000, + "unit" : "count" + }, { + "quota_key" : "free_instance_members_per_pool", + "used" : 762, + "quota_limit" : -1, + "unit" : "count" + }, { + "quota_key" : "listeners_per_loadbalancer", + "used" : 100, + "quota_limit" : -1, + "unit" : "count" + }, { + "quota_key" : "pools_per_l7policy", + "used" : 100, + "quota_limit" : -1, + "unit" : "count" + }, { + "quota_key" : "l7policies_per_listener", + "used" : 100, + "quota_limit" : -1, + "unit" : "count" } ] } diff --git a/docs/elb/api-ref/ListSecurityPolicies.html b/docs/elb/api-ref/ListSecurityPolicies.html index 6e06db53f..e06b51c69 100644 --- a/docs/elb/api-ref/ListSecurityPolicies.html +++ b/docs/elb/api-ref/ListSecurityPolicies.html @@ -1,7 +1,7 @@

                  Querying Custom Security Policies

                  -

                  Function

                  This API is used to query custom security policies.

                  +

                  Function

                  This API is used to query custom security policies.

                  Constraints

                  This API has the following constraints:

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

                    @@ -89,7 +89,7 @@
                  - - - - -
                  Table 5 QuotaInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  quota_key

                  +

                  quota_key

                  String

                  +

                  String

                  Specifies the resource type. The value can be loadbalancer, listener, listeners_per_pool, ipgroup, pool, member, members_per_pool, healthmonitor, l7policy, condition_per_policy, certificate, security_policy, ipgroup_bindings, or ipgroup_max_length.

                  -

                  listeners_per_pool indicates the maximum number of listeners that can be related to a backend server group.

                  +

                  Specifies the resource type. The value can be loadbalancer, listener, listeners_per_pool, ipgroup, ipgroup_bindings, ipgroup_max_length, ipgroups_per_listener, pool, member, members_per_pool, healthmonitor, l7policy, condition_per_policy, certificate, security_policy, free_instance_listeners_per_loadbalancer, free_instance_members_per_pool, listeners_per_loadbalancer, listeners_per_pool, pools_per_l7policy, or l7policies_per_listener.

                  +

                  listeners_per_pool indicates the maximum number of listeners that can be associated with a backend server group.

                  members_per_pool indicates the maximum number of backend servers that can be added to a backend server group.

                  -

                  ipgroup_bindings indicates the maximum number of listeners that can be bound to a ipgroup.

                  -

                  ipgroup_max_length indicates the maximum number of ip addresses that can be added to a ipgroup.

                  -

                  condition_per_policy indicates the maximum number of conditions that can be added to a l7policy.

                  +

                  ipgroup_bindings indicates the maximum number of listeners that can be associated with an IP address group.

                  +

                  ipgroup_max_length indicates the maximum number of IP addresses that can be added to an IP address group.

                  +

                  condition_per_policy indicates the maximum number of conditions that can be added to a forwarding policy.

                  +

                  ipgroups_per_listener indicates the maximum number of IP address group that can be associated with a listener.

                  +

                  l7policies_per_listener indicates the maximum number of forwarding policies that can be associated with a listener.

                  quota_limit

                  +

                  quota_limit

                  Integer

                  +

                  Integer

                  Specifies the total quota. Values:

                  +

                  Specifies the total quota.

                  +

                  Values:

                  • If the value is greater than or equal to 0, it indicates the current quota.

                  • -1 indicates that the quota is not limited.

                  used

                  +

                  used

                  Integer

                  +

                  Integer

                  Specifies the used quota.

                  +

                  Specifies the used quota.

                  unit

                  +

                  unit

                  String

                  +

                  String

                  Specifies the quota unit. The value can only be count.

                  +

                  Specifies the quota unit.

                  +

                  The value can only be count.

                  No

                  Array

                  +

                  Array of strings

                  Specifies the ID of the custom security policy.

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

                  @@ -99,7 +99,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the name of the custom security policy.

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

                  @@ -109,7 +109,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Provides supplementary information about the custom security policy.

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

                  @@ -119,7 +119,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the TLS protocols supported by the custom security policy. (Multiple protocols are separated using spaces.)

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

                  @@ -129,7 +129,7 @@

                  No

                  Array

                  +

                  Array of strings

                  Specifies the cipher suites supported by the custom security policy. (Multiple cipher suites are separated using colons.)

                  Multiple cipher suites can be queried in the format of ciphers=xxx&ciphers=xxx.

                  @@ -165,160 +165,160 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 4 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  security_policies

                  +

                  security_policies

                  Array of SecurityPolicy objects

                  +

                  Array of SecurityPolicy objects

                  Lists the security policies.

                  +

                  Lists the security policies.

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  page_info

                  +

                  page_info

                  PageInfo object

                  +

                  PageInfo object

                  Shows pagination information.

                  +

                  Shows pagination information.

                  -
                  Table 5 SecurityPolicy

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 5 SecurityPolicy

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the ID of the custom security policy.

                  +

                  Specifies the ID of the custom security policy.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID of the custom security policy.

                  +

                  Specifies the project ID of the custom security policy.

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the name of the custom security policy.

                  +

                  Specifies the name of the custom security policy.

                  description

                  +

                  description

                  String

                  +

                  String

                  Provides supplementary information about the custom security policy.

                  +

                  Provides supplementary information about the custom security policy.

                  listeners

                  +

                  listeners

                  Array of ListenerRef objects

                  +

                  Array of ListenerRef objects

                  Specifies the listeners that use the custom security policies.

                  +

                  Specifies the listeners that use the custom security policies.

                  protocols

                  +

                  protocols

                  Array of strings

                  +

                  Array of strings

                  Lists the TLS protocols supported by the custom security policy.

                  +

                  Lists the TLS protocols supported by the custom security policy.

                  ciphers

                  +

                  ciphers

                  Array of strings

                  +

                  Array of strings

                  Lists the cipher suites supported by the custom security policy.

                  +

                  Lists the cipher suites supported by the custom security policy.

                  created_at

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when the custom security policy was created.

                  +

                  Specifies the time when the custom security policy was created.

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when the custom security policy was updated.

                  +

                  Specifies the time when the custom security policy was updated.

                  -
                  Table 6 ListenerRef

                  Parameter

                  +
                  - - - - -
                  Table 6 ListenerRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the listener ID.

                  +

                  Specifies the listener ID.

                  -
                  Table 7 PageInfo

                  Parameter

                  +
                  - - - - - - - - - - - diff --git a/docs/elb/api-ref/ListSystemSecurityPolicies.html b/docs/elb/api-ref/ListSystemSecurityPolicies.html index d54cbf20c..107aabfec 100644 --- a/docs/elb/api-ref/ListSystemSecurityPolicies.html +++ b/docs/elb/api-ref/ListSystemSecurityPolicies.html @@ -1,7 +1,7 @@

                  Querying System Security Policies

                  -

                  Function

                  This API is used to query system security policies.

                  +

                  Function

                  This API is used to query system security policies.

                  System security policies are available to all users and cannot be created or modified.

                  URI

                  GET /v3/{project_id}/elb/system-security-policies

                  @@ -55,66 +55,66 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 7 PageInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  previous_marker

                  +

                  previous_marker

                  String

                  +

                  String

                  Specifies the ID of the first record in the pagination query result.

                  +

                  Specifies the ID of the first record in the pagination query result.

                  next_marker

                  +

                  next_marker

                  String

                  +

                  String

                  Specifies the ID of the last record in the pagination query result.

                  +

                  Specifies the ID of the last record in the pagination query result.

                  current_count

                  +

                  current_count

                  Integer

                  +

                  Integer

                  Specifies the number of records.

                  +

                  Specifies the number of records.

                  Table 3 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  system_security_policies

                  +

                  system_security_policies

                  Array of SystemSecurityPolicy objects

                  +

                  Array of SystemSecurityPolicy objects

                  Lists system security policies.

                  +

                  Lists system security policies.

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  -
                  Table 4 SystemSecurityPolicy

                  Parameter

                  +
                  - - - - - - - - - - - - - - diff --git a/docs/elb/api-ref/ShowCertificate.html b/docs/elb/api-ref/ShowCertificate.html index 1699c28e9..038a57573 100644 --- a/docs/elb/api-ref/ShowCertificate.html +++ b/docs/elb/api-ref/ShowCertificate.html @@ -1,205 +1,213 @@

                  Viewing Details of a Certificate

                  -

                  Function

                  This API is used to view details of an SSL certificate.

                  +

                  Function

                  This API is used to view details of an SSL certificate.

                  -

                  URI

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

                  +

                  URI

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

                  -
                  Table 4 SystemSecurityPolicy

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the name of the system security policy.

                  +

                  Specifies the name of the system security policy.

                  protocols

                  +

                  protocols

                  String

                  +

                  String

                  Lists the TLS protocols supported by the system security policy.

                  +

                  Lists the TLS protocols supported by the system security policy.

                  ciphers

                  +

                  ciphers

                  String

                  +

                  String

                  Lists the cipher suites supported by the system security policy.

                  +

                  Lists the cipher suites supported by the system security policy.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  Table 1 Path Parameters

                  Parameter

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

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  certificate_id

                  +

                  certificate_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies a certificate ID.

                  +

                  Specifies a certificate ID.

                  -

                  Request Parameters

                  -
                  Table 2 Request header parameters

                  Parameter

                  +

                  Request Parameters

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

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  X-Auth-Token

                  +

                  X-Auth-Token

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the token used for IAM authentication.

                  +

                  Specifies the token used for IAM authentication.

                  -

                  Response Parameters

                  Status code: 200

                  +

                  Response Parameters

                  Status code: 200

                  -
                  Table 3 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  certificate

                  +

                  certificate

                  CertificateInfo object

                  +

                  CertificateInfo object

                  Specifies the certificate.

                  +

                  Specifies the certificate.

                  -
                  Table 4 CertificateInfo

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 4 CertificateInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

                  Specifies the administrative status of the certificate.

                  -

                  This parameter is unsupported. Please do not use it.

                  +

                  Specifies the administrative status of the certificate.

                  +

                  This parameter is unsupported. Please do not use it.

                  certificate

                  +

                  certificate

                  String

                  +

                  String

                  Specifies the certificate content. The value must be PEM encoded.

                  +

                  Specifies the certificate content. The value must be PEM encoded.

                  description

                  +

                  description

                  String

                  +

                  String

                  Provides supplementary information about the certificate.

                  -

                  Minimum: 1

                  -

                  Maximum: 255

                  +

                  Provides supplementary information about the certificate.

                  +

                  Minimum: 1

                  +

                  Maximum: 255

                  domain

                  +

                  domain

                  String

                  +

                  String

                  Specifies the domain names used by the server certificate.

                  -

                  Note the following when using domain names:

                  -
                  • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.
                  • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com
                  • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com
                  • This parameter will take effect only when **type** is set to **server**.
                  • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.
                  • SNI certificates of a shared load balancer's listener can have up to 30 domain names.
                  -

                  Minimum: 1

                  -

                  Maximum: 10000

                  +

                  Specifies the domain names used by the server certificate.

                  +

                  Note the following when using domain names:

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

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

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

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

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

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

                    +
                  +

                  Minimum: 1

                  +

                  Maximum: 10000

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the certificate ID.

                  +

                  Specifies the certificate ID.

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the certificate name.

                  -

                  Minimum: 1

                  -

                  Maximum: 255

                  +

                  Specifies the certificate name.

                  +

                  Minimum: 1

                  +

                  Maximum: 255

                  private_key

                  +

                  private_key

                  String

                  +

                  String

                  Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

                  -
                  • This parameter is valid and mandatory only when type is set to server.
                  • This parameter will be ignored even if type is set to client. A CA certificate can still be created and used normally.
                  +

                  Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

                  +
                  • This parameter is valid and mandatory only when type is set to server.

                    +
                  • This parameter will be ignored even if type is set to client. A CA certificate can still be created and used normally.

                    +

                  type

                  +

                  type

                  String

                  +

                  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.

                  +

                  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

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when the certificate was created.

                  +

                  Specifies the time when the certificate was created.

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when the certificate was updated.

                  +

                  Specifies the time when the certificate was updated.

                  expire_time

                  +

                  expire_time

                  String

                  +

                  String

                  Specifies the time when the certificate expires.

                  +

                  Specifies the time when the certificate expires.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID of the certificate.

                  +

                  Specifies the project ID of the certificate.

                  -

                  Example Requests

                  GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/certificates/5494a835d88f40ff940554992f2f04d4
                  +

                  Example Requests

                  GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/certificates/5494a835d88f40ff940554992f2f04d4
                  -

                  Example Responses

                  Status code: 200

                  -

                  Successful request.

                  -
                  {
                  +

                  Example Responses

                  Status code: 200

                  +

                  Successful request.

                  +
                  {
                     "certificate" : {
                       "id" : "5494a835d88f40ff940554992f2f04d4",
                       "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
                  @@ -217,23 +225,23 @@
                     "request_id" : "a94af450-5ac0-4185-946c-27a59a16c1d3"
                   }
                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Successful request.

                  +

                  Successful request.

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/elb/api-ref/ShowFlavor.html b/docs/elb/api-ref/ShowFlavor.html index f8786d86d..7357f50a0 100644 --- a/docs/elb/api-ref/ShowFlavor.html +++ b/docs/elb/api-ref/ShowFlavor.html @@ -1,219 +1,230 @@

                  Viewing Details of a Flavor

                  -

                  Function

                  This API is used to view details of a flavor.

                  +

                  Function

                  This API is used to view details of a flavor.

                  -

                  URI

                  GET /v3/{project_id}/elb/flavors/{flavor_id}

                  +

                  URI

                  GET /v3/{project_id}/elb/flavors/{flavor_id}

                  -
                  Table 1 Path Parameters

                  Parameter

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

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  flavor_id

                  +

                  flavor_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the flavor ID.

                  +

                  Specifies the flavor ID.

                  -

                  Request Parameters

                  -
                  Table 2 Request header parameters

                  Parameter

                  +

                  Request Parameters

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

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  X-Auth-Token

                  +

                  X-Auth-Token

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Specifies the token used for IAM authentication.

                  +

                  Specifies the token used for IAM authentication.

                  -

                  Response Parameters

                  Status code: 200

                  +

                  Response Parameters

                  Status code: 200

                  -
                  Table 3 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  flavor

                  +

                  flavor

                  Flavor object

                  +

                  Flavor object

                  Specifies the flavor.

                  +

                  Specifies the flavor.

                  -
                  Table 4 Flavor

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - -
                  Table 4 Flavor

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the flavor ID.

                  +

                  Specifies the flavor ID.

                  info

                  +

                  info

                  FlavorInfo object

                  +

                  FlavorInfo object

                  Specifies the flavor metrics.

                  +

                  Specifies the flavor metrics.

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the flavor name.

                  +

                  Specifies the flavor name.

                  shared

                  +

                  shared

                  Boolean

                  +

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

                  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.

                    +

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  type

                  +

                  type

                  String

                  +

                  String

                  Specifies the flavor type. The value can be one of the following:

                  -
                  • L4: a Layer-4 flavor.
                  • L7: a Layer-7 flavor.
                  -

                  Minimum: 1

                  -

                  Maximum: 32

                  +

                  Specifies the flavor type. The value can be one of the following:

                  +
                  • L4: a Layer-4 flavor.

                    +
                  • L7: a Layer-7 flavor.

                    +
                  • L4_elastic_max: the maximum elastic flavor at Layer 4.

                    +
                  • L7_elastic_max: the maximum elastic flavor at Layer 7.

                    +
                  • L4_elastic indicates minimum elastic flavor at Layer 4. This parameter has been discarded. Please do not use it.

                    +
                  • L7_elastic indicates minimum elastic flavor at Layer 7. This parameter has been discarded. Please do not use it.

                    +
                  +

                  Minimum: 1

                  +

                  Maximum: 32

                  flavor_sold_out

                  +

                  flavor_sold_out

                  Boolean

                  +

                  Boolean

                  Specifies whether the flavor is unavailable.

                  -
                  • true indicates the flavor is unavailable. Load balancers with this flavor cannot be created.
                  • false indicates the flavor is available. Load balancers with this flavor can be created.
                  +

                  Specifies whether the flavor is unavailable.

                  +
                  • true indicates the flavor is unavailable. Load balancers with this flavor cannot be created.

                    +
                  • false indicates the flavor is available. Load balancers with this flavor can be created.

                    +
                  -
                  Table 5 FlavorInfo

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - -
                  Table 5 FlavorInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  connection

                  +

                  connection

                  Integer

                  +

                  Integer

                  Specifies the number of concurrent connections per second.

                  +

                  Specifies the number of concurrent connections per second.

                  cps

                  +

                  cps

                  Integer

                  +

                  Integer

                  Specifies the number of new connections per second.

                  +

                  Specifies the number of new connections per second.

                  qps

                  +

                  qps

                  Integer

                  +

                  Integer

                  Specifies the number of requests per second. This parameter is available only for load balancers at Layer 7.

                  +

                  Specifies the number of requests per second. This parameter is available only for load balancers at Layer 7.

                  bandwidth

                  +

                  bandwidth

                  Integer

                  +

                  Integer

                  Specifies the bandwidth.

                  +

                  Specifies the bandwidth.

                  lcu

                  +

                  lcu

                  Integer

                  +

                  Integer

                  Specifies the number of LCUs in the flavor. An LCU measures the dimensions on which a dedicated load balancer routes the traffic. The higher value indicates better perfromance.

                  +

                  Specifies the number of LCUs in the flavor.

                  +

                  An LCU measures the dimensions on which a dedicated load balancer routes the traffic. The higher value indicates better performance.

                  https_cps

                  +

                  https_cps

                  Integer

                  +

                  Integer

                  Specifies the number of new HTTPS connections. This parameter is available only for load balancers at Layer 7.

                  +

                  Specifies the number of new HTTPS connections. This parameter is available only for load balancers at Layer 7.

                  -

                  Example Requests

                  GET https://{ELB_Endpoint}/v3/{project_id}/elb/flavors/{flavor_id}
                  +

                  Example Requests

                  GET https://{ELB_Endpoint}/v3/{project_id}/elb/flavors/{flavor_id}
                  -

                  Example Responses

                  Status code: 200

                  -

                  Successful request.

                  -
                  {
                  +

                  Example Responses

                  Status code: 200

                  +

                  Successful request.

                  +
                  {
                     "flavor" : {
                       "shared" : true,
                       "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee",
                  @@ -232,23 +243,23 @@
                     "request_id" : "3b9fb516-b7bb-4760-9128-4a23dd36ae10"
                   }
                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Successful request.

                  +

                  Successful request.

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/elb/api-ref/ShowHealthMonitor.html b/docs/elb/api-ref/ShowHealthMonitor.html index 474c2df77..27709e0d1 100644 --- a/docs/elb/api-ref/ShowHealthMonitor.html +++ b/docs/elb/api-ref/ShowHealthMonitor.html @@ -1,7 +1,7 @@

                  Viewing Details of a Health Check

                  -

                  Function

                  This API is used to view 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}

                  @@ -63,162 +63,164 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 3 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  healthmonitor

                  +

                  healthmonitor

                  HealthMonitor object

                  +

                  HealthMonitor object

                  Specifies the health check.

                  +

                  Specifies the health check.

                  -
                  Table 4 HealthMonitor

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -255,19 +258,19 @@
                  Table 4 HealthMonitor

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

                  Specifies the administrative status of the health check.

                  +

                  Specifies the administrative status of the health check.

                  • true(default) indicates that the health check is enabled.

                  • false indicates that the health check is disabled.

                  delay

                  +

                  delay

                  Integer

                  +

                  Integer

                  Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

                  +

                  Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

                  Minimum: 1

                  Maximum: 50

                  domain_name

                  +

                  domain_name

                  String

                  +

                  String

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

                  +

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

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

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

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

                  expected_codes

                  +

                  expected_codes

                  String

                  +

                  String

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

                  +

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

                  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

                  -

                  The default value is 200. Multiple status codes can be queried in the format of expected_codes=xxx&expected_codes=xxx.

                  +

                  The default value is 200.

                  +

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

                  http_method

                  +

                  http_method

                  String

                  +

                  String

                  Specifies the HTTP method. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. The default value is GET.

                  +

                  Specifies the HTTP method. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. The default value is GET.

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

                  This parameter is unsupported. Please do not use it.

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the health check ID.

                  +

                  Specifies the health check ID.

                  max_retries

                  +

                  max_retries

                  Integer

                  +

                  Integer

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

                  +

                  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

                  +

                  max_retries_down

                  Integer

                  +

                  Integer

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

                  +

                  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, and the default value is 3.

                  Minimum: 1

                  Maximum: 10

                  monitor_port

                  +

                  monitor_port

                  Integer

                  +

                  Integer

                  Specifies the port used for the health check. If this parameter is left blank, a port of the backend server will be used by default. The port number ranges from 1 to 65535.

                  +

                  Specifies the port used for the health check. If this parameter is left blank, a port of the backend server will be used by default. The port number ranges from 1 to 65535.

                  Minimum: 1

                  Maximum: 65535

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the health check name.

                  +

                  Specifies the health check name.

                  pools

                  +

                  pools

                  Array of PoolRef objects

                  +

                  Array of PoolRef objects

                  Lists the IDs of backend server groups for which the health check is configured. Only one ID will be returned.

                  +

                  Lists the IDs of backend server groups for which the health check is configured. Only one ID will be returned.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  timeout

                  +

                  timeout

                  Integer

                  +

                  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.

                  +

                  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

                  +

                  type

                  String

                  +

                  String

                  Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, or HTTPS.

                  +

                  Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, or HTTPS.

                  Note:

                  • If the protocol of the backend server is QUIC, the value can only be UDP_CONNECT.

                  • If the protocol of the backend server is UDP, the value can only be UDP_CONNECT.

                    @@ -228,26 +230,27 @@

                  url_path

                  +

                  url_path

                  String

                  +

                  String

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

                  +

                  Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.

                  +

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

                  created_at

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  -
                  Table 5 PoolRef

                  Parameter

                  +
                  - - - - - diff --git a/docs/elb/api-ref/ShowIpGroup.html b/docs/elb/api-ref/ShowIpGroup.html index 2b41fc9b7..2fba62efa 100644 --- a/docs/elb/api-ref/ShowIpGroup.html +++ b/docs/elb/api-ref/ShowIpGroup.html @@ -1,7 +1,7 @@

                  Viewing Details of an IP Address Group

                  -

                  Function

                  This API is used to view details of an IP address group.

                  +

                  Function

                  This API is used to view details of an IP address group.

                  URI

                  GET /v3/{project_id}/elb/ipgroups/{ipgroup_id}

                  @@ -63,121 +63,121 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 5 PoolRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the ID of the backend server group.

                  +

                  Specifies the ID of the backend server group.

                  Table 3 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  ipgroup

                  +

                  ipgroup

                  IpGroup object

                  +

                  IpGroup object

                  Specifies the IP address group.

                  +

                  Specifies the IP address group.

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  -
                  Table 4 IpGroup

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 4 IpGroup

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  created_at

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when the IP address group was created.

                  +

                  Specifies the time when the IP address group was created.

                  description

                  +

                  description

                  String

                  +

                  String

                  Specifies the time when the IP address group was updated.

                  +

                  Specifies the time when the IP address group was updated.

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the ID of the IP address group.

                  +

                  Specifies the ID of the IP address group.

                  ip_list

                  +

                  ip_list

                  Array of IpInfo objects

                  +

                  Array of IpInfo objects

                  Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

                  +

                  Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

                  Array Length: 0 - 300

                  listeners

                  +

                  listeners

                  Array of ListenerRef objects

                  +

                  Array of ListenerRef objects

                  Lists the IDs of listeners with which the IP address group is associated.

                  +

                  Lists the IDs of listeners with which the IP address group is associated.

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the IP address group name.

                  +

                  Specifies the IP address group name.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID of the IP address group.

                  +

                  Specifies the project ID of the IP address group.

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when the IP address group was updated.

                  +

                  Specifies the time when the IP address group was updated.

                  -
                  Table 5 IpInfo

                  Parameter

                  +
                  - - - - - - - - @@ -186,19 +186,19 @@
                  Table 5 IpInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  ip

                  +

                  ip

                  String

                  +

                  String

                  Specifies the IP addresses in the IP address group.

                  +

                  Specifies the IP addresses in the IP address group.

                  description

                  +

                  description

                  String

                  +

                  String

                  Provides remarks about the IP address group.

                  +

                  Provides remarks about the IP address group.

                  Minimum: 0

                  Maximum: 255

                  -
                  Table 6 ListenerRef

                  Parameter

                  +
                  - - - - - diff --git a/docs/elb/api-ref/ShowL7Policy.html b/docs/elb/api-ref/ShowL7Policy.html index 976253783..b3f1e0ade 100644 --- a/docs/elb/api-ref/ShowL7Policy.html +++ b/docs/elb/api-ref/ShowL7Policy.html @@ -1,7 +1,7 @@

                  Viewing Details of a Forwarding Policy

                  -

                  Function

                  This API is used to view 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}

                  @@ -63,45 +63,45 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 6 ListenerRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the listener ID.

                  +

                  Specifies the listener ID.

                  Table 3 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  l7policy

                  +

                  l7policy

                  L7Policy object

                  +

                  L7Policy object

                  Specifies the forwarding policy.

                  +

                  Specifies the forwarding policy.

                  -
                  Table 4 L7Policy

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -278,104 +279,105 @@
                  Table 4 L7Policy

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  action

                  +

                  action

                  String

                  +

                  String

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

                  +

                  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_URL: Requests will be redirected to another URL.

                    @@ -114,59 +114,60 @@

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

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

                  +

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

                  This parameter is unsupported. Please do not use it.

                  description

                  +

                  description

                  String

                  +

                  String

                  Provides supplementary information about the forwarding policy.

                  +

                  Provides supplementary information about the forwarding policy.

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the forwarding policy ID.

                  +

                  Specifies the forwarding policy ID.

                  listener_id

                  +

                  listener_id

                  String

                  +

                  String

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

                  +

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

                  name

                  +

                  name

                  String

                  +

                  String

                  Specifies the forwarding policy name.

                  +

                  Specifies the forwarding policy name.

                  Minimum: 1

                  Maximum: 255

                  position

                  +

                  position

                  Integer

                  +

                  Integer

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

                  +

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

                  This parameter is unsupported. Please do not use it.

                  Minimum: 1

                  Maximum: 100

                  priority

                  +

                  priority

                  Integer

                  +

                  Integer

                  Specifies the forwarding policy priority. A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener. This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

                  +

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

                  +

                  This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

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

                  • If enhance_l7policy_enable is not enabled, forwarding policies are automatically prioritized based on the original policy sorting logic. The priorities of domain names are independent from each other. For the same domain name, the priorities are sorted in the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If the matching types are the same, the longer the URL is, the higher the priority is. 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 be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to be created because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, specify a value or adjust the priorities of existing forwarding policies. If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default.

                    @@ -174,45 +175,45 @@

                    This parameter is invalid for shared load balancers.

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID of the forwarding policy.

                  +

                  Specifies the project ID of the forwarding policy.

                  provisioning_status

                  +

                  provisioning_status

                  String

                  +

                  String

                  Specifies the provisioning status of the forwarding policy.

                  +

                  Specifies the provisioning status of the forwarding policy.

                  The value can be ACTIVE or ERROR.

                  • ACTIVE (default): The forwarding policy is provisioned successfully.

                  redirect_pool_id

                  +

                  redirect_pool_id

                  String

                  +

                  String

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

                  +

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

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

                  • If both redirect_pools_config and redirect_pool_id are specified, redirect_pools_config will take effect.

                  redirect_pools_config

                  +

                  redirect_pools_config

                  Array of CreateRedirectPoolsConfig objects

                  +

                  Array of CreateRedirectPoolsConfig objects

                  Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL.

                  +

                  Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL.

                  redirect_listener_id

                  +

                  redirect_listener_id

                  String

                  +

                  String

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

                  +

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

                  Note:

                  • The listener's protocol must be HTTPS or TERMINATED_HTTPS.

                  • A listener added to another load balancer is not allowed.

                    @@ -220,27 +221,27 @@

                  redirect_url

                  +

                  redirect_url

                  String

                  +

                  String

                  Specifies the URL to which requests are forwarded.

                  +

                  Specifies the URL to which requests are forwarded.

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

                  This parameter is unsupported. Please do not use it.

                  rules

                  +

                  rules

                  Array of RuleRef objects

                  +

                  Array of RuleRef objects

                  Lists the forwarding rules in the forwarding policy.

                  +

                  Lists the forwarding rules in the forwarding policy.

                  redirect_url_config

                  +

                  redirect_url_config

                  RedirectUrlConfig object

                  +

                  RedirectUrlConfig object

                  Specifies the URL to which requests are forwarded.

                  +

                  Specifies the URL to which requests are forwarded.

                  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.

                  This parameter is mandatory when action is set to REDIRECT_TO_URL. It cannot be specified if the value of action is not REDIRECT_TO_URL.

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

                  @@ -249,28 +250,28 @@

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

                  fixed_response_config

                  +

                  fixed_response_config

                  FixtedResponseConfig object

                  +

                  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.

                  +

                  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.

                  This parameter is mandatory when action is set to FIXED_RESPONSE. It cannot be specified if the value of action is not FIXED_RESPONSE.

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

                  created_at

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when the forwarding policy was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when the forwarding policy was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when the forwarding policy was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when the forwarding policy was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  -
                  Table 5 CreateRedirectPoolsConfig

                  Parameter

                  +
                  - - - - - - - -
                  Table 5 CreateRedirectPoolsConfig

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  pool_id

                  +

                  pool_id

                  String

                  +

                  String

                  Specifies the ID of the backend server group.

                  +

                  Specifies the ID of the backend server group.

                  weight

                  +

                  weight

                  Integer

                  +

                  Integer

                  Specifies the weight of the backend server group. The value ranges from 0 to 100.

                  +

                  Specifies the weight of the backend server group.

                  +

                  The value ranges from 0 to 100.

                  -
                  Table 6 RuleRef

                  Parameter

                  +
                  - - - - -
                  Table 6 RuleRef

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the forwarding rule ID.

                  +

                  Specifies the forwarding rule ID.

                  -
                  Table 7 RedirectUrlConfig

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - -
                  Table 7 RedirectUrlConfig

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  protocol

                  +

                  protocol

                  String

                  +

                  String

                  Specifies the protocol for redirection.

                  +

                  Specifies the protocol for redirection.

                  The value can be HTTP, HTTPS, or ${protocol}. The default value is ${protocol}, indicating that the protocol of the request will be used.

                  Minimum: 1

                  Maximum: 36

                  host

                  +

                  host

                  String

                  +

                  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.

                  +

                  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

                  +

                  port

                  String

                  +

                  String

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

                  +

                  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

                  +

                  path

                  String

                  +

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

                  +

                  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

                  +

                  query

                  String

                  +

                  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.

                  +

                  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.example.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.example.com:8080/elb?type=loadbalancer&name=my_name.

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

                  Default: ${query}

                  @@ -383,11 +385,11 @@

                  Maximum: 128

                  status_code

                  +

                  status_code

                  String

                  +

                  String

                  Specifies the status code returned after the requests are redirected.

                  +

                  Specifies the status code returned after the requests are redirected.

                  The value can be 301, 302, 303, 307, or 308.

                  Minimum: 1

                  Maximum: 16

                  @@ -397,38 +399,38 @@
                  -
                  Table 8 FixtedResponseConfig

                  Parameter

                  +
                  - - - - - - - - - - - diff --git a/docs/elb/api-ref/ShowL7Rule.html b/docs/elb/api-ref/ShowL7Rule.html index 7343b85ea..ed62bce23 100644 --- a/docs/elb/api-ref/ShowL7Rule.html +++ b/docs/elb/api-ref/ShowL7Rule.html @@ -1,7 +1,7 @@

                  Viewing Details of a Forwarding Rule

                  -

                  Function

                  This API is used to view 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}

                  @@ -72,79 +72,79 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 8 FixtedResponseConfig

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  status_code

                  +

                  status_code

                  String

                  +

                  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.

                  +

                  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

                  +

                  content_type

                  String

                  +

                  String

                  Specifies the format of the response body.

                  +

                  Specifies the format of the response body.

                  The value can be text/plain, text/css, text/html, application/javascript, or application/json.

                  Minimum: 0

                  Maximum: 32

                  message_body

                  +

                  message_body

                  String

                  +

                  String

                  Specifies the content of the response message body.

                  +

                  Specifies the content of the response message body.

                  Minimum: 0

                  Maximum: 1024

                  Table 3 Response body parameters

                  Parameter

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

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  request_id

                  +

                  request_id

                  String

                  +

                  String

                  Specifies the request ID. The value is automatically generated.

                  +

                  Specifies the request ID. The value is automatically generated.

                  rule

                  +

                  rule

                  L7Rule object

                  +

                  L7Rule object

                  Specifies the forwarding rule.

                  +

                  Specifies the forwarding rule.

                  -
                  Table 4 L7Rule

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -219,19 +220,19 @@
                  Table 4 L7Rule

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  admin_state_up

                  +

                  admin_state_up

                  Boolean

                  +

                  Boolean

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

                  +

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

                  This parameter is unsupported. Please do not use it.

                  compare_type

                  +

                  compare_type

                  String

                  +

                  String

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

                  +

                  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, the value can be REGEX, STARTS_WITH, or EQUAL_TO.

                  key

                  +

                  key

                  String

                  +

                  String

                  Specifies the key of the match content. This parameter will not take effect if type is set to HOST_NAME or PATH.

                  +

                  Specifies the key of the match content. This parameter will not take effect if type is set to HOST_NAME or PATH.

                  Minimum: 1

                  Maximum: 255

                  project_id

                  +

                  project_id

                  String

                  +

                  String

                  Specifies the project ID.

                  +

                  Specifies the project ID.

                  type

                  +

                  type

                  String

                  +

                  String

                  Specifies the type of the forwarding rule. The value can be one of the following:

                  +

                  Specifies the type of the forwarding rule. 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.

                  • METHOD: An HTTP request method will be used for matching.

                    @@ -156,11 +156,11 @@

                    If type is set to HOST_NAME, PATH, METHOD, and SOURCE_IP, only one forwarding rule can be created for each type. If type is set to HEADER and QUERY_STRING, multiple forwarding rules can be created for each type.

                  value

                  +

                  value

                  String

                  +

                  String

                  Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. This parameter will take effect only when conditions is left blank.

                  +

                  Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. This parameter will take effect only when conditions is left blank.

                  • 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 _~';@^-%#&$.*+?,=!:|/()[]{}

                  • If type is set to METHOD, SOURCE_IP, HEADER, or QUERY_STRING, this parameter will not take effect, and condition_pair will be used to specify the key and value.

                    @@ -169,49 +169,50 @@

                    Maximum: 128

                  provisioning_status

                  +

                  provisioning_status

                  String

                  +

                  String

                  Specifies the provisioning status of the forwarding rule.

                  +

                  Specifies the provisioning status of the forwarding rule.

                  The value can only be ACTIVE (default), PENDING_CREATE, or ERROR.

                  This parameter is unsupported. Please do not use it.

                  invert

                  +

                  invert

                  Boolean

                  +

                  Boolean

                  Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but will not take effect.

                  +

                  Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but will not take effect.

                  id

                  +

                  id

                  String

                  +

                  String

                  Specifies the forwarding policy ID.

                  +

                  Specifies the forwarding policy ID.

                  conditions

                  +

                  conditions

                  Array of RuleCondition objects

                  +

                  Array of RuleCondition 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.

                  +

                  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.

                  created_at

                  +

                  created_at

                  String

                  +

                  String

                  Specifies the time when the forwarding rule was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when the forwarding rule was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  updated_at

                  +

                  updated_at

                  String

                  +

                  String

                  Specifies the time when the forwarding rule was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                  +

                  Specifies the time when the forwarding rule was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                  -
                  Table 5 RuleCondition

                  Parameter

                  +
                  - - - - - - - -
                  Table 5 RuleCondition

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  key

                  +

                  key

                  String

                  +

                  String

                  Specifies the key of match item.

                  +

                  Specifies the key of match item.

                  • If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, this parameter is left blank.

                  • If type is set to HEADER, key indicates the name of the HTTP header parameter. The value can contain 1 to 40 characters, including letters, digits, hyphens (-), and underscores (_).

                  • If type is set to QUERY_STRING, key indicates the name of the query parameter. The value is case sensitive and can contain 1 to 128 characters. Spaces, square brackets ([ ]), curly brackets ({ }), angle brackets (< >), backslashes (), double quotation marks (" "), pound signs (#), ampersands (&), vertical bars (|), percent signs (%), and tildes (~) are not supported.

                    @@ -241,11 +242,11 @@

                    Maximum: 128

                  value

                  +

                  value

                  String

                  +

                  String

                  Specifies the value of the match item.

                  +

                  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 _~';@^-%#&$.*+?,=!:|/()[]{}

                  • If type is set to HEADER, key indicates the name of the HTTP header parameter, and value indicates the value of the HTTP header parameter. The value can contain 1 to 128 characters. Asterisks (*) and question marks (?) are allowed, but spaces and double quotation marks are not allowed. An asterisk can match zero or more characters, and a question mark can match 1 character.

                    diff --git a/docs/elb/api-ref/ShowListener.html b/docs/elb/api-ref/ShowListener.html index 0a0743906..8aa018055 100644 --- a/docs/elb/api-ref/ShowListener.html +++ b/docs/elb/api-ref/ShowListener.html @@ -1,7 +1,7 @@

                    Viewing Details of a Listener

                    -

                    Function

                    This API is used to view details of a listener.

                    +

                    Function

                    This API is used to view details of a listener.

                    URI

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

                    @@ -63,139 +63,140 @@

                    Response Parameters

                    Status code: 200

                    -
                    Table 3 Response body parameters

                    Parameter

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

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    request_id

                    +

                    request_id

                    String

                    +

                    String

                    Specifies the request ID. The value is automatically generated.

                    +

                    Specifies the request ID. The value is automatically generated.

                    listener

                    +

                    listener

                    Listener object

                    +

                    Listener object

                    Specifies the listener.

                    +

                    Specifies the listener.

                    -
                    Table 4 Listener

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    Table 4 Listener

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    admin_state_up

                    +

                    admin_state_up

                    Boolean

                    +

                    Boolean

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

                    +

                    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

                    +

                    client_ca_tls_container_ref

                    String

                    +

                    String

                    Specifies the ID of the CA certificate used by the listener. This parameter is available only when type is set to client.

                    +

                    Specifies the ID of the CA certificate used by the listener. This parameter is available only when type is set to client.

                    connection_limit

                    +

                    connection_limit

                    Integer

                    +

                    Integer

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

                    +

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

                    This parameter is unsupported. Please do not use it.

                    created_at

                    +

                    created_at

                    String

                    +

                    String

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

                    +

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

                    default_pool_id

                    +

                    default_pool_id

                    String

                    +

                    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.

                    +

                    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

                    +

                    default_tls_container_ref

                    String

                    +

                    String

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

                    +

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

                    description

                    +

                    description

                    String

                    +

                    String

                    Provides supplementary information about the listener.

                    +

                    Provides supplementary information about the listener.

                    http2_enable

                    +

                    http2_enable

                    Boolean

                    +

                    Boolean

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

                    -

                    This parameter is available only for HTTPS listeners. If you configure this parameter for listeners with other protocols, it will not take effect.

                    +

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

                    +

                    This parameter is available only for HTTPS listeners.

                    +

                    If you configure this parameter for listeners with other protocols, it will not take effect.

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the listener ID.

                    +

                    Specifies the listener ID.

                    insert_headers

                    +

                    insert_headers

                    ListenerInsertHeaders object

                    +

                    ListenerInsertHeaders object

                    Specifies the HTTP header fields that can transmit required information to backend servers. For example, the X-Forwarded-ELB-IP header field can transmit the EIP of the load balancer to backend servers.

                    +

                    Specifies the HTTP header fields that can transmit required information to backend servers. For example, the X-Forwarded-ELB-IP header field can transmit the EIP of the load balancer to backend servers.

                    loadbalancers

                    +

                    loadbalancers

                    Array of LoadBalancerRef objects

                    +

                    Array of LoadBalancerRef objects

                    Specifies the ID of the load balancer that the listener is added to. A listener can be added to only one load balancer.

                    +

                    Specifies the ID of the load balancer that the listener is added to. A listener can be added to only one load balancer.

                    name

                    +

                    name

                    String

                    +

                    String

                    Specifies the listener name.

                    +

                    Specifies the listener name.

                    project_id

                    +

                    project_id

                    String

                    +

                    String

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

                    +

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

                    protocol

                    +

                    protocol

                    String

                    +

                    String

                    Specifies the protocol used by the listener.

                    +

                    Specifies the protocol used by the listener.

                    The value can be TCP, HTTP, UDP, HTTPS or TERMINATED_HTTPS.

                    Note:

                    • Protocol used by HTTPS listeners added to a shared load balancer can only be set to TERMINATED_HTTPS. If HTTPS is passed, the value will be automatically changed to TERMINATED_HTTPS.

                      @@ -203,55 +204,55 @@

                    protocol_port

                    +

                    protocol_port

                    Integer

                    +

                    Integer

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

                    +

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

                    Minimum: 1

                    Maximum: 65535

                    sni_container_refs

                    +

                    sni_container_refs

                    Array of strings

                    +

                    Array of strings

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

                    +

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

                    Note:

                    • The domain names of all SNI certificates must be unique.

                    • The total number of domain names of all SNI certificates cannot exceed 30.

                    sni_match_algo

                    +

                    sni_match_algo

                    String

                    +

                    String

                    Specifies how wildcard domain name matches with the SNI certificates used by the listener.

                    +

                    Specifies how wildcard domain name matches with the SNI certificates used by the listener.

                    longest_suffix indicates longest suffix match. wildcard indicates wildcard match.

                    The default value is wildcard.

                    tags

                    +

                    tags

                    Array of Tag objects

                    +

                    Array of Tag objects

                    Lists the tags.

                    +

                    Lists the tags.

                    updated_at

                    +

                    updated_at

                    String

                    +

                    String

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

                    +

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

                    tls_ciphers_policy

                    +

                    tls_ciphers_policy

                    String

                    +

                    String

                    Specifies the security policy used by the listener.

                    -

                    Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

                    +

                    Specifies the security policy used by the listener.

                    +

                    Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

                    Note:

                    • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

                    • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

                      @@ -259,11 +260,11 @@

                    security_policy_id

                    +

                    security_policy_id

                    String

                    +

                    String

                    Specifies the ID of the custom security policy.

                    +

                    Specifies the ID of the custom security policy.

                    Note:

                    • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

                    • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

                      @@ -271,33 +272,33 @@

                    enable_member_retry

                    +

                    enable_member_retry

                    Boolean

                    +

                    Boolean

                    Specifies whether to enable health check retries for backend servers. The value can be true (enable health check retries) or false (disable health check retries). The default value is true.

                    +

                    Specifies whether to enable health check retries for backend servers. The value can be true (enable health check retries) or false (disable health check retries). The default value is true.

                    Note:

                    • If a shared load balancer is associated, this parameter is available only when protocol is set to HTTP or TERMINATED_HTTPS.

                    • If a dedicated load balancer is associated, this parameter is available only when protocol is set to HTTP or HTTPS.

                    keepalive_timeout

                    +

                    keepalive_timeout

                    Integer

                    +

                    Integer

                    Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

                    +

                    Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

                    • 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 1 to 4000, and the default value is 60.

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

                    client_timeout

                    +

                    client_timeout

                    Integer

                    +

                    Integer

                    Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

                    +

                    Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

                    • If the client fails to send a request header to the load balancer within the timeout duration, the request will be interrupted.

                    • If the interval between two consecutive request bodies reaching the load balancer is greater than the timeout duration, the connection will be disconnected.

                    @@ -305,27 +306,27 @@

                    This parameter is available only for HTTP and HTTPS listeners.

                    member_timeout

                    +

                    member_timeout

                    Integer

                    +

                    Integer

                    Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

                    +

                    Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

                    The value ranges from 1 to 300, and the default value is 60.

                    This parameter is available only for HTTP and HTTPS listeners.

                    ipgroup

                    +

                    ipgroup

                    ListenerIpGroup object

                    +

                    ListenerIpGroup object

                    Specifies the IP address group associated with the listener.

                    +

                    Specifies the IP address group associated with the listener.

                    transparent_client_ip_enable

                    +

                    transparent_client_ip_enable

                    Boolean

                    +

                    Boolean

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

                    +

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

                    • TCP or UDP listeners of shared load balancers: The value can be true or false, and the default value is false if this parameter is not passed.

                    • HTTP or HTTPS listeners of shared load balancers: The value can only be true, and the default value is true if this parameter is not passed.

                    • All listeners of dedicated load balancers: The value can only be true, and the default value is true if this parameter is not passed.

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

                    enhance_l7policy_enable

                    +

                    enhance_l7policy_enable

                    Boolean

                    +

                    Boolean

                    Specifies whether to enable advanced forwarding. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

                    +

                    Specifies whether to enable advanced forwarding. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

                    • If this function is enabled, action can be set to REDIRECT_TO_URL (requests will be redirected to another URL) or Fixed_RESPONSE (a fixed response body will be returned to clients).

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

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

                      @@ -353,11 +354,11 @@

                      Default: false

                    quic_config

                    +

                    quic_config

                    ListenerQuicConfig object

                    +

                    ListenerQuicConfig object

                    Specifies the QUIC configuration for the current listener. This parameter is valid only when protocol is set to HTTPS.

                    +

                    Specifies the QUIC configuration for the current listener. This parameter is valid only when protocol is set to HTTPS.

                    For a TCP/UDP/HTTP/QUIC listener, if this parameter is not left blank, an error will be reported.

                    NOTE:

                    The client sends a normal HTTP request that contains information indicating that the QUIC protocol is supported.

                    @@ -370,43 +371,43 @@
                    -
                    Table 5 ListenerInsertHeaders

                    Parameter

                    +
                    - - - - - - - - - - - - - - @@ -414,47 +415,47 @@
                    Table 5 ListenerInsertHeaders

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    X-Forwarded-ELB-IP

                    +

                    X-Forwarded-ELB-IP

                    Boolean

                    +

                    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.

                    +

                    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

                    +

                    X-Forwarded-Port

                    Boolean

                    +

                    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.

                    +

                    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

                    +

                    X-Forwarded-For-Port

                    Boolean

                    +

                    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.

                    +

                    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

                    +

                    X-Forwarded-Host

                    Boolean

                    +

                    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.

                    +

                    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

                    +
                    - - - - -
                    Table 6 LoadBalancerRef

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the load balancer ID.

                    +

                    Specifies the load balancer ID.

                    -
                    Table 7 Tag

                    Parameter

                    +
                    - - - - - - - - @@ -463,39 +464,39 @@
                    Table 7 Tag

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    key

                    +

                    key

                    String

                    +

                    String

                    Specifies the tag key.

                    +

                    Specifies the tag key.

                    Minimum: 1

                    Maximum: 36

                    value

                    +

                    value

                    String

                    +

                    String

                    Specifies the tag value.

                    +

                    Specifies the tag value.

                    Minimum: 0

                    Maximum: 43

                    -
                    Table 8 ListenerIpGroup

                    Parameter

                    +
                    - - - - - - - - - - -
                    Table 8 ListenerIpGroup

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    ipgroup_id

                    +

                    ipgroup_id

                    String

                    +

                    String

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

                    +

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

                    This parameter is mandatory when you create the IP address group and is optional when you update the IP address group.

                    The specified IP address group must exist, and the value cannot be null.

                    enable_ipgroup

                    +

                    enable_ipgroup

                    Boolean

                    +

                    Boolean

                    Specifies whether to enable access control.

                    +

                    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

                    +

                    type

                    String

                    +

                    String

                    Specifies how access to the listener is controlled.

                    +

                    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.

                    @@ -505,27 +506,32 @@
                    -
                    Table 9 ListenerQuicConfig

                    Parameter

                    +
                    - - - - - - - - diff --git a/docs/elb/api-ref/ShowLoadBalancer.html b/docs/elb/api-ref/ShowLoadBalancer.html index e44dc8c98..4bc3aba8c 100644 --- a/docs/elb/api-ref/ShowLoadBalancer.html +++ b/docs/elb/api-ref/ShowLoadBalancer.html @@ -1,7 +1,7 @@

                    Viewing Details of a Load Balancer

                    -

                    Function

                    This API is used to view 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}

                    @@ -63,326 +63,326 @@

                    Response Parameters

                    Status code: 200

                    -
                    Table 9 ListenerQuicConfig

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    quic_listener_id

                    +

                    quic_listener_id

                    String

                    +

                    String

                    Specifies the ID of the QUIC listener. This parameter is mandatory for creation and is optional for update. The specified quic_listener_id must exist. The listener protocol must be QUIC and cannot be set to null, otherwise, it will conflict with enable_quic_upgrade.

                    +

                    Specifies the ID of the QUIC listener.

                    +

                    This parameter is mandatory for creation and is optional for update.

                    +

                    The specified quic_listener_id must exist. The listener protocol must be QUIC and cannot be set to null, otherwise, it will conflict with enable_quic_upgrade.

                    QUIC protocol is not supported.

                    enable_quic_upgrade

                    +

                    enable_quic_upgrade

                    Boolean

                    +

                    Boolean

                    Specifies whether to enable QUIC upgrade. True: QUIC upgrade is enabled. False: QUIC upgrade is disabled. HTTPS listeners can be upgraded to QUIC listeners.

                    +

                    Specifies whether to enable QUIC upgrade.

                    +

                    True: QUIC upgrade is enabled.

                    +

                    False: QUIC upgrade is disabled.

                    +

                    HTTPS listeners can be upgraded to QUIC listeners.

                    QUIC protocol is not supported.

                    Table 3 Response body parameters

                    Parameter

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

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    request_id

                    +

                    request_id

                    String

                    +

                    String

                    Specifies the request ID. The value is automatically generated.

                    +

                    Specifies the request ID. The value is automatically generated.

                    loadbalancer

                    +

                    loadbalancer

                    LoadBalancer object

                    +

                    LoadBalancer object

                    Specifies the load balancer.

                    +

                    Specifies the load balancer.

                    -
                    Table 4 LoadBalancer

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    Table 4 LoadBalancer

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the load balancer ID.

                    +

                    Specifies the load balancer ID.

                    description

                    +

                    description

                    String

                    +

                    String

                    Provides supplementary information about the load balancer.

                    +

                    Provides supplementary information about the load balancer.

                    Minimum: 1

                    Maximum: 255

                    provisioning_status

                    +

                    provisioning_status

                    String

                    +

                    String

                    Specifies the provisioning status of the load balancer. The value can be one of the following:

                    +

                    Specifies the provisioning status of the load balancer. The value can be one of the following:

                    • ACTIVE: The load balancer is successfully provisioned.

                    • PENDING_DELETE: The load balancer is being deleted.

                    admin_state_up

                    +

                    admin_state_up

                    Boolean

                    +

                    Boolean

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

                    +

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

                    provider

                    +

                    provider

                    String

                    +

                    String

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

                    +

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

                    pools

                    +

                    pools

                    Array of PoolRef objects

                    +

                    Array of PoolRef objects

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

                    +

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

                    listeners

                    +

                    listeners

                    Array of ListenerRef objects

                    +

                    Array of ListenerRef objects

                    Lists the IDs of listeners added to the load balancer.

                    +

                    Lists the IDs of listeners added to the load balancer.

                    operating_status

                    +

                    operating_status

                    String

                    +

                    String

                    Specifies the operating status of the load balancer. The value can only be ONLINE, indicating that the load balancer is running normally.

                    +

                    Specifies the operating status of the load balancer. The value can only be ONLINE, indicating that the load balancer is running normally.

                    name

                    +

                    name

                    String

                    +

                    String

                    Specifies the load balancer name.

                    +

                    Specifies the load balancer name.

                    project_id

                    +

                    project_id

                    String

                    +

                    String

                    Specifies the project ID of the load balancer.

                    +

                    Specifies the project ID of the load balancer.

                    vip_subnet_cidr_id

                    +

                    vip_subnet_cidr_id

                    String

                    +

                    String

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

                    +

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

                    vip_address

                    +

                    vip_address

                    String

                    +

                    String

                    Specifies the private IPv4 address bound to the load balancer.

                    +

                    Specifies the private IPv4 address bound to the load balancer.

                    vip_port_id

                    +

                    vip_port_id

                    String

                    +

                    String

                    Specifies the ID of the port bound to the private IPv4 address of the load balancer.

                    +

                    Specifies the ID of the port bound to the private IPv4 address of the load balancer.

                    The default security group associated with the port will take effect only after at least one backend server is associated with load balancer.

                    tags

                    +

                    tags

                    Array of Tag objects

                    +

                    Array of Tag objects

                    Lists the tags added to the load balancer.

                    +

                    Lists the tags added to the load balancer.

                    created_at

                    +

                    created_at

                    String

                    +

                    String

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

                    +

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

                    updated_at

                    +

                    updated_at

                    String

                    +

                    String

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

                    +

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

                    guaranteed

                    +

                    guaranteed

                    Boolean

                    +

                    Boolean

                    Specifies whether the load balancer is a dedicated load balancer.

                    +

                    Specifies whether the load balancer is a dedicated load balancer.

                    • true (default): The load balancer is a dedicated load balancer.

                    • false: The load balancer is a shared load balancer.

                    vpc_id

                    +

                    vpc_id

                    String

                    +

                    String

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

                    +

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

                    eips

                    +

                    eips

                    Array of EipInfo objects

                    +

                    Array of EipInfo objects

                    Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                    +

                    Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                    This parameter has the same meaning as publicips.

                    ipv6_vip_address

                    +

                    ipv6_vip_address

                    String

                    +

                    String

                    Specifies the IPv6 address bound to the load balancer.

                    +

                    Specifies the IPv6 address bound to the load balancer.

                    ipv6_vip_virsubnet_id

                    +

                    ipv6_vip_virsubnet_id

                    String

                    +

                    String

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

                    +

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

                    ipv6_vip_port_id

                    +

                    ipv6_vip_port_id

                    String

                    +

                    String

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

                    +

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

                    availability_zone_list

                    +

                    availability_zone_list

                    Array of strings

                    +

                    Array of strings

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

                    +

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

                    enterprise_project_id

                    +

                    enterprise_project_id

                    String

                    +

                    String

                    Specifies the enterprise project ID.

                    +

                    Specifies the enterprise project ID.

                    If this parameter is not passed during resource creation, "0" will be returned, and the resource belongs to the default enterprise project.

                    "0" is not a valid enterprise project ID and cannot be used in the APIs for creating, updating the load balancer, or querying details of the load balancer.

                    This parameter is unsupported. Please do not use it.

                    billing_info

                    +

                    billing_info

                    String

                    +

                    String

                    Provides resource billing information.

                    +

                    Provides resource billing information.

                    This parameter is unsupported. Please do not use it.

                    Minimum: 1

                    Maximum: 1024

                    l4_flavor_id

                    +

                    l4_flavor_id

                    String

                    +

                    String

                    Specifies the ID of a flavor at Layer 4.

                    +

                    Specifies the ID of a flavor at Layer 4.

                    Minimum: 1

                    Maximum: 255

                    l4_scale_flavor_id

                    +

                    l4_scale_flavor_id

                    String

                    +

                    String

                    Specifies the ID of the reserved flavor at Layer 4.

                    +

                    Specifies the ID of the reserved flavor at Layer 4.

                    This parameter is unsupported. Please do not use it.

                    Minimum: 1

                    Maximum: 255

                    l7_flavor_id

                    +

                    l7_flavor_id

                    String

                    +

                    String

                    Specifies the ID of a flavor at Layer 7.

                    +

                    Specifies the ID of a flavor at Layer 7.

                    Minimum: 1

                    Maximum: 255

                    l7_scale_flavor_id

                    +

                    l7_scale_flavor_id

                    String

                    +

                    String

                    Specifies the ID of the reserved flavor at Layer 7.

                    +

                    Specifies the ID of the reserved flavor at Layer 7.

                    This parameter is unsupported. Please do not use it.

                    Minimum: 1

                    Maximum: 255

                    publicips

                    +

                    publicips

                    Array of PublicIpInfo objects

                    +

                    Array of PublicIpInfo objects

                    Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                    +

                    Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                    This parameter has the same meaning as eips.

                    elb_virsubnet_ids

                    +

                    elb_virsubnet_ids

                    Array of strings

                    +

                    Array of strings

                    Lists the IDs of subnets on the downstream plane.

                    +

                    Lists the IDs of subnets on the downstream plane.

                    elb_virsubnet_type

                    +

                    elb_virsubnet_type

                    String

                    +

                    String

                    Specifies the type of the subnet on the downstream plane.

                    +

                    Specifies the type of the subnet on the downstream plane.

                    • ipv4: IPv4 subnet

                    • dualstack: subnet that supports IPv4/IPv6 dual stack

                    "dualstack" is not supported.

                    ip_target_enable

                    +

                    ip_target_enable

                    Boolean

                    +

                    Boolean

                    Specifies whether to enable IP as a Backend Server.

                    +

                    Specifies whether to enable IP as a Backend Server.

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

                    This function is supported only by dedicated load balancers.

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

                    The value can only be update to true.

                    frozen_scene

                    +

                    frozen_scene

                    String

                    +

                    String

                    Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,).

                    +

                    Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,).

                    This parameter is unsupported. Please do not use it.

                    ipv6_bandwidth

                    +

                    ipv6_bandwidth

                    BandwidthRef object

                    +

                    BandwidthRef object

                    Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

                    +

                    Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

                    deletion_protection_enable

                    +

                    deletion_protection_enable

                    Boolean

                    +

                    Boolean

                    Specifies whether deletion protection is enabled.

                    +

                    Specifies whether deletion protection is enabled.

                    • false: Deletion protection is not enabled.

                    • true: Deletion protection is enabled.

                    @@ -391,18 +391,18 @@

                    This parameter is returned only when deletion protection is enabled at the site.

                    public_border_group

                    +

                    public_border_group

                    String

                    +

                    String

                    Specifies the AZ group to which the load balancer belongs.

                    +

                    Specifies the AZ group to which the load balancer belongs.

                    waf_failure_action

                    +

                    waf_failure_action

                    String

                    +

                    String

                    Specifies traffic distributing policies when the WAF is faulty.

                    +

                    Specifies traffic distributing policies when the WAF is faulty.

                    • discard: Traffic will not be distributed.

                    • forward: Traffic will be distributed to the default backend servers.

                    @@ -410,70 +410,81 @@

                    This parameter is unsupported. Please do not use it.

                    -
                    - -
                    - - - - - - -
                    Table 5 PoolRef

                    Parameter

                    -

                    Type

                    -

                    Description

                    -

                    id

                    +

                    charge_mode

                    String

                    +

                    String

                    Specifies the ID of the backend server group.

                    +

                    Specifies the charge mode when creating a load balancer.

                    +

                    Value options:

                    +
                    • flavor: billed by the fixed specification you select.

                      +
                    • lcu: billed by how many LCUs you have used.

                      +
                    -
                    Table 6 ListenerRef

                    Parameter

                    +
                    - - - - -
                    Table 5 PoolRef

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the listener ID.

                    +

                    Specifies the ID of the backend server group.

                    -
                    Table 7 Tag

                    Parameter

                    +
                    - - - - - + + +
                    Table 6 ListenerRef

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    key

                    +

                    id

                    String

                    +

                    String

                    Specifies the tag key.

                    +

                    Specifies the listener ID.

                    +
                    +
                    + +
                    + + + + + + + - - - @@ -482,85 +493,85 @@
                    Table 7 Tag

                    Parameter

                    +

                    Type

                    +

                    Description

                    +

                    key

                    +

                    String

                    +

                    Specifies the tag key.

                    Minimum: 1

                    Maximum: 36

                    value

                    +

                    value

                    String

                    +

                    String

                    Specifies the tag value.

                    +

                    Specifies the tag value.

                    Minimum: 0

                    Maximum: 43

                    -
                    Table 8 EipInfo

                    Parameter

                    +
                    - - - - - - - - - - -
                    Table 8 EipInfo

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    eip_id

                    +

                    eip_id

                    String

                    +

                    String

                    eip_id

                    +

                    eip_id

                    eip_address

                    +

                    eip_address

                    String

                    +

                    String

                    eip_address

                    +

                    eip_address

                    ip_version

                    +

                    ip_version

                    Integer

                    +

                    Integer

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

                    +

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

                    -
                    Table 9 PublicIpInfo

                    Parameter

                    +
                    - - - - - - - - - - -
                    Table 9 PublicIpInfo

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    publicip_id

                    +

                    publicip_id

                    String

                    +

                    String

                    Specifies the EIP ID.

                    +

                    Specifies the EIP ID.

                    publicip_address

                    +

                    publicip_address

                    String

                    +

                    String

                    Specifies the IP address.

                    +

                    Specifies the IP address.

                    ip_version

                    +

                    ip_version

                    Integer

                    +

                    Integer

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

                    +

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

                    -
                    Table 10 BandwidthRef

                    Parameter

                    +
                    - - - - - diff --git a/docs/elb/api-ref/ShowLoadBalancerStatus.html b/docs/elb/api-ref/ShowLoadBalancerStatus.html index ddc909393..12c447bea 100644 --- a/docs/elb/api-ref/ShowLoadBalancerStatus.html +++ b/docs/elb/api-ref/ShowLoadBalancerStatus.html @@ -1,7 +1,7 @@

                    Querying the Status Tree of a Load Balancer

                    -

                    Function

                    This API is used to query the status tree of a load balancer and to show information about all resources associated with the load balancer.

                    +

                    Function

                    This API is used to query the status tree of a load balancer and to show information about all resources associated with the load balancer.

                    When admin_state_up is set to 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

                    @@ -64,104 +64,104 @@

                    Response Parameters

                    Status code: 200

                    -
                    Table 10 BandwidthRef

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the shared bandwidth ID.

                    +

                    Specifies the shared bandwidth ID.

                    Table 3 Response body parameters

                    Parameter

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

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    statuses

                    +

                    statuses

                    LoadBalancerStatusResult object

                    +

                    LoadBalancerStatusResult object

                    Provides information about the load balancer status tree.

                    +

                    Provides information about the load balancer status tree.

                    request_id

                    +

                    request_id

                    String

                    +

                    String

                    Specifies the request ID. The value is automatically generated.

                    +

                    Specifies the request ID. The value is automatically generated.

                    -
                    Table 4 LoadBalancerStatusResult

                    Parameter

                    +
                    - - - - -
                    Table 4 LoadBalancerStatusResult

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    loadbalancer

                    +

                    loadbalancer

                    LoadBalancerStatus object

                    +

                    LoadBalancerStatus object

                    Specifies the statuses of the load balancer and its associated resources.

                    +

                    Specifies the statuses of the load balancer and its associated resources.

                    -
                    Table 5 LoadBalancerStatus

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - - - - -
                    Table 5 LoadBalancerStatus

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    name

                    +

                    name

                    String

                    +

                    String

                    Specifies the load balancer name.

                    +

                    Specifies the load balancer name.

                    Minimum: 1

                    Maximum: 255

                    provisioning_status

                    +

                    provisioning_status

                    String

                    +

                    String

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

                    +

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

                    • ACTIVE: The load balancer is successfully provisioned.

                    • PENDING_DELETE: The load balancer is being deleted.

                    listeners

                    +

                    listeners

                    Array of LoadBalancerStatusListener objects

                    +

                    Array of LoadBalancerStatusListener objects

                    Lists the listeners added to the load balancer.

                    +

                    Lists the listeners added to the load balancer.

                    pools

                    +

                    pools

                    Array of LoadBalancerStatusPool objects

                    +

                    Array of LoadBalancerStatusPool objects

                    Lists the backend server groups associated with the load balancer.

                    +

                    Lists the backend server groups associated with the load balancer.

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the load balancer ID.

                    +

                    Specifies the load balancer ID.

                    operating_status

                    +

                    operating_status

                    String

                    +

                    String

                    Specifies the operating status of the load balancer.

                    +

                    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.

                    • FROZEN: The load balancer has been frozen.

                      @@ -175,60 +175,61 @@
                    -
                    Table 6 LoadBalancerStatusListener

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - - - - - @@ -236,92 +237,93 @@
                    Table 6 LoadBalancerStatusListener

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    name

                    +

                    name

                    String

                    +

                    String

                    Specifies the name of the listener added to the load balancer.

                    +

                    Specifies the name of the listener added to the load balancer.

                    Minimum: 1

                    Maximum: 255

                    provisioning_status

                    +

                    provisioning_status

                    String

                    +

                    String

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

                    +

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

                    pools

                    +

                    pools

                    Array of LoadBalancerStatusPool objects

                    +

                    Array of LoadBalancerStatusPool objects

                    Specifies the operating status of the backend server group associated with the listener.

                    +

                    Specifies the operating status of the backend server group associated with the listener.

                    l7policies

                    +

                    l7policies

                    Array of LoadBalancerStatusPolicy objects

                    +

                    Array of LoadBalancerStatusPolicy objects

                    Specifies the operating status of the forwarding policy added to the listener.

                    +

                    Specifies the operating status of the forwarding policy added to the listener.

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the listener ID.

                    +

                    Specifies the listener ID.

                    operating_status

                    +

                    operating_status

                    String

                    +

                    String

                    Specifies the operating status of the listener.

                    +

                    Specifies the operating status of the listener.

                    The value can only be one of the following:

                    • ONLINE (default): The listener is running normally.

                    • DEGRADED: This status is displayed only when provisioning_status of a forwarding policy or a forwarding rule added to the listener is set to ERROR or operating_status is set to OFFLINE for a backend server associated with the listener.

                      -
                    • DISABLED: This status is displayed only when admin_state_up of the load balancer or of the listener is set to false. Note: DEGRADED and DISABLED are returned only when 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 or of the listener is set to false.

                      +

                      Note: DEGRADED and DISABLED are returned only when the API for querying the load balancer status tree is called.

                    -
                    Table 7 LoadBalancerStatusPolicy

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - -
                    Table 7 LoadBalancerStatusPolicy

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    action

                    +

                    action

                    String

                    +

                    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:

                    +

                    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 another backend server group.

                    • REDIRECT_TO_LISTENER: Requests are redirected to an HTTPS listener.

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the forwarding policy ID.

                    +

                    Specifies the forwarding policy ID.

                    provisioning_status

                    +

                    provisioning_status

                    String

                    +

                    String

                    Specifies the provisioning status of the forwarding policy.

                    +

                    Specifies the provisioning status of the forwarding policy.

                    • ACTIVE (default): The forwarding policy is provisioned successfully.

                    • ERROR: Another forwarding policy of the same listener has the same forwarding rule.

                    name

                    +

                    name

                    String

                    +

                    String

                    Specifies the policy name.

                    +

                    Specifies the policy name.

                    Minimum: 1

                    Maximum: 255

                    rules

                    +

                    rules

                    Array of LoadBalancerStatusL7Rule objects

                    +

                    Array of LoadBalancerStatusL7Rule objects

                    Specifies the forwarding rule.

                    +

                    Specifies the forwarding rule.

                    -
                    Table 8 LoadBalancerStatusL7Rule

                    Parameter

                    +
                    - - - - - - - - - - -
                    Table 8 LoadBalancerStatusL7Rule

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the ID of the forwarding rule.

                    +

                    Specifies the ID of the forwarding rule.

                    type

                    +

                    type

                    String

                    +

                    String

                    Specifies the type of the match content. The value can be HOST_NAME or PATH.

                    +

                    Specifies the type of the match content. The value can be HOST_NAME or PATH.

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

                    • PATH: A URL will be used for matching.

                    The value must be unique for each forwarding rule in a forwarding policy.

                    provisioning_status

                    +

                    provisioning_status

                    String

                    +

                    String

                    Specifies the provisioning status of the forwarding rule.

                    +

                    Specifies the provisioning status of the forwarding rule.

                    • ACTIVE (default): The forwarding rule is successfully provisioned.

                    • ERROR: Another forwarding policy of the same listener has the same forwarding rule.

                    @@ -331,56 +333,56 @@
                    -
                    Table 9 LoadBalancerStatusPool

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - - - - -
                    Table 9 LoadBalancerStatusPool

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    provisioning_status

                    +

                    provisioning_status

                    String

                    +

                    String

                    Specifies the provisioning status of the backend server group. The value can only be ACTIVE, indicating that the backend server group is successfully provisioned.

                    +

                    Specifies the provisioning status of the backend server group. The value can only be ACTIVE, indicating that the backend server group is successfully provisioned.

                    name

                    +

                    name

                    String

                    +

                    String

                    Specifies the name of the backend server group.

                    +

                    Specifies the name of the backend server group.

                    Minimum: 1

                    Maximum: 255

                    healthmonitor

                    +

                    healthmonitor

                    LoadBalancerStatusHealthMonitor object

                    +

                    LoadBalancerStatusHealthMonitor object

                    Specifies the health check results of backend servers in the load balancer status tree.

                    +

                    Specifies the health check results of backend servers in the load balancer status tree.

                    members

                    +

                    members

                    Array of LoadBalancerStatusMember objects

                    +

                    Array of LoadBalancerStatusMember objects

                    Specifies the backend server.

                    +

                    Specifies the backend server.

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the ID of the backend server group.

                    +

                    Specifies the ID of the backend server group.

                    operating_status

                    +

                    operating_status

                    String

                    +

                    String

                    Specifies the operating status of the backend server group.

                    +

                    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 backend server group is set to OFFLINE.

                      @@ -393,89 +395,89 @@
                    -
                    Table 10 LoadBalancerStatusHealthMonitor

                    Parameter

                    +
                    - - - - - - - - - - - - - -
                    Table 10 LoadBalancerStatusHealthMonitor

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    type

                    +

                    type

                    String

                    +

                    String

                    Specifies the health check protocol. The value can be TCP, UDP_CONNECT, or HTTP.

                    +

                    Specifies the health check protocol. The value can be TCP, UDP_CONNECT, or HTTP.

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the health check ID.

                    +

                    Specifies the health check ID.

                    name

                    +

                    name

                    String

                    +

                    String

                    Specifies the health check name.

                    +

                    Specifies the health check name.

                    Minimum: 1

                    Maximum: 255

                    provisioning_status

                    +

                    provisioning_status

                    String

                    +

                    String

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

                    +

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

                    -
                    Table 11 LoadBalancerStatusMember

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - -
                    Table 11 LoadBalancerStatusMember

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    provisioning_status

                    +

                    provisioning_status

                    String

                    +

                    String

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

                    +

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

                    address

                    +

                    address

                    String

                    +

                    String

                    Specifies the private IP address bound to the backend server.

                    +

                    Specifies the private IP address bound to the backend server.

                    protocol_port

                    +

                    protocol_port

                    Integer

                    +

                    Integer

                    Specifies the port used by the backend server to receive requests. The port number ranges from 1 to 65535.

                    +

                    Specifies the port used by the backend server to receive requests. The port number ranges from 1 to 65535.

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the backend server ID.

                    +

                    Specifies the backend server ID.

                    operating_status

                    +

                    operating_status

                    String

                    +

                    String

                    Specifies the operating status of the backend server.

                    +

                    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.

                      diff --git a/docs/elb/api-ref/ShowLogtank.html b/docs/elb/api-ref/ShowLogtank.html index 187f177ad..03aead2d2 100644 --- a/docs/elb/api-ref/ShowLogtank.html +++ b/docs/elb/api-ref/ShowLogtank.html @@ -1,7 +1,7 @@

                      Viewing Details of a Log

                      -

                      Function

                      This API is used to view details of a log.

                      +

                      Function

                      This API is used to view details of a log.

                      URI

                      GET /v3/{project_id}/elb/logtanks/{logtank_id}

                      @@ -63,73 +63,73 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 3 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      logtank

                      +

                      logtank

                      Logtank object

                      +

                      Logtank object

                      Provides supplementary information.

                      +

                      Provides supplementary information.

                      -
                      Table 4 Logtank

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - diff --git a/docs/elb/api-ref/ShowMember.html b/docs/elb/api-ref/ShowMember.html index 752e45354..76eea969c 100644 --- a/docs/elb/api-ref/ShowMember.html +++ b/docs/elb/api-ref/ShowMember.html @@ -1,7 +1,7 @@

                      Viewing Details of a Backend Server

                      -

                      Function

                      This API is used to view 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}

                      @@ -74,208 +74,208 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 4 Logtank

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the log ID.

                      +

                      Specifies the log ID.

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the ID of a load balancer.

                      +

                      Specifies the ID of a load balancer.

                      loadbalancer_id

                      +

                      loadbalancer_id

                      String

                      +

                      String

                      Specifies the ID of a load balancer.

                      +

                      Specifies the ID of a load balancer.

                      log_group_id

                      +

                      log_group_id

                      String

                      +

                      String

                      Specifies the log group ID.

                      +

                      Specifies the log group ID.

                      log_topic_id

                      +

                      log_topic_id

                      String

                      +

                      String

                      Specifies the log topic ID.

                      +

                      Specifies the log topic ID.

                      Table 3 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      member

                      +

                      member

                      Member object

                      +

                      Member object

                      Specifies the backend server.

                      +

                      Specifies the backend server.

                      -
                      Table 4 Member

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      Table 4 Member

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the backend server ID.

                      +

                      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

                      +

                      name

                      String

                      +

                      String

                      Specifies the backend server name.

                      +

                      Specifies the backend server name.

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID of the backend server.

                      +

                      Specifies the project ID of the backend server.

                      admin_state_up

                      +

                      admin_state_up

                      Boolean

                      +

                      Boolean

                      Specifies the administrative status of the backend server. The value can be true or false.

                      +

                      Specifies the administrative status of the backend server. The value can be true or false.

                      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.

                      subnet_cidr_id

                      +

                      subnet_cidr_id

                      String

                      +

                      String

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

                      +

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

                      This parameter can be left blank, indicating that IP as a Backend Server has been enabled for the load balancer. In this case, IP addresses of these servers must be IPv4 addresses, and the protocol of the backend server group must be TCP, HTTP, or HTTPS.

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

                      protocol_port

                      +

                      protocol_port

                      Integer

                      +

                      Integer

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

                      +

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

                      Minimum: 1

                      Maximum: 65535

                      weight

                      +

                      weight

                      Integer

                      +

                      Integer

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

                      +

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

                      The value ranges from 0 to 100, and the default value is 1. The larger the weight is, the higher proportion of requests the backend server receives. If the weight is set to 0, the backend server will not accept new requests.

                      If lb_algorithm is set to SOURCE_IP, this parameter will not take effect.

                      Minimum: 0

                      Maximum: 100

                      address

                      +

                      address

                      String

                      +

                      String

                      Specifies the private IP address bound to the backend server.

                      +

                      Specifies the private IP address bound to the backend server.

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

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

                      ip_version

                      +

                      ip_version

                      String

                      +

                      String

                      Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6), depending on the value of address returned by the system.

                      +

                      Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6), depending on the value of address returned by the system.

                      operating_status

                      +

                      operating_status

                      String

                      +

                      String

                      Specifies the health status of the backend server if listener_id under status is not specified. The value can be one of the following:

                      +

                      Specifies the health status of the backend server if listener_id under status is not specified. 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.

                      status

                      +

                      status

                      Array of MemberStatus objects

                      +

                      Array of MemberStatus objects

                      Specifies the health status of the backend server if listener_id is specified.

                      +

                      Specifies the health status of the backend server if listener_id is specified.

                      loadbalancer_id

                      +

                      loadbalancer_id

                      String

                      +

                      String

                      Specifies the ID of the load balancer with which the backend server is associated.

                      +

                      Specifies the ID of the load balancer with which the backend server is associated.

                      This parameter is unsupported. Please do not use it.

                      loadbalancers

                      +

                      loadbalancers

                      Array of ResourceID objects

                      +

                      Array of ResourceID objects

                      Specifies the IDs of the load balancers associated with the backend server.

                      +

                      Specifies the IDs of the load balancers associated with the backend server.

                      This parameter is unsupported. Please do not use it.

                      created_at

                      +

                      created_at

                      String

                      +

                      String

                      Specifies the time when a backend server was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when a backend server was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      updated_at

                      +

                      updated_at

                      String

                      +

                      String

                      Specifies the time when a backend server was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when a backend server was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      member_type

                      +

                      member_type

                      String

                      +

                      String

                      Specifies the type of the backend server. Values:

                      +

                      Specifies the type of the backend server. Values:

                      • ip: IP as Backend servers

                      • instance: ECSs used as backend servers

                      instance_id

                      +

                      instance_id

                      String

                      +

                      String

                      Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address.

                      +

                      Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address.

                      -
                      Table 5 MemberStatus

                      Parameter

                      +
                      - - - - - - - -
                      Table 5 MemberStatus

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      listener_id

                      +

                      listener_id

                      String

                      +

                      String

                      Specifies the listener ID.

                      +

                      Specifies the listener ID.

                      operating_status

                      +

                      operating_status

                      String

                      +

                      String

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

                      +

                      Specifies the health 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.

                        @@ -286,19 +286,19 @@
                      -
                      Table 6 ResourceID

                      Parameter

                      +
                      - - - - - diff --git a/docs/elb/api-ref/ShowPool.html b/docs/elb/api-ref/ShowPool.html index de64794f4..c3e8d8911 100644 --- a/docs/elb/api-ref/ShowPool.html +++ b/docs/elb/api-ref/ShowPool.html @@ -1,7 +1,7 @@

                      Viewing Details of a Backend Server Group

                      -

                      Function

                      This API is used to view 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}

                      @@ -63,74 +63,74 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 6 ResourceID

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the resource ID.

                      +

                      Specifies the resource ID.

                      Table 3 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      pool

                      +

                      pool

                      Pool object

                      +

                      Pool object

                      Specifies the backend server group.

                      +

                      Specifies the backend server group.

                      -
                      Table 4 Pool

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      Table 4 Pool

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      admin_state_up

                      +

                      admin_state_up

                      Boolean

                      +

                      Boolean

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

                      +

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

                      This parameter is unsupported. Please do not use it.

                      description

                      +

                      description

                      String

                      +

                      String

                      Provides supplementary information about the backend server group.

                      +

                      Provides supplementary information about the backend server group.

                      healthmonitor_id

                      +

                      healthmonitor_id

                      String

                      +

                      String

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

                      +

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

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the backend server group ID.

                      +

                      Specifies the backend server group ID.

                      lb_algorithm

                      +

                      lb_algorithm

                      String

                      +

                      String

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

                      +

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

                      The value can be one of the following:

                      • ROUND_ROBIN: weighted round robin

                      • LEAST_CONNECTIONS: weighted least connections

                        @@ -143,46 +143,46 @@

                      listeners

                      +

                      listeners

                      Array of ListenerRef objects

                      +

                      Array of ListenerRef objects

                      Specifies the IDs of the listeners with which the backend server group is associated.

                      +

                      Specifies the IDs of the listeners with which the backend server group is associated.

                      loadbalancers

                      +

                      loadbalancers

                      Array of LoadBalancerRef objects

                      +

                      Array of LoadBalancerRef objects

                      Specifies the IDs of the load balancers with which the backend server group is associated.

                      +

                      Specifies the IDs of the load balancers with which the backend server group is associated.

                      members

                      +

                      members

                      Array of MemberRef objects

                      +

                      Array of MemberRef objects

                      Specifies the IDs of the backend servers in the backend server group.

                      +

                      Specifies the IDs of the backend servers in the backend server group.

                      name

                      +

                      name

                      String

                      +

                      String

                      Specifies the backend server group name.

                      +

                      Specifies the backend server group name.

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID.

                      +

                      Specifies the project ID.

                      protocol

                      +

                      protocol

                      String

                      +

                      String

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

                      +

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

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

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

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

                        @@ -192,34 +192,34 @@

                      session_persistence

                      +

                      session_persistence

                      SessionPersistence object

                      +

                      SessionPersistence object

                      Specifies the sticky session.

                      +

                      Specifies the sticky session.

                      ip_version

                      +

                      ip_version

                      String

                      +

                      String

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

                      +

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

                      IPv6 is unsupported. Only v4 will be returned.

                      slow_start

                      +

                      slow_start

                      SlowStart object

                      +

                      SlowStart object

                      Specifies slow start details. 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.

                      +

                      Specifies slow start details. 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.

                      member_deletion_protection_enable

                      +

                      member_deletion_protection_enable

                      Boolean

                      +

                      Boolean

                      Specifies whether to enable removal protection.

                      +

                      Specifies whether to enable removal protection.

                      • true: Enable removal protection.

                      • false: Disable removal protection.

                      @@ -227,34 +227,34 @@

                      created_at

                      +

                      created_at

                      String

                      +

                      String

                      Specifies the time when a backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when a backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      updated_at

                      +

                      updated_at

                      String

                      +

                      String

                      Specifies the time when when a backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when when a backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      vpc_id

                      +

                      vpc_id

                      String

                      +

                      String

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

                      +

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

                      type

                      +

                      type

                      String

                      +

                      String

                      Specifies the type of the backend server group.

                      +

                      Specifies the type of the backend server group.

                      Values:

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

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

                        @@ -266,94 +266,97 @@
                      -
                      Table 5 ListenerRef

                      Parameter

                      +
                      - - - - -
                      Table 5 ListenerRef

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the listener ID.

                      +

                      Specifies the listener ID.

                      -
                      Table 6 LoadBalancerRef

                      Parameter

                      +
                      - - - - -
                      Table 6 LoadBalancerRef

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the load balancer ID.

                      +

                      Specifies the load balancer ID.

                      -
                      Table 7 MemberRef

                      Parameter

                      +
                      - - - - -
                      Table 7 MemberRef

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the backend server ID.

                      +

                      Specifies the backend server ID.

                      -
                      Table 8 SessionPersistence

                      Parameter

                      +
                      - - - - - - - - - - -
                      Table 8 SessionPersistence

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      cookie_name

                      +

                      cookie_name

                      String

                      +

                      String

                      Specifies the cookie name. The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.). Note: This parameter will take effect only when type is set to APP_COOKIE.

                      +

                      Specifies the cookie name.

                      +

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

                      +

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

                      type

                      +

                      type

                      String

                      +

                      String

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

                      +

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

                      +

                      Note:

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

                      • If the backend server group protocol is QUIC, sticky session must be enabled with type set to SOURCE_IP.

                      persistence_timeout

                      +

                      persistence_timeout

                      Integer

                      +

                      Integer

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

                      +

                      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, UDP, or QUIC, 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.

                      @@ -363,30 +366,30 @@
                      -
                      Table 9 SlowStart

                      Parameter

                      +
                      - - - - - - - -
                      Table 9 SlowStart

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      enable

                      +

                      enable

                      Boolean

                      +

                      Boolean

                      Specifies whether to enable slow start.

                      +

                      Specifies whether to enable slow start.

                      • true: Enable slow start.

                      • false: Disable slow start.

                      Default: false

                      duration

                      +

                      duration

                      Integer

                      +

                      Integer

                      Specifies the slow start duration, in seconds.

                      +

                      Specifies the slow start duration, in seconds.

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

                      Minimum: 30

                      Maximum: 1200

                      diff --git a/docs/elb/api-ref/ShowQuota.html b/docs/elb/api-ref/ShowQuota.html index 571bd8e41..89d45bf7f 100644 --- a/docs/elb/api-ref/ShowQuota.html +++ b/docs/elb/api-ref/ShowQuota.html @@ -1,7 +1,7 @@

                      Querying Quotas

                      -

                      Function

                      This API is used to query the quotas of load balancers and related resources in a specific project.

                      +

                      Function

                      This API is used to query the quotas of load balancers and related resources in a specific project.

                      URI

                      GET /v3/{project_id}/elb/quotas

                      @@ -54,187 +54,254 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 3 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      quota

                      +

                      quota

                      Quota object

                      +

                      Quota object

                      Specifies the quotas of load balancers and associated resources. Only the total quotas are returned. Remaining available quotas will not be returned.

                      +

                      Specifies the quotas of load balancers and associated resources. Only the total quotas are returned. Remaining available quotas will not be returned.

                      -
                      Table 4 Quota

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
                      Table 4 Quota

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID.

                      +

                      Specifies the project ID.

                      loadbalancer

                      +

                      loadbalancer

                      Integer

                      +

                      Integer

                      Specifies the load balancer quota.

                      +

                      Specifies the load balancer quota.

                      • If the value is greater than or equal to 0, it indicates the load balancer quota.

                      • If the value is -1, the quota is not limited.

                      certificate

                      +

                      certificate

                      Integer

                      +

                      Integer

                      Specifies the certificate quota.

                      +

                      Specifies the certificate quota.

                      • If the value is greater than or equal to 0, it indicates the certificate quota.

                      • If the value is -1, the quota is not limited.

                      listener

                      +

                      listener

                      Integer

                      +

                      Integer

                      Specifies the listener quota.

                      +

                      Specifies the listener quota.

                      • If the value is greater than or equal to 0, it indicates the listener quota.

                      • If the value is -1, the quota is not limited.

                      listeners_per_pool

                      +

                      listeners_per_pool

                      Integer

                      +

                      Integer

                      Specifies the quota of listeners related to a backend server group.

                      -
                      • If the value is greater than or equal to 0, it indicates the listener quota.

                        -
                      • If the value is -1, the quota is not limited.

                        +

                      Specifies the maximum number of listeners that can be associated with a backend server group.

                      +
                      • If the value is greater than or equal to 0, it indicates the current quota.

                        +
                      • -1 indicates that the quota is not limited.

                      l7policy

                      +

                      ipgroups_per_listener

                      Integer

                      +

                      Integer

                      Specifies the forwarding policy quota.

                      +

                      Specifies the maximum number of IP address groups that can be associated with a listener.

                      +

                      Value options:

                      +
                      • If the value is greater than or equal to 0, it indicates the IP address group quota.

                        +
                      • -1 indicates that the quota is not limited.

                        +
                      +

                      l7policy

                      +

                      Integer

                      +

                      Specifies the forwarding policy quota.

                      • If the value is greater than or equal to 0, it indicates the forwarding policy quota.

                      • If the value is -1, the quota is not limited.

                      condition_per_policy

                      +

                      condition_per_policy

                      Integer

                      +

                      Integer

                      Specifies the quota of conditions in a l7policy.

                      -
                      • If the value is greater than or equal to 0, it indicates the condition quota.

                        -
                      • If the value is -1, the quota is not limited.

                        +

                      Specifies the maximum number of forwarding conditions per forwarding policy.

                      +
                      • If the value is greater than or equal to 0, it indicates the current quota.

                        +
                      • -1 indicates that the quota is not limited.

                      pool

                      +

                      pool

                      Integer

                      +

                      Integer

                      Specifies the backend server group quota.

                      +

                      Specifies the backend server group quota.

                      • If the value is greater than or equal to 0, it indicates the backend server group quota.

                      • If the value is -1, the quota is not limited.

                      healthmonitor

                      +

                      healthmonitor

                      Integer

                      +

                      Integer

                      Specifies the health check quota.

                      +

                      Specifies the health check quota.

                      • If the value is greater than or equal to 0, it indicates the health check quota.

                      • If the value is -1, the quota is not limited.

                      member

                      +

                      member

                      Integer

                      +

                      Integer

                      Specifies the backend server quota.

                      +

                      Specifies the backend server quota.

                      • If the value is greater than or equal to 0, it indicates the backend server quota.

                      • If the value is -1, the quota is not limited.

                      members_per_pool

                      +

                      members_per_pool

                      Integer

                      +

                      Integer

                      Specifies the quota of backend servers in a backend server group.

                      +

                      Specifies the quota of backend servers in a backend server group.

                      • If the value is greater than or equal to 0, it indicates the backend server quota.

                      • If the value is -1, the quota is not limited.

                      ipgroup

                      +

                      ipgroup

                      Integer

                      +

                      Integer

                      Specifies the IP address group quota.

                      +

                      Specifies the IP address group quota.

                      • If the value is greater than or equal to 0, it indicates the IP address group quota.

                      • If the value is -1, the quota is not limited.

                      security_policy

                      +

                      security_policy

                      Integer

                      +

                      Integer

                      Specifies the custom security policy quota.

                      +

                      Specifies the custom security policy quota.

                      • If the value is greater than or equal to 0, it indicates the custom security policy quota.

                      • If the value is -1, the quota is not limited.

                      ipgroup_bindings

                      +

                      ipgroup_bindings

                      String

                      +

                      String

                      Specifies the quota of listeners that can be bound to a ipgroup.

                      -
                      • If the value is greater than or equal to 0, it indicates the listener quota for ipgroup.

                        +

                      Specifies the maximum number of listeners that can be associated with an IP address group.

                      +
                      • If the value is greater than or equal to 0, it indicates the maximum number of listeners that can be associated with an IP address group.

                      • If the value is -1, the quota is not limited.

                      ipgroup_max_length

                      +

                      ipgroup_max_length

                      String

                      +

                      String

                      Specifies the number of ip addresses that can be added to an ipgroup.

                      -
                      • If the value is greater than or equal to 0, it indicates the ip address quota.

                        +

                      Specifies the number of IP addresses that can be added to an address group.

                      +
                      • If the value is greater than or equal to 0, it indicates the IP address quota.

                      • If the value is -1, the quota is not limited.

                      listeners_per_loadbalancer

                      +

                      Integer

                      +

                      Specifies the maximum number of listeners that can be associated with a load balancer. The value can be:

                      +
                      • If the value is greater than or equal to 0, it indicates the current quota.

                        +
                      • -1 indicates that the quota is not limited.

                        +
                      +
                      NOTE:

                      The maximum number of listeners that can be added to each load balancer is not limited, but it is recommended the listeners not exceed the default quota.

                      +
                      +

                      free_instance_members_per_pool

                      +

                      Integer

                      +

                      Specifies the maximum number of backend servers that can be added to a backend server group for free. The value can be:

                      +
                      • If the value is greater than or equal to 0, it indicates the current quota.

                        +
                      • -1 indicates that the quota is not limited.

                        +
                      +

                      This parameter is unsupported. Please do not use it.

                      +

                      free_instance_listeners_per_loadbalancer

                      +

                      Integer

                      +

                      Specifies the maximum number of listeners that can be associated with a load balancer for free. The value can be:

                      +
                      • If the value is greater than or equal to 0, it indicates the current quota.

                        +
                      • -1 indicates that the quota is not limited.

                        +
                      +

                      This parameter is unsupported. Please do not use it.

                      +

                      pools_per_l7policy

                      +

                      String

                      +

                      Specifies the maximum number of backend server groups that can be used by a forwarding policy. The value can be:

                      +
                      • If the value is greater than or equal to 0, it indicates the current quota.

                        +
                      • -1 indicates that the quota is not limited.

                        +
                      +

                      This parameter is unsupported. Please do not use it.

                      +

                      l7policies_per_listener

                      +

                      Integer

                      +

                      Specifies the maximum number of forwarding policies that can be configured for a listener.

                      +

                      Value options:

                      +
                      • If the value is greater than or equal to 0, it indicates the forwarding policy quota.

                        +
                      • -1 indicates that the quota is not limited.

                        +
                      +
                      @@ -261,6 +328,12 @@ "security_policy" : 50, "condition_per_policy" : 10, "listeners_per_pool" : 50, + "free_instance_listeners_per_loadbalancer" : 50, + "free_instance_members_per_pool" : 50, + "listeners_per_loadbalancer" : 50, + "pools_per_l7policy" : 50, + "l7policies_per_listener" : 50, + "ipgroups_per_listener" : 50, "project_id" : "060576798a80d5762fafc01a9b5eedc7" } } diff --git a/docs/elb/api-ref/ShowSecurityPolicy.html b/docs/elb/api-ref/ShowSecurityPolicy.html index c74d96579..558e0450c 100644 --- a/docs/elb/api-ref/ShowSecurityPolicy.html +++ b/docs/elb/api-ref/ShowSecurityPolicy.html @@ -1,7 +1,7 @@

                      Querying Details of a Custom Security Policy

                      -

                      Function

                      This API is used to query details of a custom security policy.

                      +

                      Function

                      This API is used to query details of a custom security policy.

                      URI

                      GET /v3/{project_id}/elb/security-policies/{security_policy_id}

                      @@ -63,120 +63,120 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 3 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      security_policy

                      +

                      security_policy

                      SecurityPolicy object

                      +

                      SecurityPolicy object

                      This API is used to query details of a custom security policy.

                      +

                      This API is used to query details of a custom security policy.

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      -
                      Table 4 SecurityPolicy

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      Table 4 SecurityPolicy

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the ID of the custom security policy.

                      +

                      Specifies the ID of the custom security policy.

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID of the custom security policy.

                      +

                      Specifies the project ID of the custom security policy.

                      name

                      +

                      name

                      String

                      +

                      String

                      Specifies the name of the custom security policy.

                      +

                      Specifies the name of the custom security policy.

                      description

                      +

                      description

                      String

                      +

                      String

                      Provides supplementary information about the custom security policy.

                      +

                      Provides supplementary information about the custom security policy.

                      listeners

                      +

                      listeners

                      Array of ListenerRef objects

                      +

                      Array of ListenerRef objects

                      Specifies the listeners that use the custom security policies.

                      +

                      Specifies the listeners that use the custom security policies.

                      protocols

                      +

                      protocols

                      Array of strings

                      +

                      Array of strings

                      Lists the TLS protocols supported by the custom security policy.

                      +

                      Lists the TLS protocols supported by the custom security policy.

                      ciphers

                      +

                      ciphers

                      Array of strings

                      +

                      Array of strings

                      Lists the cipher suites supported by the custom security policy.

                      +

                      Lists the cipher suites supported by the custom security policy.

                      created_at

                      +

                      created_at

                      String

                      +

                      String

                      Specifies the time when the custom security policy was created.

                      +

                      Specifies the time when the custom security policy was created.

                      updated_at

                      +

                      updated_at

                      String

                      +

                      String

                      Specifies the time when the custom security policy was updated.

                      +

                      Specifies the time when the custom security policy was updated.

                      -
                      Table 5 ListenerRef

                      Parameter

                      +
                      - - - - - diff --git a/docs/elb/api-ref/UpdateCertificate.html b/docs/elb/api-ref/UpdateCertificate.html index ba18172fc..582045bb6 100644 --- a/docs/elb/api-ref/UpdateCertificate.html +++ b/docs/elb/api-ref/UpdateCertificate.html @@ -1,295 +1,311 @@

                      Updating a Certificate

                      -

                      Function

                      This API is used to update an SSL certificate.

                      +

                      Function

                      This API is used to update an SSL certificate.

                      -

                      Constraints

                      If a certificate wth a domain name is used by a listener, the domain name cannot be updated to an empty string (""), and the system returns the 409 Conflict status code.

                      +

                      Constraints

                      If a certificate wth a domain name is used by a listener, the domain name cannot be updated to an empty string (""), and the system returns the 409 Conflict status code.

                      -

                      URI

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

                      +

                      URI

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

                      -
                      Table 5 ListenerRef

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the listener ID.

                      +

                      Specifies the listener ID.

                      Table 1 Path Parameters

                      Parameter

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

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      certificate_id

                      +

                      certificate_id

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Specifies a certificate ID.

                      +

                      Specifies a certificate ID.

                      project_id

                      +

                      project_id

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Specifies the project ID of the certificate.

                      +

                      Specifies the project ID of the certificate.

                      -

                      Request Parameters

                      -
                      Table 2 Request header parameters

                      Parameter

                      +

                      Request Parameters

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

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      X-Auth-Token

                      +

                      X-Auth-Token

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      Specifies the token used for IAM authentication.

                      +

                      Specifies the token used for IAM authentication.

                      -
                      Table 3 Request body parameters

                      Parameter

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

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      certificate

                      +

                      certificate

                      Yes

                      +

                      Yes

                      UpdateCertificateOption object

                      +

                      UpdateCertificateOption object

                      Specifies the certificate.

                      +

                      Specifies the certificate.

                      -
                      Table 4 UpdateCertificateOption

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - -
                      Table 4 UpdateCertificateOption

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      certificate

                      +

                      certificate

                      No

                      +

                      No

                      String

                      +

                      String

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

                      -

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

                      +

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

                      +

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

                      description

                      +

                      description

                      No

                      +

                      No

                      String

                      +

                      String

                      Provides supplementary information about the certificate.

                      -

                      Minimum: 0

                      -

                      Maximum: 255

                      +

                      Provides supplementary information about the certificate.

                      +

                      Minimum: 0

                      +

                      Maximum: 255

                      name

                      +

                      name

                      No

                      +

                      No

                      String

                      +

                      String

                      Specifies the certificate name.

                      -

                      Minimum: 0

                      -

                      Maximum: 255

                      +

                      Specifies the certificate name.

                      +

                      Minimum: 0

                      +

                      Maximum: 255

                      private_key

                      +

                      private_key

                      No

                      +

                      No

                      String

                      +

                      String

                      Specifies the private key of the server certificate. The value must be PEM encoded. Maximum 8,192 character length is allowed.

                      -
                      • This parameter is valid and mandatory only when type is set to server.
                      • This parameter will not take effect and an error will be returned if type is set to client.
                      +

                      Specifies the private key of the server certificate. The value must be PEM encoded. Maximum 8,192 character length is allowed.

                      +
                      • This parameter is valid and mandatory only when type is set to server.

                        +
                      • This parameter will not take effect and an error will be returned if type is set to client.

                        +

                      domain

                      +

                      domain

                      No

                      +

                      No

                      String

                      +

                      String

                      Specifies the domain names used by the server certificate.

                      -

                      Note the following when using domain names:

                      -
                      • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.
                      • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com
                      • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com
                      • This parameter will take effect only when **type** is set to **server**.
                      • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.
                      • SNI certificates of a shared load balancer's listener can have up to 30 domain names.
                      -

                      Minimum: 0

                      -

                      Maximum: 10000

                      +

                      Specifies the domain names used by the server certificate.

                      +

                      Note the following when using domain names:

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

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

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

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

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

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

                        +
                      +

                      Minimum: 0

                      +

                      Maximum: 10000

                      -

                      Response Parameters

                      Status code: 200

                      +

                      Response Parameters

                      Status code: 200

                      -
                      Table 5 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      certificate

                      +

                      certificate

                      CertificateInfo object

                      +

                      CertificateInfo object

                      Specifies the certificate.

                      +

                      Specifies the certificate.

                      -
                      Table 6 CertificateInfo

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      admin_state_up

                      +

                      admin_state_up

                      Boolean

                      +

                      Boolean

                      Specifies the administrative status of the certificate.

                      -

                      This parameter is unsupported. Please do not use it.

                      +

                      Specifies the administrative status of the certificate.

                      +

                      This parameter is unsupported. Please do not use it.

                      certificate

                      +

                      certificate

                      String

                      +

                      String

                      Specifies the certificate content. The value must be PEM encoded.

                      +

                      Specifies the certificate content. The value must be PEM encoded.

                      description

                      +

                      description

                      String

                      +

                      String

                      Provides supplementary information about the certificate.

                      -

                      Minimum: 1

                      -

                      Maximum: 255

                      +

                      Provides supplementary information about the certificate.

                      +

                      Minimum: 1

                      +

                      Maximum: 255

                      domain

                      +

                      domain

                      String

                      +

                      String

                      Specifies the domain names used by the server certificate.

                      -

                      Note the following when using domain names:

                      -
                      • The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.
                      • A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com
                      • A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com
                      • This parameter will take effect only when **type** is set to **server**.
                      • SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.
                      • SNI certificates of a shared load balancer's listener can have up to 30 domain names.
                      -

                      Minimum: 1

                      -

                      Maximum: 10000

                      +

                      Specifies the domain names used by the server certificate.

                      +

                      Note the following when using domain names:

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

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

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

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

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

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

                        +
                      +

                      Minimum: 1

                      +

                      Maximum: 10000

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the certificate ID.

                      +

                      Specifies the certificate ID.

                      name

                      +

                      name

                      String

                      +

                      String

                      Specifies the certificate name.

                      -

                      Minimum: 1

                      -

                      Maximum: 255

                      +

                      Specifies the certificate name.

                      +

                      Minimum: 1

                      +

                      Maximum: 255

                      private_key

                      +

                      private_key

                      String

                      +

                      String

                      Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

                      -
                      • This parameter is valid and mandatory only when type is set to server.
                      • This parameter will be ignored even if type is set to client. A CA certificate can still be created and used normally.
                      +

                      Specifies the private key of the certificate used by HTTPS listeners. The value can contain up to 8,192 PEM encoded characters.

                      +
                      • This parameter is valid and mandatory only when type is set to server.

                        +
                      • This parameter will be ignored even if type is set to client. A CA certificate can still be created and used normally.

                        +

                      type

                      +

                      type

                      String

                      +

                      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.

                      +

                      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

                      +

                      created_at

                      String

                      +

                      String

                      Specifies the time when the certificate was created.

                      +

                      Specifies the time when the certificate was created.

                      updated_at

                      +

                      updated_at

                      String

                      +

                      String

                      Specifies the time when the certificate was updated.

                      +

                      Specifies the time when the certificate was updated.

                      expire_time

                      +

                      expire_time

                      String

                      +

                      String

                      Specifies the time when the certificate expires.

                      +

                      Specifies the time when the certificate expires.

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID of the certificate.

                      +

                      Specifies the project ID of the certificate.

                      -

                      Example Requests

                      PUT https://{ELB_Endponit}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/certificates/233a325e5e3e4ce8beeb320aa714cc12
                      +

                      Example Requests

                      PUT https://{ELB_Endponit}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/certificates/233a325e5e3e4ce8beeb320aa714cc12
                       
                       {
                         "certificate" : {
                      @@ -298,9 +314,9 @@
                         }
                       }
                      -

                      Example Responses

                      Status code: 200

                      -

                      Successful request.

                      -
                      {
                      +

                      Example Responses

                      Status code: 200

                      +

                      Successful request.

                      +
                      {
                         "certificate" : {
                           "private_key" : "-----BEGIN PRIVATE KEY-----MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPetB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rMMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXtCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2ChlZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08kEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/HlfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQBZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKrciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9MEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7AlekrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CTXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kxGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dtJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLriWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBUxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAdXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4VhafI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9ojHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIukfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd3fy+1rCUwzOp9LSjtJYf4ege-----END PRIVATE KEY-----",
                           "description" : "Update my Certificate.",
                      @@ -318,23 +334,23 @@
                         "request_id" : "d9abea6b-98ee-4ad4-8c5d-185ded48742f"
                       }
                      -

                      Status Codes

                      -
                      - @@ -226,7 +228,8 @@ - @@ -253,162 +256,164 @@

                      Response Parameters

                      Status code: 200

                      -

                      Status Code

                      +

                      Status Codes

                      +
                      - - -

                      Status Code

                      Description

                      +

                      Description

                      200

                      +

                      200

                      Successful request.

                      +

                      Successful request.

                      -

                      Error Codes

                      See Error Codes.

                      +

                      Error Codes

                      See Error Codes.

                      diff --git a/docs/elb/api-ref/UpdateHealthMonitor.html b/docs/elb/api-ref/UpdateHealthMonitor.html index 82d939232..a2f6a2102 100644 --- a/docs/elb/api-ref/UpdateHealthMonitor.html +++ b/docs/elb/api-ref/UpdateHealthMonitor.html @@ -1,7 +1,7 @@

                      Updating a Health Check

                      -

                      Function

                      This API is used to update 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.

                      @@ -145,7 +145,8 @@
                    • A list of values that are separated with commas (,), for example, 200, 202

                    • A value range, for example, 200-204

                    • -

                      The default value is 200. Multiple status codes can be queried in the format of expected_codes=xxx&expected_codes=xxx.

                      +

                      The default value is 200.

                      +

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

                      Minimum: 1

                      Maximum: 64

                      @@ -215,7 +216,8 @@

                      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.

                      +

                      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

                      String

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

                      +

                      Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.

                      +

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

                      Minimum: 1

                      Maximum: 80

                      Table 5 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      healthmonitor

                      +

                      healthmonitor

                      HealthMonitor object

                      +

                      HealthMonitor object

                      Specifies the health check.

                      +

                      Specifies the health check.

                      -
                      Table 6 HealthMonitor

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -445,19 +451,19 @@
                      Table 6 HealthMonitor

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      admin_state_up

                      +

                      admin_state_up

                      Boolean

                      +

                      Boolean

                      Specifies the administrative status of the health check.

                      +

                      Specifies the administrative status of the health check.

                      • true(default) indicates that the health check is enabled.

                      • false indicates that the health check is disabled.

                      delay

                      +

                      delay

                      Integer

                      +

                      Integer

                      Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

                      +

                      Specifies the interval between health checks, in seconds. The value ranges from 1 to 50.

                      Minimum: 1

                      Maximum: 50

                      domain_name

                      +

                      domain_name

                      String

                      +

                      String

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

                      +

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

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

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

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

                      expected_codes

                      +

                      expected_codes

                      String

                      +

                      String

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

                      +

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

                      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

                      -

                      The default value is 200. Multiple status codes can be queried in the format of expected_codes=xxx&expected_codes=xxx.

                      +

                      The default value is 200.

                      +

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

                      http_method

                      +

                      http_method

                      String

                      +

                      String

                      Specifies the HTTP method. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. The default value is GET.

                      +

                      Specifies the HTTP method. The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH. The default value is GET.

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

                      This parameter is unsupported. Please do not use it.

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the health check ID.

                      +

                      Specifies the health check ID.

                      max_retries

                      +

                      max_retries

                      Integer

                      +

                      Integer

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

                      +

                      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

                      +

                      max_retries_down

                      Integer

                      +

                      Integer

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

                      +

                      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, and the default value is 3.

                      Minimum: 1

                      Maximum: 10

                      monitor_port

                      +

                      monitor_port

                      Integer

                      +

                      Integer

                      Specifies the port used for the health check. If this parameter is left blank, a port of the backend server will be used by default. The port number ranges from 1 to 65535.

                      +

                      Specifies the port used for the health check. If this parameter is left blank, a port of the backend server will be used by default. The port number ranges from 1 to 65535.

                      Minimum: 1

                      Maximum: 65535

                      name

                      +

                      name

                      String

                      +

                      String

                      Specifies the health check name.

                      +

                      Specifies the health check name.

                      pools

                      +

                      pools

                      Array of PoolRef objects

                      +

                      Array of PoolRef objects

                      Lists the IDs of backend server groups for which the health check is configured. Only one ID will be returned.

                      +

                      Lists the IDs of backend server groups for which the health check is configured. Only one ID will be returned.

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID.

                      +

                      Specifies the project ID.

                      timeout

                      +

                      timeout

                      Integer

                      +

                      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.

                      +

                      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

                      +

                      type

                      String

                      +

                      String

                      Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, or HTTPS.

                      +

                      Specifies the health check protocol. The value can be TCP, UDP_CONNECT, HTTP, or HTTPS.

                      Note:

                      • If the protocol of the backend server is QUIC, the value can only be UDP_CONNECT.

                      • If the protocol of the backend server is UDP, the value can only be UDP_CONNECT.

                        @@ -418,26 +423,27 @@

                      url_path

                      +

                      url_path

                      String

                      +

                      String

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

                      +

                      Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.

                      +

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

                      created_at

                      +

                      created_at

                      String

                      +

                      String

                      Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      updated_at

                      +

                      updated_at

                      String

                      +

                      String

                      Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      -
                      Table 7 PoolRef

                      Parameter

                      +
                      - - - - - diff --git a/docs/elb/api-ref/UpdateIpGroup.html b/docs/elb/api-ref/UpdateIpGroup.html index 6789c37a8..6fd51ffc6 100644 --- a/docs/elb/api-ref/UpdateIpGroup.html +++ b/docs/elb/api-ref/UpdateIpGroup.html @@ -1,7 +1,7 @@

                      Updating an IP Address Group

                      -

                      Function

                      This API is used to update an IP address group. All IP addresses in the IP address group will be overwritten, and the IP addresses that are not included in the ip_list parameter in the request body will be removed. The IP address can contain IP addresses or CIDR blocks. 0.0.0.0 will be considered the same as 0.0.0.0/32. If you enter both 0.0.0.0 and 0.0.0.0/32, only one will be kept. 0:0:0:0:0:0:0:1 will be considered the same as ::1 and ::1/128. If you enter 0:0:0:0:0:0:0:1, ::1 and ::1/128, only one will be kept.

                      +

                      Function

                      This API is used to update an IP address group. All IP addresses in the IP address group will be overwritten, and the IP addresses that are not included in the ip_list parameter in the request body will be removed. The IP address can contain IP addresses or CIDR blocks. 0.0.0.0 will be considered the same as 0.0.0.0/32. If you enter both 0.0.0.0 and 0.0.0.0/32, only one will be kept. 0:0:0:0:0:0:0:1 will be considered the same as ::1 and ::1/128. If you enter 0:0:0:0:0:0:0:1, ::1 and ::1/128, only one will be kept.

                      URI

                      PUT /v3/{project_id}/elb/ipgroups/{ipgroup_id}

                      @@ -166,121 +166,121 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 7 PoolRef

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the ID of the backend server group.

                      +

                      Specifies the ID of the backend server group.

                      Table 6 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      ipgroup

                      +

                      ipgroup

                      IpGroup object

                      +

                      IpGroup object

                      Specifies the IP address group.

                      +

                      Specifies the IP address group.

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      -
                      Table 7 IpGroup

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      Table 7 IpGroup

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      created_at

                      +

                      created_at

                      String

                      +

                      String

                      Specifies the time when the IP address group was created.

                      +

                      Specifies the time when the IP address group was created.

                      description

                      +

                      description

                      String

                      +

                      String

                      Specifies the time when the IP address group was updated.

                      +

                      Specifies the time when the IP address group was updated.

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the ID of the IP address group.

                      +

                      Specifies the ID of the IP address group.

                      ip_list

                      +

                      ip_list

                      Array of IpInfo objects

                      +

                      Array of IpInfo objects

                      Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

                      +

                      Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

                      Array Length: 0 - 300

                      listeners

                      +

                      listeners

                      Array of ListenerRef objects

                      +

                      Array of ListenerRef objects

                      Lists the IDs of listeners with which the IP address group is associated.

                      +

                      Lists the IDs of listeners with which the IP address group is associated.

                      name

                      +

                      name

                      String

                      +

                      String

                      Specifies the IP address group name.

                      +

                      Specifies the IP address group name.

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID of the IP address group.

                      +

                      Specifies the project ID of the IP address group.

                      updated_at

                      +

                      updated_at

                      String

                      +

                      String

                      Specifies the time when the IP address group was updated.

                      +

                      Specifies the time when the IP address group was updated.

                      -
                      Table 8 IpInfo

                      Parameter

                      +
                      - - - - - - - - @@ -289,19 +289,19 @@
                      Table 8 IpInfo

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      ip

                      +

                      ip

                      String

                      +

                      String

                      Specifies the IP addresses in the IP address group.

                      +

                      Specifies the IP addresses in the IP address group.

                      description

                      +

                      description

                      String

                      +

                      String

                      Provides remarks about the IP address group.

                      +

                      Provides remarks about the IP address group.

                      Minimum: 0

                      Maximum: 255

                      -
                      Table 9 ListenerRef

                      Parameter

                      +
                      - - - - - diff --git a/docs/elb/api-ref/UpdateIpList.html b/docs/elb/api-ref/UpdateIpList.html index 7166ee5f1..91c784f47 100644 --- a/docs/elb/api-ref/UpdateIpList.html +++ b/docs/elb/api-ref/UpdateIpList.html @@ -1,7 +1,7 @@

                      Updating IP Addresses in an IP Address Group

                      -

                      Function

                      This API is used to update the IP addresses in an IP address group.

                      +

                      Function

                      This API is used to update the IP addresses in an IP address group.

                      URI

                      POST /v3/{project_id}/elb/ipgroups/{ipgroup_id}/iplist/create-or-update

                      @@ -161,121 +161,121 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 9 ListenerRef

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the listener ID.

                      +

                      Specifies the listener ID.

                      Table 6 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      ipgroup

                      +

                      ipgroup

                      IpGroup object

                      +

                      IpGroup object

                      Shows IP address information.

                      +

                      Shows IP address information.

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      -
                      Table 7 IpGroup

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      Table 7 IpGroup

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      created_at

                      +

                      created_at

                      String

                      +

                      String

                      Specifies the time when the IP address group was created.

                      +

                      Specifies the time when the IP address group was created.

                      description

                      +

                      description

                      String

                      +

                      String

                      Specifies the time when the IP address group was updated.

                      +

                      Specifies the time when the IP address group was updated.

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the ID of the IP address group.

                      +

                      Specifies the ID of the IP address group.

                      ip_list

                      +

                      ip_list

                      Array of IpInfo objects

                      +

                      Array of IpInfo objects

                      Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

                      +

                      Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.

                      Array Length: 0 - 300

                      listeners

                      +

                      listeners

                      Array of ListenerRef objects

                      +

                      Array of ListenerRef objects

                      Lists the IDs of listeners with which the IP address group is associated.

                      +

                      Lists the IDs of listeners with which the IP address group is associated.

                      name

                      +

                      name

                      String

                      +

                      String

                      Specifies the IP address group name.

                      +

                      Specifies the IP address group name.

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID of the IP address group.

                      +

                      Specifies the project ID of the IP address group.

                      updated_at

                      +

                      updated_at

                      String

                      +

                      String

                      Specifies the time when the IP address group was updated.

                      +

                      Specifies the time when the IP address group was updated.

                      -
                      Table 8 IpInfo

                      Parameter

                      +
                      - - - - - - - - @@ -284,19 +284,19 @@
                      Table 8 IpInfo

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      ip

                      +

                      ip

                      String

                      +

                      String

                      Specifies the IP addresses in the IP address group.

                      +

                      Specifies the IP addresses in the IP address group.

                      description

                      +

                      description

                      String

                      +

                      String

                      Provides remarks about the IP address group.

                      +

                      Provides remarks about the IP address group.

                      Minimum: 0

                      Maximum: 255

                      -
                      Table 9 ListenerRef

                      Parameter

                      +
                      - - - - - diff --git a/docs/elb/api-ref/UpdateL7Policy.html b/docs/elb/api-ref/UpdateL7Policy.html index 4dfdf650b..e68d42fdb 100644 --- a/docs/elb/api-ref/UpdateL7Policy.html +++ b/docs/elb/api-ref/UpdateL7Policy.html @@ -1,7 +1,7 @@

                      Updating a Forwarding Policy

                      -

                      Function

                      This API is used to update a forwarding policy.

                      +

                      Function

                      This API is used to update a forwarding policy.

                      URI

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

                      @@ -197,7 +197,8 @@
                      - @@ -450,7 +452,9 @@
                    • METHOD: An HTTP request method will be used for matching.

                    • HEADER: The request header will be used for matching.

                    • QUERY_STRING: A query string will be used for matching.

                      -
                    • SOURCE_IP: The source IP address will be used for matching. Note: If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, only one forwarding rule can be created for each type.

                      +
                    • SOURCE_IP: The source IP address will be used for matching.

                      +

                      Note:

                      +

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

                    • @@ -552,7 +556,8 @@ - @@ -561,45 +566,45 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 9 ListenerRef

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the listener ID.

                      +

                      Specifies the listener ID.

                      Integer

                      Specifies the forwarding policy priority. A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener. This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

                      +

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

                      +

                      This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

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

                      • If enhance_l7policy_enable is not enabled, forwarding policies are automatically prioritized based on the original policy sorting logic. The priorities of domain names are independent from each other. For the same domain name, the priorities are sorted in the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If the matching types are the same, the longer the URL is, the higher the priority is. 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 be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to be created because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, specify a value or adjust the priorities of existing forwarding policies. If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default.

                        @@ -216,7 +217,8 @@

                      Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL.

                      Note:

                      • If action is set to REDIRECT_TO_POOL, specify either redirect_pool_id or redirect_pools_config. If both are specified, only redirect_pools_config takes effect.

                        -
                      • This parameter cannot be specified when action is set to REDIRECT_TO_LISTENER. All configuration will be overwritten.

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

                        +

                        All configuration will be overwritten.

                      Integer

                      Specifies the weight of the backend server group. The value ranges from 0 to 100.

                      +

                      Specifies the weight of the backend server group.

                      +

                      The value ranges from 0 to 100.

                      Table 10 Response body parameters

                      Parameter

                      +
                      - - - - - - - -
                      Table 10 Response body parameters

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      l7policy

                      +

                      l7policy

                      L7Policy object

                      +

                      L7Policy object

                      Specifies the forwarding policy.

                      +

                      Specifies the forwarding policy.

                      -
                      Table 11 L7Policy

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -776,104 +782,105 @@
                      Table 11 L7Policy

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      action

                      +

                      action

                      String

                      +

                      String

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

                      +

                      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_URL: Requests will be redirected to another URL.

                        @@ -612,59 +617,60 @@

                      admin_state_up

                      +

                      admin_state_up

                      Boolean

                      +

                      Boolean

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

                      +

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

                      This parameter is unsupported. Please do not use it.

                      description

                      +

                      description

                      String

                      +

                      String

                      Provides supplementary information about the forwarding policy.

                      +

                      Provides supplementary information about the forwarding policy.

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the forwarding policy ID.

                      +

                      Specifies the forwarding policy ID.

                      listener_id

                      +

                      listener_id

                      String

                      +

                      String

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

                      +

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

                      name

                      +

                      name

                      String

                      +

                      String

                      Specifies the forwarding policy name.

                      +

                      Specifies the forwarding policy name.

                      Minimum: 1

                      Maximum: 255

                      position

                      +

                      position

                      Integer

                      +

                      Integer

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

                      +

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

                      This parameter is unsupported. Please do not use it.

                      Minimum: 1

                      Maximum: 100

                      priority

                      +

                      priority

                      Integer

                      +

                      Integer

                      Specifies the forwarding policy priority. A smaller value indicates a higher priority. The value must be unique for forwarding policies of the same listener. This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

                      +

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

                      +

                      This parameter will take effect only 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. This parameter is unsupported for shared load balancers.

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

                      • If enhance_l7policy_enable is not enabled, forwarding policies are automatically prioritized based on the original policy sorting logic. The priorities of domain names are independent from each other. For the same domain name, the priorities are sorted in the order of exact match (EQUAL_TO), prefix match (STARTS_WITH), and regular expression match (REGEX). If the matching types are the same, the longer the URL is, the higher the priority is. 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 be a sum of 1 and the highest priority of existing forwarding policy in the same listener by default. If the highest priority of existing forwarding policies is the maximum (10,000), the forwarding policy will fail to be created because the final priority for creating the forwarding policy is the sum of 1 and 10,000, which exceeds the maximum. In this case, specify a value or adjust the priorities of existing forwarding policies. If no forwarding policies exist, the highest priority of existing forwarding policies will be set to 1 by default.

                        @@ -672,45 +678,45 @@

                        This parameter is invalid for shared load balancers.

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID of the forwarding policy.

                      +

                      Specifies the project ID of the forwarding policy.

                      provisioning_status

                      +

                      provisioning_status

                      String

                      +

                      String

                      Specifies the provisioning status of the forwarding policy.

                      +

                      Specifies the provisioning status of the forwarding policy.

                      The value can be ACTIVE or ERROR.

                      • ACTIVE (default): The forwarding policy is provisioned successfully.

                      redirect_pool_id

                      +

                      redirect_pool_id

                      String

                      +

                      String

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

                      +

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

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

                      • If both redirect_pools_config and redirect_pool_id are specified, redirect_pools_config will take effect.

                      redirect_pools_config

                      +

                      redirect_pools_config

                      Array of CreateRedirectPoolsConfig objects

                      +

                      Array of CreateRedirectPoolsConfig objects

                      Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL.

                      +

                      Specifies the configuration of the backend server group that the requests are forwarded to. This parameter is valid only when action is set to REDIRECT_TO_POOL.

                      redirect_listener_id

                      +

                      redirect_listener_id

                      String

                      +

                      String

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

                      +

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

                      Note:

                      • The listener's protocol must be HTTPS or TERMINATED_HTTPS.

                      • A listener added to another load balancer is not allowed.

                        @@ -718,27 +724,27 @@

                      redirect_url

                      +

                      redirect_url

                      String

                      +

                      String

                      Specifies the URL to which requests are forwarded.

                      +

                      Specifies the URL to which requests are forwarded.

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

                      This parameter is unsupported. Please do not use it.

                      rules

                      +

                      rules

                      Array of RuleRef objects

                      +

                      Array of RuleRef objects

                      Lists the forwarding rules in the forwarding policy.

                      +

                      Lists the forwarding rules in the forwarding policy.

                      redirect_url_config

                      +

                      redirect_url_config

                      RedirectUrlConfig object

                      +

                      RedirectUrlConfig object

                      Specifies the URL to which requests are forwarded.

                      +

                      Specifies the URL to which requests are forwarded.

                      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.

                      This parameter is mandatory when action is set to REDIRECT_TO_URL. It cannot be specified if the value of action is not REDIRECT_TO_URL.

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

                      @@ -747,28 +753,28 @@

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

                      fixed_response_config

                      +

                      fixed_response_config

                      FixtedResponseConfig object

                      +

                      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.

                      +

                      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.

                      This parameter is mandatory when action is set to FIXED_RESPONSE. It cannot be specified if the value of action is not FIXED_RESPONSE.

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

                      created_at

                      +

                      created_at

                      String

                      +

                      String

                      Specifies the time when the forwarding policy was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when the forwarding policy was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      updated_at

                      +

                      updated_at

                      String

                      +

                      String

                      Specifies the time when the forwarding policy was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when the forwarding policy was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      -
                      Table 12 CreateRedirectPoolsConfig

                      Parameter

                      +
                      - - - - - - - -
                      Table 12 CreateRedirectPoolsConfig

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      pool_id

                      +

                      pool_id

                      String

                      +

                      String

                      Specifies the ID of the backend server group.

                      +

                      Specifies the ID of the backend server group.

                      weight

                      +

                      weight

                      Integer

                      +

                      Integer

                      Specifies the weight of the backend server group. The value ranges from 0 to 100.

                      +

                      Specifies the weight of the backend server group.

                      +

                      The value ranges from 0 to 100.

                      -
                      Table 13 RuleRef

                      Parameter

                      +
                      - - - - -
                      Table 13 RuleRef

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the forwarding rule ID.

                      +

                      Specifies the forwarding rule ID.

                      -
                      Table 14 RedirectUrlConfig

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - -
                      Table 14 RedirectUrlConfig

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      protocol

                      +

                      protocol

                      String

                      +

                      String

                      Specifies the protocol for redirection.

                      +

                      Specifies the protocol for redirection.

                      The value can be HTTP, HTTPS, or ${protocol}. The default value is ${protocol}, indicating that the protocol of the request will be used.

                      Minimum: 1

                      Maximum: 36

                      host

                      +

                      host

                      String

                      +

                      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.

                      +

                      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

                      +

                      port

                      String

                      +

                      String

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

                      +

                      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

                      +

                      path

                      String

                      +

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

                      +

                      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

                      +

                      query

                      String

                      +

                      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.

                      +

                      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.example.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.example.com:8080/elb?type=loadbalancer&name=my_name.

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

                      Default: ${query}

                      @@ -881,11 +888,11 @@

                      Maximum: 128

                      status_code

                      +

                      status_code

                      String

                      +

                      String

                      Specifies the status code returned after the requests are redirected.

                      +

                      Specifies the status code returned after the requests are redirected.

                      The value can be 301, 302, 303, 307, or 308.

                      Minimum: 1

                      Maximum: 16

                      @@ -895,38 +902,38 @@
                      -
                      Table 15 FixtedResponseConfig

                      Parameter

                      +
                      - - - - - - - - - - - diff --git a/docs/elb/api-ref/UpdateL7Rule.html b/docs/elb/api-ref/UpdateL7Rule.html index c6f201d8e..972cb74f6 100644 --- a/docs/elb/api-ref/UpdateL7Rule.html +++ b/docs/elb/api-ref/UpdateL7Rule.html @@ -1,7 +1,7 @@

                      Updating a Forwarding Rule

                      -

                      Function

                      This API is used to update 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}

                      @@ -175,7 +175,8 @@
                      - @@ -233,79 +234,79 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 15 FixtedResponseConfig

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      status_code

                      +

                      status_code

                      String

                      +

                      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.

                      +

                      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

                      +

                      content_type

                      String

                      +

                      String

                      Specifies the format of the response body.

                      +

                      Specifies the format of the response body.

                      The value can be text/plain, text/css, text/html, application/javascript, or application/json.

                      Minimum: 0

                      Maximum: 32

                      message_body

                      +

                      message_body

                      String

                      +

                      String

                      Specifies the content of the response message body.

                      +

                      Specifies the content of the response message body.

                      Minimum: 0

                      Maximum: 1024

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

                      +

                      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.

                      Table 6 Response body parameters

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      request_id

                      +

                      request_id

                      String

                      +

                      String

                      Specifies the request ID. The value is automatically generated.

                      +

                      Specifies the request ID. The value is automatically generated.

                      rule

                      +

                      rule

                      L7Rule object

                      +

                      L7Rule object

                      Specifies the forwarding rule.

                      +

                      Specifies the forwarding rule.

                      -
                      Table 7 L7Rule

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -380,19 +382,19 @@
                      Table 7 L7Rule

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      admin_state_up

                      +

                      admin_state_up

                      Boolean

                      +

                      Boolean

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

                      +

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

                      This parameter is unsupported. Please do not use it.

                      compare_type

                      +

                      compare_type

                      String

                      +

                      String

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

                      +

                      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, the value can be REGEX, STARTS_WITH, or EQUAL_TO.

                      key

                      +

                      key

                      String

                      +

                      String

                      Specifies the key of the match content. This parameter will not take effect if type is set to HOST_NAME or PATH.

                      +

                      Specifies the key of the match content. This parameter will not take effect if type is set to HOST_NAME or PATH.

                      Minimum: 1

                      Maximum: 255

                      project_id

                      +

                      project_id

                      String

                      +

                      String

                      Specifies the project ID.

                      +

                      Specifies the project ID.

                      type

                      +

                      type

                      String

                      +

                      String

                      Specifies the type of the forwarding rule. The value can be one of the following:

                      +

                      Specifies the type of the forwarding rule. 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.

                      • METHOD: An HTTP request method will be used for matching.

                        @@ -317,11 +318,11 @@

                        If type is set to HOST_NAME, PATH, METHOD, and SOURCE_IP, only one forwarding rule can be created for each type. If type is set to HEADER and QUERY_STRING, multiple forwarding rules can be created for each type.

                      value

                      +

                      value

                      String

                      +

                      String

                      Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. This parameter will take effect only when conditions is left blank.

                      +

                      Specifies the value of the match item. For example, if a domain name is used for matching, value is the domain name. This parameter will take effect only when conditions is left blank.

                      • 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 _~';@^-%#&$.*+?,=!:|/()[]{}

                      • If type is set to METHOD, SOURCE_IP, HEADER, or QUERY_STRING, this parameter will not take effect, and condition_pair will be used to specify the key and value.

                        @@ -330,49 +331,50 @@

                        Maximum: 128

                      provisioning_status

                      +

                      provisioning_status

                      String

                      +

                      String

                      Specifies the provisioning status of the forwarding rule.

                      +

                      Specifies the provisioning status of the forwarding rule.

                      The value can only be ACTIVE (default), PENDING_CREATE, or ERROR.

                      This parameter is unsupported. Please do not use it.

                      invert

                      +

                      invert

                      Boolean

                      +

                      Boolean

                      Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but will not take effect.

                      +

                      Specifies whether reverse matching is supported. The value is fixed at false. This parameter can be updated but will not take effect.

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the forwarding policy ID.

                      +

                      Specifies the forwarding policy ID.

                      conditions

                      +

                      conditions

                      Array of RuleCondition objects

                      +

                      Array of RuleCondition 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.

                      +

                      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.

                      created_at

                      +

                      created_at

                      String

                      +

                      String

                      Specifies the time when the forwarding rule was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when the forwarding rule was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      updated_at

                      +

                      updated_at

                      String

                      +

                      String

                      Specifies the time when the forwarding rule was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                      +

                      Specifies the time when the forwarding rule was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

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

                      -
                      Table 8 RuleCondition

                      Parameter

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

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      key

                      +

                      key

                      String

                      +

                      String

                      Specifies the key of match item.

                      +

                      Specifies the key of match item.

                      • If type is set to HOST_NAME, PATH, METHOD, or SOURCE_IP, this parameter is left blank.

                      • If type is set to HEADER, key indicates the name of the HTTP header parameter. The value can contain 1 to 40 characters, including letters, digits, hyphens (-), and underscores (_).

                      • If type is set to QUERY_STRING, key indicates the name of the query parameter. The value is case sensitive and can contain 1 to 128 characters. Spaces, square brackets ([ ]), curly brackets ({ }), angle brackets (< >), backslashes (), double quotation marks (" "), pound signs (#), ampersands (&), vertical bars (|), percent signs (%), and tildes (~) are not supported.

                        @@ -402,11 +404,11 @@

                        Maximum: 128

                      value

                      +

                      value

                      String

                      +

                      String

                      Specifies the value of the match item.

                      +

                      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 _~';@^-%#&$.*+?,=!:|/()[]{}

                      • If type is set to HEADER, key indicates the name of the HTTP header parameter, and value indicates the value of the HTTP header parameter. The value can contain 1 to 128 characters. Asterisks (*) and question marks (?) are allowed, but spaces and double quotation marks are not allowed. An asterisk can match zero or more characters, and a question mark can match 1 character.

                        diff --git a/docs/elb/api-ref/UpdateListener.html b/docs/elb/api-ref/UpdateListener.html index 7ef852be0..be0d8bc37 100644 --- a/docs/elb/api-ref/UpdateListener.html +++ b/docs/elb/api-ref/UpdateListener.html @@ -1,7 +1,7 @@

                        Updating a Listener

                        -

                        Function

                        This API is used to update 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.

                        @@ -153,7 +153,8 @@

                      Boolean

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

                      -

                      This parameter is available only for HTTPS listeners. If you configure this parameter for listeners with other protocols, it will not take effect.

                      +

                      This parameter is available only for HTTPS listeners.

                      +

                      If you configure this parameter for listeners with other protocols, it will not take effect.

                      insert_headers

                      @@ -207,7 +208,7 @@

                      String

                      Specifies the security policy used by the listener.

                      -

                      Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

                      +

                      Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

                      Note:

                      • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

                      • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

                        @@ -438,139 +439,140 @@

                        Response Parameters

                        Status code: 200

                        -
                        Table 7 Response body parameters

                        Parameter

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

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        request_id

                        +

                        request_id

                        String

                        +

                        String

                        Specifies the request ID. The value is automatically generated.

                        +

                        Specifies the request ID. The value is automatically generated.

                        listener

                        +

                        listener

                        Listener object

                        +

                        Listener object

                        Specifies the listener.

                        +

                        Specifies the listener.

                        -
                        Table 8 Listener

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                        Table 8 Listener

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        admin_state_up

                        +

                        admin_state_up

                        Boolean

                        +

                        Boolean

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

                        +

                        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

                        +

                        client_ca_tls_container_ref

                        String

                        +

                        String

                        Specifies the ID of the CA certificate used by the listener. This parameter is available only when type is set to client.

                        +

                        Specifies the ID of the CA certificate used by the listener. This parameter is available only when type is set to client.

                        connection_limit

                        +

                        connection_limit

                        Integer

                        +

                        Integer

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

                        +

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

                        This parameter is unsupported. Please do not use it.

                        created_at

                        +

                        created_at

                        String

                        +

                        String

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

                        +

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

                        default_pool_id

                        +

                        default_pool_id

                        String

                        +

                        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.

                        +

                        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

                        +

                        default_tls_container_ref

                        String

                        +

                        String

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

                        +

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

                        description

                        +

                        description

                        String

                        +

                        String

                        Provides supplementary information about the listener.

                        +

                        Provides supplementary information about the listener.

                        http2_enable

                        +

                        http2_enable

                        Boolean

                        +

                        Boolean

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

                        -

                        This parameter is available only for HTTPS listeners. If you configure this parameter for listeners with other protocols, it will not take effect.

                        +

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

                        +

                        This parameter is available only for HTTPS listeners.

                        +

                        If you configure this parameter for listeners with other protocols, it will not take effect.

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the listener ID.

                        +

                        Specifies the listener ID.

                        insert_headers

                        +

                        insert_headers

                        ListenerInsertHeaders object

                        +

                        ListenerInsertHeaders object

                        Specifies the HTTP header fields that can transmit required information to backend servers. For example, the X-Forwarded-ELB-IP header field can transmit the EIP of the load balancer to backend servers.

                        +

                        Specifies the HTTP header fields that can transmit required information to backend servers. For example, the X-Forwarded-ELB-IP header field can transmit the EIP of the load balancer to backend servers.

                        loadbalancers

                        +

                        loadbalancers

                        Array of LoadBalancerRef objects

                        +

                        Array of LoadBalancerRef objects

                        Specifies the ID of the load balancer that the listener is added to. A listener can be added to only one load balancer.

                        +

                        Specifies the ID of the load balancer that the listener is added to. A listener can be added to only one load balancer.

                        name

                        +

                        name

                        String

                        +

                        String

                        Specifies the listener name.

                        +

                        Specifies the listener name.

                        project_id

                        +

                        project_id

                        String

                        +

                        String

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

                        +

                        Specifies the ID of the project where the listener is used.

                        protocol

                        +

                        protocol

                        String

                        +

                        String

                        Specifies the protocol used by the listener.

                        +

                        Specifies the protocol used by the listener.

                        The value can be TCP, HTTP, UDP, HTTPS or TERMINATED_HTTPS.

                        Note:

                        • Protocol used by HTTPS listeners added to a shared load balancer can only be set to TERMINATED_HTTPS. If HTTPS is passed, the value will be automatically changed to TERMINATED_HTTPS.

                          @@ -578,55 +580,55 @@

                        protocol_port

                        +

                        protocol_port

                        Integer

                        +

                        Integer

                        Specifies the port used by the listener to receive requests from clients.

                        +

                        Specifies the port used by the listener to receive requests from clients.

                        Minimum: 1

                        Maximum: 65535

                        sni_container_refs

                        +

                        sni_container_refs

                        Array of strings

                        +

                        Array of strings

                        Specifies the IDs of SNI certificates (server certificates with domain names) used by the listener.

                        +

                        Specifies the IDs of SNI certificates (server certificates with domain names) used by the listener.

                        Note:

                        • The domain names of all SNI certificates must be unique.

                        • The total number of domain names of all SNI certificates cannot exceed 30.

                        sni_match_algo

                        +

                        sni_match_algo

                        String

                        +

                        String

                        Specifies how wildcard domain name matches with the SNI certificates used by the listener.

                        +

                        Specifies how wildcard domain name matches with the SNI certificates used by the listener.

                        longest_suffix indicates longest suffix match. wildcard indicates wildcard match.

                        The default value is wildcard.

                        tags

                        +

                        tags

                        Array of Tag objects

                        +

                        Array of Tag objects

                        Lists the tags.

                        +

                        Lists the tags.

                        updated_at

                        +

                        updated_at

                        String

                        +

                        String

                        Specifies the time when the listener was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

                        +

                        Specifies the time when the listener was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z'', for example, 2021-07-30T12:03:44Z.

                        tls_ciphers_policy

                        +

                        tls_ciphers_policy

                        String

                        +

                        String

                        Specifies the security policy used by the listener.

                        -

                        Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

                        +

                        Specifies the security policy used by the listener.

                        +

                        Values: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, tls-1-2-strict-no-cbc, and tls-1-0 (default).

                        Note:

                        • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

                        • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

                          @@ -634,11 +636,11 @@

                        security_policy_id

                        +

                        security_policy_id

                        String

                        +

                        String

                        Specifies the ID of the custom security policy.

                        +

                        Specifies the ID of the custom security policy.

                        Note:

                        • This parameter will take effect only for HTTPS listeners added to a dedicated load balancer.

                        • If both security_policy_id and tls_ciphers_policy are specified, only security_policy_id will take effect.

                          @@ -646,33 +648,33 @@

                        enable_member_retry

                        +

                        enable_member_retry

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable health check retries for backend servers. The value can be true (enable health check retries) or false (disable health check retries). The default value is true.

                        +

                        Specifies whether to enable health check retries for backend servers. The value can be true (enable health check retries) or false (disable health check retries). The default value is true.

                        Note:

                        • If a shared load balancer is associated, this parameter is available only when protocol is set to HTTP or TERMINATED_HTTPS.

                        • If a dedicated load balancer is associated, this parameter is available only when protocol is set to HTTP or HTTPS.

                        keepalive_timeout

                        +

                        keepalive_timeout

                        Integer

                        +

                        Integer

                        Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

                        +

                        Specifies the idle timeout duration, in seconds. If there are no requests reaching the load balancer after the idle timeout duration elapses, the load balancer will disconnect the connection with the client and establish a new connection when there is a new request.

                        • 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 1 to 4000, and the default value is 60.

                        • For UDP listeners, this parameter does not take effect.

                        client_timeout

                        +

                        client_timeout

                        Integer

                        +

                        Integer

                        Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

                        +

                        Specifies the timeout duration for waiting for a response from a client, in seconds. There are two situations:

                        • If the client fails to send a request header to the load balancer within the timeout duration, the request will be interrupted.

                        • If the interval between two consecutive request bodies reaching the load balancer is greater than the timeout duration, the connection will be disconnected.

                        @@ -680,27 +682,27 @@

                        This parameter is available only for HTTP and HTTPS listeners.

                        member_timeout

                        +

                        member_timeout

                        Integer

                        +

                        Integer

                        Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

                        +

                        Specifies the timeout duration for waiting for a response from a backend server, in seconds. If the backend server fails to respond after the timeout duration elapses, the load balancer will stop waiting and return HTTP 504 Gateway Timeout to the client.

                        The value ranges from 1 to 300, and the default value is 60.

                        This parameter is available only for HTTP and HTTPS listeners.

                        ipgroup

                        +

                        ipgroup

                        ListenerIpGroup object

                        +

                        ListenerIpGroup object

                        Specifies the IP address group associated with the listener.

                        +

                        Specifies the IP address group associated with the listener.

                        transparent_client_ip_enable

                        +

                        transparent_client_ip_enable

                        Boolean

                        +

                        Boolean

                        Specifies whether to pass source IP addresses of the clients to backend servers.

                        +

                        Specifies whether to pass source IP addresses of the clients to backend servers.

                        • TCP or UDP listeners of shared load balancers: The value can be true or false, and the default value is false if this parameter is not passed.

                        • HTTP or HTTPS listeners of shared load balancers: The value can only be true, and the default value is true if this parameter is not passed.

                        • All listeners of dedicated load balancers: The value can only be true, and the default value is true if this parameter is not passed.

                          @@ -712,11 +714,11 @@

                        enhance_l7policy_enable

                        +

                        enhance_l7policy_enable

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable advanced forwarding. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

                        +

                        Specifies whether to enable advanced forwarding. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.

                        • If this function is enabled, action can be set to REDIRECT_TO_URL (requests will be redirected to another URL) or Fixed_RESPONSE (a fixed response body will be returned to clients).

                        • Parameters priority, redirect_url_config, and fixed_response_config can be specified in a forwarding policy.

                        • Parameter type can be set to METHOD, HEADER, QUERY_STRING, or SOURCE_IP for a forwarding rule .

                          @@ -728,11 +730,11 @@

                          Default: false

                        quic_config

                        +

                        quic_config

                        ListenerQuicConfig object

                        +

                        ListenerQuicConfig object

                        Specifies the QUIC configuration for the current listener. This parameter is valid only when protocol is set to HTTPS.

                        +

                        Specifies the QUIC configuration for the current listener. This parameter is valid only when protocol is set to HTTPS.

                        For a TCP/UDP/HTTP/QUIC listener, if this parameter is not left blank, an error will be reported.

                        NOTE:

                        The client sends a normal HTTP request that contains information indicating that the QUIC protocol is supported.

                        @@ -745,43 +747,43 @@
                        -
                        Table 9 ListenerInsertHeaders

                        Parameter

                        +
                        - - - - - - - - - - - - - - @@ -789,47 +791,47 @@
                        Table 9 ListenerInsertHeaders

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        X-Forwarded-ELB-IP

                        +

                        X-Forwarded-ELB-IP

                        Boolean

                        +

                        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.

                        +

                        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

                        +

                        X-Forwarded-Port

                        Boolean

                        +

                        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.

                        +

                        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

                        +

                        X-Forwarded-For-Port

                        Boolean

                        +

                        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.

                        +

                        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

                        +

                        X-Forwarded-Host

                        Boolean

                        +

                        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.

                        +

                        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

                        +
                        - - - - -
                        Table 10 LoadBalancerRef

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the load balancer ID.

                        +

                        Specifies the load balancer ID.

                        -
                        Table 11 Tag

                        Parameter

                        +
                        - - - - - - - - @@ -838,39 +840,39 @@
                        Table 11 Tag

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        key

                        +

                        key

                        String

                        +

                        String

                        Specifies the tag key.

                        +

                        Specifies the tag key.

                        Minimum: 1

                        Maximum: 36

                        value

                        +

                        value

                        String

                        +

                        String

                        Specifies the tag value.

                        +

                        Specifies the tag value.

                        Minimum: 0

                        Maximum: 43

                        -
                        Table 12 ListenerIpGroup

                        Parameter

                        +
                        - - - - - - - - - - -
                        Table 12 ListenerIpGroup

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        ipgroup_id

                        +

                        ipgroup_id

                        String

                        +

                        String

                        Specifies the ID of the IP address group associated with the listener.

                        +

                        Specifies the ID of the IP address group associated with the listener.

                        This parameter is mandatory when you create the IP address group and is optional when you update the IP address group.

                        The specified IP address group must exist, and the value cannot be null.

                        enable_ipgroup

                        +

                        enable_ipgroup

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable access control.

                        +

                        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

                        +

                        type

                        String

                        +

                        String

                        Specifies how access to the listener is controlled.

                        +

                        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.

                        @@ -880,27 +882,32 @@
                        -
                        Table 13 ListenerQuicConfig

                        Parameter

                        +
                        - - - - - - - - diff --git a/docs/elb/api-ref/UpdateLoadBalancer.html b/docs/elb/api-ref/UpdateLoadBalancer.html index d4edbee44..99fc77cf6 100644 --- a/docs/elb/api-ref/UpdateLoadBalancer.html +++ b/docs/elb/api-ref/UpdateLoadBalancer.html @@ -1,789 +1,838 @@

                        Updating a Load Balancer

                        -

                        Function

                        This API is used to update a load balancer.

                        +

                        Function

                        This API is used to update a load balancer.

                        -

                        URI

                        PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

                        +

                        URI

                        PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

                        -
                        Table 13 ListenerQuicConfig

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        quic_listener_id

                        +

                        quic_listener_id

                        String

                        +

                        String

                        Specifies the ID of the QUIC listener. This parameter is mandatory for creation and is optional for update. The specified quic_listener_id must exist. The listener protocol must be QUIC and cannot be set to null, otherwise, it will conflict with enable_quic_upgrade.

                        +

                        Specifies the ID of the QUIC listener.

                        +

                        This parameter is mandatory for creation and is optional for update.

                        +

                        The specified quic_listener_id must exist. The listener protocol must be QUIC and cannot be set to null, otherwise, it will conflict with enable_quic_upgrade.

                        QUIC protocol is not supported.

                        enable_quic_upgrade

                        +

                        enable_quic_upgrade

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable QUIC upgrade. True: QUIC upgrade is enabled. False: QUIC upgrade is disabled. HTTPS listeners can be upgraded to QUIC listeners.

                        +

                        Specifies whether to enable QUIC upgrade.

                        +

                        True: QUIC upgrade is enabled.

                        +

                        False: QUIC upgrade is disabled.

                        +

                        HTTPS listeners can be upgraded to QUIC listeners.

                        QUIC protocol is not supported.

                        Table 1 Path Parameters

                        Parameter

                        +
                        - - - - - - - - - - -
                        Table 1 Path Parameters

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        loadbalancer_id

                        +

                        loadbalancer_id

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        Specifies the load balancer ID.

                        -

                        Minimum: 0

                        -

                        Maximum: 36

                        +

                        Specifies the load balancer ID.

                        +

                        Minimum: 0

                        +

                        Maximum: 36

                        project_id

                        +

                        project_id

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        Specifies the project ID.

                        -

                        Minimum: 0

                        -

                        Maximum: 36

                        +

                        Specifies the project ID.

                        +

                        Minimum: 0

                        +

                        Maximum: 36

                        -

                        Request Parameters

                        -
                        Table 2 Request header parameters

                        Parameter

                        +

                        Request Parameters

                        +
                        - - - - - - -
                        Table 2 Request header parameters

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        X-Auth-Token

                        +

                        X-Auth-Token

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        Specifies the token used for IAM authentication.

                        -

                        Minimum: 0

                        -

                        Maximum: 4096

                        +

                        Specifies the token used for IAM authentication.

                        +

                        Minimum: 0

                        +

                        Maximum: 4096

                        -
                        Table 3 Request body parameters

                        Parameter

                        +
                        - - - - - - -
                        Table 3 Request body parameters

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        loadbalancer

                        +

                        loadbalancer

                        Yes

                        +

                        Yes

                        UpdateLoadBalancerOption object

                        +

                        UpdateLoadBalancerOption object

                        Specifies the load balancer.

                        +

                        Specifies the load balancer.

                        -
                        Table 4 UpdateLoadBalancerOption

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                        Table 4 UpdateLoadBalancerOption

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        name

                        +

                        name

                        No

                        +

                        No

                        String

                        +

                        String

                        Specifies the load balancer name.

                        -

                        Minimum: 0

                        -

                        Maximum: 255

                        +

                        Specifies the load balancer name.

                        +

                        Minimum: 0

                        +

                        Maximum: 255

                        admin_state_up

                        +

                        admin_state_up

                        No

                        +

                        No

                        Boolean

                        +

                        Boolean

                        Specifies the administrative status of the load balancer. The value can only be true.

                        -

                        This parameter is unsupported. Please do not use it.

                        +

                        Specifies the administrative status of the load balancer. The value can only be true.

                        +

                        This parameter is unsupported. Please do not use it.

                        description

                        +

                        description

                        No

                        +

                        No

                        String

                        +

                        String

                        Provides supplementary information about the load balancer.

                        -

                        Minimum: 0

                        -

                        Maximum: 255

                        +

                        Provides supplementary information about the load balancer.

                        +

                        Minimum: 0

                        +

                        Maximum: 255

                        ipv6_vip_virsubnet_id

                        +

                        ipv6_vip_virsubnet_id

                        No

                        +

                        No

                        String

                        +

                        String

                        Specifies the ID of the IPv6 subnet where the load balancer resides. You can query parameter 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.

                        -

                        Note:

                        -
                        • This parameter will be passed only when IPv6 is enabled for the subnet. The subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id.
                        • This parameter can be updated only when guaranteed is set to true.
                        • The value will become null if the IPv6 address is unbound from the load balancer.
                        • The IPv4 subnet will not change, if IPv6 subet is updated.
                        +

                        Specifies the ID of the IPv6 subnet where the load balancer resides. You can query parameter 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.

                        +

                        Note:

                        +
                        • This parameter will be passed only when IPv6 is enabled for the subnet. The subnet specified by ipv6_vip_virsubnet_id must be in the VPC specified by vpc_id.

                          +
                        • This parameter can be updated only when guaranteed is set to true.

                          +
                        • The value will become null if the IPv6 address is unbound from the load balancer.

                          +
                        • The IPv4 subnet will not change, if IPv6 subnet is updated.

                          +

                        vip_subnet_cidr_id

                        +

                        vip_subnet_cidr_id

                        No

                        +

                        No

                        String

                        +

                        String

                        Specifies the ID of the IPv4 subnet where the load balancer resides. You can query parameter 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. Note:
                        • If vip_address is also specified, the IP address specified by vip_address 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 where the load balancer resides.
                        • This parameter can be updated only when guaranteed is set to true.
                        • The value will become null if the private IPv4 address is unbound from the load balancer.
                        • The IPv6 subnet will not change, if IPv4 subet is updated.
                        -

                        Minimum: 1

                        -

                        Maximum: 36

                        +

                        Specifies the ID of the IPv4 subnet where the load balancer resides. You can query parameter 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.

                          +

                          Note:

                          +
                        • If vip_address is also specified, the IP address specified by vip_address 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 where the load balancer resides.

                          +
                        • This parameter can be updated only when guaranteed is set to true.

                          +
                        • The value will become null if the private IPv4 address is unbound from the load balancer.

                          +
                        • The IPv6 subnet will not change, if IPv4 subnet is updated.

                          +
                        +

                        Minimum: 1

                        +

                        Maximum: 36

                        vip_address

                        +

                        vip_address

                        No

                        +

                        No

                        String

                        +

                        String

                        Specifies the private IPv4 address bound to the load balancer. The IP address must be from the IPv4 subnet where the load balancer resides and should not be occupied by other services.

                        -

                        vip_address can be updated only when guaranteed is set to true.

                        -

                        Minimum: 1

                        -

                        Maximum: 36

                        +

                        Specifies the private IPv4 address bound to the load balancer. The IP address must be from the IPv4 subnet where the load balancer resides and should not be occupied by other services.

                        +

                        vip_address can be updated only when guaranteed is set to true.

                        +

                        Minimum: 1

                        +

                        Maximum: 36

                        l4_flavor_id

                        +

                        l4_flavor_id

                        No

                        +

                        No

                        String

                        +

                        String

                        Specifies the ID of a flavor at Layer 4.

                        -

                        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 in the other way around.
                        • If you change the flavor, you can select only a higher or lower one. If you select a lower one, part of persistent connections will be interrupted.
                        -

                        Minimum: 1

                        -

                        Maximum: 255

                        +

                        Specifies the ID of a flavor at Layer 4.

                        +

                        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 in the other way around.

                          +
                        • If you change the flavor, you can select only a higher or lower one. If you select a lower one, part of persistent connections will be interrupted.

                          +
                        • If L7_elastic_max is specified, the load balancer uses the elastic specifications.

                          +
                        +

                        Minimum: 1

                        +

                        Maximum: 255

                        l7_flavor_id

                        +

                        l7_flavor_id

                        No

                        +

                        No

                        String

                        +

                        String

                        Specifies the ID of a flavor at Layer 7.

                        -

                        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 in the other way around.
                        • If you change the flavor, you can select only a higher or lower one. If you select a lower one, part of persistent connections will be interrupted.
                        -

                        Minimum: 1

                        -

                        Maximum: 36

                        +

                        Specifies the ID of a flavor at Layer 7.

                        +

                        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 in the other way around.

                          +
                        • If you change the flavor, you can select only a higher or lower one. If you select a lower one, part of persistent connections will be interrupted.

                          +
                        • If L7_elastic_max is specified, the load balancer uses the elastic specifications.

                          +
                        +

                        Minimum: 1

                        +

                        Maximum: 36

                        ipv6_bandwidth

                        +

                        ipv6_bandwidth

                        No

                        +

                        No

                        BandwidthRef object

                        +

                        BandwidthRef object

                        Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

                        +

                        Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

                        ip_target_enable

                        +

                        ip_target_enable

                        No

                        +

                        No

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable IP as a Backend Server.

                        -

                        If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

                        -

                        This function is supported only by dedicated load balancers.

                        -

                        The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

                        -

                        The value can only be update to true.

                        +

                        Specifies whether to enable IP as a Backend Server.

                        +

                        If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

                        +

                        This function is supported only by dedicated load balancers.

                        +

                        The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

                        +

                        The value can only be update to true.

                        elb_virsubnet_ids

                        +

                        elb_virsubnet_ids

                        No

                        +

                        No

                        Array of strings

                        +

                        Array of strings

                        Specifies the IDs of subnets on the downstream plane. You can query parameter neutron_network_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

                        -
                        • If the IDs of the subnets required by the load balancer are specified in elb_virsubnet_ids, the subnets will still be bound to the load balancer.
                        • If the IDs of the subnets required by the load balancer are not specified in elb_virsubnet_ids, the subnets will be unbound from the load balancers. Do not unbound the subnets that have been used by the load balancer. Otherwise, an error will be returned.
                        • If the IDs of the subnets are specified in elb_virsubnet_ids, but not on the downstream plane, a new load balancer will be bound to the downstream plane.
                        -

                        Note:

                        -
                        • All subnets belong to the same VPC where the load balancer resides.
                        • Edge subnets are not supported.
                        -

                        Minimum: 1

                        -

                        Maximum: 64

                        -

                        Array Length: 0 - 64

                        +

                        Specifies the IDs of subnets on the downstream plane. You can query parameter neutron_network_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

                        +
                        • If the IDs of the subnets required by the load balancer are specified in elb_virsubnet_ids, the subnets will still be bound to the load balancer.

                          +
                        • If the IDs of the subnets required by the load balancer are not specified in elb_virsubnet_ids, the subnets will be unbound from the load balancers. Do not unbound the subnets that have been used by the load balancer. Otherwise, an error will be returned.

                          +
                        • If the IDs of the subnets are specified in elb_virsubnet_ids, but not on the downstream plane, a new load balancer will be bound to the downstream plane.

                          +
                        +

                        Note:

                        +
                        • All subnets belong to the same VPC where the load balancer resides.

                          +
                        • Edge subnets are not supported.

                          +
                        +

                        Minimum: 1

                        +

                        Maximum: 64

                        +

                        Array Length: 0 - 64

                        deletion_protection_enable

                        +

                        deletion_protection_enable

                        No

                        +

                        No

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable deletion protection for the load balancer.

                        -
                        • true: Enable deletion protection.
                        • false: Disable deletion protection.
                        -
                        NOTE:

                        Disable deletion protection for all your resources before deleting your account.

                        +

                        Specifies whether to enable deletion protection for the load balancer.

                        +
                        • true: Enable deletion protection.

                          +
                        • false: Disable deletion protection.

                          +
                        +
                        NOTE:

                        Disable deletion protection for all your resources before deleting your account.

                        waf_failure_action

                        +

                        waf_failure_action

                        No

                        +

                        No

                        String

                        +

                        String

                        Specifies traffic distributing policies when the WAF is faulty.

                        -
                        • discard: Traffic will not be distributed.
                        • forward: Traffic will be distributed to the default backend servers.
                        -

                        Note: This parameter takes effect only when WAF is enabled for the load balancer.

                        -

                        This parameter is unsupported. Please do not use it.

                        -

                        Minimum: 0

                        -

                        Maximum: 36

                        +

                        Specifies traffic distributing policies when the WAF is faulty.

                        +
                        • discard: Traffic will not be distributed.

                          +
                        • forward: Traffic will be distributed to the default backend servers.

                          +
                        +

                        Note: This parameter takes effect only when WAF is enabled for the load balancer.

                        +

                        This parameter is unsupported. Please do not use it.

                        +

                        Minimum: 0

                        +

                        Maximum: 36

                        -
                        Table 5 BandwidthRef

                        Parameter

                        +
                        - - - - - - -
                        Table 5 BandwidthRef

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        Specifies the shared bandwidth ID.

                        +

                        Specifies the shared bandwidth ID.

                        -

                        Response Parameters

                        Status code: 200

                        +

                        Response Parameters

                        Status code: 200

                        -
                        Table 6 Response body parameters

                        Parameter

                        +
                        - - - - - - - -
                        Table 6 Response body parameters

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        loadbalancer

                        +

                        loadbalancer

                        LoadBalancer object

                        +

                        LoadBalancer object

                        Specifies the load balancer.

                        +

                        Specifies the load balancer.

                        request_id

                        +

                        request_id

                        String

                        +

                        String

                        Specifies the request ID. The value is automatically generated.

                        -

                        Minimum: 0

                        -

                        Maximum: 36

                        +

                        Specifies the request ID. The value is automatically generated.

                        +

                        Minimum: 0

                        +

                        Maximum: 36

                        -
                        Table 7 LoadBalancer

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
                        Table 7 LoadBalancer

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the load balancer ID.

                        +

                        Specifies the load balancer ID.

                        description

                        +

                        description

                        String

                        +

                        String

                        Provides supplementary information about the load balancer.

                        -

                        Minimum: 1

                        -

                        Maximum: 255

                        +

                        Provides supplementary information about the load balancer.

                        +

                        Minimum: 1

                        +

                        Maximum: 255

                        provisioning_status

                        +

                        provisioning_status

                        String

                        +

                        String

                        Specifies the provisioning status of the load balancer. The value can be one of the following:

                        -
                        • ACTIVE: The load balancer is successfully provisioned.
                        • PENDING_DELETE: The load balancer is being deleted.
                        +

                        Specifies the provisioning status of the load balancer. The value can be one of the following:

                        +
                        • ACTIVE: The load balancer is successfully provisioned.

                          +
                        • PENDING_DELETE: The load balancer is being deleted.

                          +

                        admin_state_up

                        +

                        admin_state_up

                        Boolean

                        +

                        Boolean

                        Specifies the administrative status of the load balancer. The value can only be true.

                        +

                        Specifies the administrative status of the load balancer. The value can only be true.

                        provider

                        +

                        provider

                        String

                        +

                        String

                        Specifies the provider of the load balancer. The value can only be vlb.

                        +

                        Specifies the provider of the load balancer. The value can only be vlb.

                        pools

                        +

                        pools

                        Array of PoolRef objects

                        +

                        Array of PoolRef objects

                        Lists the IDs of backend server groups associated with the load balancer.

                        +

                        Lists the IDs of backend server groups associated with the load balancer.

                        listeners

                        +

                        listeners

                        Array of ListenerRef objects

                        +

                        Array of ListenerRef objects

                        Lists the IDs of listeners added to the load balancer.

                        +

                        Lists the IDs of listeners added to the load balancer.

                        operating_status

                        +

                        operating_status

                        String

                        +

                        String

                        Specifies the operating status of the load balancer. The value can only be ONLINE, indicating that the load balancer is running normally.

                        +

                        Specifies the operating status of the load balancer. The value can only be ONLINE, indicating that the load balancer is running normally.

                        name

                        +

                        name

                        String

                        +

                        String

                        Specifies the load balancer name.

                        +

                        Specifies the load balancer name.

                        project_id

                        +

                        project_id

                        String

                        +

                        String

                        Specifies the project ID of the load balancer.

                        +

                        Specifies the project ID of the load balancer.

                        vip_subnet_cidr_id

                        +

                        vip_subnet_cidr_id

                        String

                        +

                        String

                        Specifies the ID of the IPv4 subnet where the load balancer resides.

                        +

                        Specifies the ID of the IPv4 subnet where the load balancer resides.

                        vip_address

                        +

                        vip_address

                        String

                        +

                        String

                        Specifies the private IPv4 address bound to the load balancer.

                        +

                        Specifies the private IPv4 address bound to the load balancer.

                        vip_port_id

                        +

                        vip_port_id

                        String

                        +

                        String

                        Specifies the ID of the port bound to the private IPv4 address of the load balancer.

                        -

                        The default security group associated with the port will take effect only after at least one backend server is associated with load balancer.

                        +

                        Specifies the ID of the port bound to the private IPv4 address of the load balancer.

                        +

                        The default security group associated with the port will take effect only after at least one backend server is associated with load balancer.

                        tags

                        +

                        tags

                        Array of Tag objects

                        +

                        Array of Tag objects

                        Lists the tags added to the load balancer.

                        +

                        Lists the tags added to the load balancer.

                        created_at

                        +

                        created_at

                        String

                        +

                        String

                        Specifies the time when the load balancer was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

                        +

                        Specifies the time when the load balancer was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

                        updated_at

                        +

                        updated_at

                        String

                        +

                        String

                        Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

                        +

                        Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''.

                        guaranteed

                        +

                        guaranteed

                        Boolean

                        +

                        Boolean

                        Specifies whether the load balancer is a dedicated load balancer.

                        -
                        • true (default): The load balancer is a dedicated load balancer.
                        • false: The load balancer is a shared load balancer.
                        +

                        Specifies whether the load balancer is a dedicated load balancer.

                        +
                        • true (default): The load balancer is a dedicated load balancer.

                          +
                        • false: The load balancer is a shared load balancer.

                          +

                        vpc_id

                        +

                        vpc_id

                        String

                        +

                        String

                        Specifies the ID of the VPC where the load balancer resides.

                        +

                        Specifies the ID of the VPC where the load balancer resides.

                        eips

                        +

                        eips

                        Array of EipInfo objects

                        +

                        Array of EipInfo objects

                        Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                        -

                        This parameter has the same meaning as publicips.

                        +

                        Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                        +

                        This parameter has the same meaning as publicips.

                        ipv6_vip_address

                        +

                        ipv6_vip_address

                        String

                        +

                        String

                        Specifies the IPv6 address bound to the load balancer.

                        +

                        Specifies the IPv6 address bound to the load balancer.

                        ipv6_vip_virsubnet_id

                        +

                        ipv6_vip_virsubnet_id

                        String

                        +

                        String

                        Specifies the ID of the IPv6 subnet where the load balancer resides.

                        +

                        Specifies the ID of the IPv6 subnet where the load balancer resides.

                        ipv6_vip_port_id

                        +

                        ipv6_vip_port_id

                        String

                        +

                        String

                        Specifies the ID of the port bound to the IPv6 address of the load balancer.

                        +

                        Specifies the ID of the port bound to the IPv6 address of the load balancer.

                        availability_zone_list

                        +

                        availability_zone_list

                        Array of strings

                        +

                        Array of strings

                        Specifies the list of AZs where the load balancer is created.

                        +

                        Specifies the list of AZs where the load balancer is created.

                        enterprise_project_id

                        +

                        enterprise_project_id

                        String

                        +

                        String

                        Specifies the enterprise project ID.

                        -

                        If this parameter is not passed during resource creation, "0" will be returned, and the resource belongs to the default enterprise project.

                        -

                        "0" is not a valid enterprise project ID and cannot be used in the APIs for creating, updating the load balancer, or querying details of the load balancer.

                        -

                        This parameter is unsupported. Please do not use it.

                        +

                        Specifies the enterprise project ID.

                        +

                        If this parameter is not passed during resource creation, "0" will be returned, and the resource belongs to the default enterprise project.

                        +

                        "0" is not a valid enterprise project ID and cannot be used in the APIs for creating, updating the load balancer, or querying details of the load balancer.

                        +

                        This parameter is unsupported. Please do not use it.

                        billing_info

                        +

                        billing_info

                        String

                        +

                        String

                        Provides resource billing information.

                        -

                        This parameter is unsupported. Please do not use it.

                        -

                        Minimum: 1

                        -

                        Maximum: 1024

                        +

                        Provides resource billing information.

                        +

                        This parameter is unsupported. Please do not use it.

                        +

                        Minimum: 1

                        +

                        Maximum: 1024

                        l4_flavor_id

                        +

                        l4_flavor_id

                        String

                        +

                        String

                        Specifies the ID of a flavor at Layer 4.

                        -

                        Minimum: 1

                        -

                        Maximum: 255

                        +

                        Specifies the ID of a flavor at Layer 4.

                        +

                        Minimum: 1

                        +

                        Maximum: 255

                        l4_scale_flavor_id

                        +

                        l4_scale_flavor_id

                        String

                        +

                        String

                        Specifies the ID of the reserved flavor at Layer 4.

                        -

                        This parameter is unsupported. Please do not use it.

                        -

                        Minimum: 1

                        -

                        Maximum: 255

                        +

                        Specifies the ID of the reserved flavor at Layer 4.

                        +

                        This parameter is unsupported. Please do not use it.

                        +

                        Minimum: 1

                        +

                        Maximum: 255

                        l7_flavor_id

                        +

                        l7_flavor_id

                        String

                        +

                        String

                        Specifies the ID of a flavor at Layer 7.

                        -

                        Minimum: 1

                        -

                        Maximum: 255

                        +

                        Specifies the ID of a flavor at Layer 7.

                        +

                        Minimum: 1

                        +

                        Maximum: 255

                        l7_scale_flavor_id

                        +

                        l7_scale_flavor_id

                        String

                        +

                        String

                        Specifies the ID of the reserved flavor at Layer 7.

                        -

                        This parameter is unsupported. Please do not use it.

                        -

                        Minimum: 1

                        -

                        Maximum: 255

                        +

                        Specifies the ID of the reserved flavor at Layer 7.

                        +

                        This parameter is unsupported. Please do not use it.

                        +

                        Minimum: 1

                        +

                        Maximum: 255

                        publicips

                        +

                        publicips

                        Array of PublicIpInfo objects

                        +

                        Array of PublicIpInfo objects

                        Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                        -

                        This parameter has the same meaning as eips.

                        +

                        Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer.

                        +

                        This parameter has the same meaning as eips.

                        elb_virsubnet_ids

                        +

                        elb_virsubnet_ids

                        Array of strings

                        +

                        Array of strings

                        Lists the IDs of subnets on the downstream plane.

                        +

                        Lists the IDs of subnets on the downstream plane.

                        elb_virsubnet_type

                        +

                        elb_virsubnet_type

                        String

                        +

                        String

                        Specifies the type of the subnet on the downstream plane.

                        -
                        • ipv4: IPv4 subnet
                        • dualstack: subnet that supports IPv4/IPv6 dual stack
                        -

                        "dualstack" is not supported.

                        +

                        Specifies the type of the subnet on the downstream plane.

                        +
                        • ipv4: IPv4 subnet

                          +
                        • dualstack: subnet that supports IPv4/IPv6 dual stack

                          +
                        +

                        "dualstack" is not supported.

                        ip_target_enable

                        +

                        ip_target_enable

                        Boolean

                        +

                        Boolean

                        Specifies whether to enable IP as a Backend Server.

                        -

                        If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

                        -

                        This function is supported only by dedicated load balancers.

                        -

                        The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

                        -

                        The value can only be update to true.

                        +

                        Specifies whether to enable IP as a Backend Server.

                        +

                        If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses.

                        +

                        This function is supported only by dedicated load balancers.

                        +

                        The value can be true (enable IP as a Backend Server) or false (disable IP as a Backend Server).

                        +

                        The value can only be update to true.

                        frozen_scene

                        +

                        frozen_scene

                        String

                        +

                        String

                        Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,).

                        -

                        This parameter is unsupported. Please do not use it.

                        +

                        Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,).

                        +

                        This parameter is unsupported. Please do not use it.

                        ipv6_bandwidth

                        +

                        ipv6_bandwidth

                        BandwidthRef object

                        +

                        BandwidthRef object

                        Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

                        +

                        Specifies the ID of the bandwidth used by an IPv6 address. This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to the shared bandwidth.

                        deletion_protection_enable

                        +

                        deletion_protection_enable

                        Boolean

                        +

                        Boolean

                        Specifies whether deletion protection is enabled.

                        -
                        • false: Deletion protection is not enabled.
                        • true: Deletion protection is enabled.
                        -
                        NOTE:

                        Disable deletion protection for all your resources before deleting your account.

                        +

                        Specifies whether deletion protection is enabled.

                        +
                        • false: Deletion protection is not enabled.

                          +
                        • true: Deletion protection is enabled.

                          +
                        +
                        NOTE:

                        Disable deletion protection for all your resources before deleting your account.

                        -

                        This parameter is returned only when deletion protection is enabled at the site.

                        +

                        This parameter is returned only when deletion protection is enabled at the site.

                        public_border_group

                        +

                        public_border_group

                        String

                        +

                        String

                        Specifies the AZ group to which the load balancer belongs.

                        +

                        Specifies the AZ group to which the load balancer belongs.

                        waf_failure_action

                        +

                        waf_failure_action

                        String

                        +

                        String

                        Specifies traffic distributing policies when the WAF is faulty.

                        -
                        • discard: Traffic will not be distributed.
                        • forward: Traffic will be distributed to the default backend servers.
                        -

                        Note: This parameter takes effect only when WAF is enabled for the load balancer.

                        -

                        This parameter is unsupported. Please do not use it.

                        +

                        Specifies traffic distributing policies when the WAF is faulty.

                        +
                        • discard: Traffic will not be distributed.

                          +
                        • forward: Traffic will be distributed to the default backend servers.

                          +
                        +

                        Note: This parameter takes effect only when WAF is enabled for the load balancer.

                        +

                        This parameter is unsupported. Please do not use it.

                        +

                        charge_mode

                        +

                        String

                        +

                        Specifies the charge mode when creating a load balancer.

                        +

                        Value options:

                        +
                        • flavor: billed by the fixed specification you select.

                          +
                        • lcu: billed by how many LCUs you have used.

                          +
                        -
                        Table 8 PoolRef

                        Parameter

                        +
                        - - - - -
                        Table 8 PoolRef

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the ID of the backend server group.

                        +

                        Specifies the ID of the backend server group.

                        -
                        Table 9 ListenerRef

                        Parameter

                        +
                        - - - - -
                        Table 9 ListenerRef

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the listener ID.

                        +

                        Specifies the listener ID.

                        -
                        Table 10 Tag

                        Parameter

                        +
                        - - - - - - - -
                        Table 10 Tag

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        key

                        +

                        key

                        String

                        +

                        String

                        Specifies the tag key.

                        -

                        Minimum: 1

                        -

                        Maximum: 36

                        +

                        Specifies the tag key.

                        +

                        Minimum: 1

                        +

                        Maximum: 36

                        value

                        +

                        value

                        String

                        +

                        String

                        Specifies the tag value.

                        -

                        Minimum: 0

                        -

                        Maximum: 43

                        +

                        Specifies the tag value.

                        +

                        Minimum: 0

                        +

                        Maximum: 43

                        -
                        Table 11 EipInfo

                        Parameter

                        +
                        - - - - - - - - - - -
                        Table 11 EipInfo

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        eip_id

                        +

                        eip_id

                        String

                        +

                        String

                        eip_id

                        +

                        eip_id

                        eip_address

                        +

                        eip_address

                        String

                        +

                        String

                        eip_address

                        +

                        eip_address

                        ip_version

                        +

                        ip_version

                        Integer

                        +

                        Integer

                        Specifies the IP version. 4 indicates IPv4, and 6 indicates IPv6.

                        +

                        Specifies the IP version. 4 indicates IPv4, and 6 indicates IPv6.

                        -
                        Table 12 PublicIpInfo

                        Parameter

                        +
                        - - - - - - - - - - -
                        Table 12 PublicIpInfo

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        publicip_id

                        +

                        publicip_id

                        String

                        +

                        String

                        Specifies the EIP ID.

                        +

                        Specifies the EIP ID.

                        publicip_address

                        +

                        publicip_address

                        String

                        +

                        String

                        Specifies the IP address.

                        +

                        Specifies the IP address.

                        ip_version

                        +

                        ip_version

                        Integer

                        +

                        Integer

                        Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6).

                        +

                        Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6).

                        -
                        Table 13 BandwidthRef

                        Parameter

                        +
                        - - - - -
                        Table 13 BandwidthRef

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the shared bandwidth ID.

                        +

                        Specifies the shared bandwidth ID.

                        -

                        Example Requests

                        Updating a load balancer

                        -
                        PUT https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
                        +

                        Example Requests

                        Updating a load balancer

                        +
                        PUT https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
                         
                         {
                           "loadbalancer" : {
                        @@ -792,9 +841,9 @@
                           }
                         }
                        -

                        Example Responses

                        Status code: 200

                        -

                        Successful request.

                        -
                        {
                        +

                        Example Responses

                        Status code: 200

                        +

                        Successful request.

                        +
                        {
                           "request_id" : "010dad1e-32a3-4405-ab83-62a1fc5f8722",
                           "loadbalancer" : {
                             "id" : "2e073bf8-edfe-4e51-a699-d915b0b8af89",
                        @@ -844,23 +893,23 @@
                           }
                         }
                        -

                        Status Codes

                        -

                        Status Code

                        +

                        Status Codes

                        +
                        - - -

                        Status Code

                        Description

                        +

                        Description

                        200

                        +

                        200

                        Successful request.

                        +

                        Successful request.

                        -

                        Error Codes

                        See Error Codes.

                        +

                        Error Codes

                        See Error Codes.

                        diff --git a/docs/elb/api-ref/UpdateLogtank.html b/docs/elb/api-ref/UpdateLogtank.html index e94bfadd7..3cf085515 100644 --- a/docs/elb/api-ref/UpdateLogtank.html +++ b/docs/elb/api-ref/UpdateLogtank.html @@ -1,7 +1,7 @@

                        Updating a Log

                        -

                        Function

                        This API is used to update a log.

                        +

                        Function

                        This API is used to update a log.

                        URI

                        PUT /v3/{project_id}/elb/logtanks/{logtank_id}

                        @@ -122,73 +122,73 @@

                        Response Parameters

                        Status code: 200

                        -
                        Table 5 Response body parameters

                        Parameter

                        +
                        - - - - - - - -
                        Table 5 Response body parameters

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        request_id

                        +

                        request_id

                        String

                        +

                        String

                        Specifies the response body to the request for updating a log.

                        +

                        Specifies the response body to the request for updating a log.

                        logtank

                        +

                        logtank

                        Logtank object

                        +

                        Logtank object

                        Specifies the log details.

                        +

                        Specifies the log details.

                        -
                        Table 6 Logtank

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - diff --git a/docs/elb/api-ref/UpdateMember.html b/docs/elb/api-ref/UpdateMember.html index 7a44e0a76..33b5a8959 100644 --- a/docs/elb/api-ref/UpdateMember.html +++ b/docs/elb/api-ref/UpdateMember.html @@ -1,7 +1,7 @@

                        Updating a Backend Server

                        -

                        Function

                        This API is used to update a backend server.

                        +

                        Function

                        This API is used to update a backend server.

                        Constraints

                        If the provisioning status of the associated load balancer is not ACTIVE, the backend server cannot be updated.

                        @@ -148,208 +148,208 @@

                        Response Parameters

                        Status code: 200

                        -
                        Table 6 Logtank

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the log ID.

                        +

                        Specifies the log ID.

                        project_id

                        +

                        project_id

                        String

                        +

                        String

                        Specifies the ID of a load balancer.

                        +

                        Specifies the ID of a load balancer.

                        loadbalancer_id

                        +

                        loadbalancer_id

                        String

                        +

                        String

                        Specifies the ID of a load balancer.

                        +

                        Specifies the ID of a load balancer.

                        log_group_id

                        +

                        log_group_id

                        String

                        +

                        String

                        Specifies the log group ID.

                        +

                        Specifies the log group ID.

                        log_topic_id

                        +

                        log_topic_id

                        String

                        +

                        String

                        Specifies the log topic ID.

                        +

                        Specifies the log topic ID.

                        Table 5 Response body parameters

                        Parameter

                        +
                        - - - - - - - -
                        Table 5 Response body parameters

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        request_id

                        +

                        request_id

                        String

                        +

                        String

                        Specifies the request ID. The value is automatically generated.

                        +

                        Specifies the request ID. The value is automatically generated.

                        member

                        +

                        member

                        Member object

                        +

                        Member object

                        Specifies the backend server.

                        +

                        Specifies the backend server.

                        -
                        Table 6 Member

                        Parameter

                        +
                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                        Table 6 Member

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the backend server ID.

                        +

                        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

                        +

                        name

                        String

                        +

                        String

                        Specifies the backend server name.

                        +

                        Specifies the backend server name.

                        project_id

                        +

                        project_id

                        String

                        +

                        String

                        Specifies the project ID of the backend server.

                        +

                        Specifies the project ID of the backend server.

                        admin_state_up

                        +

                        admin_state_up

                        Boolean

                        +

                        Boolean

                        Specifies the administrative status of the backend server. The value can be true or false.

                        +

                        Specifies the administrative status of the backend server. The value can be true or false.

                        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.

                        subnet_cidr_id

                        +

                        subnet_cidr_id

                        String

                        +

                        String

                        Specifies the ID of the IPv4 or IPv6 subnet where the backend server resides.

                        +

                        Specifies the ID of the IPv4 or IPv6 subnet where the backend server resides.

                        This parameter can be left blank, indicating that IP as a Backend Server has been enabled for the load balancer. In this case, IP addresses of these servers must be IPv4 addresses, and the protocol of the backend server group must be TCP, HTTP, or HTTPS.

                        The IPv4 or IPv6 subnet must be in the same VPC as the subnet of the load balancer.

                        protocol_port

                        +

                        protocol_port

                        Integer

                        +

                        Integer

                        Specifies the port used by the backend server to receive requests.

                        +

                        Specifies the port used by the backend server to receive requests.

                        Minimum: 1

                        Maximum: 65535

                        weight

                        +

                        weight

                        Integer

                        +

                        Integer

                        Specifies the weight of the backend server. Requests are routed to backend servers in the same backend server group based on their weights.

                        +

                        Specifies the weight of the backend server. Requests are routed to backend servers in the same backend server group based on their weights.

                        The value ranges from 0 to 100, and the default value is 1. The larger the weight is, the higher proportion of requests the backend server receives. If the weight is set to 0, the backend server will not accept new requests.

                        If lb_algorithm is set to SOURCE_IP, this parameter will not take effect.

                        Minimum: 0

                        Maximum: 100

                        address

                        +

                        address

                        String

                        +

                        String

                        Specifies the private IP address bound to the backend server.

                        +

                        Specifies the private IP address bound to the backend server.

                        • If subnet_cidr_id is left blank, IP as a Backend Server is enabled. In this case, the IP address must be an IPv4 address.

                        • If subnet_cidr_id is not left blank, the IP address can be IPv4 or IPv6. It must be in the subnet specified by subnet_cidr_id and can only be bound to the primary NIC of the backend server.

                        ip_version

                        +

                        ip_version

                        String

                        +

                        String

                        Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6), depending on the value of address returned by the system.

                        +

                        Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6), depending on the value of address returned by the system.

                        operating_status

                        +

                        operating_status

                        String

                        +

                        String

                        Specifies the health status of the backend server if listener_id under status is not specified. The value can be one of the following:

                        +

                        Specifies the health status of the backend server if listener_id under status is not specified. 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.

                        status

                        +

                        status

                        Array of MemberStatus objects

                        +

                        Array of MemberStatus objects

                        Specifies the health status of the backend server if listener_id is specified.

                        +

                        Specifies the health status of the backend server if listener_id is specified.

                        loadbalancer_id

                        +

                        loadbalancer_id

                        String

                        +

                        String

                        Specifies the ID of the load balancer with which the backend server is associated.

                        +

                        Specifies the ID of the load balancer with which the backend server is associated.

                        This parameter is unsupported. Please do not use it.

                        loadbalancers

                        +

                        loadbalancers

                        Array of ResourceID objects

                        +

                        Array of ResourceID objects

                        Specifies the IDs of the load balancers associated with the backend server.

                        +

                        Specifies the IDs of the load balancers associated with the backend server.

                        This parameter is unsupported. Please do not use it.

                        created_at

                        +

                        created_at

                        String

                        +

                        String

                        Specifies the time when a backend server was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                        +

                        Specifies the time when a backend server was added. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                        This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

                        updated_at

                        +

                        updated_at

                        String

                        +

                        String

                        Specifies the time when a backend server was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                        +

                        Specifies the time when a backend server was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                        This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

                        member_type

                        +

                        member_type

                        String

                        +

                        String

                        Specifies the type of the backend server. Values:

                        +

                        Specifies the type of the backend server. Values:

                        • ip: IP as Backend servers

                        • instance: ECSs used as backend servers

                        instance_id

                        +

                        instance_id

                        String

                        +

                        String

                        Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address.

                        +

                        Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address.

                        -
                        Table 7 MemberStatus

                        Parameter

                        +
                        - - - - - - - -
                        Table 7 MemberStatus

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        listener_id

                        +

                        listener_id

                        String

                        +

                        String

                        Specifies the listener ID.

                        +

                        Specifies the listener ID.

                        operating_status

                        +

                        operating_status

                        String

                        +

                        String

                        Specifies the health status of the backend server. The value can be one of the following:

                        +

                        Specifies the health 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.

                          @@ -360,19 +360,19 @@
                        -
                        Table 8 ResourceID

                        Parameter

                        +
                        - - - - - diff --git a/docs/elb/api-ref/UpdatePool.html b/docs/elb/api-ref/UpdatePool.html index 0a9a91039..752f95a89 100644 --- a/docs/elb/api-ref/UpdatePool.html +++ b/docs/elb/api-ref/UpdatePool.html @@ -1,7 +1,7 @@

                        Updating a Backend Server Group

                        -

                        Function

                        This API is used to update 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.

                        @@ -204,7 +204,8 @@
                      • ip: Only IP as Backend servers can be added. vpc_id cannot be specified.

                      • "": Any type of backend servers can be added.

                      • -

                        Note: This parameter can be updated only when type is left blank.

                        +

                        Note:

                        +

                        This parameter can be updated only when type is left blank.

                        @@ -227,7 +228,9 @@
                        - -
                        Table 8 ResourceID

                        Parameter

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        id

                        +

                        id

                        String

                        +

                        String

                        Specifies the resource ID.

                        +

                        Specifies the resource ID.

                        String

                        Specifies the cookie name. The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.). Note: This parameter will take effect only when type is set to APP_COOKIE.

                        +

                        Specifies the cookie name.

                        +

                        The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

                        +

                        Note: This parameter will take effect only when type is set to APP_COOKIE.

                        type

                        @@ -236,7 +239,8 @@

                        String

                        Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.Note:

                        +

                        Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

                        +

                        Note:

                        • 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.

                        • If the backend server group protocol is QUIC, sticky session must be enabled with type set to SOURCE_IP.

                          @@ -299,74 +303,74 @@

                          Response Parameters

                          Status code: 200

                          -
                          Table 7 Response body parameters

                          Parameter

                          +
                          - - - - - - - -
                          Table 7 Response body parameters

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          request_id

                          +

                          request_id

                          String

                          +

                          String

                          Specifies the request ID. The value is automatically generated.

                          +

                          Specifies the request ID. The value is automatically generated.

                          pool

                          +

                          pool

                          Pool object

                          +

                          Pool object

                          Specifies the backend server group.

                          +

                          Specifies the backend server group.

                          -
                          Table 8 Pool

                          Parameter

                          +
                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                          Table 8 Pool

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          admin_state_up

                          +

                          admin_state_up

                          Boolean

                          +

                          Boolean

                          Specifies the administrative status of the backend server group. The value can only be true.

                          +

                          Specifies the administrative status of the backend server group. The value can only be true.

                          This parameter is unsupported. Please do not use it.

                          description

                          +

                          description

                          String

                          +

                          String

                          Provides supplementary information about the backend server group.

                          +

                          Provides supplementary information about the backend server group.

                          healthmonitor_id

                          +

                          healthmonitor_id

                          String

                          +

                          String

                          Specifies the ID of the health check configured for the backend server group.

                          +

                          Specifies the ID of the health check configured for the backend server group.

                          id

                          +

                          id

                          String

                          +

                          String

                          Specifies the backend server group ID.

                          +

                          Specifies the backend server group ID.

                          lb_algorithm

                          +

                          lb_algorithm

                          String

                          +

                          String

                          Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the associated backend server group.

                          +

                          Specifies the load balancing algorithm used by the load balancer to route requests to backend servers in the associated backend server group.

                          The value can be one of the following:

                          • ROUND_ROBIN: weighted round robin

                          • LEAST_CONNECTIONS: weighted least connections

                            @@ -379,46 +383,46 @@

                          listeners

                          +

                          listeners

                          Array of ListenerRef objects

                          +

                          Array of ListenerRef objects

                          Specifies the IDs of the listeners with which the backend server group is associated.

                          +

                          Specifies the IDs of the listeners with which the backend server group is associated.

                          loadbalancers

                          +

                          loadbalancers

                          Array of LoadBalancerRef objects

                          +

                          Array of LoadBalancerRef objects

                          Specifies the IDs of the load balancers with which the backend server group is associated.

                          +

                          Specifies the IDs of the load balancers with which the backend server group is associated.

                          members

                          +

                          members

                          Array of MemberRef objects

                          +

                          Array of MemberRef objects

                          Specifies the IDs of the backend servers in the backend server group.

                          +

                          Specifies the IDs of the backend servers in the backend server group.

                          name

                          +

                          name

                          String

                          +

                          String

                          Specifies the backend server group name.

                          +

                          Specifies the backend server group name.

                          project_id

                          +

                          project_id

                          String

                          +

                          String

                          Specifies the project ID.

                          +

                          Specifies the project ID.

                          protocol

                          +

                          protocol

                          String

                          +

                          String

                          Specifies the protocol used by the backend server group to receive requests. The value can be TCP, UDP, HTTP, HTTPS, or QUIC.

                          +

                          Specifies the protocol used by the backend server group to receive requests. The value can be TCP, UDP, HTTP, HTTPS, or QUIC.

                          • If the listener's protocol is UDP, the protocol of the backend server group must be UDP.

                          • If the listener's protocol is TCP, the protocol of the backend server group must be TCP.

                          • If the listener's protocol is HTTP, the protocol of the backend server group must be HTTP.

                            @@ -428,34 +432,34 @@

                          session_persistence

                          +

                          session_persistence

                          SessionPersistence object

                          +

                          SessionPersistence object

                          Specifies the sticky session.

                          +

                          Specifies the sticky session.

                          ip_version

                          +

                          ip_version

                          String

                          +

                          String

                          Specifies the IP address version supported by the backend server group.

                          +

                          Specifies the IP address version supported by the backend server group.

                          IPv6 is unsupported. Only v4 will be returned.

                          slow_start

                          +

                          slow_start

                          SlowStart object

                          +

                          SlowStart object

                          Specifies slow start details. 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.

                          +

                          Specifies slow start details. 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.

                          member_deletion_protection_enable

                          +

                          member_deletion_protection_enable

                          Boolean

                          +

                          Boolean

                          Specifies whether to enable removal protection.

                          +

                          Specifies whether to enable removal protection.

                          • true: Enable removal protection.

                          • false: Disable removal protection.

                          @@ -463,34 +467,34 @@

                          created_at

                          +

                          created_at

                          String

                          +

                          String

                          Specifies the time when a backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                          +

                          Specifies the time when a backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                          This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

                          updated_at

                          +

                          updated_at

                          String

                          +

                          String

                          Specifies the time when when a backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                          +

                          Specifies the time when when a backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time).

                          This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.

                          vpc_id

                          +

                          vpc_id

                          String

                          +

                          String

                          Specifies the ID of the VPC where the backend server group works.

                          +

                          Specifies the ID of the VPC where the backend server group works.

                          type

                          +

                          type

                          String

                          +

                          String

                          Specifies the type of the backend server group.

                          +

                          Specifies the type of the backend server group.

                          Values:

                          • instance: Any type of backend servers can be added. vpc_id is mandatory.

                          • ip: Only IP as Backend servers can be added. vpc_id cannot be specified.

                            @@ -502,94 +506,97 @@
                          -
                          Table 9 ListenerRef

                          Parameter

                          +
                          - - - - -
                          Table 9 ListenerRef

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          id

                          +

                          id

                          String

                          +

                          String

                          Specifies the listener ID.

                          +

                          Specifies the listener ID.

                          -
                          Table 10 LoadBalancerRef

                          Parameter

                          +
                          - - - - -
                          Table 10 LoadBalancerRef

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          id

                          +

                          id

                          String

                          +

                          String

                          Specifies the load balancer ID.

                          +

                          Specifies the load balancer ID.

                          -
                          Table 11 MemberRef

                          Parameter

                          +
                          - - - - -
                          Table 11 MemberRef

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          id

                          +

                          id

                          String

                          +

                          String

                          Specifies the backend server ID.

                          +

                          Specifies the backend server ID.

                          -
                          Table 12 SessionPersistence

                          Parameter

                          +
                          - - - - - - - - - - -
                          Table 12 SessionPersistence

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          cookie_name

                          +

                          cookie_name

                          String

                          +

                          String

                          Specifies the cookie name. The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.). Note: This parameter will take effect only when type is set to APP_COOKIE.

                          +

                          Specifies the cookie name.

                          +

                          The value can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

                          +

                          Note: This parameter will take effect only when type is set to APP_COOKIE.

                          type

                          +

                          type

                          String

                          +

                          String

                          Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.Note:

                          +

                          Specifies the sticky session type. The value can be SOURCE_IP, HTTP_COOKIE, or APP_COOKIE.

                          +

                          Note:

                          • 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.

                          • If the backend server group protocol is QUIC, sticky session must be enabled with type set to SOURCE_IP.

                          persistence_timeout

                          +

                          persistence_timeout

                          Integer

                          +

                          Integer

                          Specifies the stickiness duration, in minutes. This parameter will not take effect when type is set to APP_COOKIE.

                          +

                          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, UDP, or QUIC, 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.

                          @@ -599,30 +606,30 @@
                          -
                          Table 13 SlowStart

                          Parameter

                          +
                          - - - - - - - -
                          Table 13 SlowStart

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          enable

                          +

                          enable

                          Boolean

                          +

                          Boolean

                          Specifies whether to enable slow start.

                          +

                          Specifies whether to enable slow start.

                          • true: Enable slow start.

                          • false: Disable slow start.

                          Default: false

                          duration

                          +

                          duration

                          Integer

                          +

                          Integer

                          Specifies the slow start duration, in seconds.

                          +

                          Specifies the slow start duration, in seconds.

                          The value ranges from 30 to 1200, and the default value is 30.

                          Minimum: 30

                          Maximum: 1200

                          diff --git a/docs/elb/api-ref/UpdateSecurityPolicy.html b/docs/elb/api-ref/UpdateSecurityPolicy.html index fe09e9681..3e516db0d 100644 --- a/docs/elb/api-ref/UpdateSecurityPolicy.html +++ b/docs/elb/api-ref/UpdateSecurityPolicy.html @@ -1,7 +1,7 @@

                          Updating a Custom Security Policy

                          -

                          Function

                          This API is used to update a custom security policy.

                          +

                          Function

                          This API is used to update a custom security policy.

                          Constraints

                          If protocols or ciphers is updated, the modification takes effect immediately on all listeners that use the custom security policy. Updating other fields does not affect the listeners.

                          @@ -149,120 +149,120 @@

                          Response Parameters

                          Status code: 200

                          -
                          Table 5 Response body parameters

                          Parameter

                          +
                          - - - - - - - -
                          Table 5 Response body parameters

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          security_policy

                          +

                          security_policy

                          SecurityPolicy object

                          +

                          SecurityPolicy object

                          Specifies the custom security policy that has been updated.

                          +

                          Specifies the custom security policy that has been updated.

                          request_id

                          +

                          request_id

                          String

                          +

                          String

                          Specifies the request ID. The value is automatically generated.

                          +

                          Specifies the request ID. The value is automatically generated.

                          -
                          Table 6 SecurityPolicy

                          Parameter

                          +
                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                          Table 6 SecurityPolicy

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          id

                          +

                          id

                          String

                          +

                          String

                          Specifies the ID of the custom security policy.

                          +

                          Specifies the ID of the custom security policy.

                          project_id

                          +

                          project_id

                          String

                          +

                          String

                          Specifies the project ID of the custom security policy.

                          +

                          Specifies the project ID of the custom security policy.

                          name

                          +

                          name

                          String

                          +

                          String

                          Specifies the name of the custom security policy.

                          +

                          Specifies the name of the custom security policy.

                          description

                          +

                          description

                          String

                          +

                          String

                          Provides supplementary information about the custom security policy.

                          +

                          Provides supplementary information about the custom security policy.

                          listeners

                          +

                          listeners

                          Array of ListenerRef objects

                          +

                          Array of ListenerRef objects

                          Specifies the listeners that use the custom security policies.

                          +

                          Specifies the listeners that use the custom security policies.

                          protocols

                          +

                          protocols

                          Array of strings

                          +

                          Array of strings

                          Lists the TLS protocols supported by the custom security policy.

                          +

                          Lists the TLS protocols supported by the custom security policy.

                          ciphers

                          +

                          ciphers

                          Array of strings

                          +

                          Array of strings

                          Lists the cipher suites supported by the custom security policy.

                          +

                          Lists the cipher suites supported by the custom security policy.

                          created_at

                          +

                          created_at

                          String

                          +

                          String

                          Specifies the time when the custom security policy was created.

                          +

                          Specifies the time when the custom security policy was created.

                          updated_at

                          +

                          updated_at

                          String

                          +

                          String

                          Specifies the time when the custom security policy was updated.

                          +

                          Specifies the time when the custom security policy was updated.

                          -
                          Table 7 ListenerRef

                          Parameter

                          +
                          - - - - - diff --git a/docs/elb/api-ref/elb_fl_0005.html b/docs/elb/api-ref/elb_fl_0005.html index a2065bf4f..9bd092410 100644 --- a/docs/elb/api-ref/elb_fl_0005.html +++ b/docs/elb/api-ref/elb_fl_0005.html @@ -1,7 +1,7 @@

                          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.

                          +

                          API v2.0 enables 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

                          {
                          diff --git a/docs/elb/api-ref/elb_xd_0000.html b/docs/elb/api-ref/elb_xd_0000.html
                          index 8f8c09855..5d0e11dbc 100644
                          --- a/docs/elb/api-ref/elb_xd_0000.html
                          +++ b/docs/elb/api-ref/elb_xd_0000.html
                          @@ -8,7 +8,13 @@
                           
                           
                           
                          -
                          + + +
                          Table 7 ListenerRef

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          id

                          +

                          id

                          String

                          +

                          String

                          Specifies the listener ID.

                          +

                          Specifies the listener ID.

                          2024-08-07

                          +

                          2024-09-26

                          +

                          Modified the following content:

                          +

                          Elastic specifications supported by dedicated load balancers.

                          +

                          2024-08-07

                          Modified the following content:

                          • Changed the length limit on the domain field in the certificate.
                          diff --git a/docs/elb/api-ref/elb_zq_bq_0001.html b/docs/elb/api-ref/elb_zq_bq_0001.html index 6cbd81c53..29ffbe449 100644 --- a/docs/elb/api-ref/elb_zq_bq_0001.html +++ b/docs/elb/api-ref/elb_zq_bq_0001.html @@ -46,9 +46,9 @@

                          Request Parameters

                          - - @@ -69,9 +69,9 @@
                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -92,9 +92,9 @@
                          Table 3 Parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -107,7 +107,7 @@ @@ -118,7 +118,7 @@ diff --git a/docs/elb/api-ref/elb_zq_bq_0002.html b/docs/elb/api-ref/elb_zq_bq_0002.html index 355183ff1..4fe0afa82 100644 --- a/docs/elb/api-ref/elb_zq_bq_0002.html +++ b/docs/elb/api-ref/elb_zq_bq_0002.html @@ -47,9 +47,9 @@

                          Request Parameters

                          Table 4 tag parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          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 (_)
                            +
                            • Cannot be left blank.
                            • Can contain a maximum of 128 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.

                          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 (_)
                            +
                            • Can contain a maximum of 255 characters.
                            • Can contain only the following character types:
                              • Uppercase letters
                              • Lowercase letters
                              • Digits
                              • Special characters, including hyphens (-) and underscores (_)
                          - - @@ -70,9 +70,9 @@
                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -104,9 +104,9 @@
                          Table 3 Parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -119,7 +119,7 @@ @@ -130,7 +130,7 @@ diff --git a/docs/elb/api-ref/elb_zq_bq_0003.html b/docs/elb/api-ref/elb_zq_bq_0003.html index 7d625cdfd..5bdd96c6f 100644 --- a/docs/elb/api-ref/elb_zq_bq_0003.html +++ b/docs/elb/api-ref/elb_zq_bq_0003.html @@ -42,9 +42,9 @@

                          Request Parameters

                          Table 4 tags parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          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 (_)
                            +
                            • Cannot be left blank.
                            • Can contain a maximum of 128 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.

                          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 (_)
                            +
                            • Can contain a maximum of 255 characters.
                            • Can contain only the following character types:
                              • Uppercase letters
                              • Lowercase letters
                              • Digits
                              • Special characters, including hyphens (-) and underscores (_)
                          - - @@ -85,7 +85,7 @@
                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - @@ -96,7 +96,7 @@ @@ -105,7 +105,7 @@ diff --git a/docs/elb/api-ref/elb_zq_bq_0004.html b/docs/elb/api-ref/elb_zq_bq_0004.html index 857c73f8e..3bcec9c6b 100644 --- a/docs/elb/api-ref/elb_zq_bq_0004.html +++ b/docs/elb/api-ref/elb_zq_bq_0004.html @@ -33,9 +33,9 @@

                          Request Parameters

                          Table 4 tags parameter description

                          Parameter

                          Type

                          +

                          Type

                          Description

                          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 (_)
                            +
                            • Cannot be left blank.
                            • Can contain a maximum of 128 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.

                          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 (_)
                            +
                            • Can contain a maximum of 255 characters.
                            • Can contain only the following character types:
                              • Uppercase letters
                              • Lowercase letters
                              • Digits
                              • Special characters, including hyphens (-) and underscores (_)
                          - - @@ -57,7 +57,7 @@

                          Response Parameters

                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - @@ -76,7 +76,7 @@
                          Table 3 Response parameters

                          Parameter

                          Type

                          +

                          Type

                          Description

                          - @@ -87,7 +87,7 @@ @@ -96,7 +96,7 @@ diff --git a/docs/elb/api-ref/elb_zq_bq_0005.html b/docs/elb/api-ref/elb_zq_bq_0005.html index 5c790bd66..e69882c82 100644 --- a/docs/elb/api-ref/elb_zq_bq_0005.html +++ b/docs/elb/api-ref/elb_zq_bq_0005.html @@ -35,9 +35,9 @@

                          Request Parameters

                          Table 4 tags parameter description

                          Parameter

                          Type

                          +

                          Type

                          Description

                          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 (_)
                            +
                            • Cannot be left blank.
                            • Can contain a maximum of 128 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.

                          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 (_)
                            +
                            • Can contain a maximum of 255 characters.
                            • Can contain only the following character types:
                              • Uppercase letters
                              • Lowercase letters
                              • Digits
                              • Special characters, including hyphens (-) and underscores (_)
                          - - @@ -58,9 +58,9 @@
                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -123,9 +123,9 @@
                          Table 3 Parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -137,7 +137,7 @@ -
                          Table 4 tags parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          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.)

                          +

                          Specifies the tag key. It contains a maximum of 128 Unicode characters and cannot be left blank. (This parameter is not verified in the search process.)

                          values

                          @@ -156,9 +156,9 @@
                          - - @@ -191,7 +191,7 @@

                          Response Parameters

                          Table 5 matches parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - @@ -217,7 +217,7 @@
                          Table 6 Response parameters

                          Parameter

                          Type

                          +

                          Type

                          Description

                          - @@ -264,7 +264,7 @@
                          Table 7 resource parameter description

                          Parameter

                          Type

                          +

                          Type

                          Description

                          - @@ -274,7 +274,7 @@ -
                          Table 8 tags parameter description

                          Parameter

                          Type

                          +

                          Type

                          Description

                          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.)

                          +

                          Specifies the tag key. It contains a maximum of 128 Unicode characters and cannot be left blank. (This parameter is not verified in the search process.)

                          value

                          diff --git a/docs/elb/api-ref/elb_zq_bq_0007.html b/docs/elb/api-ref/elb_zq_bq_0007.html index 97573ab83..e65c72c7c 100644 --- a/docs/elb/api-ref/elb_zq_bq_0007.html +++ b/docs/elb/api-ref/elb_zq_bq_0007.html @@ -45,9 +45,9 @@

                          Request Parameters

                          - - @@ -68,9 +68,9 @@
                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -91,9 +91,9 @@
                          Table 3 Parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -106,7 +106,7 @@ @@ -117,7 +117,7 @@ diff --git a/docs/elb/api-ref/elb_zq_bq_0008.html b/docs/elb/api-ref/elb_zq_bq_0008.html index 59013f500..6534dfbfb 100644 --- a/docs/elb/api-ref/elb_zq_bq_0008.html +++ b/docs/elb/api-ref/elb_zq_bq_0008.html @@ -45,9 +45,9 @@

                          Request Parameters

                          Table 4 tag parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          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 (_)
                            +
                            • Cannot be left blank.
                            • Can contain a maximum of 128 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.

                          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 (_)
                            +
                            • Can contain a maximum of 255 characters.
                            • Can contain only the following character types:
                              • Uppercase letters
                              • Lowercase letters
                              • Digits
                              • Special characters, including hyphens (-) and underscores (_)
                          - - @@ -68,9 +68,9 @@
                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -102,9 +102,9 @@
                          Table 3 Parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -117,7 +117,7 @@ @@ -128,7 +128,7 @@ diff --git a/docs/elb/api-ref/elb_zq_bq_0009.html b/docs/elb/api-ref/elb_zq_bq_0009.html index 467b54023..b62da81e8 100644 --- a/docs/elb/api-ref/elb_zq_bq_0009.html +++ b/docs/elb/api-ref/elb_zq_bq_0009.html @@ -9,32 +9,32 @@

                          URI

                          GET /v2.0/{project_id}/listeners/{listener_id}/tags

                          -
                          Table 4 resource_tag parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          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 (_)
                            +
                            • Cannot be left blank.
                            • Can contain a maximum of 128 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.

                          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 (_)
                            +
                            • Can contain a maximum of 255 characters.
                            • Can contain only the following character types:
                              • Uppercase letters
                              • Lowercase letters
                              • Digits
                              • Special characters, including hyphens (-) and underscores (_)
                          Table 1 Parameter description

                          Parameter

                          +
                          - - - - - - - - - - - @@ -44,9 +44,9 @@

                          Request Parameters

                          Table 1 Parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          project_id

                          +

                          project_id

                          Yes

                          +

                          Yes

                          String

                          +

                          String

                          Specifies the ID of the project where the tag is used.

                          +

                          Specifies the ID of the project where the tag is used.

                          listener_id

                          +

                          listener_id

                          Yes

                          +

                          Yes

                          String

                          +

                          String

                          Specifies the ID of the listener whose tags are to be queried.

                          +

                          Specifies the ID of the listener whose tags are to be queried.

                          - - @@ -66,48 +66,48 @@

                          Response Parameters

                          -
                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          Table 3 Response parameters

                          Parameter

                          +
                          - - - - -
                          Table 3 Response parameters

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          tags

                          +

                          tags

                          Array

                          +

                          Array

                          Lists the tags. For details, see Table 4.

                          +

                          Lists the tags. For details, see Table 4.

                          -
                          Table 4 tags parameter description

                          Parameter

                          +
                          - - - - - - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0010.html b/docs/elb/api-ref/elb_zq_bq_0010.html index 9331f8e0a..900fa2bd9 100644 --- a/docs/elb/api-ref/elb_zq_bq_0010.html +++ b/docs/elb/api-ref/elb_zq_bq_0010.html @@ -9,23 +9,23 @@

                          URI

                          GET /v2.0/{project_id}/listeners/tags

                          -
                          Table 4 tags parameter description

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          key

                          +

                          key

                          String

                          +

                          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 (_)
                            +

                          Specifies the tag key.

                          +
                          • Cannot be left blank.
                          • Can contain a maximum of 128 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

                          +

                          value

                          String

                          +

                          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 (_)
                            +

                          Specifies the tag value.

                          +
                          • Can contain a maximum of 255 characters.
                          • Can contain only the following character types:
                            • Uppercase letters
                            • Lowercase letters
                            • Digits
                            • Special characters, including hyphens (-) and underscores (_)
                          Table 1 Parameter description

                          Parameter

                          +
                          - - - - - - - @@ -35,9 +35,9 @@

                          Request Parameters

                          Table 1 Parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          project_id

                          +

                          project_id

                          Yes

                          +

                          Yes

                          String

                          +

                          String

                          Specifies the ID of the project where the tag is used.

                          +

                          Specifies the ID of the project where the tag is used.

                          - - @@ -57,19 +57,19 @@

                          Response Parameters

                          -
                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          Table 3 Response parameters

                          Parameter

                          +
                          - - - - - @@ -77,29 +77,29 @@
                          Table 3 Response parameters

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          tags

                          +

                          tags

                          Array

                          +

                          Array

                          Lists the tags, which are aggregated by the tag key. For details, see Table 4.

                          +

                          Lists the tags, which are aggregated by the tag key. For details, see Table 4.

                          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 4 tags parameter description

                          Parameter

                          +
                          - - - - - - - - diff --git a/docs/elb/api-ref/elb_zq_bq_0011.html b/docs/elb/api-ref/elb_zq_bq_0011.html index 875e75c8f..425dfab5d 100644 --- a/docs/elb/api-ref/elb_zq_bq_0011.html +++ b/docs/elb/api-ref/elb_zq_bq_0011.html @@ -35,9 +35,9 @@

                          Request Parameters

                          Table 4 tags parameter description

                          Parameter

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          key

                          +

                          key

                          String

                          +

                          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 (_)
                            +

                          Specifies the tag key.

                          +
                          • Cannot be left blank.
                          • Can contain a maximum of 128 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

                          +

                          values

                          Array

                          +

                          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 (_)
                            +

                          Lists the tag values.

                          +
                          • Can contain a maximum of 255 characters.
                          • Can contain only the following character types:
                            • Uppercase letters
                            • Lowercase letters
                            • Digits
                            • Special characters, including hyphens (-) and underscores (_)
                          - - @@ -58,9 +58,9 @@
                          Table 2 Request header parameters

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - - @@ -72,7 +72,7 @@ -
                          Table 3 Parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          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 4.

                          +

                          A maximum of 20 keys can be queried at a time, and each key can contain a maximum of 20 values. The structure body must be included. The tag key cannot be left blank or be an empty string. Each tag key and each tag value of the same tag key must be unique. For details, see Table 4.

                          limit

                          @@ -119,9 +119,9 @@
                          - - @@ -133,7 +133,7 @@ -
                          Table 4 tags parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          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.)

                          +

                          Specifies the tag key. It contains a maximum of 128 Unicode characters and cannot be left blank. (This parameter is not verified in the search process.)

                          values

                          @@ -151,9 +151,9 @@
                          - - @@ -186,7 +186,7 @@

                          Response Parameters

                          Table 5 matches parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          - @@ -212,7 +212,7 @@
                          Table 6 Response parameters

                          Parameter

                          Type

                          +

                          Type

                          Description

                          - @@ -259,7 +259,7 @@
                          Table 7 resource parameter description

                          Parameter

                          Type

                          +

                          Type

                          Description

                          - @@ -269,7 +269,7 @@ -
                          Table 8 tags parameter description

                          Parameter

                          Type

                          +

                          Type

                          Description

                          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.)

                          +

                          Specifies the tag key. It contains a maximum of 128 Unicode characters and cannot be left blank. (This parameter is not verified in the search process.)

                          value

                          diff --git a/docs/elb/api-ref/elb_zq_fz_0002.html b/docs/elb/api-ref/elb_zq_fz_0002.html index 8cff3b257..5fb05058a 100644 --- a/docs/elb/api-ref/elb_zq_fz_0002.html +++ b/docs/elb/api-ref/elb_zq_fz_0002.html @@ -8,167 +8,167 @@

                          URI

                          GET /v2.0/lbaas/loadbalancers

                          Request

                          -
                          Table 1 Parameter description

                          Parameter

                          +
                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -204,7 +204,7 @@
                          Table 1 Parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          marker

                          +

                          marker

                          No

                          +

                          No

                          String

                          +

                          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.

                          +

                          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

                          +

                          limit

                          No

                          +

                          No

                          Integer

                          +

                          Integer

                          Specifies the number of load balancers on each page.

                          +

                          Specifies the number of load balancers on each page.

                          page_reverse

                          +

                          page_reverse

                          No

                          +

                          No

                          Boolean

                          +

                          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.

                          +

                          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

                          +

                          tenant_id

                          No

                          +

                          No

                          String

                          +

                          String

                          Specifies the ID of the project where the load balancer is used.

                          +

                          Specifies the ID of the project where the load balancer is used.

                          id

                          +

                          id

                          No

                          +

                          No

                          String

                          +

                          String

                          Specifies the load balancer ID.

                          +

                          Specifies the load balancer ID.

                          description

                          +

                          description

                          No

                          +

                          No

                          String

                          +

                          String

                          Provides supplementary information about the load balancer.

                          +

                          Provides supplementary information about the load balancer.

                          The value contains a maximum of 255 characters.

                          name

                          +

                          name

                          No

                          +

                          No

                          String

                          +

                          String

                          Specifies the load balancer name.

                          +

                          Specifies the load balancer name.

                          The value contains a maximum of 255 characters.

                          operating_status

                          +

                          operating_status

                          No

                          +

                          No

                          String

                          +

                          String

                          This parameter is reserved, and its value can only be ONLINE.

                          +

                          This parameter is reserved, and its value can only be ONLINE.

                          It specifies the operating status of the load balancer.

                          provisioning_status

                          +

                          provisioning_status

                          No

                          +

                          No

                          String

                          +

                          String

                          This parameter is reserved, and its value can only be ACTIVE.

                          +

                          This parameter is reserved, and its value can only be ACTIVE.

                          It specifies the provisioning status of the load balancer.

                          admin_state_up

                          +

                          admin_state_up

                          No

                          +

                          No

                          Boolean

                          +

                          Boolean

                          This parameter is reserved, and its value can only be true.

                          +

                          This parameter is reserved, and its value can only be true.

                          It specifies the administrative status of the load balancer.

                          vip_address

                          +

                          vip_address

                          No

                          +

                          No

                          String

                          +

                          String

                          Specifies the private IP address of the load balancer.

                          +

                          Specifies the private IP address of the load balancer.

                          The value contains a maximum of 64 characters.

                          vip_port_id

                          +

                          vip_port_id

                          No

                          +

                          No

                          String

                          +

                          String

                          Specifies the ID of the port bound to the private IP address of the load balancer.

                          +

                          Specifies the ID of the port bound to the private IP address of the load balancer.

                          vip_subnet_id

                          +

                          vip_subnet_id

                          No

                          +

                          No

                          String

                          +

                          String

                          Specifies the ID of the IPv4 subnet where the load balancer works.

                          +

                          Specifies the ID of the IPv4 subnet where the load balancer works.

                          member_address

                          +

                          member_address

                          No

                          +

                          No

                          String

                          +

                          String

                          Specifies the IP address of the backend server associated with the load balancer.

                          +

                          Specifies the IP address of the backend server associated with the load balancer.

                          member_device_id

                          +

                          member_device_id

                          No

                          +

                          No

                          String

                          +

                          String

                          Specifies the ID of the cloud server used as the backend server associated with the load balancer.

                          +

                          Specifies the ID of the cloud server used as the backend server associated with the load balancer.

                          vpc_id

                          +

                          vpc_id

                          No

                          +

                          No

                          String

                          +

                          String

                          Specifies the ID of the VPC where the load balancer works.

                          +

                          Specifies the ID of the VPC where the load balancer works.

                          - diff --git a/docs/elb/api-ref/elb_zq_fz_0003.html b/docs/elb/api-ref/elb_zq_fz_0003.html index 50fcbaf8f..0a11da0f2 100644 --- a/docs/elb/api-ref/elb_zq_fz_0003.html +++ b/docs/elb/api-ref/elb_zq_fz_0003.html @@ -227,7 +227,7 @@
                          Table 3 loadbalancer parameter description

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          -

                          Example Request

                          • Example request 1: Querying details of a load balancer using its ID
                          • Example request 2: Querying the EIP bound to the load balancer. For details, see section "Querying EIPs" in the Elastic IP Address API Reference.
                            GET https://{EIP_Endpoint}/v1/{project_id}/publicips?port_id={vip_port_id}
                            +

                            Example Request

                            • Example request 1: Querying details of a load balancer using its ID
                            • Example request 2: Querying the EIP bound to the load balancer. For details, see section "Querying EIPs" in the Elastic IP Address API Reference.
                              GET https://{EIP_Endpoint}/v1/{project_id}/publicips?port_id={vip_port_id}

                              vip_port_id is the value of vip_port_id for the load balancer.

                            diff --git a/docs/elb/api-ref/elb_zq_hd_0002.html b/docs/elb/api-ref/elb_zq_hd_0002.html index ed3b53f10..53ff1ffa0 100644 --- a/docs/elb/api-ref/elb_zq_hd_0002.html +++ b/docs/elb/api-ref/elb_zq_hd_0002.html @@ -8,32 +8,32 @@

                            URI

                            GET /v2.0/lbaas/pools/{pool_id}/members

                            -
                            Table 1 Parameter description

                            Parameter

                            +
                            - - - - - - -
                            Table 1 Parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            pool_id

                            +

                            pool_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the ID of the backend server group.

                            +

                            Specifies the ID of the backend server group.

                            Request

                            -
                            Table 2 Parameter description

                            Parameter

                            +
                            - @@ -41,9 +41,9 @@ - - @@ -51,18 +51,18 @@

                            This parameter must be used together with limit.

                            - - - - @@ -70,9 +70,9 @@

                            This parameter must be used together with limit.

                            - - @@ -81,9 +81,9 @@ - - @@ -92,9 +92,9 @@

                            - - @@ -104,9 +104,9 @@ - - @@ -114,27 +114,27 @@

                            The value contains a maximum of 64 characters.

                            - - - - - - @@ -142,9 +142,9 @@

                            This parameter is reserved, and the default value is true.

                            - - @@ -183,111 +183,111 @@
                            Table 2 Parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            marker

                            +

                            marker

                            No

                            +

                            No

                            String

                            limit

                            +

                            limit

                            No

                            +

                            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

                            +

                            page_reverse

                            No

                            +

                            No

                            Boolean

                            id

                            +

                            id

                            No

                            +

                            No

                            String

                            tenant_id

                            +

                            tenant_id

                            No

                            +

                            No

                            String

                            name

                            +

                            name

                            No

                            +

                            No

                            String

                            address

                            +

                            address

                            No

                            +

                            No

                            String

                            protocol_port

                            +

                            protocol_port

                            No

                            +

                            No

                            Integer

                            Specifies the port used by the backend server.

                            subnet_id

                            +

                            subnet_id

                            No

                            +

                            No

                            String

                            Specifies the ID of the subnet where the backend server works.

                            admin_state_up

                            +

                            admin_state_up

                            No

                            +

                            No

                            Boolean

                            weight

                            +

                            weight

                            No

                            +

                            No

                            Integer

                            -
                            Table 4 members parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                            Table 4 members parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            id

                            +

                            id

                            String

                            +

                            String

                            Specifies the backend server ID.

                            +

                            Specifies the backend server ID.

                            NOTE:

                            The value of this parameter is not the ID of server. It is the ID automatically generated for the backend server associated with the load balancer.

                            tenant_id

                            +

                            tenant_id

                            String

                            +

                            String

                            Specifies the ID of the project where the backend server is used.

                            +

                            Specifies the ID of the project where the backend server is used.

                            The value contains a maximum of 255 characters.

                            name

                            +

                            name

                            String

                            +

                            String

                            Specifies the backend server name.

                            +

                            Specifies the backend server name.

                            The value contains a maximum of 255 characters.

                            address

                            +

                            address

                            String

                            +

                            String

                            Specifies the private IP address of the backend server. This IP address must be in the subnet specified by subnet_id.

                            +

                            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

                            +

                            protocol_port

                            Integer

                            +

                            Integer

                            Specifies the port used by the backend server. The port number ranges from 1 to 65535.

                            +

                            Specifies the port used by the backend server. The port number ranges from 1 to 65535.

                            subnet_id

                            +

                            subnet_id

                            String

                            +

                            String

                            Specifies the ID of the subnet where the backend server works. The private IP address of the backend server is in this subnet.

                            +

                            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

                            +

                            admin_state_up

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the backend server.

                            +

                            Specifies the administrative status of the backend server.

                            This parameter is reserved. The value can be true or false.

                            • true: Enabled
                            • false: Disabled

                            weight

                            +

                            weight

                            Integer

                            +

                            Integer

                            Specifies the backend server weight. The value ranges from 0 to 100.

                            +

                            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

                            +

                            operating_status

                            String

                            +

                            String

                            Specifies the operating status of the load balancer. This parameter is reserved, and its value can only be ONLINE.

                            +

                            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

                            +
                            - - - - - - - - diff --git a/docs/elb/api-ref/elb_zq_jk_0001.html b/docs/elb/api-ref/elb_zq_jk_0001.html index 0d92dd03a..6d6e4b720 100644 --- a/docs/elb/api-ref/elb_zq_jk_0001.html +++ b/docs/elb/api-ref/elb_zq_jk_0001.html @@ -221,104 +221,104 @@
                            Table 5 members_links parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            href

                            +

                            href

                            String

                            +

                            String

                            Provides links to the previous or next page during pagination query, respectively.

                            +

                            Provides links to the previous or next page during pagination query, respectively.

                            rel

                            +

                            rel

                            String

                            +

                            String

                            Specifies the prompt of the previous or next page. The value can be next or previous.

                            +

                            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.
                            -
                            Table 4 healthmonitor parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                            Table 4 healthmonitor parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            id

                            +

                            id

                            String

                            +

                            String

                            Specifies the health check ID.

                            +

                            Specifies the health check ID.

                            tenant_id

                            +

                            tenant_id

                            String

                            +

                            String

                            Specifies the ID of the project where the health check is performed.

                            +

                            Specifies the ID of the project where the health check is performed.

                            name

                            +

                            name

                            String

                            +

                            String

                            Specifies the health check name.

                            +

                            Specifies the health check name.

                            delay

                            +

                            delay

                            Integer

                            +

                            Integer

                            Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

                            +

                            Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

                            max_retries

                            +

                            max_retries

                            Integer

                            +

                            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.

                            +

                            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

                            +

                            max_retries_down

                            Integer

                            +

                            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.

                            +

                            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

                            +

                            pools

                            Array

                            +

                            Array

                            Specifies the ID of the backend server group associated with the health check. For details, see Table 5.

                            +

                            Specifies the ID of the backend server group associated with the health check. For details, see Table 5.

                            admin_state_up

                            +

                            admin_state_up

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the health check.

                            +

                            Specifies the administrative status of the health check.

                            This parameter is reserved. The value can be true or false.

                            • true: Enabled
                            • false: Disabled

                            timeout

                            +

                            timeout

                            Integer

                            +

                            Integer

                            Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

                            +

                            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

                            +

                            type

                            String

                            +

                            String

                            Specifies the health check protocol.

                            +

                            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

                            +

                            monitor_port

                            Integer

                            +

                            Integer

                            Specifies the health check port. The port number ranges from 1 to 65535.

                            +

                            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

                            +

                            expected_codes

                            String

                            +

                            String

                            Specifies the expected HTTP status code. The following options are available:

                            +

                            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

                            @@ -326,30 +326,30 @@

                            Currently, this parameter is not supported and is fixed at 200.

                            domain_name

                            +

                            domain_name

                            String

                            +

                            String

                            Specifies the domain name of HTTP requests during the health check.

                            +

                            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

                            +

                            url_path

                            String

                            +

                            String

                            Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

                            +

                            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

                            +

                            http_method

                            String

                            +

                            String

                            Specifies the HTTP request method. The default value is GET.

                            +

                            Specifies the HTTP request method. The default value is GET.

                            The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

                            This parameter is valid only when the value of type is set to HTTP.

                            NOTE:

                            This parameter is reserved.

                            diff --git a/docs/elb/api-ref/elb_zq_jk_0003.html b/docs/elb/api-ref/elb_zq_jk_0003.html index fec1e7a44..b7449031e 100644 --- a/docs/elb/api-ref/elb_zq_jk_0003.html +++ b/docs/elb/api-ref/elb_zq_jk_0003.html @@ -50,104 +50,104 @@
                            -
                            Table 3 healthmonitor parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                            Table 3 healthmonitor parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            id

                            +

                            id

                            String

                            +

                            String

                            Specifies the health check ID.

                            +

                            Specifies the health check ID.

                            tenant_id

                            +

                            tenant_id

                            String

                            +

                            String

                            Specifies the ID of the project where the health check is performed.

                            +

                            Specifies the ID of the project where the health check is performed.

                            name

                            +

                            name

                            String

                            +

                            String

                            Specifies the health check name.

                            +

                            Specifies the health check name.

                            delay

                            +

                            delay

                            Integer

                            +

                            Integer

                            Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

                            +

                            Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

                            max_retries

                            +

                            max_retries

                            Integer

                            +

                            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.

                            +

                            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

                            +

                            max_retries_down

                            Integer

                            +

                            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.

                            +

                            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

                            +

                            pools

                            Array

                            +

                            Array

                            Specifies the ID of the backend server group associated with the health check. For details, see Table 5.

                            +

                            Specifies the ID of the backend server group associated with the health check. For details, see Table 5.

                            admin_state_up

                            +

                            admin_state_up

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the health check.

                            +

                            Specifies the administrative status of the health check.

                            This parameter is reserved. The value can be true or false.

                            • true: Enabled
                            • false: Disabled

                            timeout

                            +

                            timeout

                            Integer

                            +

                            Integer

                            Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

                            +

                            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

                            +

                            type

                            String

                            +

                            String

                            Specifies the health check protocol.

                            +

                            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

                            +

                            monitor_port

                            Integer

                            +

                            Integer

                            Specifies the health check port. The port number ranges from 1 to 65535.

                            +

                            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

                            +

                            expected_codes

                            String

                            +

                            String

                            Specifies the expected HTTP status code. The following options are available:

                            +

                            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

                            @@ -155,30 +155,30 @@

                            Currently, this parameter is not supported and is fixed at 200.

                            domain_name

                            +

                            domain_name

                            String

                            +

                            String

                            Specifies the domain name of HTTP requests during the health check.

                            +

                            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

                            +

                            url_path

                            String

                            +

                            String

                            Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

                            +

                            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

                            +

                            http_method

                            String

                            +

                            String

                            Specifies the HTTP request method. The default value is GET.

                            +

                            Specifies the HTTP request method. The default value is GET.

                            The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

                            This parameter is valid only when the value of type is set to HTTP.

                            NOTE:

                            This parameter is reserved.

                            diff --git a/docs/elb/api-ref/elb_zq_jk_0004.html b/docs/elb/api-ref/elb_zq_jk_0004.html index 1da0aeb07..35212601e 100644 --- a/docs/elb/api-ref/elb_zq_jk_0004.html +++ b/docs/elb/api-ref/elb_zq_jk_0004.html @@ -217,104 +217,104 @@
                            -
                            Table 5 healthmonitor parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                            Table 5 healthmonitor parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            id

                            +

                            id

                            String

                            +

                            String

                            Specifies the health check ID.

                            +

                            Specifies the health check ID.

                            tenant_id

                            +

                            tenant_id

                            String

                            +

                            String

                            Specifies the ID of the project where the health check is performed.

                            +

                            Specifies the ID of the project where the health check is performed.

                            name

                            +

                            name

                            String

                            +

                            String

                            Specifies the health check name.

                            +

                            Specifies the health check name.

                            delay

                            +

                            delay

                            Integer

                            +

                            Integer

                            Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

                            +

                            Specifies the maximum time between health checks in the unit of second. The value ranges from 1 to 50.

                            max_retries

                            +

                            max_retries

                            Integer

                            +

                            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.

                            +

                            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

                            +

                            max_retries_down

                            Integer

                            +

                            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.

                            +

                            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

                            +

                            pools

                            Array

                            +

                            Array

                            Specifies the ID of the backend server group associated with the health check. For details, see Table 5.

                            +

                            Specifies the ID of the backend server group associated with the health check. For details, see Table 5.

                            admin_state_up

                            +

                            admin_state_up

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the health check.

                            +

                            Specifies the administrative status of the health check.

                            This parameter is reserved. The value can be true or false.

                            • true: Enabled
                            • false: Disabled

                            timeout

                            +

                            timeout

                            Integer

                            +

                            Integer

                            Specifies the health check timeout duration in the unit of second. The value ranges from 1 to 50.

                            +

                            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

                            +

                            type

                            String

                            +

                            String

                            Specifies the health check protocol.

                            +

                            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

                            +

                            monitor_port

                            Integer

                            +

                            Integer

                            Specifies the health check port. The port number ranges from 1 to 65535.

                            +

                            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

                            +

                            expected_codes

                            String

                            +

                            String

                            Specifies the expected HTTP status code. The following options are available:

                            +

                            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

                            @@ -322,30 +322,30 @@

                            Currently, this parameter is not supported and is fixed at 200.

                            domain_name

                            +

                            domain_name

                            String

                            +

                            String

                            Specifies the domain name of HTTP requests during the health check.

                            +

                            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

                            +

                            url_path

                            String

                            +

                            String

                            Specifies the HTTP request path for the health check. The default value is /, and the value must start with a slash (/).

                            +

                            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

                            +

                            http_method

                            String

                            +

                            String

                            Specifies the HTTP request method. The default value is GET.

                            +

                            Specifies the HTTP request method. The default value is GET.

                            The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

                            This parameter is valid only when the value of type is set to HTTP.

                            NOTE:

                            This parameter is reserved.

                            diff --git a/docs/elb/api-ref/elb_zq_jt_0001.html b/docs/elb/api-ref/elb_zq_jt_0001.html index 616829591..1b6ec4c77 100644 --- a/docs/elb/api-ref/elb_zq_jt_0001.html +++ b/docs/elb/api-ref/elb_zq_jt_0001.html @@ -8,143 +8,143 @@

                            URI

                            POST /v2.0/lbaas/listeners

                            Request

                            -
                            Table 1 Parameter description

                            Parameter

                            +
                            - - - - - - -
                            Table 1 Parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            listener

                            +

                            listener

                            Yes

                            +

                            Yes

                            Object

                            +

                            Object

                            Specifies the listener. For details, see Table 2.

                            +

                            Specifies the listener. For details, see Table 2.

                            -
                            Table 2 listener parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -206,26 +206,26 @@
                            Table 2 listener parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            tenant_id

                            +

                            tenant_id

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the ID of the project where the listener is used.

                            +

                            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

                            +

                            name

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the listener name.

                            +

                            Specifies the listener name.

                            The value contains a maximum of 255 characters.

                            description

                            +

                            description

                            No

                            +

                            No

                            String

                            +

                            String

                            Provides supplementary information about the listener.

                            +

                            Provides supplementary information about the listener.

                            The value contains a maximum of 255 characters.

                            protocol

                            +

                            protocol

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the protocol used by the listener.

                            +

                            Specifies the protocol used by the listener.

                            The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

                            protocol_port

                            +

                            protocol_port

                            Yes

                            +

                            Yes

                            Integer

                            +

                            Integer

                            Specifies the port used by the listener.

                            +

                            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

                            +

                            loadbalancer_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the ID of the associated load balancer.

                            +

                            Specifies the ID of the associated load balancer.

                            connection_limit

                            +

                            connection_limit

                            No

                            +

                            No

                            Integer

                            +

                            Integer

                            Specifies the maximum number of connections.

                            +

                            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

                            +

                            admin_state_up

                            No

                            +

                            No

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the listener.

                            +

                            Specifies the administrative status of the listener.

                            This parameter is reserved, and the default value is true.

                            http2_enable

                            +

                            http2_enable

                            No

                            +

                            No

                            Boolean

                            +

                            Boolean

                            Specifies whether to use HTTP/2.

                            +

                            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

                            +

                            default_pool_id

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the ID of the associated backend server group.

                            +

                            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.
                            @@ -152,13 +152,13 @@

                            default_tls_container_ref

                            +

                            default_tls_container_ref

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the ID of the server certificate used by the listener.

                            +

                            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.

                            @@ -166,39 +166,39 @@

                            client_ca_tls_container_ref

                            +

                            client_ca_tls_container_ref

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the ID of the CA certificate used by the listener.

                            +

                            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

                            +

                            sni_container_refs

                            No

                            +

                            No

                            Array

                            +

                            Array

                            Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

                            +

                            Lists the IDs of SNI certificates (server certificates with domain names) 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

                            +

                            tls_ciphers_policy

                            No

                            +

                            No

                            String

                            +

                            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.

                            +

                            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

                            +
                            - - - - - - - - - - - @@ -250,169 +250,169 @@

                            Response

                            -
                            Table 3 tls_ciphers_policy parameter description

                            Security Policy

                            TLS Version

                            +

                            TLS Version

                            Cipher Suite

                            +

                            Cipher Suite

                            tls-1-0-inherit

                            +

                            tls-1-0-inherit

                            TLS 1.2 TLS 1.1 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: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

                            +

                            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-0

                            TLS 1.2 TLS 1.1 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

                            +

                            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

                            @@ -238,11 +238,11 @@

                            TLS 1.2

                            tls-1-2-strict

                            +

                            tls-1-2-strict

                            TLS 1.2

                            +

                            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

                            +

                            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 4 Response parameters

                            Parameter

                            +
                            - - - - -
                            Table 4 Response parameters

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            listener

                            +

                            listener

                            Object

                            +

                            Object

                            Specifies the listener. For details, see Table 5.

                            +

                            Specifies the listener. For details, see Table 5.

                            -
                            Table 5 listeners parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/elb/api-ref/elb_zq_jt_0002.html b/docs/elb/api-ref/elb_zq_jt_0002.html index 8d0c2512d..4df826fd2 100644 --- a/docs/elb/api-ref/elb_zq_jt_0002.html +++ b/docs/elb/api-ref/elb_zq_jt_0002.html @@ -206,26 +206,26 @@
                            Table 5 listeners parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            id

                            +

                            id

                            String

                            +

                            String

                            Specifies the listener ID.

                            +

                            Specifies the listener ID.

                            tenant_id

                            +

                            tenant_id

                            String

                            +

                            String

                            Specifies the ID of the project where the listener is used.

                            +

                            Specifies the ID of the project where the listener is used.

                            name

                            +

                            name

                            String

                            +

                            String

                            Specifies the listener name.

                            +

                            Specifies the listener name.

                            description

                            +

                            description

                            String

                            +

                            String

                            Provides supplementary information about the listener.

                            +

                            Provides supplementary information about the listener.

                            protocol

                            +

                            protocol

                            String

                            +

                            String

                            Specifies the protocol used by the listener.

                            +

                            Specifies the protocol used by the listener.

                            The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

                            protocol_port

                            +

                            protocol_port

                            Integer

                            +

                            Integer

                            Specifies the port used by the listener.

                            +

                            Specifies the port used by the listener.

                            The port number ranges from 1 to 65535.

                            loadbalancers

                            +

                            loadbalancers

                            Array

                            +

                            Array

                            Specifies the ID of the associated load balancer. For details, see Table 6.

                            +

                            Specifies the ID of the associated load balancer. For details, see Table 6.

                            connection_limit

                            +

                            connection_limit

                            Integer

                            +

                            Integer

                            Specifies the maximum number of connections.

                            +

                            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

                            +

                            admin_state_up

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the listener.

                            +

                            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

                            +

                            http2_enable

                            Boolean

                            +

                            Boolean

                            Specifies whether to use HTTP/2.

                            +

                            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

                            +

                            default_pool_id

                            String

                            +

                            String

                            Specifies the ID of the associated backend server group.

                            +

                            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

                            +

                            default_tls_container_ref

                            String

                            +

                            String

                            Specifies the ID of the server certificate used by the listener. For details, see Certificate.

                            +

                            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

                            +

                            client_ca_tls_container_ref

                            String

                            +

                            String

                            Specifies the ID of the CA certificate used by the listener. For details, see Certificate.

                            +

                            Specifies the ID of the CA certificate used by the listener. For details, see Certificate.

                            sni_container_refs

                            +

                            sni_container_refs

                            Array

                            +

                            Array

                            Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

                            +

                            Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

                            If the parameter value is an empty list, the SNI feature is disabled.

                            tags

                            +

                            tags

                            Array

                            +

                            Array

                            Tags the listener.

                            +

                            Tags the listener.

                            created_at

                            +

                            created_at

                            String

                            +

                            String

                            Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            +

                            Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            updated_at

                            +

                            updated_at

                            String

                            +

                            String

                            Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            +

                            Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            tls_ciphers_policy

                            +

                            tls_ciphers_policy

                            String

                            +

                            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.

                            +

                            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 2 tls_ciphers_policy parameter description

                            Security Policy

                            +
                            - - - - - - - - - - - @@ -250,221 +250,221 @@

                            Response

                            -
                            Table 2 tls_ciphers_policy parameter description

                            Security Policy

                            TLS Version

                            +

                            TLS Version

                            Cipher Suite

                            +

                            Cipher Suite

                            tls-1-0-inherit

                            +

                            tls-1-0-inherit

                            TLS 1.2 TLS 1.1 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: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

                            +

                            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-0

                            TLS 1.2 TLS 1.1 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

                            +

                            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

                            @@ -238,11 +238,11 @@

                            TLS 1.2

                            tls-1-2-strict

                            +

                            tls-1-2-strict

                            TLS 1.2

                            +

                            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

                            +

                            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 3 Parameter description

                            Parameter

                            +
                            - - - - - - - -
                            Table 3 Parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            listeners

                            +

                            listeners

                            Array

                            +

                            Array

                            Lists the listeners. For details, see Table 4.

                            +

                            Lists the listeners. For details, see Table 4.

                            listeners_links

                            +

                            listeners_links

                            Array

                            +

                            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.

                            +

                            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

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -491,26 +491,26 @@
                            Table 4 listeners parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            id

                            +

                            id

                            String

                            +

                            String

                            Specifies the listener ID.

                            +

                            Specifies the listener ID.

                            tenant_id

                            +

                            tenant_id

                            String

                            +

                            String

                            Specifies the ID of the project where the listener is used.

                            +

                            Specifies the ID of the project where the listener is used.

                            The value contains a maximum of 255 characters.

                            name

                            +

                            name

                            String

                            +

                            String

                            Specifies the listener name.

                            +

                            Specifies the listener name.

                            The value contains a maximum of 255 characters.

                            description

                            +

                            description

                            String

                            +

                            String

                            Provides supplementary information about the listener.

                            +

                            Provides supplementary information about the listener.

                            The value contains a maximum of 255 characters.

                            protocol

                            +

                            protocol

                            String

                            +

                            String

                            Specifies the protocol used by the listener.

                            +

                            Specifies the protocol used by the listener.

                            The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

                            protocol_port

                            +

                            protocol_port

                            Integer

                            +

                            Integer

                            Specifies the port used by the listener.

                            +

                            Specifies the port used by the listener.

                            The port number ranges from 1 to 65535.

                            loadbalancers

                            +

                            loadbalancers

                            Array

                            +

                            Array

                            Specifies the ID of the associated load balancer.

                            +

                            Specifies the ID of the associated load balancer.

                            connection_limit

                            +

                            connection_limit

                            Integer

                            +

                            Integer

                            Specifies the maximum number of connections.

                            +

                            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

                            +

                            admin_state_up

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the listener.

                            +

                            Specifies the administrative status of the listener.

                            This parameter is reserved. The value can be true or false.

                            • true: Enabled
                            • false: Disabled

                            http2_enable

                            +

                            http2_enable

                            Boolean

                            +

                            Boolean

                            Specifies whether to use HTTP/2.

                            +

                            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

                            +

                            keepalive_timeout

                            Integer

                            +

                            Integer

                            Specifies the idle timeout duration in the unit of second.

                            +

                            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

                            +

                            client_timeout

                            Integer

                            +

                            Integer

                            Specifies the request timeout duration in the unit of second.

                            +

                            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

                            +

                            member_timeout

                            Integer

                            +

                            Integer

                            Specifies the response timeout duration in the unit of second.

                            +

                            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

                            +

                            default_pool_id

                            String

                            +

                            String

                            Specifies the ID of the associated backend server group.

                            +

                            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

                            +

                            default_tls_container_ref

                            String

                            +

                            String

                            Specifies the ID of the server certificate used by the listener.

                            +

                            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

                            +

                            client_ca_tls_container_ref

                            String

                            +

                            String

                            Specifies the ID of the CA certificate used by the listener.

                            +

                            Specifies the ID of the CA certificate used by the listener.

                            The value contains a maximum of 128 characters.

                            sni_container_refs

                            +

                            sni_container_refs

                            Array

                            +

                            Array

                            Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

                            +

                            Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

                            tags

                            +

                            tags

                            Array

                            +

                            Array

                            Tags the listener.

                            +

                            Tags the listener.

                            created_at

                            +

                            created_at

                            String

                            +

                            String

                            Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            +

                            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

                            +

                            updated_at

                            String

                            +

                            String

                            Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            +

                            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

                            +

                            listeners_links

                            Array

                            +

                            Array

                            Provides links to the previous or next page during pagination query, respectively. This parameter exists only in the response body of pagination query.

                            +

                            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

                            +

                            tls_ciphers_policy

                            String

                            +

                            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.

                            +

                            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 6 tls_ciphers_policy parameter description

                            Security Policy

                            +
                            - - - - - - - - - - -
                            Table 6 tls_ciphers_policy parameter description

                            Security Policy

                            TLS Version

                            +

                            TLS Version

                            Cipher Suite

                            +

                            Cipher Suite

                            tls-1-0-inherit

                            +

                            tls-1-0-inherit

                            TLS 1.2 TLS 1.1 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: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

                            +

                            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-0

                            TLS 1.2 TLS 1.1 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

                            +

                            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

                            @@ -523,37 +523,37 @@

                            TLS 1.2

                            tls-1-2-strict

                            +

                            tls-1-2-strict

                            TLS 1.2

                            +

                            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

                            +

                            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

                            +
                            - - - - - - - - diff --git a/docs/elb/api-ref/elb_zq_jt_0003.html b/docs/elb/api-ref/elb_zq_jt_0003.html index 5d70a0a63..cb54ecb10 100644 --- a/docs/elb/api-ref/elb_zq_jt_0003.html +++ b/docs/elb/api-ref/elb_zq_jt_0003.html @@ -6,23 +6,23 @@

                            URI

                            GET /v2.0/lbaas/listeners/{listener_id}

                            -
                            Table 7 listeners_links parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            href

                            +

                            href

                            String

                            +

                            String

                            Provides links to the previous or next page during pagination query, respectively.

                            +

                            Provides links to the previous or next page during pagination query, respectively.

                            rel

                            +

                            rel

                            String

                            +

                            String

                            Specifies the prompt of the previous or next page.

                            +

                            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.

                            Table 1 Parameter description

                            Parameter

                            +
                            - - - - - - - @@ -31,169 +31,169 @@

                            Request

                            None

                            Response

                            -
                            Table 1 Parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            listener_id

                            +

                            listener_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the listener ID.

                            +

                            Specifies the listener ID.

                            Table 2 Response parameters

                            Parameter

                            +
                            - - - - -
                            Table 2 Response parameters

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            listener

                            +

                            listener

                            Object

                            +

                            Object

                            Lists the listeners. For details, see Table 3.

                            +

                            Lists the listeners. For details, see Table 3.

                            -
                            Table 3 listeners parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/elb/api-ref/elb_zq_jt_0004.html b/docs/elb/api-ref/elb_zq_jt_0004.html index ec78ce464..838802b88 100644 --- a/docs/elb/api-ref/elb_zq_jt_0004.html +++ b/docs/elb/api-ref/elb_zq_jt_0004.html @@ -9,23 +9,23 @@

                            URI

                            PUT /v2.0/lbaas/listeners/{listener_id}

                            -
                            Table 3 listeners parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            id

                            +

                            id

                            String

                            +

                            String

                            Specifies the listener ID.

                            +

                            Specifies the listener ID.

                            tenant_id

                            +

                            tenant_id

                            String

                            +

                            String

                            Specifies the ID of the project where the listener is used.

                            +

                            Specifies the ID of the project where the listener is used.

                            name

                            +

                            name

                            String

                            +

                            String

                            Specifies the listener name.

                            +

                            Specifies the listener name.

                            description

                            +

                            description

                            String

                            +

                            String

                            Provides supplementary information about the listener.

                            +

                            Provides supplementary information about the listener.

                            protocol

                            +

                            protocol

                            String

                            +

                            String

                            Specifies the protocol used by the listener.

                            +

                            Specifies the protocol used by the listener.

                            The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

                            protocol_port

                            +

                            protocol_port

                            Integer

                            +

                            Integer

                            Specifies the port used by the listener.

                            +

                            Specifies the port used by the listener.

                            The port number ranges from 1 to 65535.

                            loadbalancers

                            +

                            loadbalancers

                            Array

                            +

                            Array

                            Specifies the ID of the associated load balancer. For details, see Table 6.

                            +

                            Specifies the ID of the associated load balancer. For details, see Table 6.

                            connection_limit

                            +

                            connection_limit

                            Integer

                            +

                            Integer

                            Specifies the maximum number of connections.

                            +

                            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

                            +

                            admin_state_up

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the listener.

                            +

                            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

                            +

                            http2_enable

                            Boolean

                            +

                            Boolean

                            Specifies whether to use HTTP/2.

                            +

                            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

                            +

                            default_pool_id

                            String

                            +

                            String

                            Specifies the ID of the associated backend server group.

                            +

                            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

                            +

                            default_tls_container_ref

                            String

                            +

                            String

                            Specifies the ID of the server certificate used by the listener. For details, see Certificate.

                            +

                            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

                            +

                            client_ca_tls_container_ref

                            String

                            +

                            String

                            Specifies the ID of the CA certificate used by the listener. For details, see Certificate.

                            +

                            Specifies the ID of the CA certificate used by the listener. For details, see Certificate.

                            sni_container_refs

                            +

                            sni_container_refs

                            Array

                            +

                            Array

                            Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

                            +

                            Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

                            If the parameter value is an empty list, the SNI feature is disabled.

                            tags

                            +

                            tags

                            Array

                            +

                            Array

                            Tags the listener.

                            +

                            Tags the listener.

                            created_at

                            +

                            created_at

                            String

                            +

                            String

                            Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            +

                            Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            updated_at

                            +

                            updated_at

                            String

                            +

                            String

                            Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            +

                            Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            tls_ciphers_policy

                            +

                            tls_ciphers_policy

                            String

                            +

                            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.

                            +

                            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 1 Parameter description

                            Parameter

                            +
                            - - - - - - - @@ -183,26 +183,26 @@
                            Table 1 Parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            listener_id

                            +

                            listener_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the listener ID.

                            +

                            Specifies the listener ID.

                            -
                            Table 4 tls_ciphers_policy parameter description

                            Security Policy

                            +
                            - - - - - - - - - - - @@ -229,167 +229,167 @@

                            Response

                            Table 4 tls_ciphers_policy parameter description

                            Security Policy

                            TLS Version

                            +

                            TLS Version

                            Cipher Suite

                            +

                            Cipher Suite

                            tls-1-0-inherit

                            +

                            tls-1-0-inherit

                            TLS 1.2 TLS 1.1 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: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

                            +

                            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-0

                            TLS 1.2 TLS 1.1 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

                            +

                            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

                            @@ -215,11 +215,11 @@

                            TLS 1.2

                            tls-1-2-strict

                            +

                            tls-1-2-strict

                            TLS 1.2

                            +

                            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

                            +

                            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 5 Response parameters

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            listener

                            Object

                            +

                            Object

                            Specifies the listener. For details, see Table 6.

                            +

                            Specifies the listener. For details, see Table 6.

                            -
                            Table 6 listeners parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/elb/api-ref/elb_zq_zf_0001.html b/docs/elb/api-ref/elb_zq_zf_0001.html index 7ae4072cf..00960f097 100644 --- a/docs/elb/api-ref/elb_zq_zf_0001.html +++ b/docs/elb/api-ref/elb_zq_zf_0001.html @@ -10,155 +10,155 @@

                            URI

                            POST /v2.0/lbaas/l7policies

                            Request

                            -
                            Table 6 listeners parameter description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            id

                            +

                            id

                            String

                            +

                            String

                            Specifies the listener ID.

                            +

                            Specifies the listener ID.

                            tenant_id

                            +

                            tenant_id

                            String

                            +

                            String

                            Specifies the ID of the project where the listener is used.

                            +

                            Specifies the ID of the project where the listener is used.

                            name

                            +

                            name

                            String

                            +

                            String

                            Specifies the listener name.

                            +

                            Specifies the listener name.

                            description

                            +

                            description

                            String

                            +

                            String

                            Provides supplementary information about the listener.

                            +

                            Provides supplementary information about the listener.

                            protocol

                            +

                            protocol

                            String

                            +

                            String

                            Specifies the protocol used by the listener.

                            +

                            Specifies the protocol used by the listener.

                            The value can be TCP, HTTP, UDP, or TERMINATED_HTTPS.

                            protocol_port

                            +

                            protocol_port

                            Integer

                            +

                            Integer

                            Specifies the port used by the listener.

                            +

                            Specifies the port used by the listener.

                            The port number ranges from 1 to 65535.

                            loadbalancers

                            +

                            loadbalancers

                            Array

                            +

                            Array

                            Specifies the ID of the associated load balancer. For details, see Table 6.

                            +

                            Specifies the ID of the associated load balancer. For details, see Table 6.

                            connection_limit

                            +

                            connection_limit

                            Integer

                            +

                            Integer

                            Specifies the maximum number of connections.

                            +

                            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

                            +

                            admin_state_up

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the listener.

                            +

                            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

                            +

                            http2_enable

                            Boolean

                            +

                            Boolean

                            Specifies whether to use HTTP/2.

                            +

                            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

                            +

                            default_pool_id

                            String

                            +

                            String

                            Specifies the ID of the associated backend server group.

                            +

                            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

                            +

                            default_tls_container_ref

                            String

                            +

                            String

                            Specifies the ID of the server certificate used by the listener. For details, see Certificate.

                            +

                            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

                            +

                            client_ca_tls_container_ref

                            String

                            +

                            String

                            Specifies the ID of the CA certificate used by the listener. For details, see Certificate.

                            +

                            Specifies the ID of the CA certificate used by the listener. For details, see Certificate.

                            sni_container_refs

                            +

                            sni_container_refs

                            Array

                            +

                            Array

                            Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

                            +

                            Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.

                            If the parameter value is an empty list, the SNI feature is disabled.

                            tags

                            +

                            tags

                            Array

                            +

                            Array

                            Tags the listener.

                            +

                            Tags the listener.

                            created_at

                            +

                            created_at

                            String

                            +

                            String

                            Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            +

                            Specifies the time when the listener was created. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            updated_at

                            +

                            updated_at

                            String

                            +

                            String

                            Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            +

                            Specifies the time when the listener was updated. The UTC time is in YYYY-MM-DDTHH:MM:SS format.

                            tls_ciphers_policy

                            +

                            tls_ciphers_policy

                            String

                            +

                            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.

                            +

                            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 1 Parameter description

                            Parameter

                            +
                            - - - - - - -
                            Table 1 Parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            l7policy

                            +

                            l7policy

                            Yes

                            +

                            Yes

                            Object

                            +

                            Object

                            Specifies the forwarding policy. For details, see Table 2.

                            +

                            Specifies the forwarding policy. For details, see Table 2.

                            -
                            Table 2 l7policy parameter description

                            Parameter

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -248,26 +248,26 @@

                            Response

                            -
                            Table 2 l7policy parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            tenant_id

                            +

                            tenant_id

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the ID of the project where the forwarding policy is used.

                            +

                            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

                            +

                            name

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the forwarding policy name.

                            +

                            Specifies the forwarding policy name.

                            The value contains a maximum of 255 characters.

                            admin_state_up

                            +

                            admin_state_up

                            No

                            +

                            No

                            Boolean

                            +

                            Boolean

                            Specifies the administrative status of the forwarding policy.

                            +

                            Specifies the administrative status of the forwarding policy.

                            This parameter is reserved, and the default value is true.

                            description

                            +

                            description

                            No

                            +

                            No

                            String

                            +

                            String

                            Provides supplementary information about the forwarding policy.

                            +

                            Provides supplementary information about the forwarding policy.

                            The value contains a maximum of 255 characters.

                            listener_id

                            +

                            listener_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the ID of the listener to which the forwarding policy is added.

                            +

                            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

                            +

                            action

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies whether requests are forwarded to another backend server group or redirected to an HTTPS listener.

                            +

                            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

                            +

                            redirect_pool_id

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the ID of the backend server group to which traffic is forwarded. The default value is null.

                            +

                            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

                            +

                            redirect_listener_id

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the ID of the listener to which the traffic is redirected. The default value is null.

                            +

                            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:

                            +

                            This parameter is mandatory when action is set to REDIRECT_TO_LISTENER, and the listener:

                            • Can only be an HTTPS listener.
                            • Can only be a listener of the same load balancer.

                            redirect_url

                            +

                            redirect_url

                            No

                            +

                            No

                            String

                            +

                            String

                            Specifies the URL to which traffic is redirected. The default value is null.

                            +

                            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

                            +

                            position

                            No

                            +

                            No

                            Integer

                            +

                            Integer

                            Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

                            +

                            Specifies the forwarding priority. The value ranges from 1 to 100. The default value is 100.

                            This parameter is reserved.

                            rules

                            +

                            rules

                            No

                            +

                            No

                            Array

                            +

                            Array

                            Lists the forwarding rules of the forwarding policy. For details, see Table 3.

                            +

                            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 4 Response parameters

                            Parameter

                            +
                            - - - - -
                            Table 4 Response parameters

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            l7policy

                            +

                            l7policy

                            Object

                            +

                            Object

                            Specifies the forwarding policy. For details, see Table 5.

                            +

                            Specifies the forwarding policy. For details, see Table 5.

                            -
                            Table 5 l7policy parameter description

                            Parameter

                            +
                            diff --git a/docs/elb/api-ref/elb_zq_zf_0002.html b/docs/elb/api-ref/elb_zq_zf_0002.html index da5768c37..8c5f25263 100644 --- a/docs/elb/api-ref/elb_zq_zf_0002.html +++ b/docs/elb/api-ref/elb_zq_zf_0002.html @@ -211,7 +211,7 @@
                            Table 5 l7policy parameter description

                            Parameter

                            Type

                            -
                            Table 3 l7policy parameter description

                            Parameter

                            +
                            diff --git a/docs/elb/api-ref/elb_zq_zf_0003.html b/docs/elb/api-ref/elb_zq_zf_0003.html index 12a6c4696..c5ee70227 100644 --- a/docs/elb/api-ref/elb_zq_zf_0003.html +++ b/docs/elb/api-ref/elb_zq_zf_0003.html @@ -50,7 +50,7 @@
                            Table 3 l7policy parameter description

                            Parameter

                            Type

                            -
                            Table 3 l7policy parameter description

                            Parameter

                            +
                            diff --git a/docs/elb/api-ref/elb_zq_zf_0004.html b/docs/elb/api-ref/elb_zq_zf_0004.html index d5e4a834d..a438f0d7a 100644 --- a/docs/elb/api-ref/elb_zq_zf_0004.html +++ b/docs/elb/api-ref/elb_zq_zf_0004.html @@ -145,7 +145,7 @@
                            Table 3 l7policy parameter description

                            Parameter

                            Type

                            -
                            Table 5 l7policy parameter description

                            Parameter

                            +
                            diff --git a/docs/elb/api-ref/elb_zq_zg_0003.html b/docs/elb/api-ref/elb_zq_zg_0003.html index 8da59f368..eb82ef3c6 100644 --- a/docs/elb/api-ref/elb_zq_zg_0003.html +++ b/docs/elb/api-ref/elb_zq_zg_0003.html @@ -1,37 +1,37 @@

                            Querying Details of a Forwarding Rule

                            -

                            Function

                            This API is used to query details about a forwarding rule using its ID.

                            +

                            Function

                            This API is used to query details about a forwarding rule by ID.

                            URI

                            GET /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}

                            -
                            Table 5 l7policy parameter description

                            Parameter

                            Type

                            Table 1 Parameter description

                            Parameter

                            +
                            - - - - - - - - - - - @@ -40,19 +40,19 @@

                            Request

                            None

                            Response

                            -
                            Table 1 Parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            l7policy_id

                            +

                            l7policy_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the forwarding policy ID.

                            +

                            Specifies the forwarding policy ID.

                            l7rule_id

                            +

                            l7rule_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the forwarding rule ID.

                            +

                            Specifies the forwarding rule ID.

                            Table 2 Response parameters

                            Parameter

                            +
                            - - - - - diff --git a/docs/elb/api-ref/elb_zq_zg_0005.html b/docs/elb/api-ref/elb_zq_zg_0005.html index ac29385b0..f726666a0 100644 --- a/docs/elb/api-ref/elb_zq_zg_0005.html +++ b/docs/elb/api-ref/elb_zq_zg_0005.html @@ -5,32 +5,32 @@

                            URI

                            DELETE /v2.0/lbaas/l7policies/{l7policy_id}/rules/{l7rule_id}

                            -
                            Table 2 Response parameters

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            rule

                            +

                            rule

                            Object

                            +

                            Object

                            Specifies the forwarding rule. For details, see Table 3.

                            +

                            Specifies the forwarding rule. For details, see Table 3.

                            Table 1 Parameter description

                            Parameter

                            +
                            - - - - - - - - - - -
                            Table 1 Parameter description

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            l7policy_id

                            +

                            l7policy_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the forwarding policy ID.

                            +

                            Specifies the forwarding policy ID.

                            l7rule_id

                            +

                            l7rule_id

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            Specifies the forwarding rule ID.

                            +

                            Specifies the forwarding rule ID.