@alicloud/elasticsearch20170613 4.3.1 → 4.3.2

package/src/models/CloseHttpsRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CloseHttpsRequest extends $dara.Model {
   /**
+   * @remarks
+   * A unique token used to ensure idempotence of the request. The client generates this value. The value must be unique across different requests and can contain a maximum of 64 ASCII characters.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B350****
    */

package/src/models/CloseHttpsResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class CloseHttpsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DC****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The returned result. Valid values:
+   * 
+   * - true: The HTTPS protocol is disabled.
+   * - false: The HTTPS protocol failed to be disabled.
+   * 
    * @example
    * true
    */

package/src/models/CloseManagedIndexRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CloseManagedIndexRequest extends $dara.Model {
   /**
    * @remarks
-   * Used to ensure the idempotency of the request. Generated by the client, it must be unique across different requests and not exceed 64 ASCII characters.
+   * A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but 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/CloseManagedIndexResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CloseManagedIndexResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
@@ -13,11 +13,11 @@ export class CloseManagedIndexResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the index\\"s cloud management has been successfully closed:
+   * Indicates whether the cloud managed feature for the index is disabled. Valid values:
    * 
-   * - true: Success
+   * - true: The feature is disabled.
    * 
-   * - false: Failure
+   * - false: The feature failed to be disabled.
    * 
    * @example
    * true

package/src/models/CreateCollectorRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCollectorRequestConfigs extends $dara.Model {
   /**
    * @remarks
+   * The file content.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class CreateCollectorRequestConfigs extends $dara.Model {
   content?: string;
   /**
    * @remarks
+   * The file name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -43,14 +47,25 @@ export class CreateCollectorRequestConfigs extends $dara.Model {
 }
 
 export class CreateCollectorRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The collection paths of fileBeat. This parameter is required only when the collector is deployed on ECS instances.
+   */
   collectorPaths?: string[];
   /**
    * @remarks
+   * The configuration file information of the collector.
+   * 
    * This parameter is required.
    */
   configs?: CreateCollectorRequestConfigs[];
   /**
    * @remarks
+   * Specifies whether to perform only a dry run without performing the actual request. This parameter is used only when you create or update a collector. Valid values:
+   * 
+   * - true: performs only a dry run without creating or updating the collector.
+   * - false: performs a dry run and sends the request.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -59,11 +74,15 @@ export class CreateCollectorRequest extends $dara.Model {
   dryRun?: boolean;
   /**
    * @remarks
+   * The extended configurations of the collector.
+   * 
    * This parameter is required.
    */
   extendConfigs?: { [key: string]: any }[];
   /**
    * @remarks
+   * The name of the collector. The name must be 1 to 30 characters in length, start with an uppercase or lowercase letter, and can contain letters, digits, underscores (_), or hyphens (-).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -72,6 +91,8 @@ export class CreateCollectorRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
+   * The type of the collector. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -80,6 +101,10 @@ export class CreateCollectorRequest extends $dara.Model {
   resType?: string;
   /**
    * @remarks
+   * The version of the collector. Valid values:
+   * - ECS-based deployment: 6.8.5_with_community
+   * - ACK-based deployment: 6.8.13_with_community.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -88,6 +113,8 @@ export class CreateCollectorRequest extends $dara.Model {
   resVersion?: string;
   /**
    * @remarks
+   * The ID of the virtual private cloud (VPC) where the collector resides.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -96,7 +123,7 @@ export class CreateCollectorRequest extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
-   * The ID of the created crawer.
+   * 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/CreateCollectorResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateCollectorResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the collector that is created.
+   * 
    * @example
    * ct-cn-4135is2tj194p****
    */
@@ -31,10 +34,17 @@ export class CreateCollectorResponseBodyResult extends $dara.Model {
 
 export class CreateCollectorResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 8466BDFB-C513-4B8D-B4E3-5AB256AB****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   result?: CreateCollectorResponseBodyResult;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateComponentIndexRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateComponentIndexRequestTemplate extends $dara.Model {
   /**
+   * @remarks
+   * The aliases configuration of the template.
+   * 
    * @example
    * {}
    */
   aliases?: { [key: string]: any };
   /**
+   * @remarks
+   * The mappings configuration of the template.
+   * 
    * @example
    * { 			"properties": { 				"@timestamp": { 					"type": "date" 				} 			} 		}
    */
   mappings?: { [key: string]: any };
   /**
+   * @remarks
+   * The settings configuration of the template.
+   * 
    * @example
    * { 			"index.number_of_replicas": 0 		}
    */
@@ -54,10 +63,17 @@ export class CreateComponentIndexRequestTemplate extends $dara.Model {
 
 export class CreateComponentIndexRequest extends $dara.Model {
   /**
+   * @remarks
+   * The metadata, which is used to store information such as remarks.
+   * 
    * @example
    * {       "description": "set number of shards to one"   }
    */
   meta?: { [key: string]: any };
+  /**
+   * @remarks
+   * The composable template information.
+   */
   template?: CreateComponentIndexRequestTemplate;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateComponentIndexResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateComponentIndexResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C20022BA-5382-4339-89FB-30AF48A05431
    */
   requestId?: string;
   /**
+   * @remarks
+   * The returned result. Valid values:
+   * 
+   * - true: The template was created successfully.
+   * - false: The template failed to be created.
+   * 
    * @example
    * true
    */

package/src/models/CreateDataStreamRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateDataStreamRequest extends $dara.Model {
   /**
+   * @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***
    */

package/src/models/CreateDataStreamResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateDataStreamResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * The data stream name.
+   * 
    * @example
    * ds-
    */
@@ -31,10 +34,17 @@ export class CreateDataStreamResponseBodyResult extends $dara.Model {
 
 export class CreateDataStreamResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The name of the created data stream.
+   */
   result?: CreateDataStreamResponseBodyResult;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateIlmpolicyRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateILMPolicyRequest extends $dara.Model {
   /**
+   * @remarks
+   * A unique token used to ensure the idempotence of the request. The client generates this value. The value must be unique among different requests and can contain a maximum of 64 ASCII characters.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */

package/src/models/CreateIlmpolicyResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateILMPolicyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The name of the lifecycle policy that is created.
+   * 
    * @example
    * my-policy
    */

package/src/models/CreateIndexTemplateRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateIndexTemplateRequestTemplate extends $dara.Model {
   /**
+   * @remarks
+   * The aliases configuration.
+   * 
    * @example
    * {\\"mydata\\":{}}
    */
   aliases?: string;
   /**
+   * @remarks
+   * The mappings configuration.
+   * 
    * @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.
+   * 
    * @example
    * {\\"index.number_of_shards\\":\\"1\\"}
    */
@@ -45,12 +54,20 @@ export class CreateIndexTemplateRequestTemplate extends $dara.Model {
 
 export class CreateIndexTemplateRequest extends $dara.Model {
   /**
+   * @remarks
+   * 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 be up to 64 ASCII characters in length.
+   * 
    * @example
    * E1136AE9-4E49-4585-9358-6FDD2A6D****
    */
   clientToken?: string;
   /**
    * @remarks
+   * Specifies whether to enable data streams. Valid values:
+   * 
+   * - true: enabled.
+   * - false (default): disabled.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -58,17 +75,24 @@ export class CreateIndexTemplateRequest extends $dara.Model {
    */
   dataStream?: boolean;
   /**
+   * @remarks
+   * The Policy Name of the index lifecycle management (ILM) epoch.
+   * 
    * @example
    * policy-1
    */
   ilmPolicy?: string;
   /**
    * @remarks
+   * The index pattern for matching indexes.
+   * 
    * This parameter is required.
    */
   indexPatterns?: string[];
   /**
    * @remarks
+   * The name of the index template.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -76,10 +100,17 @@ export class CreateIndexTemplateRequest extends $dara.Model {
    */
   indexTemplate?: string;
   /**
+   * @remarks
+   * The priority of the cluster index template.
+   * 
    * @example
    * 30
    */
   priority?: number;
+  /**
+   * @remarks
+   * The template settings. For more information, see [Multiple Component Templates](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html#multiple-component-templates).
+   */
   template?: CreateIndexTemplateRequestTemplate;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateIndexTemplateResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateIndexTemplateResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The name of the created cluster index template.
+   * 
    * @example
    * index-template
    */

package/src/models/CreateInstanceRequest.ts

@@ -11,7 +11,21 @@ import { WarmNodeConfiguration } from "./WarmNodeConfiguration";
 
 
 export class CreateInstanceRequestTags extends $dara.Model {
+  /**
+   * @remarks
+   * The tag key of the instance.
+   * 
+   * @example
+   * KeyTest
+   */
   tagKey?: string;
+  /**
+   * @remarks
+   * The tag value of the instance.
+   * 
+   * @example
+   * KeyValue
+   */
   tagValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -37,23 +51,48 @@ export class CreateInstanceRequestTags extends $dara.Model {
 }
 
 export class CreateInstanceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Coordinating node configuration.
+   */
   clientNodeConfiguration?: ClientNodeConfiguration;
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * es
    */
   description?: string;
+  /**
+   * @remarks
+   * Elastic node configuration.
+   */
   elasticDataNodeConfiguration?: ElasticDataNodeConfiguration;
   /**
    * @remarks
+   * The access password of the instance. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=). The password must be 8 to 32 characters in length.
+   * 
    * This parameter is required.
    * 
    * @example
-   * es_password
+   * Es_password
    */
   esAdminPassword?: string;
   /**
    * @remarks
+   * The instance version. Valid values:
+   * - 8.5.1_with_X-Pack
+   * - 7.10_with_X-Pack
+   * - 6.7_with_X-Pack
+   * - 7.7_with_X-Pack
+   * - 6.8_with_X-Pack
+   * - 6.3_with_X-Pack
+   * - 5.6_with_X-Pack
+   * - 5.5.3_with_X-Pack
+   * 
+   * > The versions listed above may not include all versions supported by Elasticsearch instances. You can call the [GetRegionConfiguration](https://help.aliyun.com/document_detail/254099.html) operation to view the actually supported versions.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -61,45 +100,100 @@ export class CreateInstanceRequest extends $dara.Model {
    */
   esVersion?: string;
   /**
+   * @remarks
+   * The edition type:
+   * - x-pack: creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
+   * - IS: creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
+   * 
    * @example
    * advanced
    */
   instanceCategory?: string;
+  /**
+   * @remarks
+   * Kibana node configuration.
+   * 
+   * > We strongly recommend that you enable the Kibana node.
+   */
   kibanaConfiguration?: KibanaNodeConfiguration;
+  /**
+   * @remarks
+   * Dedicated master node configuration.
+   * > In the Beijing, Shanghai, Hangzhou, and Shenzhen regions, when you use createInstance to create an instance with next-generation cloud disk dedicated master nodes, you must specify the instance family with the `.new` suffix, for example, elasticsearch.sn1ne.large.new.
+   */
   masterConfiguration?: MasterNodeConfiguration;
   /**
    * @remarks
+   * Network configuration.
+   * 
+   * > Specifying IP whitelists is not supported when creating an instance.
+   * 
    * This parameter is required.
    */
   networkConfig?: NetworkConfig;
   /**
    * @remarks
+   * The number of data nodes. Valid values: 2 to 50.
+   * 
    * This parameter is required.
    * 
    * @example
    * 3
    */
   nodeAmount?: number;
+  /**
+   * @remarks
+   * Data node configuration.
+   * 
+   * > In the Beijing, Shanghai, Hangzhou, and Shenzhen regions, when you use createInstance to create an instance with next-generation cloud disk data nodes, you must specify the instance family with the `.new` suffix, for example, elasticsearch.sn1ne.large.new.
+   */
   nodeSpec?: NodeSpec;
+  /**
+   * @remarks
+   * The billing details of the subscription instance. This parameter is required when you create a subscription instance.
+   */
   paymentInfo?: PaymentInfo;
   /**
+   * @remarks
+   * The billing method. Valid values:
+   * 
+   * - postpaid: pay-as-you-go.
+   * - prepaid: subscription.
+   * 
    * @example
    * postpaid
    */
   paymentType?: string;
   /**
+   * @remarks
+   * The ID of the resource group to which the instance belongs.
+   * 
    * @example
-   * rg-aekzu7tsu4nem4q
+   * rg-aekzu7tsu4n****
    */
   resourceGroupId?: string;
+  /**
+   * @remarks
+   * Instance tags.
+   */
   tags?: CreateInstanceRequestTags[];
+  /**
+   * @remarks
+   * Cold data node configuration.
+   */
   warmNodeConfiguration?: WarmNodeConfiguration;
   /**
+   * @remarks
+   * The number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
+   * 
    * @example
    * 2
    */
   zoneCount?: number;
   /**
+   * @remarks
+   * Used to ensure the idempotency of the request. The parameter value is generated by the client and must be unique across different requests. The value cannot exceed 64 ASCII characters.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */