@alicloud/elasticsearch20170613 4.3.0 → 4.3.2

package/src/models/RestartInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RestartInstanceResponseBodyResultDictList extends $dara.Model {
   /**
    * @remarks
-   * The size of the Dictionary File. Unit: bytes.
+   * The size of the dictionary file. Unit: bytes.
    * 
    * @example
    * 2782602
@@ -23,9 +23,9 @@ export class RestartInstanceResponseBodyResultDictList extends $dara.Model {
    * @remarks
    * The source type. Valid values:
    * 
-   * *   OSS: OSS open storage (need to ensure that OSS storage space is public readable.)
-   * *   ORIGIN: Open source Elasticsearch
-   * *   UPLOAD: Uploaded files
+   * - OSS: Object Storage Service (OSS). The OSS bucket must have public-read permissions.
+   * - ORIGIN: open-source Elasticsearch
+   * - UPLOAD: uploaded file.
    * 
    * @example
    * ORIGIN
@@ -33,12 +33,12 @@ export class RestartInstanceResponseBodyResultDictList extends $dara.Model {
   sourceType?: string;
   /**
    * @remarks
-   * The type of the dictionary. Valid values:
+   * The dictionary type. Valid values:
    * 
-   * *   STOP: The STOP word.
-   * *   MAIN: MAIN Dictionary
-   * *   SYNONYMS: SYNONYMS
-   * *   ALI_WS: an Alibaba Dictionary.
+   * - STOP: stopword dictionary
+   * - MAIN: main dictionary
+   * - SYNONYMS: synonym dictionary
+   * - ALI_WS: Alibaba dictionary.
    * 
    * @example
    * MAIN
@@ -74,7 +74,7 @@ export class RestartInstanceResponseBodyResultDictList extends $dara.Model {
 export class RestartInstanceResponseBodyResultKibanaConfiguration extends $dara.Model {
   /**
    * @remarks
-   * The number of performance metrics.
+   * The number of nodes.
    * 
    * @example
    * 1
@@ -82,7 +82,7 @@ export class RestartInstanceResponseBodyResultKibanaConfiguration extends $dara.
   amount?: number;
   /**
    * @remarks
-   * The size of the node storage space. Unit: GB.
+   * The storage size of the node. Unit: GB.
    * 
    * @example
    * 20
@@ -98,7 +98,7 @@ export class RestartInstanceResponseBodyResultKibanaConfiguration extends $dara.
   diskType?: string;
   /**
    * @remarks
-   * The specification of data nodes.
+   * The node specifications.
    * 
    * @example
    * elasticsearch.n4.small
@@ -134,7 +134,7 @@ export class RestartInstanceResponseBodyResultKibanaConfiguration extends $dara.
 export class RestartInstanceResponseBodyResultMasterConfiguration extends $dara.Model {
   /**
    * @remarks
-   * The number of nodes in the cluster.
+   * The number of nodes.
    * 
    * @example
    * 3
@@ -142,7 +142,7 @@ export class RestartInstanceResponseBodyResultMasterConfiguration extends $dara.
   amount?: number;
   /**
    * @remarks
-   * The size of the node storage space. Unit: GB.
+   * The storage size of the node. Unit: GB.
    * 
    * @example
    * 20
@@ -150,7 +150,7 @@ export class RestartInstanceResponseBodyResultMasterConfiguration extends $dara.
   disk?: number;
   /**
    * @remarks
-   * The storage type of the node. This tool only supports cloud_ssd (cloud SSD) disks.
+   * The storage type of the node. Only cloud_ssd (standard SSD) is supported.
    * 
    * @example
    * cloud_ssd
@@ -158,7 +158,7 @@ export class RestartInstanceResponseBodyResultMasterConfiguration extends $dara.
   diskType?: string;
   /**
    * @remarks
-   * The node specifications of the cluster.
+   * The node specifications.
    * 
    * @example
    * elasticsearch.sn2ne.large
@@ -202,7 +202,7 @@ export class RestartInstanceResponseBodyResultNetworkConfig extends $dara.Model
   type?: string;
   /**
    * @remarks
-   * The ID of the VPC.
+   * The VPC ID.
    * 
    * @example
    * vpc-bp16k1dvzxtmagcva****
@@ -218,7 +218,7 @@ export class RestartInstanceResponseBodyResultNetworkConfig extends $dara.Model
   vsArea?: string;
   /**
    * @remarks
-   * The ID of the vSwitch associated with the specified VPC.
+   * The vSwitch ID.
    * 
    * @example
    * vsw-bp1k4ec6s7sjdbudw****
@@ -254,7 +254,7 @@ export class RestartInstanceResponseBodyResultNetworkConfig extends $dara.Model
 export class RestartInstanceResponseBodyResultNodeSpec extends $dara.Model {
   /**
    * @remarks
-   * The storage space size per data node. Unit: GB.
+   * The storage size of the node. Unit: GB.
    * 
    * @example
    * 50
@@ -262,7 +262,7 @@ export class RestartInstanceResponseBodyResultNodeSpec extends $dara.Model {
   disk?: number;
   /**
    * @remarks
-   * The storage type of the node. Valid values: cloud_ssd and cloud_efficiency.
+   * The storage type of the node.
    * 
    * @example
    * cloud_ssd
@@ -270,7 +270,7 @@ export class RestartInstanceResponseBodyResultNodeSpec extends $dara.Model {
   diskType?: string;
   /**
    * @remarks
-   * The specification of data nodes.
+   * The node specifications.
    * 
    * @example
    * elasticsearch.n4.small
@@ -304,7 +304,7 @@ export class RestartInstanceResponseBodyResultNodeSpec extends $dara.Model {
 export class RestartInstanceResponseBodyResultSynonymsDicts extends $dara.Model {
   /**
    * @remarks
-   * The size of the Dictionary File. Unit: bytes.
+   * The size of the dictionary file. Unit: bytes.
    * 
    * @example
    * 2782602
@@ -322,9 +322,9 @@ export class RestartInstanceResponseBodyResultSynonymsDicts extends $dara.Model
    * @remarks
    * The source type. Valid values:
    * 
-   * *   OSS:OSS open storage (the OSS storage space must be publicly readable.)
-   * *   ORIGIN: open-source Elasticsearch
-   * *   UPLOAD
+   * - OSS: Object Storage Service (OSS). The OSS bucket must have public-read permissions.
+   * - ORIGIN: open-source Elasticsearch
+   * - UPLOAD: uploaded file.
    * 
    * @example
    * ORIGIN
@@ -332,12 +332,12 @@ export class RestartInstanceResponseBodyResultSynonymsDicts extends $dara.Model
   sourceType?: string;
   /**
    * @remarks
-   * The type of the dictionary. Valid values:
+   * The dictionary type. Valid values:
    * 
-   * *   STOP: The STOP word.
-   * *   MAIN: MAIN Dictionary
-   * *   SYNONYMS: SYNONYMS
-   * *   ALI_WS: an Alibaba Dictionary.
+   * - STOP: stopword dictionary
+   * - MAIN: main dictionary
+   * - SYNONYMS: synonym dictionary
+   * - ALI_WS: Alibaba dictionary.
    * 
    * @example
    * STOP
@@ -381,7 +381,7 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   createdAt?: string;
   /**
    * @remarks
-   * The name of the instance.
+   * The instance name.
    * 
    * @example
    * es-cn-abc
@@ -389,12 +389,12 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The configuration of the IK dictionaries.
+   * The IK dictionary configuration.
    */
   dictList?: RestartInstanceResponseBodyResultDictList[];
   /**
    * @remarks
-   * The intranet access address of the instance.
+   * The internal endpoint of the instance.
    * 
    * @example
    * es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com
@@ -402,7 +402,7 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   domain?: string;
   /**
    * @remarks
-   * The version of the instance.
+   * The instance version.
    * 
    * @example
    * 6.7.0_with_X-Pack
@@ -410,7 +410,7 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   esVersion?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * @example
    * es-cn-n6w1o1x0w001c****
@@ -418,12 +418,12 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The configuration of Kibana nodes.
+   * The Kibana node configuration.
    */
   kibanaConfiguration?: RestartInstanceResponseBodyResultKibanaConfiguration;
   /**
    * @remarks
-   * The public network access address of Kibana.
+   * The Kibana public network access address.
    * 
    * @example
    * es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com
@@ -431,7 +431,7 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   kibanaDomain?: string;
   /**
    * @remarks
-   * The public port of the Kibana network.
+   * The public port of Kibana.
    * 
    * @example
    * 5601
@@ -439,7 +439,7 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   kibanaPort?: number;
   /**
    * @remarks
-   * The configuration of dedicated master nodes.
+   * The master node configuration.
    */
   masterConfiguration?: RestartInstanceResponseBodyResultMasterConfiguration;
   /**
@@ -449,7 +449,7 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   networkConfig?: RestartInstanceResponseBodyResultNetworkConfig;
   /**
    * @remarks
-   * The number of data nodes.
+   * The number of data nodes in the instance.
    * 
    * @example
    * 2
@@ -457,14 +457,14 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   nodeAmount?: number;
   /**
    * @remarks
-   * The configuration of data nodes.
+   * The data node configuration.
    */
   nodeSpec?: RestartInstanceResponseBodyResultNodeSpec;
   /**
    * @remarks
-   * The billing method of the created ECS instance.
+   * The billing method of the instance.
    * 
-   * Valid values: prepaid and postpaid.
+   * Valid values: prepaid (subscription) and postpaid (pay-as-you-go).
    * 
    * @example
    * postpaid
@@ -480,7 +480,7 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   publicDomain?: string;
   /**
    * @remarks
-   * The public network port.
+   * The public port.
    * 
    * @example
    * 9200
@@ -488,9 +488,9 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   publicPort?: number;
   /**
    * @remarks
-   * The state of the cluster.
+   * The status of the instance.
    * 
-   * Supported: active (normal), activating (initializing), inactive (blocked), and invalid (expired).
+   * Valid values: active, activating, inactive, and invalid.
    * 
    * @example
    * active
@@ -498,7 +498,7 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The configuration of the synonym dictionaries.
+   * The synonym dictionary configuration.
    */
   synonymsDicts?: RestartInstanceResponseBodyResultSynonymsDicts[];
   /**
@@ -587,7 +587,7 @@ export class RestartInstanceResponseBodyResult extends $dara.Model {
 export class RestartInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DC****
@@ -595,7 +595,7 @@ export class RestartInstanceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The return results.
+   * The returned result.
    */
   result?: RestartInstanceResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/RestartLogstashRequest.ts

@@ -4,28 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class RestartLogstashRequest extends $dara.Model {
   /**
+   * @remarks
+   * The concurrency for force restart. This parameter does not need to be set during a blue-green restart because force restart is not supported in that scenario.
+   * 
    * @example
    * 20%
    */
   batchCount?: number;
   /**
+   * @remarks
+   * Specifies whether to perform a blue-green restart. Default value: false.
+   * 
    * @example
    * false
    */
   blueGreenDep?: boolean;
+  /**
+   * @remarks
+   * The type of role node to restart. This parameter is not supported.
+   */
   nodeTypes?: string[];
+  /**
+   * @remarks
+   * The node information selected when restarting nodes.
+   */
   nodes?: string[];
   /**
+   * @remarks
+   * The restart type. Valid values:
+   * 
+   * - instance: restart the instance
+   * - nodeIp: restart a node.
+   * 
    * @example
    * instance
    */
   restartType?: string;
   /**
+   * @remarks
+   * 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****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * Specifies whether to force restart the instance. Valid values:
+   * 
+   * - true: force restart
+   * - false (default): do not force restart.
+   * 
    * @example
    * true
    */

package/src/models/RestartLogstashResponseBody.ts

@@ -5,10 +5,17 @@ import { Logstash } from "./Logstash";
 
 export class RestartLogstashResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The details of the current instance.
+   */
   result?: Logstash;
   static names(): { [key: string]: string } {
     return {

package/src/models/ResumeElasticsearchTaskRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ResumeElasticsearchTaskRequest 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 used to ensure the idempotency of the request. This parameter value is generated by the client. It must be unique across different requests and cannot exceed 64 ASCII characters.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/ResumeElasticsearchTaskResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ResumeElasticsearchTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
@@ -13,10 +13,10 @@ export class ResumeElasticsearchTaskResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return results:
+   * The return result:
    * 
-   * *   true: resume the interrupted change successfully
-   * *   false: resume the interrupted change successfully failed
+   * - true: The interrupted change was resumed successfully.
+   * - false: The interrupted change failed to be resumed.
    * 
    * @example
    * true

package/src/models/ResumeLogstashTaskRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ResumeLogstashTaskRequest extends $dara.Model {
   /**
    * @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.
+   * 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 printable ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/ResumeLogstashTaskResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ResumeLogstashTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned. If the API operation is successfully called, this parameter is not returned.
+   * The error code. This parameter is not returned if the call is successful.
    * 
    * @example
    * InstanceNotFound
@@ -13,7 +13,7 @@ export class ResumeLogstashTaskResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The error message returned. If the API operation is successfully called, this parameter is not returned.
+   * The error message. This parameter is not returned if the call is successful.
    * 
    * @example
    * The specified cluster does not exist. Check the cluster status and try again.
@@ -21,7 +21,7 @@ export class ResumeLogstashTaskResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0FA05123-745C-42FD-A69B-AFF48EF9****
@@ -29,10 +29,10 @@ export class ResumeLogstashTaskResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the change task is resumed. Valid values:
+   * The returned result. Valid values:
    * 
-   * *   true: The change task is resumed.
-   * *   false: The change task fails to be resumed.
+   * - true: The task is resumed.
+   * - false: The task failed to be resumed.
    * 
    * @example
    * true

package/src/models/RolloverDataStreamRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class RolloverDataStreamRequest extends $dara.Model {
   /**
+   * @remarks
+   * A unique token used to ensure idempotence of the request. This value is generated by the client and must be unique across different requests. The token can be up to 64 ASCII characters in length.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */

package/src/models/RolloverDataStreamResponseBody.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class RolloverDataStreamResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The returned result. Valid values:
+   * 
+   * - true: The rollover succeeded.
+   * 
+   * - false: The rollover failed.
+   * 
    * @example
    * true
    */

package/src/models/RunPipelinesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RunPipelinesRequest extends $dara.Model {
   /**
    * @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 unique token generated by the client to ensure idempotence of the request. The token can contain up to 64 ASCII characters and must be unique across different requests.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/RunPipelinesResponseBody.ts

@@ -15,8 +15,8 @@ export class RunPipelinesResponseBody extends $dara.Model {
    * @remarks
    * The returned result. Valid values:
    * 
-   * *   true: successful
-   * *   false: failed
+   * - true: The deployment succeeded.
+   * - false: The deployment failed.
    * 
    * @example
    * true

package/src/models/ShrinkNodeRequest.ts

@@ -4,26 +4,44 @@ import * as $dara from '@darabonba/typescript';
 
 export class ShrinkNodeRequestBody extends $dara.Model {
   /**
+   * @remarks
+   * The IP address of the node.
+   * 
    * @example
    * 192.168.xx.xx
    */
   host?: string;
   /**
+   * @remarks
+   * The name of the node in a cloud-native ACK-based cluster. You can call the [ListAllNode](https://help.aliyun.com/document_detail/183958.html) operation to obtain the node name.
+   * 
    * @example
    * es-cn-pl32xxxxxxx-data-f-1
    */
   hostName?: string;
   /**
+   * @remarks
+   * The type of nodes to scale in. Valid values:
+   * 
+   * - WORKER: hot node
+   * - WORKER_WARM: warm node.
+   * 
    * @example
    * WORKER
    */
   nodeType?: string;
   /**
+   * @remarks
+   * The access port number of the node.
+   * 
    * @example
    * 9200
    */
   port?: number;
   /**
+   * @remarks
+   * The zone ID of the instance node. For example, the zone ID for Singapore Zone C is ap-southeast-1c.
+   * 
    * @example
    * cn-shanghai-c
    */
@@ -58,24 +76,47 @@ export class ShrinkNodeRequestBody extends $dara.Model {
 }
 
 export class ShrinkNodeRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The request body.
+   */
   body?: ShrinkNodeRequestBody[];
   /**
+   * @remarks
+   * 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****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The number of nodes to remove.
+   * >Notice:  This parameter applies only to ACK-based instances. When this parameter is specified, the host parameter in the request body is not supported.
+   * .
+   * 
    * @example
    * 2
    */
   count?: number;
   /**
+   * @remarks
+   * Specifies whether to ignore the cluster health status. Valid values:
+   * 
+   * - true: Ignored.
+   * - false: Not ignored.
+   * 
    * @example
    * false
    */
   ignoreStatus?: boolean;
   /**
    * @remarks
+   * The type of nodes to scale in. Valid values:
+   * 
+   * - WORKER: hot node
+   * - WORKER_WARM: warm node.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ShrinkNodeResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class ShrinkNodeResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The result of the operation. Valid values:
+   * 
+   * - true: The scale-in operation succeeded.
+   * - false: The scale-in operation failed.
+   * 
    * @example
    * true
    */

package/src/models/StartCollectorRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StartCollectorRequest extends $dara.Model {
   /**
    * @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 ensure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * A unique token generated by the client to ensure the idempotence of the request. The value must be unique across different requests and can contain a maximum of 64 ASCII characters.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/StartCollectorResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StartCollectorResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****