@alicloud/ga20191120 3.0.0 → 3.0.1

package/src/models/CreateEndpointGroupRequest.ts

@@ -5,15 +5,24 @@ import * as $dara from '@darabonba/typescript';
 export class CreateEndpointGroupRequestEndpointConfigurations extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to automatically preserve client IP addresses. Valid values:
+   * The API keys for the AI service.
+   */
+  apiKeys?: string[];
+  /**
+   * @remarks
+   * 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.
+   * 
+   * > * By default, this feature is disabled for endpoint groups that are associated with TCP or UDP listeners. You can enable this feature based on your business requirements.
+   * >
+   * > * By default, this feature is enabled for endpoint groups that are associated with HTTP or HTTPS listeners. The source IP address is retrieved from the X-Forwarded-For header field. This feature cannot be disabled.
+   * >
+   * > * `EnableClientIPPreservation` and `EnableProxyProtocol` cannot both be set to `true`.
+   * >
+   * > * For more information, see [Preserve client source IP addresses](https://help.aliyun.com/document_detail/158080.html).
    * 
    * @example
    * false
@@ -21,14 +30,17 @@ export class CreateEndpointGroupRequestEndpointConfigurations 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**: uses the PROXY protocol.
    * 
-   * *   **true**
-   * *   **false** (default)
+   * - **false** (default): does not use the PROXY protocol.
    * 
-   * > *   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).
+   * > * This parameter can be configured only for endpoint groups that are associated with TCP listeners.
+   * >
+   * > * `EnableClientIPPreservation` and `EnableProxyProtocol` cannot both be set to `true`.
+   * >
+   * > * For more information, see [Preserve client source IP addresses](https://help.aliyun.com/document_detail/158080.html).
    * 
    * @example
    * false
@@ -36,7 +48,7 @@ export class CreateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
   enableProxyProtocol?: boolean;
   /**
    * @remarks
-   * The IP address, domain name, or instance ID based on the value of Type.
+   * The IP address, domain name, or resource ID of the endpoint. The value of this parameter depends on the value of the `Type` parameter.
    * 
    * This parameter is required.
    * 
@@ -44,35 +56,56 @@ export class CreateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
    * 120.1.XX.XX
    */
   endpoint?: string;
+  /**
+   * @remarks
+   * The AI service provider. Set this to `BAILIAN` to use Alibaba Cloud Model Studio.
+   * 
+   * @example
+   * BAILIAN
+   */
+  provider?: string;
   /**
    * @remarks
    * The private IP address of the ENI.
    * 
-   * >  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.
+   * > This parameter applies only when the endpoint type is set to **ENI**. If you omit this parameter, the primary private IP address of the ENI is used.
    * 
    * @example
-   * 172.168.XX.XX
+   * 172.168.X.X
    */
   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.
