@alicloud/ga20191120 3.0.0 → 3.0.1

package/src/models/UpdateEndpointGroupRequest.ts

@@ -3,17 +3,22 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Model {
+  apiKeys?: string[];
   /**
    * @remarks
-   * Specifies whether to automatically preserve client IP addresses. Valid values:
+   * Specifies whether to preserve client source IP addresses. Valid values:
    * 
-   * *   **true**
-   * *   **false** (default)
+   * - **true**: Preserves client source IP addresses.
    * 
-   * > *   By default, client IP address preservation is disabled for an endpoint group of a UDP or TCP listener. You can configure this parameter based on your business requirements.
-   * >*   By default, client IP address preservation is enabled for an endpoint group of an HTTP or HTTP listener. You can obtain client IP addresses by using the X-Forwarded-For header. You cannot disable the feature.
-   * >*   EnableClientIPPreservation and EnableProxyProtocol cannot be set to true at the same time.
-   * >>For more information, see [Preserve client IP addresses](https://help.aliyun.com/document_detail/158080.html).
+   * - **false** (default): Does not preserve client source IP addresses.
+   * 
+   * > * For endpoint groups of TCP or UDP listeners, this feature is disabled by default but can be enabled if needed.
+   * >
+   * > * For endpoint groups of HTTP or HTTPS listeners, client source IP addresses are preserved by default. The client IP addresses are retrieved from the X-Forwarded-For header. You cannot disable this feature.
+   * >
+   * > * You cannot set both `EnableClientIPPreservation` and `EnableProxyProtocol` to `true`.
+   * >
+   * > * For more information, see [preserve client source IP addresses](https://help.aliyun.com/document_detail/158080.html).
    * 
    * @example
    * false
@@ -21,14 +26,17 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
   enableClientIPPreservation?: boolean;
   /**
    * @remarks
-   * Specifies whether to use the proxy protocol to preserve client IP addresses. Valid values:
+   * Specifies whether to use the Proxy Protocol to preserve client source IP addresses. Valid values:
+   * 
+   * - **true**: Preserves client source IP addresses.
    * 
-   * *   **true**
-   * *   **false** (default)
+   * - **false** (default): Does not preserve client source IP addresses.
    * 
-   * > *   This parameter is available only to endpoint groups of TCP listeners.
-   * >*   EnableClientIPPreservation and EnableProxyProtocol cannot be set to true at the same time.
-   * >>For more information, see [Preserve client IP addresses](https://help.aliyun.com/document_detail/158080.html).
+   * > * You can configure this parameter only for endpoint groups of TCP listeners.
+   * >
+   * > * You cannot set both `EnableClientIPPreservation` and `EnableProxyProtocol` to `true`.
+   * >
+   * > * For more information, see [preserve client source IP addresses](https://help.aliyun.com/document_detail/158080.html).
    * 
    * @example
    * false
@@ -36,7 +44,7 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
   enableProxyProtocol?: boolean;
   /**
    * @remarks
-   * Enter the IP address, domain name, or instance ID based on the value of the Type parameter.
+   * Enter an IP address, a domain name, or an instance ID based on the value of the `Type` parameter.
    * 
    * This parameter is required.
    * 
@@ -44,11 +52,16 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
    * 120.XX.XX.21
    */
   endpoint?: string;
+  /**
+   * @example
+   * BAILIAN
+   */
+  provider?: string;
   /**
    * @remarks
-   * The private IP address of the ENI.
+   * The private IP address of the elastic network interface.
    * 
-   * >  This parameter is available only when you set the endpoint type to **ENI**. If you leave this parameter empty, the primary private IP address of the ENI is used.
+   * > If the endpoint type is **ENI**, you can specify this parameter. If you omit this parameter, the primary private IP address of the ENI is used.
    * 
    * @example
    * 172.168.XX.XX
@@ -56,24 +69,37 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
   subAddress?: string;
   /**
    * @remarks
-   * The type of the endpoint. Valid values:
-   * 
-   * *   **Domain**: a custom domain name.
-   * *   **Ip**: a custom IP address.
-   * *   **IpTarget**: a custom private IP address.
-   * *   **PublicIp**: a public IP address provided by Alibaba Cloud.
-   * *   **ECS**: an Elastic Compute Service (ECS) instance.
-   * *   **SLB**: a Server Load Balancer (SLB) instance.
-   * *   **ALB**: an Application Load Balancer (ALB) instance.
-   * *   **OSS**: an Object Storage Service (OSS) bucket.
-   * *   **ENI**: an elastic network interface (ENI).
-   * *   **NLB**: a Network Load Balancer (NLB) instance.
-   * 
-   * > *   If you set this parameter to **ECS**, **ENI**, **SLB**, **ALB**, **NLB**, or **IpTarget**, and the AliyunServiceRoleForGaVpcEndpoint service-linked role does not exist, the system automatically creates the role.
-   * >*   If you set this parameter to **ALB** and the AliyunServiceRoleForGaAlb service-linked role does not exist, the system automatically creates the role.
-   * >*   If you set this parameter to **OSS** and the AliyunServiceRoleForGaOss service-linked role does not exist, the system automatically creates the role.
-   * >*   If you set this parameter to **NLB** and the AliyunServiceRoleForGaNlb service-linked role does not exist, the system automatically creates the role.
-   * >>For more information, see [Service-linked roles](https://help.aliyun.com/document_detail/178360.html).
+   * The type of endpoint. Valid values:
+   * 
+   * - **Domain**: a custom domain name.
+   * 
+   * - **Ip**: a custom IP address.
+   * 
+   * - **IpTarget**: a custom private IP address.
+   * 
+   * - **PublicIp**: an Alibaba Cloud public IP address.
+   * 
+   * - **ECS**: an ECS instance.
+   * 
+   * - **SLB**: an SLB instance.
+   * 
+   * - **ALB**: an ALB instance.
+   * 
+   * - **OSS**: an OSS instance.
+   * 
+   * - **ENI**: an elastic network interface.
+   * 
+   * - **NLB**: an NLB instance.
+   * 
+   * > * If the endpoint type is **ECS**, **ENI**, **SLB**, or **IpTarget**, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaVpcEndpoint.
+   * >
+   * > * If the endpoint type is **ALB**, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaAlb.
+   * >
+   * > * If the endpoint type is **OSS**, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaOss.
+   * >
+   * > * If the endpoint type is **NLB**, and the service-linked role does not exist, the system automatically creates a service-linked role named AliyunServiceRoleForGaNlb.
+   * >
+   * > > For more information, see [service-linked roles](https://help.aliyun.com/document_detail/178360.html).
    * 
    * This parameter is required.
    * 
@@ -83,16 +109,16 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
   type?: string;
   /**
    * @remarks
-   * The IDs of vSwitches that are deployed in the VPC.
+   * A list of vSwitches in the VPC.
    */
   vSwitchIds?: string[];
   /**
    * @remarks
-   * The virtual private cloud (VPC) ID.
+   * The ID of the VPC.
    * 
-   * You can specify one VPC ID for an endpoint group of an intelligent routing listener.
+   * You can specify at most one VPC ID for an endpoint group that is associated with an intelligent routing listener.
    * 
-   * >  This parameter is valid and required only if Type is set to **IpTarget**.
+   * > This parameter is required only when the endpoint type is **IpTarget**.
    * 
    * @example
    * vpc-2zen6t0u7xhm0k5iz****
@@ -104,7 +130,7 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
    * 
    * Valid values: **0** to **255**.
    * 
-   * >  If you set the weight of an endpoint to 0, GA stops distributing traffic to the endpoint. Proceed with caution.
+   * > If you set the weight of an endpoint to 0, Global Accelerator stops distributing traffic to the endpoint. Proceed with caution.
    * 
    * This parameter is required.
    * 
@@ -114,9 +140,11 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
   weight?: number;
   static names(): { [key: string]: string } {
     return {
+      apiKeys: 'ApiKeys',
       enableClientIPPreservation: 'EnableClientIPPreservation',
       enableProxyProtocol: 'EnableProxyProtocol',
       endpoint: 'Endpoint',
+      provider: 'Provider',
       subAddress: 'SubAddress',
       type: 'Type',
       vSwitchIds: 'VSwitchIds',
@@ -127,9 +155,11 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
 
   static types(): { [key: string]: any } {
     return {
+      apiKeys: { 'type': 'array', 'itemType': 'string' },
       enableClientIPPreservation: 'boolean',
       enableProxyProtocol: 'boolean',
       endpoint: 'string',
+      provider: 'string',
       subAddress: 'string',
       type: 'string',
       vSwitchIds: { 'type': 'array', 'itemType': 'string' },
@@ -139,6 +169,9 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
   }
 
   validate() {
+    if(Array.isArray(this.apiKeys)) {
+      $dara.Model.validateArray(this.apiKeys);
+    }
     if(Array.isArray(this.vSwitchIds)) {
       $dara.Model.validateArray(this.vSwitchIds);
     }
@@ -153,7 +186,7 @@ export class UpdateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
 export class UpdateEndpointGroupRequestPortOverrides extends $dara.Model {
   /**
    * @remarks
-   * The endpoint port that is mapped to the listener port.
+   * The endpoint port in the port override settings.
    * 
    * @example
    * 80
@@ -161,11 +194,13 @@ export class UpdateEndpointGroupRequestPortOverrides extends $dara.Model {
   endpointPort?: number;
   /**
    * @remarks
-   * The listener port that is mapped to the endpoint port.
+   * The listener port in the port override settings.
    * 
-   * > *   You cannot configure port mappings for virtual endpoint groups of TCP listeners. If a virtual endpoint group already exists on the listener, you cannot configure port mappings for the default endpoint group. If port mappings are configured for the default endpoint group, you cannot add a virtual endpoint group.
-   * >*   If you configure port mappings for a listener, you cannot modify the listener protocol. You can only switch between HTTP and HTTPS.
-   * >*   Listener port: When you modify the listener port range, make sure that the port range includes the ports configured in port mappings. For example, if you set the listener port range to 80 to 82 and map the listener ports to endpoint ports 100 to 102, you cannot change the listener port range to 80 to 81.
+   * > - For TCP listeners, virtual endpoint groups do not support port overrides. If a listener is already associated with a virtual endpoint group, you cannot configure port overrides for the default endpoint group. If the default endpoint group has port overrides configured, you cannot add a virtual endpoint group.
+   * >
+   * > - After you configure port overrides, you can change the listener protocol only between HTTP and HTTPS.
+   * >
+   * > - The updated listener port range must include all listener ports in the configured port overrides. For example, if the listener port range is 80-82 and port overrides are configured to map the ports to endpoint ports 100-102, you cannot update the listener port range to 80-81.
    * 
    * @example
    * 443
@@ -197,11 +232,11 @@ export class UpdateEndpointGroupRequestPortOverrides extends $dara.Model {
 export class UpdateEndpointGroupRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request.
+   * A client-generated token to ensure the idempotence of the request.
    * 
-   * You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.
+   * The token must be unique across requests and can contain only ASCII characters.
    * 
-   * > If you do not specify this parameter, the system automatically uses the **request ID** as the **client token**. The **request ID** may be different for each request.
+   * > If you do not specify this parameter, the system automatically uses the **RequestId** of the API request as the **ClientToken**. The **RequestId** is unique for each API request.
    * 
    * @example
    * 123e4567-e89b-12d3-a456-426655440000
@@ -211,7 +246,7 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
    * @remarks
    * The description of the endpoint group.
    * 
-   * The description can be up to 200 characters in length and cannot start with `http://` or `https://`.
+   * The description can be up to 200 characters long and cannot start with `http://` or `https://`.
    * 
    * @example
    * EndpointGroup
@@ -219,7 +254,7 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The configurations of the endpoints in the endpoint group.
+   * The configurations of the endpoints.
    */
   endpointConfigurations?: UpdateEndpointGroupRequestEndpointConfigurations[];
   /**
@@ -234,7 +269,7 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
   endpointGroupId?: string;
   /**
    * @remarks
-   * The ID of the region where the endpoint group is created.
+   * The ID of the region where the endpoint group is deployed.
    * 
    * This parameter is required.
    * 
@@ -242,15 +277,23 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
    * cn-hangzhou
    */
   endpointGroupRegion?: string;
+  /**
+   * @remarks
+   * Specifies the IP protocol that GA uses to communicate with endpoints. Valid values: ● **IPv4** (default): Use IPv4. ● **IPv6**: Use IPv6. ● **ProtocolAffinity**: Use the same IP protocol as the client request.
+   * 
+   * @example
+   * IPv4
+   */
   endpointIpVersion?: string;
   /**
    * @remarks
-   * The protocol version that is used by the backend service. Valid values:
+   * The version of the backend service protocol. Valid values:
    * 
-   * *   **HTTP1.1**
-   * *   **HTTP2**
+   * - **HTTP1.1**
    * 
-   * >  This parameter takes effect only when you set EndpointRequestProtocol to HTTPS.
+   * - **HTTP2**
+   * 
+   * > You can configure this parameter only when `EndpointRequestProtocol` is set to HTTPS.
    * 
    * @example
    * HTTP1.1
@@ -258,13 +301,15 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
   endpointProtocolVersion?: string;
   /**
    * @remarks
-   * The protocol that is used by the backend service. Valid values:
+   * The backend service protocol. Valid values:
+   * 
+   * - **HTTP**
    * 
-   * *   **HTTP**
-   * *   **HTTPS**
+   * - **HTTPS**
    * 
-   * > *   You can set this parameter only when the listener that is associated with the endpoint group uses the HTTP or HTTPS protocol.
-   * > *   For an HTTP listener, the backend service protocol must be HTTP.
+   * > * You can configure this parameter only for endpoint groups of HTTP or HTTPS listeners.
+   * >
+   * > * For an HTTP listener, the backend service protocol must be HTTP.
    * 
    * @example
    * HTTP
@@ -272,19 +317,27 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
   endpointRequestProtocol?: string;
   /**
    * @remarks
-   * Specifies whether to enable the health check feature. Valid values: Valid values:
+   * Specifies whether to enable health checks. Valid values:
    * 
-   * *   **true**: The health check feature is enabled.
-   * *   **false** (default)
+   * - **true**: Enables health checks.
+   * 
+   * - **false** (default): Disables health checks.
    * 
    * @example
    * true
    */
   healthCheckEnabled?: boolean;
+  /**
+   * @remarks
+   * The domain name for the health check.
+   * 
+   * @example
+   * www.taobao.com
+   */
   healthCheckHost?: string;
   /**
    * @remarks
-   * The interval between two consecutive health checks. Unit: seconds. Valid values: **1** to **50**.
+   * The interval between health checks, in seconds. Valid values: **1** to **50**.
    * 
    * @example
    * 3
@@ -292,7 +345,7 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
   healthCheckIntervalSeconds?: number;
   /**
    * @remarks
-   * The path to which health check requests are sent.
+   * The path for health checks.
    * 
    * @example
    * /healthcheck
@@ -300,7 +353,7 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
   healthCheckPath?: string;
   /**
    * @remarks
-   * The port that is used for health checks. Valid values: **1** to **65535**.
+   * The port used for health checks. Valid values: **1** to **65535**.
    * 
    * @example
    * 20
@@ -308,21 +361,23 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
   healthCheckPort?: number;
   /**
    * @remarks
-   * The protocol over which to send health check requests. Valid values:
+   * The protocol for health checks. Valid values:
+   * 
+   * - **tcp** or **TCP**
+   * 
+   * - **http** or **HTTP**
    * 
-   * *   **tcp** or **TCP**
-   * *   **http** or **HTTP**
-   * *   **https** or **HTTPS**
+   * - **https** or **HTTPS**
    * 
    * @example
-   * tcp
+   * HTTPS
    */
   healthCheckProtocol?: string;
   /**
    * @remarks
    * The name of the endpoint group.
    * 
-   * The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
+   * The name must be 1 to 128 characters long, start with a letter or a Chinese character, and can contain digits, periods (.), underscores (_), and hyphens (-).
    * 
    * @example
    * group1
@@ -330,7 +385,7 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The port mapping.
+   * The port override settings.
    */
   portOverrides?: UpdateEndpointGroupRequestPortOverrides[];
   /**
@@ -345,7 +400,7 @@ export class UpdateEndpointGroupRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The number of consecutive health check failures that must occur before a healthy endpoint group is considered unhealthy, or the number of consecutive health check successes that must occur before an unhealthy endpoint group is considered healthy.
+   * The number of consecutive successful or failed health checks required to change an endpoint\\"s health status.
    * 
    * Valid values: **2** to **10**.
    *