@alicloud/elasticsearch20170613 4.3.0 → 4.3.2

package/src/models/ActivateZonesRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ActivateZonesRequest extends $dara.Model {
   /**
    * @remarks
-   * 请求体参数。
+   * The request body parameters.
    * 
    * @example
-   * ["cn-hangzhou-i","cn-hangzhou-h"]
+   * 空
    */
   body?: string;
   /**

package/src/models/ActivateZonesResponseBody.ts

@@ -13,10 +13,9 @@ export class ActivateZonesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the nodes in disabled zones are restored. Valid values:
-   * 
-   * *   true
-   * *   false
+   * The result of the operation. Valid values:
+   * - true: The zone is resumed.
+   * - false: The zone failed to be resumed.
    * 
    * @example
    * true

package/src/models/AddConnectableClusterRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class AddConnectableClusterRequest extends $dara.Model {
   /**
    * @remarks
-   * 请求体。
+   * Instance ID of the remote instance. Specifies instance ID of the remote instance with which you want to establish network connectivity. The remote instance must be in the same virtual private cloud (VPC) as the current instance.
    * 
    * @example
    * {     "instanceId":"es-cn-09k1rgid9000g****" }
@@ -13,7 +13,7 @@ export class AddConnectableClusterRequest extends $dara.Model {
   body?: string;
   /**
    * @remarks
-   * 5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*
+   * 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****

package/src/models/AddConnectableClusterResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class AddConnectableClusterResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5A5D8E74-565C-43DC-B031-29289FA****
@@ -13,10 +13,10 @@ export class AddConnectableClusterResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The following information is returned:
+   * The result. Valid values:
    * 
-   * *   true: The configuration is successful.
-   * *   false: The configuration failed.
+   * - true: The configuration succeeded.
+   * - false: The configuration failed.
    * 
    * @example
    * true

package/src/models/AddSnapshotRepoRequest.ts

@@ -3,6 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AddSnapshotRepoRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The cross-cluster backup information, which specifies the reference instance.
+   * 
+   * @example
+   * {
+   *     "repoPath" :"es-cn-4591jumei000u****"
+   * }
+   */
   body?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AddSnapshotRepoResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class AddSnapshotRepoResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
@@ -13,10 +13,10 @@ export class AddSnapshotRepoResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return results:
+   * The result. Valid values:
    * 
-   * *   true: Reference warehouse created successfully
-   * *   false: Reference warehouse created failed
+   * - true: The reference repository is created.
+   * - false: The reference repository failed to be created.
    * 
    * @example
    * true

package/src/models/CancelDeletionRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CancelDeletionRequest 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 used to ensure idempotence of the request. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/CancelDeletionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CancelDeletionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * D682B6B3-B425-46DA-A5FC-5F5C60553622
@@ -13,10 +13,10 @@ export class CancelDeletionResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the cluster is restored. Valid values:
+   * Indicates whether the instance is recovered. Valid values:
    * 
-   * *   true: The cluster is restored.
-   * *   false: The cluster fails to be restored.
+   * - true: The instance is recovered.
+   * - false: The instance failed to be recovered.
    * 
    * @example
    * true

package/src/models/CancelLogstashDeletionRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CancelLogstashDeletionRequest 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 used to ensure idempotence of the request. The client generates this value. The value must be unique among different requests and can be up to 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/CancelLogstashDeletionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CancelLogstashDeletionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 23EBF56B-2DC0-4507-8BE5-B87395DB0FEB
@@ -13,10 +13,10 @@ export class CancelLogstashDeletionResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the cluster is restored. Valid values:
+   * Indicates whether the instance is successfully resumed. Valid values:
    * 
-   * *   true: The cluster is restored.
-   * *   false: The cluster is not restored.
+   * - true: The instance is successfully resumed.
+   * - false: The instance failed to be resumed.
    * 
    * @example
    * true

package/src/models/CancelTaskRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CancelTaskRequest extends $dara.Model {
   /**
    * @remarks
-   * A unique token generated by the client to guarantee the idempotency 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.
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can be up to 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
@@ -13,7 +13,7 @@ export class CancelTaskRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The type of the data migration task. Set the value to MigrateData.
+   * The task type. Set this parameter to MigrateData, which indicates a data migration task.
    * 
    * This parameter is required.
    * 

package/src/models/CancelTaskResponseBody.ts

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

package/src/models/CapacityPlanRequest.ts

@@ -5,14 +5,14 @@ import * as $dara from '@darabonba/typescript';
 export class CapacityPlanRequestDataInfo extends $dara.Model {
   /**
    * @remarks
-   * Disk data metric code. Options:
+   * The disk data metric code. Valid values:
    * 
-   * - totalRawData: Raw data information
-   * - document: Data document information, estimated document count
-   * - dailyIncrement: Daily data growth
-   * - dailyIncrementDoc: Daily incremental document count
-   * - retentionTime: Data retention period
-   * - replica: Replica settings
+   * - totalRawData: source data information
+   * - document: data document information, estimated number of documents
+   * - dailyIncrement: daily data growth
+   * - dailyIncrement: daily incremental documents
+   * - retentionTime: data retention period
+   * - replica: replica settings.
    * 
    * @example
    * totalRawData
@@ -20,7 +20,7 @@ export class CapacityPlanRequestDataInfo extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Disk usage metric value.
+   * The metric value of disk usage.
    * 
    * @example
    * 100
@@ -28,7 +28,7 @@ export class CapacityPlanRequestDataInfo extends $dara.Model {
   size?: number;
   /**
    * @remarks
-   * Total number of data entries.
+   * The total number of data entries.
    * 
    * @example
    * 10000
@@ -36,10 +36,10 @@ export class CapacityPlanRequestDataInfo extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * Disk data type. Options:
+   * The disk data type. Valid values:
    * 
-   * - hot: Hot data
-   * - warm: Cold data
+   * - hot: hot data
+   * - warm: warm data.
    * 
    * @example
    * hot
@@ -47,10 +47,10 @@ export class CapacityPlanRequestDataInfo extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * Data or time unit. Options:
+   * The data unit or time unit. Valid values:
    * 
    * - Data units: MiB, GiB, TB, PB
-   * - Time units: DAYS, WEEKS, MONTHS, YEARS
+   * - Time units: DAYS, WEEKS, MONTHS, YEARS.
    * 
    * @example
    * MiB
@@ -88,7 +88,7 @@ export class CapacityPlanRequestDataInfo extends $dara.Model {
 export class CapacityPlanRequestMetric extends $dara.Model {
   /**
    * @remarks
-   * Average QPS.
+   * The average QPS.
    * 
    * @example
    * 30
@@ -96,10 +96,10 @@ export class CapacityPlanRequestMetric extends $dara.Model {
   averageQps?: number;
   /**
    * @remarks
-   * Search or write metric code. Options:
+   * The search or write metric code. Valid values:
    * 
-   * - write: Write
-   * - search: Search
+   * - write: write
+   * - search: search.
    * 
    * @example
    * write
@@ -107,7 +107,7 @@ export class CapacityPlanRequestMetric extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Concurrent number.
+   * The number of concurrent connections.
    * 
    * @example
    * 2
@@ -115,7 +115,7 @@ export class CapacityPlanRequestMetric extends $dara.Model {
   concurrent?: number;
   /**
    * @remarks
-   * Peak QPS.
+   * The peak QPS.
    * 
    * @example
    * 30
@@ -123,7 +123,7 @@ export class CapacityPlanRequestMetric extends $dara.Model {
   peakQps?: number;
   /**
    * @remarks
-   * Expected average response time, unit: milliseconds.
+   * The expected average response time, in milliseconds.
    * 
    * @example
    * 100
@@ -131,7 +131,7 @@ export class CapacityPlanRequestMetric extends $dara.Model {
   responseTime?: number;
   /**
    * @remarks
-   * Throughput, unit: MB/S.
+   * The throughput, in MB/s.
    * 
    * @example
    * 100
@@ -139,10 +139,10 @@ export class CapacityPlanRequestMetric extends $dara.Model {
   throughput?: number;
   /**
    * @remarks
-   * Search/write peak type. Options:
+   * The search or write peak type. Valid values:
    * 
-   * - common: Regular
-   * - peak: Peak
+   * - common: normal
+   * - peak: peak.
    * 
    * @example
    * common
@@ -184,10 +184,10 @@ export class CapacityPlanRequestMetric extends $dara.Model {
 export class CapacityPlanRequest extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether there is a need for complex aggregation queries. Options:
+   * Specifies whether complex aggregate query is required. Valid values:
    * 
-   * - true: Yes
-   * - false (default): No
+   * - true: Required.
+   * - false (default): Not required.
    * 
    * @example
    * true
@@ -195,23 +195,23 @@ export class CapacityPlanRequest extends $dara.Model {
   complexQueryAvailable?: boolean;
   /**
    * @remarks
-   * Disk usage status.
+   * The disk usage information.
    */
   dataInfo?: CapacityPlanRequestDataInfo[];
   /**
    * @remarks
-   * Metrics information including disk usage, search and write operations, aggregation requests, etc.
+   * The metric information, including disk usage, search and write operations, and aggregation requests.
    */
   metric?: CapacityPlanRequestMetric[];
   /**
    * @remarks
-   * Usage scenarios, options:
+   * Scenarios. Valid values:
    * 
-   * - general: General scenario
-   * - analysisVisualization: Data analysis scenario
-   * - dbAcceleration: Database acceleration scenario
-   * - search: Search scenario
-   * - log: Log scenario
+   * - general: general-purpose scenario
+   * - analysisVisualization: data analytics scenario
+   * - dbAcceleration: database acceleration scenario
+   * - search: search scenario
+   * - log: log scenario.
    * 
    * @example
    * general

package/src/models/CapacityPlanResponseBody.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CapacityPlanResponseBodyResultExtendConfigs extends $dara.Model {
   /**
    * @remarks
-   * Configuration type, with a single value: sharedDisk.
+   * The configuration type. The only valid value is sharedDisk.
    * 
-   * > This extendConfigs attribute may appear when the planned instance type is Advanced.
+   * > This extendConfigs property may appear when the planned instance type is Advanced Edition (advanced).
    * 
    * @example
    * sharedDisk
@@ -15,7 +15,7 @@ export class CapacityPlanResponseBodyResultExtendConfigs extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Disk size, in GiB.
+   * The disk size, in GiB.
    * 
    * @example
    * 2048
@@ -23,9 +23,9 @@ export class CapacityPlanResponseBodyResultExtendConfigs extends $dara.Model {
   disk?: number;
   /**
    * @remarks
-   * Disk type, with a single value: CPFS_PREMIUM.
+   * The disk type. The only valid value is CPFS_PREMIUM.
    * 
-   * > This extendConfigs attribute may appear when the planned instance type is Advanced.
+   * > This extendConfigs property may appear when the planned instance type is Advanced Edition (advanced).
    * 
    * @example
    * CPFS_PREMIUM
@@ -59,7 +59,7 @@ export class CapacityPlanResponseBodyResultExtendConfigs extends $dara.Model {
 export class CapacityPlanResponseBodyResultNodeConfigurations extends $dara.Model {
   /**
    * @remarks
-   * Number of nodes.
+   * The number of nodes.
    * 
    * @example
    * 10
@@ -67,7 +67,7 @@ export class CapacityPlanResponseBodyResultNodeConfigurations extends $dara.Mode
   amount?: number;
   /**
    * @remarks
-   * Number of CPUs.
+   * The number of CPUs.
    * 
    * @example
    * 1
@@ -75,7 +75,7 @@ export class CapacityPlanResponseBodyResultNodeConfigurations extends $dara.Mode
   cpu?: number;
   /**
    * @remarks
-   * Disk size, in GiB.
+   * The disk size, in GiB.
    * 
    * @example
    * 20
@@ -83,17 +83,17 @@ export class CapacityPlanResponseBodyResultNodeConfigurations extends $dara.Mode
   disk?: number;
   /**
    * @remarks
-   * Disk type, with meanings as follows:
+   * The disk type. Valid values:
    * 
-   * - cloud_essd: ESSD Cloud Disk
+   * - cloud_essd: ESSD
    * 
-   * - cloud_ssd: SSD Cloud Disk
+   * - cloud_ssd: standard SSD
    * 
-   * - cloud_efficiency: Efficient Cloud Disk
+   * - cloud_efficiency: ultra cloud disk
    * 
-   * - local_ssd: Local SSD Disk
+   * - local_ssd: local SSD
    * 
-   * - local_efficiency: Local Efficient Disk
+   * - local_efficiency: local ultra disk.
    * 
    * @example
    * cloud_ssd
@@ -101,7 +101,7 @@ export class CapacityPlanResponseBodyResultNodeConfigurations extends $dara.Mode
   diskType?: string;
   /**
    * @remarks
-   * Specified memory size for the current node role.
+   * The memory size of the specifications for the current node role.
    * 
    * @example
    * 2
@@ -109,19 +109,19 @@ export class CapacityPlanResponseBodyResultNodeConfigurations extends $dara.Mode
   memory?: number;
   /**
    * @remarks
-   * Node type, with supported types as follows:
+   * The node type. Valid values:
    * 
-   * - WORKER: Data Node
+   * - WORKER: data node
    * 
-   * - WORKER_WARM: Cold Data Node
+   * - WORKER_WARM: warm node
    * 
-   * - MASTER: Dedicated Master Node
+   * - MASTER: dedicated master node
    * 
-   * - KIBANA: Kibana Node
+   * - KIBANA: Kibana node
    * 
-   * - COORDINATING: Coordinator Node
+   * - COORDINATING: client node
    * 
-   * - ELASTIC_WORKER: Elastic Node
+   * - ELASTIC_WORKER: elastic node.
    * 
    * @example
    * WORKER
@@ -161,18 +161,18 @@ export class CapacityPlanResponseBodyResultNodeConfigurations extends $dara.Mode
 export class CapacityPlanResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * Extended configuration information.
+   * The extended configuration information.
    */
   extendConfigs?: CapacityPlanResponseBodyResultExtendConfigs[];
   /**
    * @remarks
-   * Edition type, with values meaning as follows:
+   * The edition type. Valid values:
    * 
-   * - advanced: Enhanced Edition
+   * - advanced: Advanced Edition
    * 
    * - x-pack: Commercial Edition
    * 
-   * - community: Community Edition
+   * - community: Community Edition.
    * 
    * @example
    * advanced
@@ -180,16 +180,16 @@ export class CapacityPlanResponseBodyResult extends $dara.Model {
   instanceCategory?: string;
   /**
    * @remarks
-   * Node information.
+   * The node information.
    */
   nodeConfigurations?: CapacityPlanResponseBodyResultNodeConfigurations[];
   /**
    * @remarks
-   * Based on the capacity planning calculation, there is no default value. The meanings of the values are as follows:
+   * The result calculated based on capacity planning. No default value is available. Valid values:
    * 
-   * - true: Represents an oversized cluster, indicating that the number of data nodes calculated by the capacity planning exceeds the threshold of 50.
+   * - true: The cluster is oversized. The number of data nodes calculated by capacity planning exceeds the threshold of 50.
    * 
-   * - false: The number of data nodes calculated by the capacity planning is within 50.
+   * - false: The number of data nodes calculated by capacity planning is within 50.
    * 
    * @example
    * true
@@ -231,7 +231,7 @@ export class CapacityPlanResponseBodyResult extends $dara.Model {
 export class CapacityPlanResponseBody extends $dara.Model {
   /**
    * @remarks
-   * ID of the current request.
+   * The ID of the request.
    * 
    * @example
    * E91B7129-A669-4D9D-A743-F90A0FF1F5EF
@@ -239,7 +239,7 @@ export class CapacityPlanResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Returned result of the request.
+   * The result of the request.
    */
   result?: CapacityPlanResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/ClientNodeConfiguration.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ClientNodeConfiguration extends $dara.Model {
   /**
    * @remarks
+   * The number of client nodes.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ClientNodeConfiguration extends $dara.Model {
   amount?: number;
   /**
    * @remarks
+   * The storage size of the client node. Unit: GB.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ClientNodeConfiguration extends $dara.Model {
   disk?: number;
   /**
    * @remarks
+   * The storage type of the client node. Only cloud_efficiency (ultra cloud disk) is supported.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +35,8 @@ export class ClientNodeConfiguration extends $dara.Model {
   diskType?: string;
   /**
    * @remarks
+   * The node specifications of the client node. For more information, see [Specifications](https://help.aliyun.com/document_detail/271718.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CloseDiagnosisRequest.ts

@@ -5,13 +5,22 @@ import * as $dara from '@darabonba/typescript';
 export class CloseDiagnosisRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * A unique token used to ensure idempotence of the request. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The language of the response. Default value: the browser language. Valid values:
+   * 
+   * - en: English
+   * - zh: Simplified Chinese
+   * - zt: Traditional Chinese
+   * - es: Spanish
+   * - fr: French.
+   * 
    * @example
    * spanish
    */

package/src/models/CloseDiagnosisResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class CloseDiagnosisResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the intelligent O&M feature is disabled. Valid values:
+   * 
+   * - true: Succeeded.
+   * - false: Failed.
+   * 
    * @example
    * true
    */