@alicloud/elasticsearch20170613 4.3.1 → 4.3.2

package/src/models/ListDataStreamsResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDataStreamsResponseBodyHeaders extends $dara.Model {
   /**
+   * @remarks
+   * The total number of data streams.
+   * 
    * @example
    * 100
    */
   xManagedCount?: number;
   /**
+   * @remarks
+   * The total storage size of indexes. Unit: bytes.
+   * 
    * @example
    * 143993923932990
    */
@@ -38,31 +44,60 @@ export class ListDataStreamsResponseBodyHeaders extends $dara.Model {
 
 export class ListDataStreamsResponseBodyResultIndices extends $dara.Model {
   /**
+   * @remarks
+   * The time when the data stream list was queried.
+   * 
    * @example
    * 2018-07-13T03:58:07.253Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The index status. Valid values:
+   * 
+   * - Green: healthy.
+   * 
+   * - Yellow: warning.
+   * 
+   * - Red: abnormal.
+   * 
    * @example
    * Green
    */
   health?: string;
   /**
+   * @remarks
+   * This field is deprecated and can be ignored.
+   * 
    * @example
    * false
    */
   isManaged?: boolean;
   /**
+   * @remarks
+   * The managed status of the index. Valid values:
+   * - following: managed.
+   * 
+   * - closing: being unmanaged.
+   * 
+   * - closed: not managed.
+   * 
    * @example
    * following
    */
   managedStatus?: string;
   /**
+   * @remarks
+   * The data stream name.
+   * 
    * @example
    * Log1
    */
   name?: string;
   /**
+   * @remarks
+   * The total storage space occupied by the current index. Unit: bytes.
+   * 
    * @example
    * 15393899
    */
@@ -100,32 +135,60 @@ export class ListDataStreamsResponseBodyResultIndices extends $dara.Model {
 
 export class ListDataStreamsResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * The data stream status. Valid values:
+   * 
+   * - Green: healthy.
+   * 
+   * - Yellow: warning.
+   * 
+   * - Red: abnormal.
+   * 
    * @example
    * Green
    */
   health?: string;
   /**
+   * @remarks
+   * The index lifecycle policy name.
+   * 
    * @example
    * rollver1
    */
   ilmPolicyName?: string;
   /**
+   * @remarks
+   * The index template name.
+   * 
    * @example
    * template1
    */
   indexTemplateName?: string;
+  /**
+   * @remarks
+   * The index information under the current data stream.
+   */
   indices?: ListDataStreamsResponseBodyResultIndices[];
   /**
+   * @remarks
+   * The total storage space occupied by managed indexes under the current data stream. Unit: bytes.
+   * 
    * @example
    * 1788239393298
    */
   managedStorageSize?: number;
   /**
+   * @remarks
+   * The index name.
+   * 
    * @example
    * my-index-0001
    */
   name?: string;
   /**
+   * @remarks
+   * The total storage space occupied by all indexes under the current data stream. Unit: bytes.
+   * 
    * @example
    * 1788239393298
    */
@@ -167,12 +230,23 @@ export class ListDataStreamsResponseBodyResult extends $dara.Model {
 }
 
 export class ListDataStreamsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response headers.
+   */
   headers?: ListDataStreamsResponseBodyHeaders;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The details of the returned data streams.
+   */
   result?: ListDataStreamsResponseBodyResult[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListDataTasksResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListDataTasksResponseBodyResultSinkCluster extends $dara.Model {
   /**
    * @remarks
-   * The type of the target cluster. Default value: elasticsearch.
+   * The destination cluster type. Default value: elasticsearch.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListDataTasksResponseBodyResultSinkCluster extends $dara.Model {
   dataSourceType?: string;
   /**
    * @remarks
-   * The public network access address of the target cluster.
+   * The public network access address of the destination cluster.
    * 
    * @example
    * http://192.168.xx.xx:4101
@@ -21,7 +21,7 @@ export class ListDataTasksResponseBodyResultSinkCluster extends $dara.Model {
   endpoint?: string;
   /**
    * @remarks
-   * The target index.
+   * The destination index.
    * 
    * @example
    * product_info
@@ -29,7 +29,7 @@ export class ListDataTasksResponseBodyResultSinkCluster extends $dara.Model {
   index?: string;
   /**
    * @remarks
-   * The type of the destination index.
+   * The index type.
    * 
    * @example
    * _doc
@@ -37,7 +37,7 @@ export class ListDataTasksResponseBodyResultSinkCluster extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The ID of the VPC to which the cluster belongs.
+   * The ID of the virtual private cloud (VPC) where the cluster resides.
    * 
    * @example
    * vpc-2ze55voww95g82gak****
@@ -45,7 +45,7 @@ export class ListDataTasksResponseBodyResultSinkCluster extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
-   * The instance ID or Server Load Balancer (SLB) ID of the current cluster.
+   * The instance ID of the current cluster or the load balancing SLB (Server Load Balancer) instance ID.
    * 
    * @example
    * es-cn-09k1rnu3g0002****-worker
@@ -53,7 +53,7 @@ export class ListDataTasksResponseBodyResultSinkCluster extends $dara.Model {
   vpcInstanceId?: string;
   /**
    * @remarks
-   * The access port number of the cluster.
+   * The port number used to access the cluster.
    * 
    * @example
    * 9200
@@ -95,7 +95,7 @@ export class ListDataTasksResponseBodyResultSinkCluster extends $dara.Model {
 export class ListDataTasksResponseBodyResultSourceCluster extends $dara.Model {
   /**
    * @remarks
-   * The type of the source cluster. Default value: elasticsearch.
+   * The source cluster type. Default value: elasticsearch.
    * 
    * @example
    * 1
@@ -103,7 +103,7 @@ export class ListDataTasksResponseBodyResultSourceCluster extends $dara.Model {
   dataSourceType?: string;
   /**
    * @remarks
-   * The index whose data you want to migrate.
+   * The index to be migrated.
    * 
    * @example
    * product_info
@@ -119,7 +119,7 @@ export class ListDataTasksResponseBodyResultSourceCluster extends $dara.Model {
   mapping?: string;
   /**
    * @remarks
-   * The routing field to index the table. It is set to the primary key by default.
+   * The routing field of the index. The primary key field is used by default.
    * 
    * @example
    * _id
@@ -127,7 +127,7 @@ export class ListDataTasksResponseBodyResultSourceCluster extends $dara.Model {
   routing?: string;
   /**
    * @remarks
-   * The Settings of the cluster.
+   * The Settings configuration of the cluster.
    * 
    * @example
    * {\\n  \\"index\\": {\\n    \\"replication\\": {\\n}.....}}
@@ -135,7 +135,7 @@ export class ListDataTasksResponseBodyResultSourceCluster extends $dara.Model {
   settings?: string;
   /**
    * @remarks
-   * The type of the destination index.
+   * The index type.
    * 
    * @example
    * _doc
@@ -175,7 +175,7 @@ export class ListDataTasksResponseBodyResultSourceCluster extends $dara.Model {
 export class ListDataTasksResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The time when the site monitoring task was created.
+   * The time when the task was created.
    * 
    * @example
    * 2020-07-30 06:32:18
@@ -183,17 +183,17 @@ export class ListDataTasksResponseBodyResult extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The information of the target cluster.
+   * The destination cluster information.
    */
   sinkCluster?: ListDataTasksResponseBodyResultSinkCluster;
   /**
    * @remarks
-   * The information about the source cluster.
+   * The source cluster information.
    */
   sourceCluster?: ListDataTasksResponseBodyResultSourceCluster;
   /**
    * @remarks
-   * The status of the task.
+   * The task status.
    * 
    * @example
    * SUCCESS
@@ -201,7 +201,7 @@ export class ListDataTasksResponseBodyResult extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The ID of the task.
+   * The task ID.
    * 
    * @example
    * et_cn_mfv1233r47272****
@@ -245,7 +245,7 @@ export class ListDataTasksResponseBodyResult extends $dara.Model {
 export class ListDataTasksResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***
@@ -253,7 +253,7 @@ export class ListDataTasksResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The return results.
+   * The returned results.
    */
   result?: ListDataTasksResponseBodyResult[];
   static names(): { [key: string]: string } {

package/src/models/ListDefaultCollectorConfigurationsRequest.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ListDefaultCollectorConfigurationsRequest extends $dara.Model {
   /**
    * @remarks
-   * The shipper type. Valid values:
+   * The type of the collector. Valid values:
    * 
-   * *   fileBeat
-   * *   metricBeat
-   * *   heartBeat
-   * *   auditBeat
+   * - fileBeat
+   * - metricBeat
+   * - heartBeat
+   * - auditBeat.
    * 
    * This parameter is required.
    * 
@@ -20,10 +20,10 @@ export class ListDefaultCollectorConfigurationsRequest extends $dara.Model {
   resType?: string;
   /**
    * @remarks
-   * The shipper version. The shipper version varies based on the type of the machine on which the shipper is deployed. Valid values:
+   * The version of the collector. The available versions vary based on the type of machine on which the collector is deployed. Valid values:
    * 
-   * *   ECS: 6.8.5_with_community
-   * *   ACK: 6.8.13_with_community
+   * - ECS: 6.8.5_with_community
+   * - ACK: 6.8.13_with_community.
    * 
    * This parameter is required.
    * 
@@ -33,10 +33,10 @@ export class ListDefaultCollectorConfigurationsRequest extends $dara.Model {
   resVersion?: string;
   /**
    * @remarks
-   * The type of the machine on which the shipper is deployed. If you do not configure this parameter, the default configuration files of shippers deployed on all types of machines are returned. Valid values:
+   * The type of machine on which the collector is deployed. If you do not specify this parameter, all types are returned. Valid values:
    * 
-   * *   ECS: ECS instance
-   * *   ACK: ACK cluster
+   * - ECS: Elastic Compute Service (ECS) instance
+   * - ACK: Container Service for Kubernetes (ACK) cluster.
    * 
    * @example
    * ECS

package/src/models/ListDefaultCollectorConfigurationsResponseBody.ts

@@ -45,7 +45,7 @@ export class ListDefaultCollectorConfigurationsResponseBodyResult extends $dara.
 export class ListDefaultCollectorConfigurationsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5

package/src/models/ListDeprecatedTemplatesRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDeprecatedTemplatesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The index template name.
+   * 
    * @example
    * component-openstore-index-template
    */
   name?: string;
   /**
+   * @remarks
+   * The page number Settings for a paged query. Paging is used to retrieve results.
+   * 
    * @example
    * 5
    */
   page?: number;
   /**
+   * @remarks
+   * The number of entries per page Settings for a paged query. Paging is used to retrieve results.
+   * 
    * @example
    * 10
    * 

package/src/models/ListDeprecatedTemplatesResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDeprecatedTemplatesResponseBodyHeaders extends $dara.Model {
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 5
    */
@@ -31,16 +34,25 @@ export class ListDeprecatedTemplatesResponseBodyHeaders extends $dara.Model {
 
 export class ListDeprecatedTemplatesResponseBodyResultTemplate extends $dara.Model {
   /**
+   * @remarks
+   * The alias configuration of the template.
+   * 
    * @example
    * "{}"
    */
   aliases?: string;
   /**
+   * @remarks
+   * The mappings configuration of the template.
+   * 
    * @example
    * "{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}"
    */
   mappings?: string;
   /**
+   * @remarks
+   * The settings configuration of the template.
+   * 
    * @example
    * "{\\"index.number_of_shards\\":\\"1\\"}"
    */
@@ -72,23 +84,46 @@ export class ListDeprecatedTemplatesResponseBodyResultTemplate extends $dara.Mod
 
 export class ListDeprecatedTemplatesResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the template matches a data stream. Valid values:
+   * 
+   * - true: matched
+   * - false: not matched.
+   * 
    * @example
    * false
    */
   dataStream?: boolean;
+  /**
+   * @remarks
+   * The index template information.
+   */
   indexPatterns?: string[];
   /**
+   * @remarks
+   * The index template name.
+   * 
    * @example
    * openstore-index-template
    */
   indexTemplate?: string;
   /**
+   * @remarks
+   * The priority.
+   * 
    * @example
    * 100
    */
   order?: number;
+  /**
+   * @remarks
+   * The index template configuration.
+   */
   template?: ListDeprecatedTemplatesResponseBodyResultTemplate;
   /**
+   * @remarks
+   * The version of the index template.
+   * 
    * @example
    * 70000
    */
@@ -131,12 +166,23 @@ export class ListDeprecatedTemplatesResponseBodyResult extends $dara.Model {
 }
 
 export class ListDeprecatedTemplatesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response headers.
+   */
   headers?: ListDeprecatedTemplatesResponseBodyHeaders;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC47D9
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned results.
+   */
   result?: ListDeprecatedTemplatesResponseBodyResult[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListDiagnoseIndicesRequest.ts

@@ -5,7 +5,13 @@ import * as $dara from '@darabonba/typescript';
 export class ListDiagnoseIndicesRequest extends $dara.Model {
   /**
    * @remarks
-   * The language. Multiple languages are supported.
+   * The language. Default value: the browser language. Valid values:
+   * 
+   * - en: English
+   * - zh: Simplified Chinese
+   * - zt: Traditional Chinese
+   * - es: Spanish
+   * - fr: French.
    * 
    * @example
    * en

package/src/models/ListDiagnoseIndicesResponseBody.ts

@@ -11,6 +11,10 @@ export class ListDiagnoseIndicesResponseBody extends $dara.Model {
    * F05ED12E-140A-4ACB-B059-3A508A69F2E1
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   result?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListDiagnoseReportIdsRequest.ts

@@ -5,7 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ListDiagnoseReportIdsRequest extends $dara.Model {
   /**
    * @remarks
-   * The end of the time range to query. The value must be a UNIX timestamp.
+   * The end timestamp of the query.
+   * Minimum value: 1000000000000 ms
+   * Maximum value: 2000000000000 ms.
    * 
    * This parameter is required.
    * 
@@ -15,15 +17,20 @@ export class ListDiagnoseReportIdsRequest extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * The language of the reports.
+   * The language of the reports to retrieve. Default value: the browser language. Valid values:
+   * - en: English
+   * - zh: Simplified Chinese
+   * - zt: Traditional Chinese
+   * - es: Spanish
+   * - fr: French.
    * 
    * @example
-   * spanish
+   * en
    */
   lang?: string;
   /**
    * @remarks
-   * The number of the page to return. Valid values: 1 to 200. Default value: 1.
+   * The page number. Default value: 1. Minimum value: 1. Maximum value: 200.
    * 
    * @example
    * 1
@@ -31,7 +38,7 @@ export class ListDiagnoseReportIdsRequest extends $dara.Model {
   page?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Valid values: 1 to 500. Default value: 10.
+   * The number of report IDs per page. Default value: 10. Minimum value: 1. Maximum value: 500.
    * 
    * @example
    * 15
@@ -39,7 +46,9 @@ export class ListDiagnoseReportIdsRequest extends $dara.Model {
   size?: number;
   /**
    * @remarks
-   * The beginning of the time range to query. The value must be a UNIX timestamp.
+   * The start timestamp of the query.
+   * Minimum value: 1000000000000 ms
+   * Maximum value: 2000000000000 ms.
    * 
    * This parameter is required.
    * 
@@ -49,7 +58,7 @@ export class ListDiagnoseReportIdsRequest extends $dara.Model {
   startTime?: number;
   /**
    * @remarks
-   * The method that is used to trigger health diagnostics. Valid values: SYSTEM, INNER, and USER.
+   * The trigger method of the health diagnostics. Valid values: SYSTEM (automatically triggered by the system), INNER (internally triggered), and USER (manually triggered by the user).
    * 
    * @example
    * SYSTEM

package/src/models/ListDiagnoseReportIdsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListDiagnoseReportIdsResponseBodyHeaders extends $dara.Model {
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of records returned.
    * 
    * @example
    * 1
@@ -35,7 +35,7 @@ export class ListDiagnoseReportIdsResponseBodyHeaders extends $dara.Model {
 export class ListDiagnoseReportIdsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The header of the response.
+   * The response headers.
    */
   headers?: ListDiagnoseReportIdsResponseBodyHeaders;
   /**
@@ -46,6 +46,10 @@ export class ListDiagnoseReportIdsResponseBody extends $dara.Model {
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned results.
+   */
   result?: string[];
   static names(): { [key: string]: string } {
     return {