@alicloud/elasticsearch20170613 4.3.1 → 4.3.2

package/src/models/UpgradeEngineVersionRequest.ts

@@ -3,9 +3,25 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpgradeEngineVersionRequestPlugins extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to install the plug-in. A value of true indicates that the plug-in is installed. A value of false indicates that the plug-in is uninstalled.
+   */
   enable?: string;
+  /**
+   * @remarks
+   * The file version of the plug-in. For more information, see the response of the ListUserPlugin operation.
+   */
   fileVersion?: string;
+  /**
+   * @remarks
+   * The plug-in name.
+   */
   name?: string;
+  /**
+   * @remarks
+   * The Elasticsearch version that corresponds to the plug-in, such as 7.16.2.
+   */
   version?: string;
   static names(): { [key: string]: string } {
     return {
@@ -37,18 +53,27 @@ export class UpgradeEngineVersionRequestPlugins extends $dara.Model {
 export class UpgradeEngineVersionRequest extends $dara.Model {
   plugins?: UpgradeEngineVersionRequestPlugins[];
   /**
+   * @remarks
+   * The upgrade type. Valid values:
+   * 
+   * - engineVersion (default): major engine version upgrade.
+   * - aliVersion: kernel version upgrade.
+   * 
    * @example
    * engineVersion
    */
   type?: string;
   /**
+   * @remarks
+   * The version after the upgrade. If type is set to engineVersion, the value is the instance version, such as 6.7. If type is set to aliVersion, the value is the kernel version, such as ali1.2.0.
+   * 
    * @example
    * 6.7
    */
   version?: string;
   /**
    * @remarks
-   * The moderation results.
+   * 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****
@@ -56,17 +81,22 @@ export class UpgradeEngineVersionRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The monitoring type. Valid values:
+   * Specifies whether to perform a pre-upgrade check. Valid values:
+   * 
+   * - true: performs a pre-upgrade check.
+   * - false (default): does not perform a pre-upgrade check.
    * 
-   * *   checkClusterHealth: Cluster Health Status
-   * *   checkConfigCompatible: Configuration Compatibility Status
-   * *   checkClusterResource: resource space status
-   * *   checkClusterSnapshot: Whether a snapshot exists
+   * >Warning:  The version upgrade check involves checks on the cluster YML configuration, plug-in configuration, cluster status, indexes, and resources. We strongly recommend that you perform a pre-upgrade check before upgrading. Otherwise, upgrade issues may occur.
+   * .
    * 
    * @example
    * false
    */
   dryRun?: boolean;
+  /**
+   * @remarks
+   * The update strategy. Valid values: blue_green (blue-green deployment), normal (in-place update), and intelligent (intelligent update).
+   */
   updateStrategy?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpgradeEngineVersionResponseBody.ts

@@ -4,21 +4,30 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpgradeEngineVersionResponseBodyResultValidateResult extends $dara.Model {
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * ClusterStatusNotHealth
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * The cluster status is not health
    */
   errorMsg?: string;
   /**
    * @remarks
-   * The verification is passed. Valid values:
+   * The error type. Valid values:
    * 
-   * *   success: through
-   * *   failed: failed
+   * - clusterStatus: cluster health status.
+   * - clusterConfigYml: cluster YML file.
+   * - clusterConfigPlugins: cluster configuration file.
+   * - clusterResource: cluster resources.
+   * - clusterSnapshot: cluster snapshot.
    * 
    * @example
    * clusterStatus
@@ -51,18 +60,29 @@ export class UpgradeEngineVersionResponseBodyResultValidateResult extends $dara.
 
 export class UpgradeEngineVersionResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the check is passed. Valid values:
+   * 
+   * - success: passed.
+   * - failed: not passed.
+   * 
    * @example
    * success
    */
   status?: string;
   /**
    * @remarks
-   * The error message returned.
+   * The check information.
    */
   validateResult?: UpgradeEngineVersionResponseBodyResultValidateResult[];
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The check type. Valid values:
+   * 
+   * - checkClusterHealth: cluster health status.
+   * - checkConfigCompatible: configuration compatibility status.
+   * - checkClusterResource: resource space status.
+   * - checkClusterSnapshot: whether a snapshot exists.
    * 
    * @example
    * checkClusterHealth
@@ -99,7 +119,7 @@ export class UpgradeEngineVersionResponseBodyResult extends $dara.Model {
 export class UpgradeEngineVersionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The verification information.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DC*****
@@ -107,13 +127,7 @@ export class UpgradeEngineVersionResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The type of the error. Valid values:
-   * 
-   * *   clusterStatus: the health status of the cluster.
-   * *   clusterConfigYml: Cluster YML File
-   * *   clusterConfigPlugins: Cluster Configuration File
-   * *   clusterResource: cluster resources
-   * *   clusterSnapshot: cluster snapshot
+   * The returned result.
    */
   result?: UpgradeEngineVersionResponseBodyResult[];
   static names(): { [key: string]: string } {

package/src/models/UpgradeInfoResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpgradeInfoResponseBodyResultUpgradeInfo extends $dara.Model {
   /**
+   * @remarks
+   * Current repo version.
+   * 
    * @example
    * 1.7.3
    */
   curRepoVersion?: string;
   /**
+   * @remarks
+   * Upgradable repo version.
+   * 
    * @example
    * 1.7.3
    */
   updateRepoVersion?: string;
   /**
+   * @remarks
+   * Indicates whether an upgradable version exists.
+   * 
    * @example
    * false
    */
   upgrade?: boolean;
   /**
+   * @remarks
+   * Current Milvus version
+   * 
    * @example
    * 2.2.4
    */
   curApackVersion?: string;
   /**
+   * @remarks
+   * Current ES version
+   * 
    * @example
    * 8.17.0
    */
   curEsVersion?: string;
   /**
+   * @remarks
+   * Upgradable Milvus version.
+   * 
    * @example
    * 2.2.4
    */
   upgradeApackVersion?: string;
   /**
+   * @remarks
+   * Upgradable ES version
+   * 
    * @example
    * 8.17.0
    */
@@ -72,6 +93,10 @@ export class UpgradeInfoResponseBodyResultUpgradeInfo extends $dara.Model {
 }
 
 export class UpgradeInfoResponseBodyResult extends $dara.Model {
+  /**
+   * @remarks
+   * Upgrade information.
+   */
   upgradeInfo?: UpgradeInfoResponseBodyResultUpgradeInfo;
   static names(): { [key: string]: string } {
     return {
@@ -100,12 +125,16 @@ export class UpgradeInfoResponseBodyResult extends $dara.Model {
 export class UpgradeInfoResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Result body
+   */
   result?: UpgradeInfoResponseBodyResult;
   static names(): { [key: string]: string } {
     return {

package/src/models/ValidateConnectionRequest.ts

@@ -5,12 +5,19 @@ import * as $dara from '@darabonba/typescript';
 export class ValidateConnectionRequest 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 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
+   * The information about the Elasticsearch instance to which you want to validate connectivity.
+   * 
+   * @example
+   * {     "endpoints": [         "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"     ],     "userName": "elastic",     "password": "xxxx" }
+   */
   body?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ValidateConnectionResponseBody.ts

@@ -13,10 +13,10 @@ export class ValidateConnectionResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the connectivity is normal. Valid values:
+   * The returned result. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true: The validation succeeded.
+   * - false: The validation failed.
    * 
    * @example
    * true

package/src/models/ValidateShrinkNodesRequest.ts

@@ -4,26 +4,44 @@ import * as $dara from '@darabonba/typescript';
 
 export class ValidateShrinkNodesRequestBody extends $dara.Model {
   /**
+   * @remarks
+   * The IP address of the node.
+   * 
    * @example
    * 192.168.xx.xx
    */
   host?: string;
   /**
+   * @remarks
+   * The node name of the cloud-native ACK-based cluster. You can call the [ListAllNode](https://help.aliyun.com/document_detail/183958.html) operation to obtain the node name.
+   * 
    * @example
    * es-cn-pl32xxxxxxx-data-f-1
    */
   hostName?: string;
   /**
+   * @remarks
+   * The node type. Valid values:
+   * 
+   * - WORKER: hot node
+   * - WORKER_WARM: warm node
+   * 
    * @example
    * WORKER
    */
   nodeType?: string;
   /**
+   * @remarks
+   * The access port number of the node.
+   * 
    * @example
    * 9200
    */
   port?: number;
   /**
+   * @remarks
+   * The zone ID of the node in the instance. For example, the zone ID of China (Shanghai) Zone C is cn-shanghai-c.
+   * 
    * @example
    * cn-shanghai-c
    */
@@ -58,15 +76,25 @@ export class ValidateShrinkNodesRequestBody extends $dara.Model {
 }
 
 export class ValidateShrinkNodesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The request body.
+   */
   body?: ValidateShrinkNodesRequestBody[];
   /**
+   * @remarks
+   * The number of nodes.
+   * 
    * @example
    * 2
    */
   count?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * Specifies whether to ignore the cluster health status.
+   * 
+   * - true: ignores the cluster health status.
+   * - false (default): does not ignore the cluster health status.
    * 
    * @example
    * false
@@ -74,10 +102,10 @@ export class ValidateShrinkNodesRequest extends $dara.Model {
   ignoreStatus?: boolean;
   /**
    * @remarks
-   * Returned results:
+   * The type of nodes to scale in. Valid values:
    * 
-   * *   true: can be scaled in
-   * *   false: cannot be scaled in.
+   * - WORKER: hot node
+   * - WORKER_WARM: warm node
    * 
    * This parameter is required.
    * 

package/src/models/ValidateShrinkNodesResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class ValidateShrinkNodesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The returned result.
+   * 
+   * - true: The nodes can be scaled in.
+   * - false: The nodes cannot be scaled in.
+   * 
    * @example
    * true
    */

package/src/models/ValidateSlrPermissionRequest.ts

@@ -4,12 +4,19 @@ import * as $dara from '@darabonba/typescript';
 
 export class ValidateSlrPermissionRequest extends $dara.Model {
   /**
+   * @remarks
+   * Used to ensure the idempotency of the request. This parameter value is generated by the client and must be unique across different requests, with a maximum length of 64 ASCII characters.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */
   clientToken?: string;
   /**
    * @remarks
+   * The service-linked role name. Valid values:
+   * 
+   * <props="china">- AliyunServiceRoleForElasticsearchOps: Performs elastic scaling tasks for a cluster.- AliyunServiceRoleForElasticsearchCollector: Creates and manages Beats collectors.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ValidateSlrPermissionResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class ValidateSlrPermissionResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * BC4ED7DD-8C84-49B5-8A95-456F82E44D13
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the service-linked role has been created. Valid values:
+   * 
+   * - true: The role has been created.
+   * - false: The role has not been created.
+   * 
    * @example
    * true
    */

package/src/models/ValidateTransferableNodesRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ValidateTransferableNodesRequestBody extends $dara.Model {
   /**
+   * @remarks
+   * The IP address of the node.
+   * 
    * @example
    * 172.16.xx.xx
    */
   host?: string;
   /**
+   * @remarks
+   * The access port number of the node.
+   * 
    * @example
    * 9200
    */
   port?: number;
   /**
+   * @remarks
+   * The zone ID of the instance node. For example, the ID of Zone C in the China (Shanghai) region is cn-shanghai-c.
+   * 
    * @example
    * cn-shanghai-c
    */
@@ -44,9 +53,20 @@ export class ValidateTransferableNodesRequestBody extends $dara.Model {
 }
 
 export class ValidateTransferableNodesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The request body.
+   */
   body?: ValidateTransferableNodesRequestBody[];
   /**
    * @remarks
+   * The node type. Valid values:
+   * 
+   * - WORKER: hot node
+   * - WORKER_WARM: warm node
+   * 
+   * > COORDINATING (client node) and KIBANA (Kibana node) are not supported.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ValidateTransferableNodesResponseBody.ts

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

package/src/models/WarmNodeConfiguration.ts

@@ -4,32 +4,52 @@ import * as $dara from '@darabonba/typescript';
 
 export class WarmNodeConfiguration extends $dara.Model {
   /**
+   * @remarks
+   * The number of cold data nodes.
+   * 
    * @example
    * 3
    */
   amount?: number;
   /**
+   * @remarks
+   * The storage space size of cold data nodes, in GB.
+   * 
    * @example
    * 500
    */
   disk?: number;
   /**
+   * @remarks
+   * Specifies whether to enable cloud disk encryption for cold data nodes. Valid values:
+   * 
+   * - true: enabled.
+   * - false: not enabled.
+   * 
    * @example
    * false
    */
   diskEncryption?: boolean;
   /**
+   * @remarks
+   * The storage type of cold data nodes. Only cloud_efficiency (ultra cloud disk) is supported.
+   * 
    * @example
    * cloud_efficiency
    */
   diskType?: string;
   /**
+   * @remarks
+   * The performance level (PL) of the ESSD cloud disk. This parameter is required when the disk type of cold data nodes is a standard SSD. Valid values: PL1, PL2, and PL3.
+   * 
    * @example
    * PL1
    */
   performanceLevel?: string;
   /**
    * @remarks
+   * The node specifications of cold data nodes. For more information, see [Product specifications](https://help.aliyun.com/document_detail/271718.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/WhiteIpGroup.ts

@@ -4,15 +4,30 @@ import * as $dara from '@darabonba/typescript';
 
 export class WhiteIpGroup extends $dara.Model {
   /**
+   * @remarks
+   * The type of the IP address whitelist. Valid values:
+   * 
+   * - PRIVATE_ES: Elasticsearch private network access whitelist
+   * - PUBLIC_ES: Elasticsearch public network access whitelist
+   * - PRIVATE_KIBANA: Kibana private network access whitelist
+   * - PUBLIC_KIBANA: Kibana public network access whitelist.
+   * 
    * @example
    * PRIVATE_ES
    */
   whiteIpType?: string;
   /**
+   * @remarks
+   * The name of the IP address whitelist group.
+   * 
    * @example
    * test_group
    */
   groupName?: string;
+  /**
+   * @remarks
+   * The list of IP addresses in the whitelist group.
+   */
   ips?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ZoneInfo.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class ZoneInfo extends $dara.Model {
   /**
+   * @remarks
+   * The zone status. Valid values:
+   * 
+   * - ISOLATION: offline
+   * - NORMAL: Normal.
+   * 
    * @example
    * NORMAL
    */
   status?: string;
   /**
+   * @remarks
+   * The zone ID, which uniquely identifies the zone.
+   * 
    * @example
    * cn-hangzhou-b
    */

package/src/models/model.ts

@@ -36,6 +36,7 @@ export { DescribeDeprecatedTemplateResponseBodyResultTemplate } from './Describe
 export { DescribeDeprecatedTemplateResponseBodyResult } from './DescribeDeprecatedTemplateResponseBody';
 export { DescribeDiagnoseReportResponseBodyResultDiagnoseItemsDetail } from './DescribeDiagnoseReportResponseBody';
 export { DescribeDiagnoseReportResponseBodyResultDiagnoseItems } from './DescribeDiagnoseReportResponseBody';
+export { DescribeDiagnoseReportResponseBodyResultItems } from './DescribeDiagnoseReportResponseBody';
 export { DescribeDiagnoseReportResponseBodyResult } from './DescribeDiagnoseReportResponseBody';
 export { DescribeDiagnosisSettingsResponseBodyResult } from './DescribeDiagnosisSettingsResponseBody';
 export { DescribeILMPolicyResponseBodyResult } from './DescribeIlmpolicyResponseBody';
@@ -70,6 +71,7 @@ export { DescribeRegionsResponseBodyResult } from './DescribeRegionsResponseBody
 export { DescribeSnapshotSettingResponseBodyResult } from './DescribeSnapshotSettingResponseBody';
 export { DescribeTemplatesResponseBodyResult } from './DescribeTemplatesResponseBody';
 export { DescribeXpackMonitorConfigResponseBodyResult } from './DescribeXpackMonitorConfigResponseBody';
+export { DiagnoseInstanceResponseBodyResultItems } from './DiagnoseInstanceResponseBody';
 export { DiagnoseInstanceResponseBodyResult } from './DiagnoseInstanceResponseBody';
 export { EnableKibanaPvlNetworkRequestVSwitchIdsZone } from './EnableKibanaPvlNetworkRequest';
 export { EstimatedLogstashRestartTimeResponseBodyResult } from './EstimatedLogstashRestartTimeResponseBody';
@@ -155,6 +157,7 @@ export { ListDeprecatedTemplatesResponseBodyResult } from './ListDeprecatedTempl
 export { ListDiagnoseReportResponseBodyHeaders } from './ListDiagnoseReportResponseBody';
 export { ListDiagnoseReportResponseBodyResultDiagnoseItemsDetail } from './ListDiagnoseReportResponseBody';
 export { ListDiagnoseReportResponseBodyResultDiagnoseItems } from './ListDiagnoseReportResponseBody';
+export { ListDiagnoseReportResponseBodyResultItems } from './ListDiagnoseReportResponseBody';
 export { ListDiagnoseReportResponseBodyResult } from './ListDiagnoseReportResponseBody';
 export { ListDiagnoseReportIdsResponseBodyHeaders } from './ListDiagnoseReportIdsResponseBody';
 export { ListDiagnosisItemsResponseBodyResult } from './ListDiagnosisItemsResponseBody';