@alicloud/elasticsearch20170613 4.3.0 → 4.3.2

package/src/models/UpdateLogstashRequest.ts

@@ -4,16 +4,27 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateLogstashRequestNodeSpec extends $dara.Model {
   /**
+   * @remarks
+   * The disk size. Unit: GB.
+   * 
    * @example
    * 20
    */
   disk?: number;
   /**
+   * @remarks
+   * The disk type. Valid values:
+   * - cloud_efficiency: ultra cloud disk
+   * - cloud_ssd: SSD cloud disk.
+   * 
    * @example
    * cloud_efficiency
    */
   diskType?: string;
   /**
+   * @remarks
+   * The specification information. For more information, see [Product specifications](https://help.aliyun.com/document_detail/271718.html).
+   * 
    * @example
    * elasticsearch.sn1ne.large
    */
@@ -45,12 +56,22 @@ export class UpdateLogstashRequestNodeSpec extends $dara.Model {
 
 export class UpdateLogstashRequest extends $dara.Model {
   /**
+   * @remarks
+   * The number of nodes.
+   * 
    * @example
    * 3
    */
   nodeAmount?: number;
+  /**
+   * @remarks
+   * The node specifications.
+   */
   nodeSpec?: UpdateLogstashRequestNodeSpec;
   /**
+   * @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.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */

package/src/models/UpdateLogstashResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateLogstashResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the instance information is modified. Valid values:
+   * 
+   * - true: The instance information is modified.
+   * - false: The instance information failed to be modified.
+   * 
    * @example
    * true
    */

package/src/models/UpdateLogstashSettingsRequest.ts

@@ -6,7 +6,7 @@ export class UpdateLogstashSettingsRequest extends $dara.Model {
   body?: string;
   /**
    * @remarks
-   * 5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*
+   * A unique token used to ensure idempotence of the request. This parameter 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/UpdateLogstashSettingsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateLogstashSettingsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 71D0D1DA-B22F-58CB-AF5B-D1657A6A****

package/src/models/UpdatePipelineManagementConfigRequest.ts

@@ -3,25 +3,48 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdatePipelineManagementConfigRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The list of access addresses of the Elasticsearch instance where Kibana resides after Kibana pipeline management is enabled.
+   */
   endpoints?: string[];
   esInstanceId?: string;
   /**
+   * @remarks
+   * The password used to log on to Kibana.
+   * 
    * @example
    * ******
    */
   password?: string;
+  /**
+   * @remarks
+   * The list of pipelines managed by Kibana.
+   */
   pipelineIds?: string[];
   /**
+   * @remarks
+   * The pipeline management method. Valid values:
+   * 
+   * - ES: Kibana pipeline management.
+   * - MULTIPLE_PIPELINE: configuration file management.
+   * 
    * @example
    * ES
    */
   pipelineManagementType?: string;
   /**
+   * @remarks
+   * The username used to log on to Kibana.
+   * 
    * @example
    * elastic
    */
   userName?: string;
   /**
+   * @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 up to 64 ASCII characters.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */

package/src/models/UpdatePipelineManagementConfigResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdatePipelineManagementConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The result of the operation. Valid values:
+   * 
+   * - true: The update was successful.
+   * - false: The update failed.
+   * 
    * @example
    * true
    */

package/src/models/UpdatePipelinesRequest.ts

@@ -6,7 +6,7 @@ export class UpdatePipelinesRequest 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 used to ensure idempotence. This parameter 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****
@@ -14,7 +14,7 @@ export class UpdatePipelinesRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * Specifies whether to deploy the pipeline immediately.
+   * Specifies whether to immediately deploy the pipeline.
    * 
    * @example
    * false

package/src/models/UpdatePipelinesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePipelinesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
@@ -13,10 +13,10 @@ export class UpdatePipelinesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the pipeline is updated. Valid values:
+   * The returned result. Valid values:
    * 
-   * *   true: The pipeline is updated.
-   * *   false: The pipeline fails to be updated.
+   * - true: The update was successful.
+   * - false: The update failed.
    * 
    * @example
    * true

package/src/models/UpdatePrivateNetworkWhiteIpsRequest.ts

@@ -6,7 +6,7 @@ export class UpdatePrivateNetworkWhiteIpsRequest extends $dara.Model {
   body?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * 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 maximum length is 64 ASCII characters.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
@@ -14,7 +14,13 @@ export class UpdatePrivateNetworkWhiteIpsRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The results that are returned.
+   * The modification mode. Valid values:
+   * 
+   * - Cover (default): overwrites the original IP whitelist with the value of the ips parameter.
+   * 
+   * - Append: adds the IP addresses specified in the ips parameter to the original IP whitelist.
+   * 
+   * - Delete: removes the IP addresses specified in the ips parameter from the original IP whitelist. At least one IP address must be retained.
    * 
    * @example
    * Cover

package/src/models/UpdatePrivateNetworkWhiteIpsResponseBody.ts

@@ -30,10 +30,17 @@ export class UpdatePrivateNetworkWhiteIpsResponseBodyResult extends $dara.Model
 
 export class UpdatePrivateNetworkWhiteIpsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 6DEBE5EE-0368-4757-8F82-EF9C3972****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   result?: UpdatePrivateNetworkWhiteIpsResponseBodyResult;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdatePublicNetworkRequest.ts

@@ -6,7 +6,7 @@ export class UpdatePublicNetworkRequest extends $dara.Model {
   body?: string;
   /**
    * @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.
+   * A unique token that is used to ensure idempotence. This parameter value is generated by the client and must be unique among different requests. The value cannot exceed 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/UpdatePublicNetworkResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePublicNetworkResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The status of the public network access switch.
+   * The status of the public network address switch.
    * 
    * @example
    * false
@@ -35,7 +35,7 @@ export class UpdatePublicNetworkResponseBodyResult extends $dara.Model {
 export class UpdatePublicNetworkResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 2A88ECA1-D827-4581-AD39-05149586****
@@ -43,7 +43,7 @@ export class UpdatePublicNetworkResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The return results.
+   * The returned result.
    */
   result?: UpdatePublicNetworkResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/UpdatePublicWhiteIpsRequest.ts

@@ -6,7 +6,7 @@ export class UpdatePublicWhiteIpsRequest extends $dara.Model {
   body?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * A unique token generated by the client to guarantee the idempotency of the request. The value must be unique among different requests and cannot exceed 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
@@ -14,7 +14,13 @@ export class UpdatePublicWhiteIpsRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The results that are returned.
+   * The modification method. Valid values:
+   * 
+   * - Cover (default): overwrites the original IP whitelist with the value of the ips parameter.
+   * 
+   * - Append: adds the IP addresses specified in the ips parameter to the original IP whitelist.
+   * 
+   * - Delete: removes the IP addresses specified in the ips parameter from the original IP whitelist. At least one IP address must be retained.
    * 
    * @example
    * Cover

package/src/models/UpdatePublicWhiteIpsResponseBody.ts

@@ -30,10 +30,17 @@ export class UpdatePublicWhiteIpsResponseBodyResult extends $dara.Model {
 
 export class UpdatePublicWhiteIpsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C82758DD-282F-4D48-934F-92170A33****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   result?: UpdatePublicWhiteIpsResponseBodyResult;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateReadWritePolicyRequest.ts

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

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateReadWritePolicyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The returned result. Valid values:
+   * 
+   * - true: The write high availability feature is enabled or disabled.
+   * - false: Failed to enable or disable the write high availability feature.
+   * 
    * @example
    * true
    */

package/src/models/UpdateSnapshotSettingResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSnapshotSettingResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable automatic backup.
+   * Indicates whether automatic backup is enabled.
    * 
    * @example
    * true
@@ -45,7 +45,7 @@ export class UpdateSnapshotSettingResponseBodyResult extends $dara.Model {
 export class UpdateSnapshotSettingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****
@@ -53,7 +53,7 @@ export class UpdateSnapshotSettingResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The return results.
+   * The returned result.
    */
   result?: UpdateSnapshotSettingResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/UpdateSynonymsDictsRequest.ts

@@ -6,7 +6,7 @@ export class UpdateSynonymsDictsRequest 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 used to ensure idempotence of the request. The client generates this value. The value must be unique across different requests and cannot exceed 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/UpdateSynonymsDictsResponseBody.ts

@@ -23,8 +23,8 @@ export class UpdateSynonymsDictsResponseBodyResult extends $dara.Model {
    * @remarks
    * The source type of the dictionary file. Valid values:
    * 
-   * *   OSS
-   * *   ORIGIN
+   * - OSS: OSS open storage.
+   * - ORIGIN: retains the previously uploaded dictionary.
    * 
    * @example
    * OSS
@@ -32,7 +32,7 @@ export class UpdateSynonymsDictsResponseBodyResult extends $dara.Model {
   sourceType?: string;
   /**
    * @remarks
-   * The dictionary type. The value is fixed as SYNONYMS.
+   * The dictionary type. Valid values: SYNONYMS (synonym).
    * 
    * @example
    * SYNONYMS

package/src/models/UpdateTemplateRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateTemplateRequest 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****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The template configuration content. For more information, see the RequestBody section below.
+   * 
    * @example
    * {     "content": "{\\n\\t\\"persistent\\":{\\n\\t\\t\\"search\\":{\\n\\t\\t\\t\\"max_buckets\\":\\"10000\\"\\n\\t\\t}\\n\\t}\\n}" }
    */

package/src/models/UpdateTemplateResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateTemplateResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the scenario-specific template configuration is modified. Valid values:
+   * 
+   * - true: The modification is successful.
+   * - false: The modification failed.
+   * 
    * @example
    * true
    */

package/src/models/UpdateWhiteIpsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateWhiteIpsRequestWhiteIpGroup extends $dara.Model {
   /**
    * @remarks
-   * The type of the whitelist. Set the value to **PRIVATE_ES**. This value indicates a private IP address whitelist.
+   * The name of the whitelist group. This parameter is required if the whiteIpGroup parameter is specified.
    * 
    * @example
    * test_group
@@ -13,12 +13,12 @@ export class UpdateWhiteIpsRequestWhiteIpGroup extends $dara.Model {
   groupName?: string;
   /**
    * @remarks
-   * The returned result.
+   * The list of IP addresses in the whitelist group.
    */
   ips?: string[];
   /**
    * @remarks
-   * The returned result.
+   * The type of the IP whitelist. The value is fixed as **PRIVATE_ES**, which indicates the private network internal-facing access whitelist.
    * 
    * @example
    * PRIVATE_ES
@@ -55,17 +55,19 @@ export class UpdateWhiteIpsRequestWhiteIpGroup extends $dara.Model {
 export class UpdateWhiteIpsRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the whitelist. This parameter is required if you configure the whiteIpGroup parameter.
+   * The IP address information in the whitelist.
    */
   esIPWhitelist?: string[];
   /**
    * @remarks
-   * The IP addresses in the whitelist. This parameter is required if you configure the whiteIpGroup parameter.
+   * Updates the instance whitelist configuration by using the whitelist group method. Only one whitelist group can be updated at a time.
+   * >Notice:  You cannot configure esIPWhitelist and whiteIpGroup at the same time.
+   * .
    */
   whiteIpGroup?: UpdateWhiteIpsRequestWhiteIpGroup;
   /**
    * @remarks
-   * The IP addresses in the whitelist.
+   * A unique token generated by the client to guarantee the idempotency of the request. The value must be unique across different requests and can contain a maximum of 64 ASCII characters.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
@@ -73,9 +75,13 @@ export class UpdateWhiteIpsRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The IP addresses in the whitelist. This parameter is available if the whiteIpGroup parameter is left empty. The default IP address whitelist is updated based on the value of this parameter.
+   * The modification mode. Valid values:
    * 
-   * >  You cannot configure both the esIPWhitelist and whiteIpGroup parameters.
+   * - Cover (default): overwrites the IP addresses in the original whitelist with the value of the ips parameter.
+   * 
+   * - Append: adds the IP addresses specified in the ips parameter to the original whitelist.
+   * 
+   * - Delete: removes the IP addresses specified in the ips parameter from the original whitelist. At least one IP address must be retained.
    * 
    * @example
    * Cover

package/src/models/UpdateWhiteIpsResponseBody.ts

@@ -5,14 +5,21 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateWhiteIpsResponseBodyResultNetworkConfigWhiteIpGroupList extends $dara.Model {
   /**
    * @remarks
-   * The type of the whitelist. The value of this parameter is fixed as PRIVATE_ES, which indicates a private IP address whitelist.
+   * The name of the whitelist group. The default group is included by default.
    * 
    * @example
    * test_group
    */
   groupName?: string;
+  /**
+   * @remarks
+   * The IP address information in the whitelist group.
+   */
   ips?: string[];
   /**
+   * @remarks
+   * The whitelist type. The value is fixed as PRIVATE_ES, which indicates the private network internal-facing access whitelist.
+   * 
    * @example
    * PRIVATE_ES
    */
@@ -48,7 +55,7 @@ export class UpdateWhiteIpsResponseBodyResultNetworkConfigWhiteIpGroupList exten
 export class UpdateWhiteIpsResponseBodyResultNetworkConfig extends $dara.Model {
   /**
    * @remarks
-   * The IP addresses in the whitelist.
+   * The list of whitelist groups.
    */
   whiteIpGroupList?: UpdateWhiteIpsResponseBodyResultNetworkConfigWhiteIpGroupList[];
   static names(): { [key: string]: string } {
@@ -78,12 +85,12 @@ export class UpdateWhiteIpsResponseBodyResultNetworkConfig extends $dara.Model {
 export class UpdateWhiteIpsResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The list of whitelists.
+   * The private network internal-facing access whitelist (deprecated).
    */
   esIPWhitelist?: string[];
   /**
    * @remarks
-   * The name of the whitelist. By default, the default whitelist is included.
+   * The network configuration.
    */
   networkConfig?: UpdateWhiteIpsResponseBodyResultNetworkConfig;
   static names(): { [key: string]: string } {
@@ -118,7 +125,7 @@ export class UpdateWhiteIpsResponseBodyResult extends $dara.Model {
 export class UpdateWhiteIpsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The updated whitelist.
+   * The request ID.
    * 
    * @example
    * 8D58B014-BBD7-4D80-B219-00B9D5C6860C
@@ -126,7 +133,7 @@ export class UpdateWhiteIpsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The network configurations.
+   * The returned result.
    */
   result?: UpdateWhiteIpsResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/UpdateXpackMonitorConfigRequest.ts

@@ -4,17 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateXpackMonitorConfigRequest 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 cannot exceed 64 ASCII characters in length.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * Specifies whether to enable X-Pack monitoring. Valid values:
+   * 
+   * - true: Enable X-Pack monitoring.
+   * - false: Disable X-Pack monitoring.
+   * 
    * @example
    * true
    */
   enable?: boolean;
+  /**
+   * @remarks
+   * The access endpoint of the Elasticsearch instance.
+   */
   endpoints?: string[];
   /**
+   * @remarks
+   * The password of the Elasticsearch instance.
+   * 
    * @example
    * ******
    * 
@@ -23,6 +39,9 @@ export class UpdateXpackMonitorConfigRequest extends $dara.Model {
    */
   password?: string;
   /**
+   * @remarks
+   * The username of the Elasticsearch instance.
+   * 
    * @example
    * elastic
    * 

package/src/models/UpdateXpackMonitorConfigResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateXpackMonitorConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***
    */
   requestId?: string;
   /**
+   * @remarks
+   * The result of the operation. Valid values:
+   * 
+   * - true: The update was successful.
+   * - false: The update failed.
+   * 
    * @example
    * true
    */