@alicloud/elasticsearch20170613 4.3.0 → 4.3.2

package/src/models/ModifyWhiteIpsRequest.ts

@@ -5,12 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyWhiteIpsRequestWhiteIpGroup extends $dara.Model {
   /**
    * @remarks
-   * The type of the IP address whitelist. Valid values:
-   * 
-   * *   PRIVATE_KIBANA
-   * *   PRIVATE_ES
-   * *   PUBLIC_ES
-   * *   PUBLIC_KIBANA
+   * The name of the whitelist group. This parameter is required if you specify the whiteIpGroup parameter.
    * 
    * @example
    * test_group
@@ -18,12 +13,17 @@ export class ModifyWhiteIpsRequestWhiteIpGroup extends $dara.Model {
   groupName?: string;
   /**
    * @remarks
-   * The returned result.
+   * The list of IP addresses in the whitelist group. This parameter is required if you specify the whiteIpGroup parameter.
    */
   ips?: string[];
   /**
    * @remarks
-   * The request ID.
+   * The type of the IP whitelist. Valid values:
+   * 
+   * - PRIVATE_KIBANA: Kibana internal-facing whitelist
+   * - PRIVATE_ES: Elasticsearch internal-facing whitelist
+   * - PUBLIC_ES: Elasticsearch public network access whitelist
+   * - PUBLIC_KIBANA: Kibana public network access whitelist.
    * 
    * @example
    * PRIVATE_ES
@@ -60,9 +60,11 @@ export class ModifyWhiteIpsRequestWhiteIpGroup extends $dara.Model {
 export class ModifyWhiteIpsRequest extends $dara.Model {
   /**
    * @remarks
-   * The information about the IP address whitelist that you want to update. You can specify only one whitelist.
+   * The modification mode. Valid values:
    * 
-   * > You cannot configure both the whiteIpList and whiteIpGroup parameters.
+   * - Cover (default): overwrites the original IP whitelist with the value of the ips parameter.
+   * - Append: adds the IP addresses specified in the ips parameter to the original IP whitelist.
+   * - Delete: removes the IP addresses specified in the ips parameter from the original IP whitelist. At least one IP address must be retained.
    * 
    * @example
    * Cover
@@ -70,9 +72,10 @@ export class ModifyWhiteIpsRequest extends $dara.Model {
   modifyMode?: string;
   /**
    * @remarks
-   * The IP addresses in the whitelist. This parameter is available if the whiteIpGroup parameter is left empty. The default IP address whitelist is updated based on the value of this parameter.
+   * The network type. This parameter is required if you specify the whiteIpList parameter. Valid values:
    * 
-   * > You cannot configure both the whiteIpList and whiteIpGroup parameters.
+   * - PRIVATE: private network
+   * - PUBLIC: public network.
    * 
    * @example
    * PUBLIC
@@ -80,7 +83,10 @@ export class ModifyWhiteIpsRequest extends $dara.Model {
   networkType?: string;
   /**
    * @remarks
-   * The IP addresses in the whitelist. This parameter is available if the whiteIpGroup parameter is left empty. The default IP address whitelist is updated based on the value of this parameter.
+   * The node type. This parameter is required if you specify the whiteIpList parameter. Valid values:
+   * 
+   * - WORKER: Elasticsearch cluster
+   * - KIBANA: Kibana cluster.
    * 
    * @example
    * WORKER
@@ -88,20 +94,19 @@ export class ModifyWhiteIpsRequest extends $dara.Model {
   nodeType?: string;
   /**
    * @remarks
-   * The IP addresses in the whitelist. This parameter is required if you configure the whiteIpGroup parameter.
+   * Updates the instance whitelist configuration by whitelist group. Only one whitelist group can be updated at a time.
+   * >Notice: You cannot specify both whiteIpList and whiteIpGroup at the same time.
+   * .
    */
   whiteIpGroup?: ModifyWhiteIpsRequestWhiteIpGroup;
   /**
    * @remarks
-   * The name of the whitelist. This parameter is required if you configure the whiteIpGroup parameter.
+   * The IP address whitelist. This parameter is available when whiteIpGroup is empty and updates the default group whitelist.
    */
   whiteIpList?: string[];
   /**
    * @remarks
-   * The network type. This parameter is required if you configure the whiteIpList parameter. Valid values:
-   * 
-   * *   PRIVATE
-   * *   PUBLIC
+   * A unique token generated by the client to guarantee the idempotency of the request. The maximum length is 64 ASCII characters.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/ModifyWhiteIpsResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyWhiteIpsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG
    */
   requestId?: string;
   /**
+   * @remarks
+   * The result. Valid values:
+   * 
+   * - true: The whitelist is updated.
+   * - false: The whitelist failed to be updated.
+   * 
    * @example
    * true
    */

package/src/models/MoveResourceGroupRequest.ts

@@ -6,7 +6,7 @@ export class MoveResourceGroupRequest extends $dara.Model {
   body?: string;
   /**
    * @remarks
-   * The client token that is used 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 token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * A client token that is used 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 token can contain only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/MoveResourceGroupResponseBody.ts

@@ -21,10 +21,10 @@ export class MoveResourceGroupResponseBodyResultDictList extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The type of the source of the dictionary file. Valid values:
+   * The source type. Valid values:
    * 
-   * *   OSS: Object Storage Service (OSS). You must make sure that the access control list (ACL) of the related OSS bucket is public read.
-   * *   ORIGIN: previously uploaded dictionary.
+   * - OSS: OSS open storage. Make sure that the OSS bucket has public-read permission.
+   * - ORIGIN: retains the previously uploaded dictionary.
    * 
    * @example
    * ORIGIN
@@ -32,12 +32,12 @@ export class MoveResourceGroupResponseBodyResultDictList extends $dara.Model {
   sourceType?: string;
   /**
    * @remarks
-   * The type of the dictionary. Valid values:
+   * The dictionary type. Valid values:
    * 
-   * *   STOP: stopword list
-   * *   MAIN: main dictionary
-   * *   SYNONYMS: synonym dictionary
-   * *   ALI_WS: Alibaba Cloud dictionary
+   * - STOP: stopword.
+   * - MAIN: main dictionary.
+   * - SYNONYMS: synonym dictionary.
+   * - ALI_WS: Alibaba dictionary.
    * 
    * @example
    * MAIN
@@ -81,7 +81,7 @@ export class MoveResourceGroupResponseBodyResultKibanaConfiguration extends $dar
   amount?: number;
   /**
    * @remarks
-   * The storage capacity. Unit: GB.
+   * The storage size of the node. Unit: GB.
    * 
    * @example
    * 20
@@ -89,7 +89,7 @@ export class MoveResourceGroupResponseBodyResultKibanaConfiguration extends $dar
   disk?: number;
   /**
    * @remarks
-   * The storage type.
+   * The storage type of the node.
    * 
    * @example
    * cloud_ssd
@@ -97,7 +97,7 @@ export class MoveResourceGroupResponseBodyResultKibanaConfiguration extends $dar
   diskType?: string;
   /**
    * @remarks
-   * The specification category.
+   * The node specifications.
    * 
    * @example
    * elasticsearch.n4.small
@@ -141,7 +141,7 @@ export class MoveResourceGroupResponseBodyResultMasterConfiguration extends $dar
   amount?: number;
   /**
    * @remarks
-   * The storage capacity. Unit: GB.
+   * The storage size of the node. Unit: GB.
    * 
    * @example
    * 20
@@ -149,7 +149,7 @@ export class MoveResourceGroupResponseBodyResultMasterConfiguration extends $dar
   disk?: number;
   /**
    * @remarks
-   * The storage type.
+   * The storage type of the node.
    * 
    * @example
    * cloud_ssd
@@ -157,7 +157,7 @@ export class MoveResourceGroupResponseBodyResultMasterConfiguration extends $dar
   diskType?: string;
   /**
    * @remarks
-   * The specification category.
+   * The node specifications.
    * 
    * @example
    * elasticsearch.sn2ne.large
@@ -193,7 +193,7 @@ export class MoveResourceGroupResponseBodyResultMasterConfiguration extends $dar
 export class MoveResourceGroupResponseBodyResultNetworkConfig extends $dara.Model {
   /**
    * @remarks
-   * The network type. Only the VPC is supported.
+   * The network type. Only VPC is supported.
    * 
    * @example
    * vpc
@@ -201,7 +201,7 @@ export class MoveResourceGroupResponseBodyResultNetworkConfig extends $dara.Mode
   type?: string;
   /**
    * @remarks
-   * The ID of the virtual private cloud (VPC).
+   * The virtual private cloud (VPC) ID.
    * 
    * @example
    * vpc-bp16k1dvzxtmagcva****
@@ -209,7 +209,7 @@ export class MoveResourceGroupResponseBodyResultNetworkConfig extends $dara.Mode
   vpcId?: string;
   /**
    * @remarks
-   * The zone where the cluster resides.
+   * The zone where the instance resides.
    * 
    * @example
    * cn-hangzhou-i
@@ -217,7 +217,7 @@ export class MoveResourceGroupResponseBodyResultNetworkConfig extends $dara.Mode
   vsArea?: string;
   /**
    * @remarks
-   * The ID of the vSwitch.
+   * The vSwitch ID.
    * 
    * @example
    * vsw-bp1k4ec6s7sjdbudw****
@@ -253,7 +253,7 @@ export class MoveResourceGroupResponseBodyResultNetworkConfig extends $dara.Mode
 export class MoveResourceGroupResponseBodyResultNodeSpec extends $dara.Model {
   /**
    * @remarks
-   * The storage capacity. Unit: GB.
+   * The storage size of the node. Unit: GB.
    * 
    * @example
    * 50
@@ -261,7 +261,7 @@ export class MoveResourceGroupResponseBodyResultNodeSpec extends $dara.Model {
   disk?: number;
   /**
    * @remarks
-   * The storage type.
+   * The storage type of the node.
    * 
    * @example
    * cloud_ssd
@@ -269,7 +269,7 @@ export class MoveResourceGroupResponseBodyResultNodeSpec extends $dara.Model {
   diskType?: string;
   /**
    * @remarks
-   * The specification category.
+   * The node specifications.
    * 
    * @example
    * elasticsearch.n4.small
@@ -319,10 +319,10 @@ export class MoveResourceGroupResponseBodyResultSynonymsDicts extends $dara.Mode
   name?: string;
   /**
    * @remarks
-   * The type of the source of the dictionary file. Valid values:
+   * The source type. Valid values:
    * 
-   * *   OSS: Object Storage Service (OSS). You must make sure that the ACL of the related OSS bucket is public read.
-   * *   ORIGIN: previously uploaded dictionary.
+   * - OSS: OSS open storage. Make sure that the OSS bucket has public-read permission.
+   * - ORIGIN: retains the previously uploaded dictionary.
    * 
    * @example
    * ORIGIN
@@ -330,12 +330,12 @@ export class MoveResourceGroupResponseBodyResultSynonymsDicts extends $dara.Mode
   sourceType?: string;
   /**
    * @remarks
-   * The type of the dictionary. Valid values:
+   * The dictionary type. Valid values:
    * 
-   * *   STOP: stopword list
-   * *   MAIN: main dictionary
-   * *   SYNONYMS: synonym dictionary
-   * *   ALI_WS: Alibaba Cloud dictionary
+   * - STOP: stopword.
+   * - MAIN: main dictionary.
+   * - SYNONYMS: synonym dictionary.
+   * - ALI_WS: Alibaba dictionary.
    * 
    * @example
    * STOP
@@ -371,7 +371,7 @@ export class MoveResourceGroupResponseBodyResultSynonymsDicts extends $dara.Mode
 export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The time when the cluster was created.
+   * The time when the instance was created.
    * 
    * @example
    * 2020-07-06T10:18:48.662Z
@@ -379,7 +379,7 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   createdAt?: string;
   /**
    * @remarks
-   * The name of the cluster.
+   * The instance name.
    * 
    * @example
    * es-cn-abc
@@ -387,12 +387,12 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The configurations of IK dictionaries.
+   * The IK dictionary configuration.
    */
   dictList?: MoveResourceGroupResponseBodyResultDictList[];
   /**
    * @remarks
-   * The internal endpoint of the cluster.
+   * The internal endpoint of the instance.
    * 
    * @example
    * es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com
@@ -400,7 +400,7 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   domain?: string;
   /**
    * @remarks
-   * The version of the cluster.
+   * The instance version.
    * 
    * @example
    * 6.7.0_with_X-Pack
@@ -408,7 +408,7 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   esVersion?: string;
   /**
    * @remarks
-   * The ID of the cluster.
+   * The instance ID.
    * 
    * @example
    * es-cn-n6w1o1x0w001c****
@@ -416,12 +416,12 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The configurations of Kibana nodes.
+   * The configuration of Kibana nodes.
    */
   kibanaConfiguration?: MoveResourceGroupResponseBodyResultKibanaConfiguration;
   /**
    * @remarks
-   * The public endpoint of the Kibana console of the cluster.
+   * The public network access address for Kibana.
    * 
    * @example
    * es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com
@@ -429,7 +429,7 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   kibanaDomain?: string;
   /**
    * @remarks
-   * The port number that is used to access the Kibana console of the cluster over the Internet.
+   * The public port for Kibana.
    * 
    * @example
    * 5601
@@ -437,17 +437,17 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   kibanaPort?: number;
   /**
    * @remarks
-   * The configurations of dedicated master nodes.
+   * The configuration of master nodes.
    */
   masterConfiguration?: MoveResourceGroupResponseBodyResultMasterConfiguration;
   /**
    * @remarks
-   * The network configurations.
+   * The network configuration.
    */
   networkConfig?: MoveResourceGroupResponseBodyResultNetworkConfig;
   /**
    * @remarks
-   * The number of data nodes in the cluster.
+   * The number of data nodes of the instance.
    * 
    * @example
    * 2
@@ -455,15 +455,15 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   nodeAmount?: number;
   /**
    * @remarks
-   * The configurations of data nodes.
+   * The configuration of data nodes.
    */
   nodeSpec?: MoveResourceGroupResponseBodyResultNodeSpec;
   /**
    * @remarks
-   * The billing method of the cluster. Valid values:
+   * The billing method of the instance. Valid values:
    * 
-   * *   prepaid: subscription
-   * *   postpaid: pay-as-you-go
+   * - prepaid: subscription.
+   * - postpaid: pay-as-you-go.
    * 
    * @example
    * postpaid
@@ -471,7 +471,7 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   paymentType?: string;
   /**
    * @remarks
-   * The public endpoint of the cluster.
+   * The public network access address.
    * 
    * @example
    * es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com
@@ -479,7 +479,7 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   publicDomain?: string;
   /**
    * @remarks
-   * The port number that is used to access the cluster over the Internet.
+   * The public port.
    * 
    * @example
    * 9200
@@ -487,12 +487,12 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   publicPort?: number;
   /**
    * @remarks
-   * The status of the cluster. Valid values:
+   * The status of the instance. Valid values:
    * 
-   * *   active: The cluster is normal.
-   * *   activating: The cluster is being activated.
-   * *   Inactive: The cluster is frozen.
-   * *   invalid: The cluster is valid.
+   * - active: Normal.
+   * - activating: Taking effect.
+   * - inactive: Frozen.
+   * - invalid: Expired.
    * 
    * @example
    * active
@@ -500,12 +500,12 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The configurations of synonym dictionaries.
+   * The synonym dictionary configuration.
    */
   synonymsDicts?: MoveResourceGroupResponseBodyResultSynonymsDicts[];
   /**
    * @remarks
-   * The time when the cluster was last updated.
+   * The time when the instance was last updated.
    * 
    * @example
    * 2018-07-18T10:10:04.484Z
@@ -589,7 +589,7 @@ export class MoveResourceGroupResponseBodyResult extends $dara.Model {
 export class MoveResourceGroupResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

package/src/models/NetworkConfig.ts

@@ -4,8 +4,15 @@ import { WhiteIpGroup } from "./WhiteIpGroup";
 
 
 export class NetworkConfigLoadBalanceConfig extends $dara.Model {
+  /**
+   * @remarks
+   * 可用区信息，如: cn-hangzhou-i
+   */
   vsArea?: string;
   /**
+   * @remarks
+   * vswitchId
+   * 
    * @example
    * vsw-xxxx
    */
@@ -37,30 +44,49 @@ export class NetworkConfig extends $dara.Model {
   lbReplica?: number;
   loadBalanceConfig?: NetworkConfigLoadBalanceConfig[];
   /**
+   * @remarks
+   * The load balancing type. Default value: DEFAULT.
+   * 
    * @example
    * DEFAULT
    */
   loadBalanceType?: string;
   /**
+   * @remarks
+   * The network type. Only Virtual Private Cloud (VPC) is supported.
+   * 
    * @example
    * vpc
    */
   type?: string;
   /**
+   * @remarks
+   * The VPC ID.
+   * 
    * @example
    * vpc-bp1xk0naij7jx4ph1****
    */
   vpcId?: string;
   /**
+   * @remarks
+   * The zone ID of the network.
+   * 
    * @example
    * cn-hangzhou-e
    */
   vsArea?: string;
   /**
+   * @remarks
+   * The vSwitch ID.
+   * 
    * @example
    * vsw-bp1ogpdintii5qvyx****
    */
   vswitchId?: string;
+  /**
+   * @remarks
+   * The IP whitelist group configuration. You do not need to set this parameter when you call the createInstance operation to create an instance because the setting does not take effect during instance creation. Use a separate API operation to configure whitelists for different roles.
+   */
   whiteIpGroupList?: WhiteIpGroup[];
   static names(): { [key: string]: string } {
     return {

package/src/models/NodeInfo.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class NodeInfo extends $dara.Model {
   /**
+   * @remarks
+   * The IP address of the node.
+   * 
    * @example
    * 172.16.xx.xx
    */
   host?: string;
   /**
+   * @remarks
+   * The node name. This parameter is supported only for instances of version 7.16 deployed on ACK.
+   * 
    * @example
    * es-cn-tl32vdghe0005cd99-data-b-2
    */
   hostName?: string;
   /**
+   * @remarks
+   * The port number of the node.
+   * 
    * @example
    * 9200
    */
   port?: number;
   /**
+   * @remarks
+   * The zone ID of the node.
+   * 
    * @example
    * cn-hangzhou-b
    */

package/src/models/NodeSpec.ts

@@ -4,28 +4,53 @@ import * as $dara from '@darabonba/typescript';
 
 export class NodeSpec extends $dara.Model {
   /**
+   * @remarks
+   * Storage space size of data nodes, in GB.
+   * 
    * @example
    * 20
    */
   disk?: number;
   /**
+   * @remarks
+   * Whether to enable cloud disk encryption for data nodes:
+   * 
+   * - true: Enabled
+   * - false: Disabled
+   * 
    * @example
    * false
    */
   diskEncryption?: boolean;
+  /**
+   * @remarks
+   * Storage preference.
+   */
   diskPreference?: string;
   /**
+   * @remarks
+   * Storage type of data nodes. Supported values:
+   * 
+   * - cloud_ssd: SSD cloud disk
+   * - cloud_essd: ESSD cloud disk
+   * - cloud_efficiency: Ultra cloud disk
+   * 
    * @example
    * cloud_ssd
    */
   diskType?: string;
   /**
+   * @remarks
+   * Performance level of ESSD cloud disks. Required when the disk type of data nodes is ESSD cloud disk. Supported values: PL1, PL2, PL3.
+   * 
    * @example
    * PL1
    */
   performanceLevel?: string;
   /**
    * @remarks
+   * Data node specification. Specification details can be viewed in [Product Specifications](https://help.aliyun.com/document_detail/271718.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/OpenDiagnosisRequest.ts

@@ -5,13 +5,22 @@ import * as $dara from '@darabonba/typescript';
 export class OpenDiagnosisRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * A unique token used to ensure idempotence. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The language of the request. Default value: the language of the browser. Valid values:
+   * 
+   * - en: English.
+   * - zh: Simplified Chinese.
+   * - zt: Traditional Chinese.
+   * - es: Spanish.
+   * - fr: French.
+   * 
    * @example
    * en
    */

package/src/models/OpenDiagnosisResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class OpenDiagnosisResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the intelligent O&M feature is enabled. Valid values:
+   * 
+   * - true: Enabled.
+   * - false: Failed.
+   * 
    * @example
    * true
    */

package/src/models/OpenHttpsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class OpenHttpsRequest extends $dara.Model {
   /**
    * @remarks
-   * A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.
+   * A unique token generated by the client to guarantee the idempotence of the request. The value of this parameter must be unique among different requests and can be up to 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****