@alicloud/elasticsearch20170613 4.3.0 → 4.3.2

package/src/models/StopCollectorRequest.ts

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

package/src/models/StopPipelinesRequest.ts

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

package/src/models/StopPipelinesResponseBody.ts

@@ -15,8 +15,8 @@ export class StopPipelinesResponseBody extends $dara.Model {
    * @remarks
    * The returned result. Valid values:
    * 
-   * *   true: The pipelines are stopped.
-   * *   false: The pipelines fail to be stopped.
+   * - true: The pipelines are stopped.
+   * - false: The pipelines failed to be stopped.
    * 
    * @example
    * true

package/src/models/Tag.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class Tag extends $dara.Model {
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * env
    */
   tagKey?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * dev
    */

package/src/models/TagResourcesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class TagResourcesRequestTags extends $dara.Model {
   /**
    * @remarks
-   * The returned object.
+   * The tag key.
    * 
    * This parameter is required.
    * 
@@ -15,10 +15,7 @@ export class TagResourcesRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Indicates whether tags are added to the clusters. Valid values:
-   * 
-   * *   true
-   * *   false
+   * The tag value.
    * 
    * This parameter is required.
    * 
@@ -52,14 +49,14 @@ export class TagResourcesRequestTags extends $dara.Model {
 export class TagResourcesRequest extends $dara.Model {
   /**
    * @remarks
-   * A tag.
+   * The resource IDs.
    * 
    * This parameter is required.
    */
   resourceIds?: string[];
   /**
    * @remarks
-   * The request ID.
+   * The resource type. Set this parameter to INSTANCE.
    * 
    * This parameter is required.
    * 
@@ -69,7 +66,7 @@ export class TagResourcesRequest extends $dara.Model {
   resourceType?: string;
   /**
    * @remarks
-   * The value of the tag.
+   * The tag information.
    * 
    * This parameter is required.
    */

package/src/models/TagResourcesResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class TagResourcesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 3D8795D9-8FF5-46B2-86E6-E3B407*******
    */
   requestId?: string;
   /**
+   * @remarks
+   * The returned result. Valid values:
+   * 
+   * - true: The tag-resource relationships are created.
+   * - false: The tag-resource relationships failed to be created.
+   * 
    * @example
    * true
    */

package/src/models/TransferNodeRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class TransferNodeRequestBody extends $dara.Model {
   /**
+   * @remarks
+   * The IP address of the node.
+   * 
    * @example
    * 192.168.xx.xx
    */
   host?: 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 Zone C in the China (Shanghai) region is cn-shanghai-c.
+   * 
    * @example
    * cn-shanghai-c
    */
@@ -44,14 +53,26 @@ export class TransferNodeRequestBody extends $dara.Model {
 }
 
 export class TransferNodeRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The request body.
+   */
   body?: TransferNodeRequestBody[];
   /**
+   * @remarks
+   * A unique token generated by the client to ensure the idempotence of the request. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */
   clientToken?: string;
   /**
    * @remarks
+   * The node type. Valid values:
+   * 
+   * - WORKER: hot node
+   * - WORKER_WARM: warm node.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/TransferNodeResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class TransferNodeResponseBody 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 task was successful.
+   * - false: The task failed.
+   * 
    * @example
    * true
    */

package/src/models/TriggerNetworkRequest.ts

@@ -5,6 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class TriggerNetworkRequest extends $dara.Model {
   /**
    * @remarks
+   * The action type. Valid values:
+   * 
+   * - CLOSE: disable.
+   * - OPEN: enable.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +18,11 @@ export class TriggerNetworkRequest extends $dara.Model {
   actionType?: string;
   /**
    * @remarks
+   * The network type. Valid values:
+   * 
+   * - PUBLIC: public network.
+   * - PRIVATE: private network.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +31,11 @@ export class TriggerNetworkRequest extends $dara.Model {
   networkType?: string;
   /**
    * @remarks
+   * The instance type. Valid values:
+   * 
+   * - KIBANA: Kibana cluster.
+   * - WORKER: Elasticsearch cluster.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -28,6 +43,9 @@ export class TriggerNetworkRequest extends $dara.Model {
    */
   nodeType?: 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
    * 407d02b74c49beb5bfdac7ec8bde2488
    */

package/src/models/TriggerNetworkResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class TriggerNetworkResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5A5D8E74-565C-43DC-B031-29289FA****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The returned result. Valid values:
+   * 
+   * - true: The operation was successful.
+   * - false: The operation failed.
+   * 
    * @example
    * true
    */

package/src/models/TurnOffZoneRequest.ts

@@ -3,19 +3,25 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class TurnOffZoneRequest extends $dara.Model {
+  hpAlbZoneDrained?: boolean;
   /**
+   * @remarks
+   * The zone of the instance.
+   * 
    * @example
    * cn-hangzhou-i
    */
   zone?: string;
   static names(): { [key: string]: string } {
     return {
+      hpAlbZoneDrained: 'hpAlbZoneDrained',
       zone: 'zone',
     };
   }
 
   static types(): { [key: string]: any } {
     return {
+      hpAlbZoneDrained: 'boolean',
       zone: 'string',
     };
   }

package/src/models/TurnOnZoneRequest.ts

@@ -3,19 +3,25 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class TurnOnZoneRequest extends $dara.Model {
+  hpAlbZoneDrained?: boolean;
   /**
+   * @remarks
+   * The zone of the instance.
+   * 
    * @example
    * cn-hangzhou-i
    */
   zone?: string;
   static names(): { [key: string]: string } {
     return {
+      hpAlbZoneDrained: 'hpAlbZoneDrained',
       zone: 'zone',
     };
   }
 
   static types(): { [key: string]: any } {
     return {
+      hpAlbZoneDrained: 'boolean',
       zone: 'string',
     };
   }

package/src/models/UninstallKibanaPluginRequest.ts

@@ -6,7 +6,7 @@ export class UninstallKibanaPluginRequest extends $dara.Model {
   body?: string;
   /**
    * @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 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/UninstallKibanaPluginResponseBody.ts

@@ -5,16 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class UninstallKibanaPluginResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****
    */
   requestId?: string;
-  /**
-   * @remarks
-   * The returned result shows a list of uninstalled plug-ins.
-   */
   result?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UninstallLogstashPluginRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UninstallLogstashPluginRequest extends $dara.Model {
   /**
+   * @remarks
+   * The list of plug-in names to uninstall, in the format `["pluginName1","pluginName2",...,"pluginNamen"]`.
+   * 
    * @example
    * ["logstash-input-datahub", "logstash-input-maxcompute" ]
    */
   body?: string[];
   /**
+   * @remarks
+   * A unique token generated by the client to ensure the idempotence of the request. The value of this parameter must be unique across different requests and can contain a maximum of 64 ASCII characters.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */

package/src/models/UninstallLogstashPluginResponseBody.ts

@@ -5,6 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class UninstallLogstashPluginResponseBody extends $dara.Model {
   headers?: { [key: string]: any };
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */

package/src/models/UninstallPluginRequest.ts

@@ -3,15 +3,29 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UninstallPluginRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The names of the system plug-ins that you want to uninstall.
+   * 
+   * @example
+   * ["aliyun-sql","codec-compression"]
+   */
   body?: string;
   /**
    * @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 that is used to ensure idempotence. This parameter value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */
   clientToken?: string;
+  /**
+   * @remarks
+   * Specifies whether to forcefully uninstall the plug-in. You can cancel the installation of a plug-in that is being installed. This parameter is applicable only to instances of the new architecture. Default value: false.
+   * 
+   * @example
+   * false
+   */
   force?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/UninstallPluginResponseBody.ts

@@ -5,16 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class UninstallPluginResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
-  /**
-   * @remarks
-   * The list of plug-ins to be unloaded. If the unloading fails, an exception is returned.
-   */
   result?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UntagResourcesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UntagResourcesRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to delete all parts. Default value: **false** . This parameter is valid only when **TagKeys** is not specified.
+   * Specifies whether to delete all tags. Default value: **false**. This parameter is valid only when **TagKeys** is empty.
    * 
    * @example
    * false
@@ -13,7 +13,7 @@ export class UntagResourcesRequest extends $dara.Model {
   all?: boolean;
   /**
    * @remarks
-   * The resource list that you want to delete.
+   * The list of resources to delete.
    * 
    * @example
    * ["es-cn-09k1rocex0006****","es-cn-oew1rgiev0009****"]
@@ -21,7 +21,7 @@ export class UntagResourcesRequest extends $dara.Model {
   resourceIds?: string;
   /**
    * @remarks
-   * The type of the resource. Fixed to **INSTANCE** .
+   * The resource type. Set this to **INSTANCE**.
    * 
    * @example
    * INSTANCE
@@ -29,7 +29,7 @@ export class UntagResourcesRequest extends $dara.Model {
   resourceType?: string;
   /**
    * @remarks
-   * The list of tags that you want to delete. The list can contain up to 20 subitems.
+   * The list of tags to delete. A maximum of 20 items can be specified.
    * 
    * @example
    * ["tagKey1","tagKey2"]

package/src/models/UntagResourcesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UntagResourcesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6D******
@@ -13,10 +13,10 @@ export class UntagResourcesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return results:
+   * The returned result.
    * 
-   * *   true: deleted
-   * *   false: Failed
+   * - true: The deletion was successful.
+   * - false: The deletion failed.
    * 
    * @example
    * true

package/src/models/UpdateAdminPasswordRequest.ts

@@ -4,16 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateAdminPasswordRequest extends $dara.Model {
   /**
+   * @remarks
+   * The new password.
+   * > The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, and special characters: !@#$%^&*()_+-=.
+   * 
    * @example
    * es_password
    */
   esAdminPassword?: string;
   /**
    * @remarks
-   * Indicates whether the password was updated. Valid values:
-   * 
-   * *   true: The call was successful.
-   * *   false: The call failed.
+   * A unique token used to ensure idempotence of the request. Generated by the client, this value must be unique across different requests and cannot exceed 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/UpdateAdminPasswordResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateAdminPasswordResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0FA05123-745C-42FD-A69B-AFF48EF9****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the password is updated. Valid values:
+   * 
+   * - true: The password is updated.
+   * - false: The password failed to be updated.
+   * 
    * @example
    * true
    */

package/src/models/UpdateAdvancedSettingRequest.ts

@@ -6,7 +6,7 @@ export class UpdateAdvancedSettingRequest extends $dara.Model {
   body?: string;
   /**
    * @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 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/UpdateAdvancedSettingResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateAdvancedSettingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****
@@ -13,10 +13,10 @@ export class UpdateAdvancedSettingResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return results:
+   * The returned result. Valid values:
    * 
-   * *   true: garbage collector configuration changed successfully
-   * *   false: garbage collector configuration changed successfully failed
+   * - true: The garbage collector configuration is changed.
+   * - false: The garbage collector configuration failed to be changed.
    * 
    * @example
    * true

package/src/models/UpdateAliwsDictRequest.ts

@@ -6,7 +6,7 @@ export class UpdateAliwsDictRequest 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 unique token used to ensure idempotence of the request. The client generates this value. The value must be unique across different requests and cannot exceed 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/UpdateAliwsDictResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateAliwsDictResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The size of the dictionary file. Unit: bytes.
+   * The file size. Unit: bytes.
    * 
    * @example
    * 6226
@@ -13,7 +13,7 @@ export class UpdateAliwsDictResponseBodyResult extends $dara.Model {
   fileSize?: number;
   /**
    * @remarks
-   * The name of the uploaded dictionary file.
+   * The name of the uploaded file.
    * 
    * @example
    * aliws_ext_dict.txt
@@ -22,9 +22,8 @@ export class UpdateAliwsDictResponseBodyResult extends $dara.Model {
   /**
    * @remarks
    * The source type of the dictionary file. Valid values:
-   * 
-   * *   OSS
-   * *   ORIGIN
+   * - OSS: uses OSS open storage.
+   * - ORIGIN: retains the previously uploaded dictionary.
    * 
    * @example
    * OSS
@@ -32,7 +31,7 @@ export class UpdateAliwsDictResponseBodyResult extends $dara.Model {
   sourceType?: string;
   /**
    * @remarks
-   * The dictionary type. The value is fixed as ALI_WS.
+   * The dictionary type. Valid values: ALI_WS (AliNLP tokenizer).
    * 
    * @example
    * ALI_WS

package/src/models/UpdateCollectorNameRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCollectorNameRequest 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 the idempotence of the request. The value of this parameter must be unique across different requests and can contain a maximum of 64 ASCII characters.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****