@alicloud/elasticsearch20170613 4.3.1 → 4.3.2

package/src/models/OpenHttpsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class OpenHttpsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
@@ -13,10 +13,10 @@ export class OpenHttpsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return results:
+   * The returned result. Valid values:
    * 
-   * *   true: open the HTTPS protocol successfully
-   * *   false: open the HTTPS protocol failed
+   * - true: The HTTPS protocol is enabled.
+   * - false: The HTTPS protocol failed to be enabled.
    * 
    * @example
    * true

package/src/models/PaymentInfo.ts

@@ -4,21 +4,39 @@ import * as $dara from '@darabonba/typescript';
 
 export class PaymentInfo extends $dara.Model {
   /**
+   * @remarks
+   * The auto-renewal cycle. Unit: month. This parameter is required when **isAutoRenew** is set to **true**. The valid values are the same as those on the buy page.
+   * 
    * @example
    * 3
    */
   autoRenewDuration?: number;
   /**
+   * @remarks
+   * The subscription duration. This parameter is required. You can specify the duration in months or years.
+   * 
    * @example
    * 1
    */
   duration?: number;
   /**
+   * @remarks
+   * Specifies whether to enable auto-renewal. Valid values:
+   * 
+   * - true: enabled.
+   * - false (default): disabled.
+   * 
    * @example
    * true
    */
   isAutoRenew?: boolean;
   /**
+   * @remarks
+   * The unit of the subscription duration. This parameter is required. Valid values:
+   * 
+   * - Year: year
+   * - Month: month.
+   * 
    * @example
    * Month
    */

package/src/models/PluginAnalysisRequest.ts

@@ -4,6 +4,11 @@ import * as $dara from '@darabonba/typescript';
 
 export class PluginAnalysisRequest extends $dara.Model {
   /**
+   * @remarks
+   * Request body parameters  
+   * 
+   * ```json
+   * 
    * @example
    * {
    *     "name": "plugin_name.zip",// plugin name
@@ -15,6 +20,12 @@ export class PluginAnalysisRequest extends $dara.Model {
    */
   body?: string;
   /**
+   * @remarks
+   * Whether to perform pre-upgrade validation:  
+   * 
+   * - true: Validate only  
+   * - false: Upload directly
+   * 
    * @example
    * false
    */

package/src/models/PluginAnalysisResponseBody.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class PluginAnalysisResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * Plugin Description.
+   * 
    * @example
    * plugin description
    */
   description?: string;
   /**
+   * @remarks
+   * Plugin version.
+   * 
    * @example
    * 8.17.0
    */
   elasticsearchVersion?: string;
   /**
+   * @remarks
+   * Plugin Name.
+   * 
    * @example
    * plugin_name
    */
   name?: string;
   /**
+   * @remarks
+   * Plugin security policy.
+   * 
    * @example
    * null
    */
   securityPolicy?: string;
   /**
+   * @remarks
+   * Plugin Version.
+   * 
    * @example
    * 8.17.0
    */
@@ -60,12 +75,16 @@ export class PluginAnalysisResponseBodyResult extends $dara.Model {
 export class PluginAnalysisResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Return Result.
+   */
   result?: PluginAnalysisResponseBodyResult[];
   static names(): { [key: string]: string } {
     return {

package/src/models/PostEmonTryAlarmRuleResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class PostEmonTryAlarmRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * ""
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the alert message was sent. Valid values: true (sent) and false (failed to send).
+   * 
    * @example
    * true
    */

package/src/models/ReadWritePolicy.ts

@@ -4,16 +4,39 @@ import * as $dara from '@darabonba/typescript';
 
 export class ReadWritePolicy extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to automatically generate a document hash primary key when no primary key exists. Valid values:
+   * 
+   * - true (default): automatically generates a primary key.
+   * - false: does not automatically generate a primary key.
+   * 
+   * >Notice:  autoGeneratePk cannot be modified independently. The autoGeneratePk setting takes effect only when writeHa is changed from false to true.
+   * .
+   * 
    * @example
    * true
    */
   autoGeneratePk?: boolean;
   /**
+   * @remarks
+   * Specifies whether to enable the write high-availability feature. Valid values:
+   * 
+   * - true: enabled.
+   * - false: not enabled.
+   * 
    * @example
    * true
    */
   writeHa?: boolean;
   /**
+   * @remarks
+   * Temporarily switches between synchronous and asynchronous high availability. Valid values:
+   * 
+   * - sync: temporarily switches from asynchronous write high availability to synchronous write.
+   * - async: restores asynchronous write high availability after synchronous write is temporarily enabled.
+   * 
+   * > This field takes effect only when high availability is enabled, that is, writeHa is set to true. You do not need to pass in the writeHa field when setting this field.
+   * 
    * @example
    * sync
    */

package/src/models/RecommendTemplatesRequest.ts

@@ -5,15 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class RecommendTemplatesRequest extends $dara.Model {
   /**
    * @remarks
-   * *
-   * *
-   * *
-   * *
-   * *
+   * The scenario-specific templatetype used by the cluster. Valid values:
    * 
-   * **
+   * - general: general-purpose scenario
+   * - analysisVisualization: data analytics scenario
+   * - dbAcceleration: database acceleration scenario
+   * - search: search scenario
+   * - log: log scenario
    * 
-   * ****
+   * > Commercial model instances support the general-purpose, data analytics, database acceleration, and search scenarios. Advanced Edition instances support only the log scenario.
    * 
    * This parameter is required.
    * 

package/src/models/RecommendTemplatesResponseBody.ts

@@ -4,20 +4,22 @@ import * as $dara from '@darabonba/typescript';
 
 export class RecommendTemplatesResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * The template configuration 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: cluster static configuration
+   * - dynamicSettings: cluster dynamic configuration
+   * - indexTemplate: index template configuration
+   * - ilmPolicy: index lifecycle configuration
    * 
-   * **
-   * 
-   * ****
+   * > Advanced Edition instances of version 6.7.0 or later support enabling the index lifecycle template.
    * 
    * @example
    * dynamicSettings
@@ -48,10 +50,17 @@ export class RecommendTemplatesResponseBodyResult extends $dara.Model {
 
 export class RecommendTemplatesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 66B060CF-7381-49C7-9B89-7757927FDA16
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned results.
+   */
   result?: RecommendTemplatesResponseBodyResult[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ReinstallCollectorRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ReinstallCollectorRequest extends $dara.Model {
   /**
    * @remarks
-   * The request body parameters. For more information, see the Request body section in this topic.
+   * 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
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
@@ -13,10 +13,7 @@ export class ReinstallCollectorRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * Indicates whether the shipper is installed. Valid values:
-   * 
-   * *   true: The shipper is installed.
-   * *   false: The shipper fails to be installed.
+   * The request body parameters. For more information, see the following RequestBody section.
    * 
    * @example
    * {

package/src/models/ReinstallCollectorResponseBody.ts

@@ -4,13 +4,19 @@ import * as $dara from '@darabonba/typescript';
 
 export class ReinstallCollectorResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request result. Valid values:
+   * 
+   * - true: The installation succeeded.
+   * - false: The installation failed.
    * 
    * @example
    * true

package/src/models/RemovePluginRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class RemovePluginRequest extends $dara.Model {
   /**
+   * @remarks
+   * Request body.
+   * 
    * @example
    * [
    *   {

package/src/models/RemovePluginResponseBody.ts

@@ -5,13 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class RemovePluginResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Return Result
+   * 
    * @example
    * true
    */

package/src/models/RenewInstanceRequest.ts

@@ -6,7 +6,7 @@ export class RenewInstanceRequest extends $dara.Model {
   body?: string;
   /**
    * @remarks
-   * This parameter is used to ensure the idempotence 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 value must be unique across different requests and can contain up to 64 ASCII characters.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B350****

package/src/models/RenewInstanceResponseBody.ts

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

package/src/models/RenewLogstashRequest.ts

@@ -6,7 +6,7 @@ export class RenewLogstashRequest 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 generated by the client to ensure 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/RenewLogstashResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RenewLogstashResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DC****
@@ -15,8 +15,8 @@ export class RenewLogstashResponseBody extends $dara.Model {
    * @remarks
    * The returned result. Valid values:
    * 
-   * *   true: The cluster is renewed.
-   * *   false: The cluster fails to be renewed.
+   * - true: The renewal was successful.
+   * - false: The renewal failed.
    * 
    * @example
    * true

package/src/models/RestartCollectorRequest.ts

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

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RestartCollectorResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 84B4038A-AF38-4BF4-9FAD-EA92A4FFF00A
@@ -13,10 +13,10 @@ export class RestartCollectorResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the shipper is restarted. Valid values:
+   * The returned result. Valid values:
    * 
-   * *   true: The shipper is restarted.
-   * *   false: The shipper fails to be restarted.
+   * - true: The restart was successful.
+   * - false: The restart failed.
    * 
    * @example
    * true

package/src/models/RestartInstanceRequest.ts

@@ -3,10 +3,26 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class RestartInstanceRequest extends $dara.Model {
+  /**
+   * @example
+   * 1. restart nodes example:
+   * {
+   *   "restartType": "nodeIp",
+   *   "nodes": [
+   *     "es-cn-xx-data-j-0"
+   *   ],
+   *   "blueGreenDep": false
+   * }
+   * 2. restart instance example:
+   * {
+   *   "restartType": "instance",
+   *   "blueGreenDep": false
+   * }
+   */
   body?: string;
   /**
    * @remarks
-   * A unique token generated by the client to guarantee the idempotency of the request. The maximum length of the token is 64 ASCII characters.
+   * 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****
@@ -14,7 +30,7 @@ export class RestartInstanceRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * Specifies whether to ignore the status of the instance and forcibly restart the instance.
+   * Specifies whether to forcefully restart the cluster regardless of the cluster status.
    * 
    * @example
    * false