@alicloud/elasticsearch20170613 4.3.0 → 4.3.2

package/src/models/UpdateInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateInstanceResponseBodyResultKibanaConfiguration extends $dara.Model {
   /**
    * @remarks
-   * The configuration of dedicated master nodes.
+   * The number of nodes.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class UpdateInstanceResponseBodyResultKibanaConfiguration extends $dara.M
   amount?: number;
   /**
    * @remarks
-   * The node specifications.
+   * The storage size of the node.
    * 
    * @example
    * 20
@@ -21,7 +21,7 @@ export class UpdateInstanceResponseBodyResultKibanaConfiguration extends $dara.M
   disk?: number;
   /**
    * @remarks
-   * The number of nodes.
+   * The storage type of the node. You can ignore this parameter.
    * 
    * @example
    * cloud_ssd
@@ -29,7 +29,7 @@ export class UpdateInstanceResponseBodyResultKibanaConfiguration extends $dara.M
   diskType?: string;
   /**
    * @remarks
-   * The storage type of the node. This parameter can be ignored.
+   * 节点规格。
    * 
    * @example
    * elasticsearch.n4.small
@@ -64,23 +64,32 @@ export class UpdateInstanceResponseBodyResultKibanaConfiguration extends $dara.M
 
 export class UpdateInstanceResponseBodyResultMasterConfiguration extends $dara.Model {
   /**
+   * @remarks
+   * The number of nodes.
+   * 
    * @example
    * 3
    */
   amount?: number;
   /**
+   * @remarks
+   * The storage size of the node. Unit: GB.
+   * 
    * @example
    * 20
    */
   disk?: number;
   /**
+   * @remarks
+   * The storage type of the node. Only cloud_ssd (standard SSD) is supported.
+   * 
    * @example
    * cloud_ssd
    */
   diskType?: string;
   /**
    * @remarks
-   * The storage type of the node. Only cloud_ssd(SSD cloud disk) is supported.
+   * 节点规格。
    * 
    * @example
    * elasticsearch.sn2ne.large
@@ -116,7 +125,7 @@ export class UpdateInstanceResponseBodyResultMasterConfiguration extends $dara.M
 export class UpdateInstanceResponseBodyResultNodeSpec extends $dara.Model {
   /**
    * @remarks
-   * The node specifications.
+   * The storage size of the node. Unit: GB.
    * 
    * @example
    * 40
@@ -124,7 +133,10 @@ export class UpdateInstanceResponseBodyResultNodeSpec extends $dara.Model {
   disk?: number;
   /**
    * @remarks
-   * The number of nodes.
+   * The storage type of the node. Valid values:
+   * 
+   * - cloud_ssd: standard SSD
+   * - cloud_efficiency: ultra disk.
    * 
    * @example
    * cloud_ssd
@@ -132,7 +144,7 @@ export class UpdateInstanceResponseBodyResultNodeSpec extends $dara.Model {
   diskType?: string;
   /**
    * @remarks
-   * The configuration of Kibana nodes.
+   * 节点规格。
    * 
    * @example
    * elasticsearch.sn2ne.xlarge
@@ -166,7 +178,7 @@ export class UpdateInstanceResponseBodyResultNodeSpec extends $dara.Model {
 export class UpdateInstanceResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The private domain name of the instance.
+   * The time when the instance was created.
    * 
    * @example
    * 2018-07-13T03:58:07.253Z
@@ -174,7 +186,7 @@ export class UpdateInstanceResponseBodyResult extends $dara.Model {
   createdAt?: string;
   /**
    * @remarks
-   * The configuration of data nodes.
+   * The instance name.
    * 
    * @example
    * test
@@ -182,7 +194,7 @@ export class UpdateInstanceResponseBodyResult extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * 实例的私网访问域名。
    * 
    * @example
    * es-cn-abc.elasticsearch.aliyuncs.com
@@ -190,7 +202,7 @@ export class UpdateInstanceResponseBodyResult extends $dara.Model {
   domain?: string;
   /**
    * @remarks
-   * The node specifications.
+   * The instance version.
    * 
    * @example
    * 5.5.3_with_X-Pack
@@ -198,7 +210,7 @@ export class UpdateInstanceResponseBodyResult extends $dara.Model {
   esVersion?: string;
   /**
    * @remarks
-   * The storage space of the node. Unit: GB.
+   * The instance ID.
    * 
    * @example
    * es-cn-abc
@@ -206,20 +218,17 @@ export class UpdateInstanceResponseBodyResult extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The size of the node storage space.
+   * The Kibana node configuration.
    */
   kibanaConfiguration?: UpdateInstanceResponseBodyResultKibanaConfiguration;
   /**
    * @remarks
-   * The storage space of the node. Unit: GB.
+   * The master node configuration.
    */
   masterConfiguration?: UpdateInstanceResponseBodyResultMasterConfiguration;
   /**
    * @remarks
-   * The billing method of the instance. Valid values:
-   * 
-   * *   prepaid: subscription
-   * *   postpaid: pay-as-you-go
+   * The number of data nodes.
    * 
    * @example
    * 2
@@ -227,15 +236,15 @@ export class UpdateInstanceResponseBodyResult extends $dara.Model {
   nodeAmount?: number;
   /**
    * @remarks
-   * The storage type of the node. Valid values:
-   * 
-   * *   cloud_ssd: standard SSD
-   * *   cloud_efficiency: ultra disk
+   * The data node configuration.
    */
   nodeSpec?: UpdateInstanceResponseBodyResultNodeSpec;
   /**
    * @remarks
-   * The edition of the dedicated KMS instance.
+   * The billing method of the instance. Valid values:
+   * 
+   * - prepaid: subscription
+   * - postpaid: pay-as-you-go.
    * 
    * @example
    * postpaid
@@ -243,7 +252,12 @@ export class UpdateInstanceResponseBodyResult extends $dara.Model {
   paymentType?: string;
   /**
    * @remarks
-   * The name of the instance.
+   * The status of the instance. Valid values:
+   * 
+   * - active: Normal
+   * - activating: Taking effect
+   * - inactive: Frozen
+   * - invalid: Invalid.
    * 
    * @example
    * active
@@ -304,7 +318,7 @@ export class UpdateInstanceResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The time when the instance was created.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
@@ -312,12 +326,7 @@ export class UpdateInstanceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The state of the instance. Valid values:
-   * 
-   * *   active: normal
-   * *   activating: taking effect
-   * *   inactive: frozen
-   * *   invalid: invalid
+   * The returned result.
    */
   result?: UpdateInstanceResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/UpdateInstanceSettingsRequest.ts

@@ -3,16 +3,34 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateInstanceSettingsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The YML file configuration of the instance.
+   */
   esConfig?: { [key: string]: 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 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
+   * Specifies whether to forcefully apply the change.
+   */
   force?: boolean;
+  /**
+   * @remarks
+   * The change strategy for Elasticsearch (for example, the change method used during index updates, cluster upgrades, or service deployments). Valid values:
+   * - blue_green: blue-green change. Implements seamless switchover by running two identical environments (blue and green) in parallel.
+   * - normal: in-place change. Performs changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
+   * - intelligent: intelligent change. The system automatically analyzes the change type and environment state, and dynamically selects the optimal change method (blue-green change or in-place change).
+   * 
+   * @example
+   * normal
+   */
   updateStrategy?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateInstanceSettingsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateInstanceSettingsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * BB1C321A-211C-4FD7-BD8B-7F2FABE2****

package/src/models/UpdateKeystoresRequest.ts

@@ -3,9 +3,20 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateKeystoresRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Delete keystore configuration
+   */
   remove?: string[];
+  /**
+   * @remarks
+   * Add or update keystore
+   */
   update?: { [key: string]: string };
   /**
+   * @remarks
+   * Whether to force the change. false: non-forced, true: forced
+   * 
    * @example
    * false
    */

package/src/models/UpdateKeystoresResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateKeystoresResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****

package/src/models/UpdateKibanaPvlNetworkRequest.ts

@@ -4,19 +4,32 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateKibanaPvlNetworkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The endpoint name.
+   * 
    * @example
-   * es-cn-27a3mul6l00***-kibana
+   * es-cn-text-kibana
    */
   endpointName?: string;
+  /**
+   * @remarks
+   * The list of security groups.
+   */
   securityGroups?: string[];
   /**
+   * @remarks
+   * Used to ensure the idempotency of the request.
+   * 
    * @example
    * xxxx
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The Kibana private network connection ID.
+   * 
    * @example
-   * es-cn-27a3mul6l0***-kibana-internal
+   * es-cn-vo93ngti8000a****-kibana-internal-internal
    */
   pvlId?: string;
   static names(): { [key: string]: string } {

package/src/models/UpdateKibanaPvlNetworkResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateKibanaPvlNetworkResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The result. Valid values:
+   * 
+   * - true: The operation was successful.
+   * - false: The operation failed.
+   * 
    * @example
    * true
    */

package/src/models/UpdateKibanaSettingsRequest.ts

@@ -6,7 +6,7 @@ export class UpdateKibanaSettingsRequest 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 the idempotence of the request. The token must be unique across different requests and can contain up to 64 ASCII characters.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B350****

package/src/models/UpdateKibanaSettingsResponseBody.ts

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

package/src/models/UpdateKibanaSsoRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateKibanaSsoRequest extends $dara.Model {
   /**
    * @remarks
+   * true: Enabled; false: shutdown
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdateKibanaSsoResponseBody.ts

@@ -12,6 +12,9 @@ export class UpdateKibanaSsoResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Return Result.
+   * 
    * @example
    * true
    */

package/src/models/UpdateKibanaWhiteIpsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateKibanaWhiteIpsRequestWhiteIpGroup extends $dara.Model {
   /**
    * @remarks
-   * The type of the whitelist. Set the value to PUBLIC_KIBANA. This value indicates a public IP address whitelist.
+   * The name of the whitelist group. This parameter is required if the whiteIpGroup parameter is specified.
    * 
    * @example
    * test_group_name
@@ -13,12 +13,12 @@ export class UpdateKibanaWhiteIpsRequestWhiteIpGroup extends $dara.Model {
   groupName?: string;
   /**
    * @remarks
-   * The IP addresses in the whitelist. This parameter is required if you configure the whiteIpGroup parameter.
+   * The list of IP addresses in the whitelist group.
    */
   ips?: string[];
   /**
    * @remarks
-   * The IP addresses in the whitelist.
+   * The whitelist type. Only PUBLIC_KIBANA (public network access whitelist) is supported.
    * 
    * @example
    * PUBLIC_KIBANA
@@ -55,23 +55,19 @@ export class UpdateKibanaWhiteIpsRequestWhiteIpGroup extends $dara.Model {
 export class UpdateKibanaWhiteIpsRequest extends $dara.Model {
   /**
    * @remarks
-   * The IP address whitelists. 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.
-   * 
-   * You cannot configure both the kibanaIPWhitelist and whiteIpGroup parameters.
+   * The Kibana node IP access whitelist. This parameter cannot be set together with the whitelist group.
    */
   kibanaIPWhitelist?: string[];
   /**
    * @remarks
-   * The name of the whitelist. This parameter is required if you configure the whiteIpGroup parameter.
+   * Updates the Kibana access whitelist configuration by using the whitelist group method. Only one whitelist group can be updated at a time.
+   * 
+   * You cannot configure kibanaIPWhitelist and whiteIpGroup at the same time.
    */
   whiteIpGroup?: UpdateKibanaWhiteIpsRequestWhiteIpGroup;
   /**
    * @remarks
-   * The update mode. Valid values:
-   * 
-   * *   Cover: overwrites the IP addresses in the specified IP address whitelist with the IP addresses specified by using the ips parameter. This is the default value.
-   * *   Append: adds the IP addresses specified by using the ips parameter to the specified IP address whitelist.
-   * *   Delete: deletes the IP addresses specified by using the ips parameter from the specified IP address whitelist. At least one IP address must be retained for 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****
@@ -79,7 +75,13 @@ export class UpdateKibanaWhiteIpsRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The body of the request.
+   * 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/UpdateKibanaWhiteIpsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateKibanaWhiteIpsResponseBodyResultNetworkConfigWhiteIpGroupList extends $dara.Model {
   /**
    * @remarks
-   * The IP addresses in the whitelist.
+   * The name of the whitelist group.
    * 
    * @example
    * test_group_name
@@ -13,10 +13,13 @@ export class UpdateKibanaWhiteIpsResponseBodyResultNetworkConfigWhiteIpGroupList
   groupName?: string;
   /**
    * @remarks
-   * The IP addresses in the whitelist.
+   * The list of IP addresses in the whitelist group.
    */
   ips?: string[];
   /**
+   * @remarks
+   * The whitelist type.
+   * 
    * @example
    * PUBLIC_KIBANA
    */
@@ -52,7 +55,7 @@ export class UpdateKibanaWhiteIpsResponseBodyResultNetworkConfigWhiteIpGroupList
 export class UpdateKibanaWhiteIpsResponseBodyResultNetworkConfig extends $dara.Model {
   /**
    * @remarks
-   * The IP address whitelists.
+   * The network type.
    * 
    * @example
    * vpc
@@ -60,7 +63,7 @@ export class UpdateKibanaWhiteIpsResponseBodyResultNetworkConfig extends $dara.M
   type?: string;
   /**
    * @remarks
-   * The ID of the vSwitch.
+   * The VPC ID.
    * 
    * @example
    * vpc-bp1jy348ibzulk6hn****
@@ -68,7 +71,7 @@ export class UpdateKibanaWhiteIpsResponseBodyResultNetworkConfig extends $dara.M
   vpcId?: string;
   /**
    * @remarks
-   * The network type.
+   * The region where the instance resides.
    * 
    * @example
    * cn-hangzhou-h
@@ -76,7 +79,7 @@ export class UpdateKibanaWhiteIpsResponseBodyResultNetworkConfig extends $dara.M
   vsArea?: string;
   /**
    * @remarks
-   * The region ID.
+   * The vSwitch ID.
    * 
    * @example
    * vsw-bp1a0mifpletdd1da****
@@ -84,7 +87,7 @@ export class UpdateKibanaWhiteIpsResponseBodyResultNetworkConfig extends $dara.M
   vswitchId?: string;
   /**
    * @remarks
-   * The IP address whitelists.
+   * The whitelist group list.
    */
   whiteIpGroupList?: UpdateKibanaWhiteIpsResponseBodyResultNetworkConfigWhiteIpGroupList[];
   static names(): { [key: string]: string } {
@@ -122,17 +125,17 @@ export class UpdateKibanaWhiteIpsResponseBodyResultNetworkConfig extends $dara.M
 export class UpdateKibanaWhiteIpsResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The public IP address whitelists for access to the Kibana console of the cluster.
+   * The Kibana access whitelist.
    */
   kibanaIPWhitelist?: string[];
   /**
    * @remarks
-   * The private IP address whitelists for access to the Kibana console of the cluster.
+   * The Kibana internal-facing whitelist.
    */
   kibanaPrivateIPWhitelist?: string[];
   /**
    * @remarks
-   * The ID of the virtual private cloud (VPC).
+   * The network configuration.
    */
   networkConfig?: UpdateKibanaWhiteIpsResponseBodyResultNetworkConfig;
   static names(): { [key: string]: string } {
@@ -172,7 +175,7 @@ export class UpdateKibanaWhiteIpsResponseBodyResult extends $dara.Model {
 export class UpdateKibanaWhiteIpsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details of the Elasticsearch cluster.
+   * The request ID.
    * 
    * @example
    * E5EF11F1-DBAE-4020-AC24-DFA6C4345CAE
@@ -180,7 +183,7 @@ export class UpdateKibanaWhiteIpsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The private IP address whitelists for access to the Kibana console of the cluster.
+   * The details of the Elasticsearch instance.
    */
   result?: UpdateKibanaWhiteIpsResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/UpdateLogstashChargeTypeRequest.ts

@@ -6,7 +6,7 @@ export class UpdateLogstashChargeTypeRequest 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. Generated by the client. The value must be unique across requests and cannot exceed 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/UpdateLogstashChargeTypeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateLogstashChargeTypeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
@@ -13,10 +13,10 @@ export class UpdateLogstashChargeTypeResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the billing method of the cluster is switched. Valid values:
+   * The returned result. Valid values:
    * 
-   * *   true: The billing method is switched.
-   * *   false: The billing method fails to be switched.
+   * - true: The conversion succeeded.
+   * - false: The conversion failed.
    * 
    * @example
    * true

package/src/models/UpdateLogstashDescriptionRequest.ts

@@ -6,7 +6,7 @@ export class UpdateLogstashDescriptionRequest extends $dara.Model {
   description?: 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/UpdateLogstashDescriptionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateLogstashDescriptionResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The name of the cluster.
+   * The instance name.
    * 
    * @example
    * logstash_name
@@ -35,7 +35,7 @@ export class UpdateLogstashDescriptionResponseBodyResult extends $dara.Model {
 export class UpdateLogstashDescriptionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
@@ -43,7 +43,7 @@ export class UpdateLogstashDescriptionResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The result returned.
+   * The returned result.
    */
   result?: UpdateLogstashDescriptionResponseBodyResult;
   static names(): { [key: string]: string } {