@alicloud/elasticsearch20170613 4.3.0 → 4.3.2

package/src/models/DescribeKibanaSettingsResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeKibanaSettingsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6D*****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Some configurable Kibana settings. For more information, see [Kibana settings](https://www.elastic.co/guide/cn/kibana/current/settings.html).
+   * 
    * @example
    * {"map.includeElasticMapsService": "false", "server.ssl.cert": "/home/admin/packages/kibana/config/cert/client.crt", "server.ssl.enabled": "true", "server.ssl.key": "/home/admin/packages/kibana/config/cert/client.key", "xpack.reporting.capture.browser.chromium.disableSandbox": "true"}
    */

package/src/models/DescribeLogstashResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeLogstashResponseBodyResultTags extends $dara.Model {
   /**
    * @remarks
-   * The value of the tag.
+   * The tag key.
    * 
    * @example
    * env
@@ -13,7 +13,7 @@ export class DescribeLogstashResponseBodyResultTags extends $dara.Model {
   tagKey?: string;
   /**
    * @remarks
-   * The information about the zones.
+   * The tag value.
    * 
    * @example
    * dev
@@ -45,7 +45,10 @@ export class DescribeLogstashResponseBodyResultTags extends $dara.Model {
 export class DescribeLogstashResponseBodyResultZoneInfos extends $dara.Model {
   /**
    * @remarks
-   * The zone ID of the new instance.
+   * The status of the zone. Valid values:
+   * 
+   * - ISOLATION: offline.
+   * - NORMAL: Normal.
    * 
    * @example
    * NORMAL
@@ -53,7 +56,7 @@ export class DescribeLogstashResponseBodyResultZoneInfos extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The configuration of cluster extension parameters.
+   * The zone ID.
    * 
    * @example
    * cn-hangzhou-b
@@ -85,7 +88,7 @@ export class DescribeLogstashResponseBodyResultZoneInfos extends $dara.Model {
 export class DescribeLogstashResponseBodyResultEndpointList extends $dara.Model {
   /**
    * @remarks
-   * The tags added to the ALB instance.
+   * The IP address of the node.
    * 
    * @example
    * ``172.16.**.**``
@@ -93,7 +96,7 @@ export class DescribeLogstashResponseBodyResultEndpointList extends $dara.Model
   host?: string;
   /**
    * @remarks
-   * The IP address of the node.
+   * The port number.
    * 
    * @example
    * 9600
@@ -101,7 +104,7 @@ export class DescribeLogstashResponseBodyResultEndpointList extends $dara.Model
   port?: string;
   /**
    * @remarks
-   * The port number.
+   * The zone ID of the node.
    * 
    * @example
    * cn-hangzhou-b
@@ -135,7 +138,7 @@ export class DescribeLogstashResponseBodyResultEndpointList extends $dara.Model
 export class DescribeLogstashResponseBodyResultNetworkConfig extends $dara.Model {
   /**
    * @remarks
-   * The ID of the vSwitch to which the instance is connected.
+   * The network type. Currently, only Virtual Private Cloud (VPC) is supported.
    * 
    * @example
    * vpc
@@ -143,7 +146,7 @@ export class DescribeLogstashResponseBodyResultNetworkConfig extends $dara.Model
   type?: string;
   /**
    * @remarks
-   * The zone where the cluster resides.
+   * The VPC ID.
    * 
    * @example
    * vpc-bp16k1dvzxtmagcva****
@@ -151,13 +154,16 @@ export class DescribeLogstashResponseBodyResultNetworkConfig extends $dara.Model
   vpcId?: string;
   /**
    * @remarks
-   * The network type of the instance. Valid values: Currently, only Virtual Private Cloud (VPC) are supported.
+   * The zone in which the instance resides.
    * 
    * @example
    * cn-hangzhou-*
    */
   vsArea?: string;
   /**
+   * @remarks
+   * The vSwitch ID.
+   * 
    * @example
    * vsw-bp1k4ec6s7sjdbudw****
    */
@@ -192,10 +198,7 @@ export class DescribeLogstashResponseBodyResultNetworkConfig extends $dara.Model
 export class DescribeLogstashResponseBodyResultNodeSpec extends $dara.Model {
   /**
    * @remarks
-   * Whether to use disk encryption:
-   * 
-   * *   true
-   * *   false
+   * The disk size of the node.
    * 
    * @example
    * 20
@@ -203,7 +206,10 @@ export class DescribeLogstashResponseBodyResultNodeSpec extends $dara.Model {
   disk?: number;
   /**
    * @remarks
-   * The disk type of the node.
+   * Indicates whether cloud disk encryption is enabled. Valid values:
+   * 
+   * - true: Enabled.
+   * - false: Disabled.
    * 
    * @example
    * true
@@ -211,7 +217,7 @@ export class DescribeLogstashResponseBodyResultNodeSpec extends $dara.Model {
   diskEncryption?: boolean;
   /**
    * @remarks
-   * The network configurations.
+   * The disk type of the node.
    * 
    * @example
    * cloud_ssd
@@ -219,7 +225,7 @@ export class DescribeLogstashResponseBodyResultNodeSpec extends $dara.Model {
   diskType?: string;
   /**
    * @remarks
-   * The disk size of the node.
+   * The specification of the node.
    * 
    * @example
    * elasticsearch.sn1ne.large
@@ -253,14 +259,10 @@ export class DescribeLogstashResponseBodyResultNodeSpec extends $dara.Model {
 }
 
 export class DescribeLogstashResponseBodyResult extends $dara.Model {
-  /**
-   * @remarks
-   * The configuration information of the node.
-   */
   extendConfigs?: { [key: string]: any }[];
   /**
    * @remarks
-   * The number of data nodes.
+   * The ID of the resource group to which the instance belongs.
    * 
    * @example
    * rg-aekzvowej3i****
@@ -268,23 +270,17 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The key of the tag.
+   * The instance labels.
    */
   tags?: DescribeLogstashResponseBodyResultTags[];
   /**
    * @remarks
-   * The status of the zone. Valid values:
-   * 
-   * *   ISOLATION: offline
-   * *   NORMAL
+   * The zone information.
    */
   zoneInfos?: DescribeLogstashResponseBodyResultZoneInfos[];
   /**
    * @remarks
-   * The billing method of the instance. Valid values:
-   * 
-   * *   prepaid: subscription
-   * *   postpaid: pay-as-you-go
+   * The instance configuration.
    * 
    * @example
    * {"slowlog.threshold.warn": "2s","slowlog.threshold.info": "1s","slowlog.threshold.debug": "500ms","slowlog.threshold.trace": "100ms" }
@@ -292,12 +288,7 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   config?: { [key: string]: any };
   /**
    * @remarks
-   * The state of the instance. Four states are supported:
-   * 
-   * *   Normal: active
-   * *   Active: activating
-   * *   Freeze: inactive
-   * *   Invalid: invalid
+   * The time when the instance was created.
    * 
    * @example
    * 2020-02-06T14:12:03.672Z
@@ -305,7 +296,7 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   createdAt?: string;
   /**
    * @remarks
-   * The time when the instance was created.
+   * The name of the instance.
    * 
    * @example
    * ls-cn-abc
@@ -314,12 +305,12 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * The ID of the zone where the node resides.
+   * The access information of the nodes.
    */
   endpointList?: DescribeLogstashResponseBodyResultEndpointList[];
   /**
    * @remarks
-   * The access information of the node.
+   * The instance ID.
    * 
    * @example
    * ls-cn-abc
@@ -327,12 +318,12 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the virtual private cloud (VPC).
+   * The network configuration.
    */
   networkConfig?: DescribeLogstashResponseBodyResultNetworkConfig;
   /**
    * @remarks
-   * The name of the instance.
+   * The number of nodes in the instance.
    * 
    * @example
    * 2
@@ -340,12 +331,15 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   nodeAmount?: number;
   /**
    * @remarks
-   * The specifications of the node.
+   * The configuration of the node.
    */
   nodeSpec?: DescribeLogstashResponseBodyResultNodeSpec;
   /**
    * @remarks
-   * The ID of the resource group to which the instance belongs.
+   * The billing method of the instance. Valid values:
+   * 
+   * - prepaid: subscription
+   * - postpaid: pay-as-you-go.
    * 
    * @example
    * prepaid
@@ -353,7 +347,12 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   paymentType?: string;
   /**
    * @remarks
-   * The ID of the virtual private cloud (VPC) to which the elastic container instances belong.
+   * The status of the instance. Valid values:
+   * 
+   * - active: Normal.
+   * - activating: Taking effect.
+   * - inactive: Frozen.
+   * - invalid: Expired.
    * 
    * @example
    * active
@@ -361,7 +360,7 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The edition of the dedicated KMS instance.
+   * The time when the instance was last updated.
    * 
    * @example
    * 2020-02-06T14:22:36.850Z
@@ -369,7 +368,7 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   updatedAt?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The version of the instance.
    * 
    * @example
    * 7.4.0_with_X-Pack
@@ -377,7 +376,7 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
   version?: string;
   /**
    * @remarks
-   * The time when the instance was last updated.
+   * The ID of the VPC to which the instance belongs.
    * 
    * @example
    * vpc-bp16k1dvzxtmagcva****
@@ -462,7 +461,7 @@ export class DescribeLogstashResponseBodyResult extends $dara.Model {
 export class DescribeLogstashResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Detailed information about the instance.
+   * The request ID.
    * 
    * @example
    * C9334241-4837-46C2-B24B-9BDC517318DE
@@ -470,7 +469,7 @@ export class DescribeLogstashResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The configurations of the instance.
+   * The details of the instance.
    */
   result?: DescribeLogstashResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/DescribePipelineManagementConfigRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePipelineManagementConfigRequest 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****

package/src/models/DescribePipelineManagementConfigResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePipelineManagementConfigResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The access addresses of the Elasticsearch cluster. Specify each address in the `http://Endpoint of the Elasticsearch cluster:Port number` format.
+   * The list of access endpoints for the Elasticsearch instance, in the format of `domain name:port number`.
    * 
    * @example
    * ["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]
@@ -13,7 +13,7 @@ export class DescribePipelineManagementConfigResponseBodyResult extends $dara.Mo
   endpoints?: string;
   /**
    * @remarks
-   * The ID of the Elasticsearch cluster.
+   * The Elasticsearch instance ID.
    * 
    * @example
    * es-cn-n6w1o1x0w001c****
@@ -30,7 +30,7 @@ export class DescribePipelineManagementConfigResponseBodyResult extends $dara.Mo
   pipelineManagementType?: string;
   /**
    * @remarks
-   * The username that is used to access the Elasticsearch cluster.
+   * The username used to access the instance.
    * 
    * @example
    * elastic
@@ -71,7 +71,7 @@ export class DescribePipelineManagementConfigResponseBodyResult extends $dara.Mo
 export class DescribePipelineManagementConfigResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

package/src/models/DescribePipelineResponseBody.ts

@@ -5,20 +5,23 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePipelineResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The time when the pipeline was created.
+   * The batch delay of the pipeline. Unit: milliseconds.
    * 
    * @example
    * 50
    */
   batchDelay?: number;
   /**
+   * @remarks
+   * The batch size of the pipeline.
+   * 
    * @example
    * 125
    */
   batchSize?: number;
   /**
    * @remarks
-   * The description of the pipeline.
+   * The specific configuration of the pipeline.
    * 
    * @example
    * input {  }  filter {  }  output {  }
@@ -26,24 +29,23 @@ export class DescribePipelineResponseBodyResult extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * The state of the MPS queue. Valid values:
-   * 
-   * *   NOT_DEPLOYED: The node is not deployed.
-   * *   RUNNING
-   * *   DELETED: Deleted. The console does not display this status.
+   * The pipeline description.
    * 
    * @example
    * this is a test
    */
   description?: string;
   /**
+   * @remarks
+   * The time when the pipeline was created.
+   * 
    * @example
    * 2020-06-20T07:26:47.000+0000
    */
   gmtCreatedTime?: string;
   /**
    * @remarks
-   * The total capacity of the queue in bytes. Unit: MB.
+   * The time when the pipeline was last updated.
    * 
    * @example
    * 2020-06-20T07:26:47.000+0000
@@ -51,20 +53,27 @@ export class DescribePipelineResponseBodyResult extends $dara.Model {
   gmtUpdateTime?: string;
   /**
    * @remarks
-   * Number of queue checkpoint writes.
+   * 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
    * RUNNING
    */
   pipelineStatus?: string;
   /**
    * @remarks
-   * Pipeline batch delay. Unit: milliseconds.
+   * The number of queue checkpoint writes.
    * 
    * @example
    * 1024
@@ -72,7 +81,7 @@ export class DescribePipelineResponseBodyResult extends $dara.Model {
   queueCheckPointWrites?: number;
   /**
    * @remarks
-   * The number of pipeline workers.
+   * The total capacity of the queue, in bytes. Unit: MB.
    * 
    * @example
    * 1024
@@ -80,7 +89,10 @@ export class DescribePipelineResponseBodyResult extends $dara.Model {
   queueMaxBytes?: number;
   /**
    * @remarks
-   * The specific configuration of the pipeline.
+   * The queue type. Valid values:
+   * 
+   * - MEMORY: a traditional memory-based queue.
+   * - PERSISTED: a disk-based ACKed queue (persistent queue).
    * 
    * @example
    * MEMORY
@@ -88,7 +100,7 @@ export class DescribePipelineResponseBodyResult extends $dara.Model {
   queueType?: string;
   /**
    * @remarks
-   * The size of the pipeline batch.
+   * The number of pipeline worker threads.
    * 
    * @example
    * 2
@@ -140,7 +152,7 @@ export class DescribePipelineResponseBodyResult extends $dara.Model {
 export class DescribePipelineResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The time when the pipeline was updated.
+   * The request ID.
    * 
    * @example
    * 829F38F6-E2D6-4109-90A6-888160BD1***
@@ -148,10 +160,7 @@ export class DescribePipelineResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The type of the queue. Valid values:
-   * 
-   * *   MEMORY: a traditional memory-based queue.
-   * *   PERSISTED: disk-based ACKed queue (persistent queue).
+   * The returned pipeline information. For more information, see [logstash.yml](https://www.elastic.co/guide/en/logstash/6.7/logstash-settings-file.html).
    */
   result?: DescribePipelineResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/DescribeRegionsResponseBody.ts

@@ -4,23 +4,32 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeRegionsResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * The endpoint of the region exposed in the console.
+   * 
    * @example
    * https://elasticsearch-cn-hangzhou.console.aliyun.com
    */
   consoleEndpoint?: string;
   /**
+   * @remarks
+   * The name of the region.
+   * 
    * @example
    * China (Hangzhou)
    */
   localName?: string;
   /**
+   * @remarks
+   * The endpoint of the region.
+   * 
    * @example
    * elasticsearch.cn-hangzhou.aliyuncs.com
    */
   regionEndpoint?: string;
   /**
    * @remarks
-   * The name of the region.
+   * The region ID.
    * 
    * @example
    * cn-hangzhou
@@ -28,7 +37,7 @@ export class DescribeRegionsResponseBodyResult extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The endpoint of the region that is exposed in the console.
+   * The availability status of the region.
    * 
    * @example
    * available
@@ -66,7 +75,7 @@ export class DescribeRegionsResponseBodyResult extends $dara.Model {
 export class DescribeRegionsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The available status of the region.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1ADFG
@@ -74,7 +83,7 @@ export class DescribeRegionsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The endpoint of the region.
+   * The list of returned results.
    */
   result?: DescribeRegionsResponseBodyResult[];
   static names(): { [key: string]: string } {

package/src/models/DescribeSnapshotSettingResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSnapshotSettingResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * Whether to enable automatic backup.
+   * Indicates whether automatic backup is enabled.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class DescribeSnapshotSettingResponseBodyResult extends $dara.Model {
   enable?: boolean;
   /**
    * @remarks
-   * Automatic backup time configuration, using Quartz Cron expression.
+   * The automatic backup time configuration, specified as a Quartz Cron expression.
    * 
    * @example
    * 0 0 01 ? * * *
@@ -45,7 +45,7 @@ export class DescribeSnapshotSettingResponseBodyResult extends $dara.Model {
 export class DescribeSnapshotSettingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****
@@ -53,7 +53,7 @@ export class DescribeSnapshotSettingResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The return results.
+   * The returned result.
    */
   result?: DescribeSnapshotSettingResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/DescribeTemplatesResponseBody.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeTemplatesResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * The template content.
+   * 
    * @example
    * {\\n\\t\\"persistent\\":{\\n\\t\\t\\"search\\":{\\n\\t\\t\\t\\"max_buckets\\":\\"10000\\"\\n\\t\\t}\\n\\t}\\n}
    */
   content?: string;
   /**
+   * @remarks
+   * The template name. Valid values:
+   * - staticSettings: elasticsearch.yml configuration
+   * - ilmPolicy: index lifecycle configuration
+   * - indexTemplate: index template configuration
+   * - dynamicSettings: cluster dynamic configuration.
+   * 
    * @example
    * dynamicSettings
    */
@@ -38,10 +48,17 @@ export class DescribeTemplatesResponseBodyResult extends $dara.Model {
 
 export class DescribeTemplatesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   result?: DescribeTemplatesResponseBodyResult[];
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeXpackMonitorConfigResponseBody.ts

@@ -5,10 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeXpackMonitorConfigResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the X-Pack Monitoring feature is enabled. Valid values:
-   * 
-   * *   true: enabled
-   * *   false: disabled
+   * Indicates whether X-Pack monitoring is enabled. Valid values:
+   * - true: enabled.
+   * - false: not enabled.
    * 
    * @example
    * true
@@ -17,7 +16,7 @@ export class DescribeXpackMonitorConfigResponseBodyResult extends $dara.Model {
   endpoints?: string[];
   /**
    * @remarks
-   * The ID of the associated Elasticsearch cluster.
+   * The instance ID of the Elasticsearch instance associated with X-Pack monitoring.
    * 
    * @example
    * es-cn-n6w1o1x0w001c****
@@ -26,7 +25,7 @@ export class DescribeXpackMonitorConfigResponseBodyResult extends $dara.Model {
   pipelineIds?: string[];
   /**
    * @remarks
-   * The username that is used to access the associated Elasticsearch cluster.
+   * The username used to access the Elasticsearch instance associated with X-Pack monitoring.
    * 
    * @example
    * elastic
@@ -70,7 +69,7 @@ export class DescribeXpackMonitorConfigResponseBodyResult extends $dara.Model {
 export class DescribeXpackMonitorConfigResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****