+   * - **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 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 the endpoint type to **ECS**, **ENI**, **SLB**, **ALB**, **NLB**, or **IpTarget**, the system automatically creates a service-linked role named AliyunServiceRoleForGaVpcEndpoint if the role does not exist.
+   * >
+   * > * If you set the endpoint type to **ALB**, the system automatically creates a service-linked role named AliyunServiceRoleForGaAlb if the role does not exist.
+   * >
+   * > * If you set the endpoint type to **OSS**, the system automatically creates a service-linked role named AliyunServiceRoleForGaOss if the role does not exist.
+   * >
+   * > * If you set the endpoint type to **NLB**, the system automatically creates a service-linked role named AliyunServiceRoleForGaNlb if the role does not exist.
+   * >
    * > > For more information, see [Service-linked roles](https://help.aliyun.com/document_detail/178360.html).
    * 
    * This parameter is required.
@@ -83,16 +116,16 @@ export class CreateEndpointGroupRequestEndpointConfigurations 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 Virtual Private Cloud (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 of 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 set to **IpTarget**.
    * 
    * @example
    * vpc-bp1quce3451z5b2hv****
@@ -104,7 +137,7 @@ export class CreateEndpointGroupRequestEndpointConfigurations 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, GA stops distributing traffic to it. Proceed with caution.
    * 
    * This parameter is required.
    * 
@@ -114,9 +147,11 @@ export class CreateEndpointGroupRequestEndpointConfigurations 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 +162,11 @@ export class CreateEndpointGroupRequestEndpointConfigurations 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 +176,9 @@ export class CreateEndpointGroupRequestEndpointConfigurations 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 +193,7 @@ export class CreateEndpointGroupRequestEndpointConfigurations extends $dara.Mode
 export class CreateEndpointGroupRequestPortOverrides extends $dara.Model {
   /**
    * @remarks
-   * The endpoint port that is mapped to the listener port.
+   * The endpoint port for the port mapping.
    * 
    * @example
    * 80
@@ -161,11 +201,13 @@ export class CreateEndpointGroupRequestPortOverrides extends $dara.Model {
   endpointPort?: number;
   /**
    * @remarks
-   * The listener port that is mapped to the endpoint port.
+   * The listener port for the port mapping.
    * 
-   * > *   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, you cannot configure port mappings for virtual endpoint groups. If a listener is associated with a virtual endpoint group, you cannot configure port mappings for the default endpoint group. If a default endpoint group has port mappings configured, you cannot add a virtual endpoint group.
+   * >
+   * > - After you configure port mappings, you cannot change the listener protocol, except for switching between HTTP and HTTPS.
+   * >
+   * > - When you modify the listener port range, the new range must include all listener ports used in port mappings. For example, if the listener port range is 80-82 and the listener ports are mapped to endpoint ports 100-102, you cannot change the listener port range to 80-81.
    * 
    * @example
    * 443
@@ -197,9 +239,9 @@ export class CreateEndpointGroupRequestPortOverrides extends $dara.Model {
 export class CreateEndpointGroupRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The tag key of the GA instance. The tag key cannot be an empty string.
+   * The tag key. The tag key cannot be an empty string.
    * 
-   * The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.
+   * The tag key can be up to 64 characters long and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.
    * 
    * You can specify up to 20 tag keys.
    * 
@@ -209,9 +251,9 @@ export class CreateEndpointGroupRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The tag value of the GA instance. The tag value cannot be an empty string.
+   * The tag value. The tag value can be an empty string.
    * 
-   * The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.
+   * The tag value can be up to 128 characters long and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.
    * 
    * You can specify up to 20 tag values.
    * 
@@ -255,11 +297,11 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   acceleratorId?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request.
+   * The client token used to ensure request idempotence.
    * 
-   * You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.
+   * You can generate this token, but you must ensure it is unique for each request. The token 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 request as the **ClientToken**. Each request has a unique **RequestId**.
    * 
    * @example
    * 123e4567-e89b-12d3-a456-426655440000
@@ -269,7 +311,7 @@ export class CreateEndpointGroupRequest 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
@@ -277,10 +319,11 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Specifies whether to perform a dry run, without sending the actual request. Valid values:
+   * Specifies whether to perform a dry run. Valid values:
+   * 
+   * - **true**: performs a dry run. The system checks the required parameters, request format, and service limits. If the request fails the dry run, the system returns an error message. If the request passes the dry run, the system returns an HTTP 2xx status code.
    * 
-   * *   **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, a 2xx HTTP status code is returned.
-   * *   **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
+   * - **false** (default): sends a normal request. If the request passes the check, the system returns an HTTP 2xx status code and creates the endpoint group.
    * 
    * @example
    * false
@@ -288,12 +331,12 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   dryRun?: boolean;
   /**
    * @remarks
-   * The configurations of the endpoints in the endpoint group.
+   * The endpoint configurations.
    */
   endpointConfigurations?: CreateEndpointGroupRequestEndpointConfigurations[];
   /**
    * @remarks
-   * The ID of the region in which to create the endpoint group.
+   * The ID of the region where the endpoint group is deployed.
    * 
    * This parameter is required.
    * 
@@ -305,24 +348,39 @@ export class CreateEndpointGroupRequest extends $dara.Model {
    * @remarks
    * The type of the endpoint group. Valid values:
    * 
-   * *   **default** (default): a default endpoint group.
-   * *   **virtual**: a virtual endpoint group.
+   * - **default** (default): a default endpoint group.
    * 
-   * >  When you call this operation to create a virtual endpoint group for a Layer 4 listener, make sure that a default endpoint group is created.
+   * - **virtual**: a virtual endpoint group.
+   * 
+   * > Before you create a virtual endpoint group for a Layer 4 listener, make sure that you have created a default endpoint group.
    * 
    * @example
    * default
    */
   endpointGroupType?: string;
+  /**
+   * @remarks
+   * The IP version used to communicate with the backend service. Valid values:
+   * 
+   * - **IPv4** (default): GA uses only IPv4 to communicate with the backend service.
+   * 
+   * - **IPv6**: GA uses only IPv6 to communicate with the backend service.
+   * 
+   * - **ProtocolAffinity**: GA uses the same IP version as the client request to communicate with the backend service.
+   * 
+   * @example
+   * IPv4
+   */
   endpointIpVersion?: string;
   /**
    * @remarks
-   * The backend service protocol. Valid values:
+   * The version of the backend service protocol. Valid values:
    * 
-   * *   **HTTP1.1** (default)
-   * *   **HTTP2**
+   * - **HTTP1.1** (default): HTTP/1.1.
    * 
-   * >  This parameter is required only when you set the EndpointRequestProtocol parameter to HTTPS.
+   * - **HTTP2**: HTTP/2.
+   * 
+   * > This parameter is available only when `EndpointRequestProtocol` is set to HTTPS.
    * 
    * @example
    * HTTP1.1
@@ -330,13 +388,15 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   endpointProtocolVersion?: string;
   /**
    * @remarks
-   * The protocol that is used by the backend service. Default value: HTTP. Valid values:
+   * The protocol used by the backend service. Valid values:
+   * 
+   * - **HTTP** (default)
    * 
-   * *   **HTTP**
-   * *   **HTTPS**
+   * - **HTTPS**
    * 
-   * > *   You can set this parameter only when the listener that is associated with the endpoint group uses **HTTP** or **HTTPS**.
-   * >*   For an **HTTP** listener, the backend service protocol must be **HTTP**.
+   * > * This parameter is available only for endpoint groups of **HTTP** or **HTTPS** listeners.
+   * >
+   * > * For an **HTTP** listener, the backend service protocol must be **HTTP**.
    * 
    * @example
    * HTTP
@@ -344,19 +404,27 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   endpointRequestProtocol?: string;
   /**
    * @remarks
-   * Specifies whether to enable the health check feature. Valid values:
+   * Specifies whether to enable health checks. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: enables health checks.
+   * 
+   * - **false**: disables health checks.
    * 
    * @example
    * true
    */
   healthCheckEnabled?: boolean;
+  /**
+   * @remarks
+   * The domain name used for health checks.
+   * 
+   * @example
+   * www.taobao.com
+   */
   healthCheckHost?: string;
   /**
    * @remarks
-   * The interval at which health checks are performed. Unit: seconds.
+   * The health check interval, in seconds.
    * 
    * @example
    * 3
@@ -364,7 +432,7 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   healthCheckIntervalSeconds?: number;
   /**
    * @remarks
-   * The path to which to send health check requests.
+   * The path used for health checks.
    * 
    * @example
    * /healthcheck
@@ -372,7 +440,7 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   healthCheckPath?: string;
   /**
    * @remarks
-   * The port that is used for health checks.
+   * The port used for health checks.
    * 
    * @example
    * 20
@@ -380,11 +448,13 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   healthCheckPort?: number;
   /**
    * @remarks
-   * The protocol over which to send health check requests. Valid values:
+   * The protocol used for health checks. Valid values:
+   * 
+   * - **tcp** or **TCP**: TCP
+   * 
+   * - **http** or **HTTP**: HTTP
    * 
-   * *   **tcp** or **TCP**
-   * *   **http** or **HTTP**
-   * *   **https** or **HTTPS**
+   * - **https** or **HTTPS**: HTTPS
    * 
    * @example
    * tcp
@@ -404,7 +474,7 @@ export class CreateEndpointGroupRequest extends $dara.Model {
    * @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
@@ -412,12 +482,12 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The port mappings.
+   * The listener-to-endpoint port mappings.
    */
   portOverrides?: CreateEndpointGroupRequestPortOverrides[];
   /**
    * @remarks
-   * The ID of the region where the GA instance is deployed. Set the value to **cn-hangzhou**.
+   * The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to **cn-hangzhou**.
    * 
    * This parameter is required.
    * 
@@ -427,14 +497,12 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Tags of GA instances.
+   * The tags of the endpoint group.
    */
   tag?: CreateEndpointGroupRequestTag[];
   /**
    * @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.
-   * 
-   * Valid values: **2** to **10**. Default value: **3**.
+   * The number of consecutive health checks that must succeed or fail before an endpoint\\"s status changes between healthy and unhealthy. Valid values: **2** to **10**. Default value: **3**.
    * 
    * @example
    * 3
@@ -442,9 +510,7 @@ export class CreateEndpointGroupRequest extends $dara.Model {
   thresholdCount?: number;
   /**
    * @remarks
-   * The traffic ratio for the endpoint group when the specified listener is associated with multiple endpoint groups.
-   * 
-   * Valid values: **1** to **100**.
+   * The percentage of traffic distributed to the endpoint group when the listener is associated with multiple endpoint groups. Valid values: **1** to **100**.
    * 
    * @example
    * 20

package/src/models/CreateEndpointGroupResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateEndpointGroupResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the endpoint group.
+   * The endpoint group ID.
    * 
    * @example
    * epg-bp1dmlohjjz4kqaun****
@@ -13,7 +13,7 @@ export class CreateEndpointGroupResponseBody extends $dara.Model {
   endpointGroupId?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368