@alicloud/elasticsearch20170613 4.3.1 → 4.3.2

package/src/models/ListNodesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListNodesRequest extends $dara.Model {
   /**
    * @remarks
-   * The IDs of the ECS instances.
+   * The list of ECS instance IDs.
    * 
    * @example
    * i-bp1ei8ysh7orb6eq****
@@ -13,7 +13,7 @@ export class ListNodesRequest extends $dara.Model {
   ecsInstanceIds?: string;
   /**
    * @remarks
-   * The name of the ECS instance.
+   * The ECS instance name.
    * 
    * @example
    * test
@@ -21,7 +21,7 @@ export class ListNodesRequest extends $dara.Model {
   ecsInstanceName?: string;
   /**
    * @remarks
-   * The number of the page to return.
+   * The page number of the returned results.
    * 
    * @example
    * 1
@@ -29,7 +29,7 @@ export class ListNodesRequest extends $dara.Model {
   page?: number;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * The number of results per page.
    * 
    * @example
    * 10
@@ -37,7 +37,7 @@ export class ListNodesRequest extends $dara.Model {
   size?: number;
   /**
    * @remarks
-   * The tags of the ECS instance. You must configure tagKey and tagValue.
+   * The tag information of the ECS instance. The tag key (tagKey) and tag value (tagValue) must be included.
    * 
    * @example
    * [{"tagKey":"abc","tagValue":"xyz"}]

package/src/models/ListNodesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListNodesResponseBodyHeaders extends $dara.Model {
   /**
    * @remarks
-   * The number of entries returned.
+   * The total number of returned records.
    * 
    * @example
    * 10
@@ -45,8 +45,8 @@ export class ListNodesResponseBodyResultIpAddress extends $dara.Model {
    * @remarks
    * The type of the IP address. Valid values:
    * 
-   * *   public: public IP address
-   * *   private: private IP address
+   * - public: public IP address.
+   * - private: private IP address.
    * 
    * @example
    * public
@@ -78,7 +78,7 @@ export class ListNodesResponseBodyResultIpAddress extends $dara.Model {
 export class ListNodesResponseBodyResultTags extends $dara.Model {
   /**
    * @remarks
-   * The key of the tag.
+   * The tag key.
    * 
    * @example
    * abc
@@ -86,7 +86,7 @@ export class ListNodesResponseBodyResultTags extends $dara.Model {
   tagKey?: string;
   /**
    * @remarks
-   * The value of the tag.
+   * The tag value.
    * 
    * @example
    * xyz
@@ -118,12 +118,12 @@ export class ListNodesResponseBodyResultTags extends $dara.Model {
 export class ListNodesResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The status of the shipper on the ECS instance. Valid values:
+   * The status of each collector on the ECS instance. Valid values:
    * 
-   * *   heartOk: The heartbeat is normal.
-   * *   heartLost: The heartbeat is abnormal.
-   * *   uninstalled: The shipper is not installed.
-   * *   failed: The shipper fails to be installed.
+   * - heartOk: normal heartbeat.
+   * - heartLost: abnormal heartbeat.
+   * - uninstalled: not installed.
+   * - failed: installation failed.
    * 
    * @example
    * heartOk
@@ -131,10 +131,10 @@ export class ListNodesResponseBodyResult extends $dara.Model {
   agentStatus?: string;
   /**
    * @remarks
-   * Indicates whether the Cloud Assistant client is installed. Valid values:
+   * Indicates whether Cloud Assistant is enabled. Valid values:
    * 
-   * *   true: installed
-   * *   false: not installed
+   * - true: enabled.
+   * - false: not enabled.
    * 
    * @example
    * true
@@ -142,7 +142,7 @@ export class ListNodesResponseBodyResult extends $dara.Model {
   cloudAssistantStatus?: string;
   /**
    * @remarks
-   * The ID of the ECS instance.
+   * The ECS instance ID.
    * 
    * @example
    * i-bp13y63575oypr****
@@ -150,7 +150,7 @@ export class ListNodesResponseBodyResult extends $dara.Model {
   ecsInstanceId?: string;
   /**
    * @remarks
-   * The name of the ECS instance.
+   * The ECS instance name.
    * 
    * @example
    * ECS_beat
@@ -158,15 +158,15 @@ export class ListNodesResponseBodyResult extends $dara.Model {
   ecsInstanceName?: string;
   /**
    * @remarks
-   * The IP addresses of the ECS instance.
+   * The list of IP address information of the ECS instance.
    */
   ipAddress?: ListNodesResponseBodyResultIpAddress[];
   /**
    * @remarks
    * The operating system type of the ECS instance. Valid values:
    * 
-   * *   windows: Windows Server
-   * *   linux: Linux
+   * - windows: Windows Server.
+   * - linux: Linux.
    * 
    * @example
    * linux
@@ -176,10 +176,10 @@ export class ListNodesResponseBodyResult extends $dara.Model {
    * @remarks
    * The status of the ECS instance. Valid values:
    * 
-   * *   running: The instance is running.
-   * *   starting: The instance is being started.
-   * *   stopping: The instance is being stopped.
-   * *   stopped: The instance is stopped.
+   * - running: running.
+   * - starting: starting.
+   * - stopping: stopping.
+   * - stopped: stopped.
    * 
    * @example
    * running
@@ -187,7 +187,7 @@ export class ListNodesResponseBodyResult extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The tags of the ECS instance.
+   * The tag information of the ECS instance.
    */
   tags?: ListNodesResponseBodyResultTags[];
   static names(): { [key: string]: string } {
@@ -234,12 +234,12 @@ export class ListNodesResponseBodyResult extends $dara.Model {
 export class ListNodesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The header of the response.
+   * The response headers.
    */
   headers?: ListNodesResponseBodyHeaders;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * E1FD7642-7C40-4FF2-9C0F-21F1A1746F70
@@ -247,7 +247,7 @@ export class ListNodesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The returned result.
+   * The returned results.
    */
   result?: ListNodesResponseBodyResult[];
   static names(): { [key: string]: string } {

package/src/models/ListPipelineIdsRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListPipelineIdsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The request body parameters. For more information, see the RequestBody section below.
+   * 
    * @example
    * {     "userName":"elastic",     "password":"xxxxxx" }
    */

package/src/models/ListPipelineIdsResponseBody.ts

@@ -4,21 +4,37 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListPipelineIdsResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the pipeline is available. Valid values:
+   * 
+   * - true: Available.
+   * 
+   * - false: Not available.
+   * 
    * @example
    * true
    */
   available?: boolean;
   /**
+   * @remarks
+   * The error code returned when the pipeline is unavailable.
+   * 
    * @example
    * OK
    */
   code?: string;
   /**
+   * @remarks
+   * The error message returned when the pipeline is unavailable.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The pipeline ID created in Kibana.
+   * 
    * @example
    * testKibanaManagement
    */
@@ -52,10 +68,17 @@ export class ListPipelineIdsResponseBodyResult extends $dara.Model {
 
 export class ListPipelineIdsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The list of results.
+   */
   result?: ListPipelineIdsResponseBodyResult[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListPipelineRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPipelineRequest extends $dara.Model {
   /**
    * @remarks
-   * The header of the response.
+   * The page number of the current page for a paged query. Valid values: 1 to 200. Default value: 1.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListPipelineRequest extends $dara.Model {
   page?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The pipeline ID.
    * 
    * @example
    * pipeline_test
@@ -21,7 +21,7 @@ export class ListPipelineRequest extends $dara.Model {
   pipelineId?: string;
   /**
    * @remarks
-   * The total number of returned entries.
+   * The number of pipelines per page for a paged query. Valid values: 1 to 200.
    * 
    * @example
    * 15

package/src/models/ListPipelineResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPipelineResponseBodyHeaders extends $dara.Model {
   /**
    * @remarks
-   * The time when the pipeline was updated.
+   * The total number of records.
    * 
    * @example
    * 2
@@ -34,28 +34,37 @@ export class ListPipelineResponseBodyHeaders extends $dara.Model {
 
 export class ListPipelineResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * The time when the pipeline was created.
+   * 
    * @example
    * 2020-08-05T03:10:38.188Z
    */
   gmtCreatedTime?: string;
   /**
+   * @remarks
+   * The time when the pipeline was last updated.
+   * 
    * @example
    * 2020-08-05T08:43:31.757Z
    */
   gmtUpdateTime?: string;
   /**
    * @remarks
-   * The status of the pipeline. Supported:
-   * 
-   * *   NOT_DEPLOYED: The node is not deployed.
-   * *   RUNNING
-   * *   DELETED: Deleted. The console does not display this status.
+   * The pipeline ID.
    * 
    * @example
    * pipeline_test
    */
   pipelineId?: string;
   /**
+   * @remarks
+   * The pipeline status. Valid values:
+   * 
+   * - NOT_DEPLOYED: not deployed.
+   * - RUNNING: running.
+   * - DELETED: deleted. This status is not displayed in the console.
+   * 
    * @example
    * NOT_DEPLOYED
    */
@@ -90,12 +99,12 @@ export class ListPipelineResponseBodyResult extends $dara.Model {
 export class ListPipelineResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.
+   * The response headers.
    */
   headers?: ListPipelineResponseBodyHeaders;
   /**
    * @remarks
-   * The response.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
@@ -103,7 +112,7 @@ export class ListPipelineResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The time when the pipeline was created.
+   * The returned results.
    */
   result?: ListPipelineResponseBodyResult[];
   static names(): { [key: string]: string } {

package/src/models/ListPluginsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPluginsRequest extends $dara.Model {
   /**
    * @remarks
-   * SYSTEM
+   * The plugin name.
    * 
    * @example
    * analysis-ik
@@ -13,7 +13,7 @@ export class ListPluginsRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The page number.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class ListPluginsRequest extends $dara.Model {
   page?: string;
   /**
    * @remarks
-   * The header of the response.
+   * The number of records per page.
    * 
    * @example
    * 10
@@ -29,7 +29,7 @@ export class ListPluginsRequest extends $dara.Model {
   size?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The plugin source type. Only SYSTEM (system plugin) is supported.
    * 
    * @example
    * SYSTEM

package/src/models/ListPluginsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPluginsResponseBodyHeaders extends $dara.Model {
   /**
    * @remarks
-   * The address of the plug-in description document.
+   * The total number of records returned.
    * 
    * @example
    * 2
@@ -35,31 +35,40 @@ export class ListPluginsResponseBodyHeaders extends $dara.Model {
 export class ListPluginsResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The source type of the plug-in.
+   * The plugin description.
    * 
    * @example
    * IK analysis plug-in for Elasticsearch.
    */
   description?: string;
   /**
+   * @remarks
+   * The plugin name.
+   * 
    * @example
    * analysis-ik
    */
   name?: string;
   /**
+   * @remarks
+   * The plugin source type.
+   * 
    * @example
    * SYSTEM
    */
   source?: string;
   /**
    * @remarks
-   * The name of the plug-in.
+   * The URL of the plugin documentation.
    * 
    * @example
    * https://xxxx.html
    */
   specificationUrl?: string;
   /**
+   * @remarks
+   * The plugin status.
+   * 
    * @example
    * INSTALLED
    */
@@ -96,12 +105,12 @@ export class ListPluginsResponseBodyResult extends $dara.Model {
 export class ListPluginsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The description of the plug-in.
+   * The response headers.
    */
   headers?: ListPluginsResponseBodyHeaders;
   /**
    * @remarks
-   * The return results.
+   * The request ID.
    * 
    * @example
    * 5A5D8E74-565C-43DC-B031-29289FA9****
@@ -109,7 +118,7 @@ export class ListPluginsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The status of the plug-in.
+   * The returned results.
    */
   result?: ListPluginsResponseBodyResult[];
   static names(): { [key: string]: string } {

package/src/models/ListSearchLogRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListSearchLogRequest extends $dara.Model {
   /**
    * @remarks
-   * 20
+   * The start timestamp of the log, in milliseconds. The value must be within the last 7 days. If this parameter is not specified, all logs within the [current time - 7 days, endTime\\] range are queried.
    * 
    * @example
    * 1531910852074
@@ -13,7 +13,7 @@ export class ListSearchLogRequest extends $dara.Model {
   beginTime?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The end timestamp of the log, in milliseconds. The value must be within the last 7 days. Specify this parameter. If this parameter is not specified, an empty result is returned.
    * 
    * @example
    * 1531910852074
@@ -21,7 +21,7 @@ export class ListSearchLogRequest extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * The header of the response.
+   * The page number of the plug-in list. Minimum value: 1. Default value: 1.
    * 
    * @example
    * 1
@@ -29,7 +29,7 @@ export class ListSearchLogRequest extends $dara.Model {
   page?: number;
   /**
    * @remarks
-   * 1
+   * The keyword to query.
    * 
    * This parameter is required.
    * 
@@ -39,7 +39,7 @@ export class ListSearchLogRequest extends $dara.Model {
   query?: string;
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page for a paged query. Default value: 20. Minimum value: 1. Maximum value: 50.
    * 
    * @example
    * 20
@@ -47,7 +47,15 @@ export class ListSearchLogRequest extends $dara.Model {
   size?: number;
   /**
    * @remarks
-   * 1531910852074
+   * The log type. Valid values:
+   * - INSTANCELOG: primary log.
+   * - SEARCHSLOW: searching slow log.
+   * - INDEXINGSLOW: indexing slow log.
+   * - JVMLOG: GC log.
+   * - ES_SEARCH_ACCESS_LOG: Elasticsearch access log.
+   * - AUDIT: audit log.
+   * 
+   * For limits on viewing logs, see [Query logs](https://help.aliyun.com/document_detail/72026.html).
    * 
    * This parameter is required.
    * 

package/src/models/ListSearchLogResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListSearchLogResponseBodyHeaders extends $dara.Model {
   /**
    * @remarks
-   * The IP address of the node that generates the log.
+   * The total number of records for the instance.
    * 
    * @example
    * 1000
@@ -35,39 +35,56 @@ export class ListSearchLogResponseBodyHeaders extends $dara.Model {
 export class ListSearchLogResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The ID of the instance.
+   * The detailed log content. This field has been migrated to the contentCollection field.
    * 
    * @example
    * [GC (Allocation Failure) 2018-07-19T17:24:20.682+0800: 7516.513: [ParNew: 6604768K->81121K(7341504K), 0.0760606 secs] 7226662K->703015K(31813056K), 0.0762507 secs] [Times: user=0.52 sys=0.00, real=0.07 secs]
    */
   content?: string;
   /**
+   * @remarks
+   * The log details. Different log types return different content fields.
+   * 
    * @example
    * {"level": "info", "host": "``192.168.**.**``", "time": "2019-03-18T08:16:12.741Z","content": "[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...])."}
    */
   contentCollection?: { [key: string]: any };
   /**
    * @remarks
-   * Details of the log entry. Different content fields are returned for different log types.
+   * The IP address of the node that generated the log.
    * 
    * @example
    * ``192.168.**.**``
    */
   host?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * es-cn-n6w1o1x0w001c****
    */
   instanceId?: string;
   /**
    * @remarks
-   * The timestamp when the log is generated. Unit: ms.
+   * The log level. Valid values:
+   * 
+   * - warn: warning log
+   * - info: information log
+   * - error: error log
+   * - trace: trace log
+   * - debug: debug log
+   * 
+   * The level information has been migrated to the contentCollection field.
    * 
    * @example
    * info
    */
   level?: string;
   /**
+   * @remarks
+   * The timestamp when the log was generated, in milliseconds.
+   * 
    * @example
    * 1531985112420
    */
@@ -109,20 +126,12 @@ export class ListSearchLogResponseBodyResult extends $dara.Model {
 export class ListSearchLogResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The level of the log. Valid values:
-   * 
-   * *   warn: warning log
-   * *   info: information log
-   * *   error: error log
-   * *   trace: trace logs
-   * *   debug: debug logs
-   * 
-   * The level information has been migrated to the contentCollection field.
+   * The response headers.
    */
   headers?: ListSearchLogResponseBodyHeaders;
   /**
    * @remarks
-   * The list of logs returned by the request.
+   * The request ID.
    * 
    * @example
    * 7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****
@@ -130,7 +139,7 @@ export class ListSearchLogResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The content of the log entry. Migrated to the contentCollection field.
+   * The list of logs returned by the request.
    */
   result?: ListSearchLogResponseBodyResult[];
   static names(): { [key: string]: string } {

package/src/models/ListShardRecoveriesRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListShardRecoveriesRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to return information about data restoration of shards. Valid values:
+   * Specifies whether to display shard data recovery tracking information. Valid values:
    * 
-   * *   true: returns information about data restoration of shards that are being restored.
-   * *   false: returns information about data restoration of all shards.
+   * - true: Displays only ongoing shard data recovery tracking information.
+   * 
+   * - false: Displays all shard data recovery tracking information.
    * 
    * @example
    * true