tencentcloud-sdk-nodejs-intl-en
Version:
1,975 lines (1,664 loc) • 164 kB
JavaScript
/*
* Copyright (c) 2018 Tencent. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const AbstractModel = require("../../common/abstract_model");
/**
* Visual node configuration
* @class
*/
class WebNodeTypeInfo extends AbstractModel {
constructor(){
super();
/**
* Number of visual nodes. The value is always `1`.
* @type {number || null}
*/
this.NodeNum = null;
/**
* Visual node specification
* @type {string || null}
*/
this.NodeType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.NodeNum = 'NodeNum' in params ? params.NodeNum : null;
this.NodeType = 'NodeType' in params ? params.NodeType : null;
}
}
/**
* ES cluster log details
* @class
*/
class InstanceLog extends AbstractModel {
constructor(){
super();
/**
* Log time
* @type {string || null}
*/
this.Time = null;
/**
* Log level
* @type {string || null}
*/
this.Level = null;
/**
* Cluster node IP
* @type {string || null}
*/
this.Ip = null;
/**
* Log content
* @type {string || null}
*/
this.Message = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Time = 'Time' in params ? params.Time : null;
this.Level = 'Level' in params ? params.Level : null;
this.Ip = 'Ip' in params ? params.Ip : null;
this.Message = 'Message' in params ? params.Message : null;
}
}
/**
* Local disk information of node
* @class
*/
class LocalDiskInfo extends AbstractModel {
constructor(){
super();
/**
* Local disk type <li>LOCAL_SATA: big data </li><li>NVME_SSD: high IO</li>
* @type {string || null}
*/
this.LocalDiskType = null;
/**
* Size of a single local disk
* @type {number || null}
*/
this.LocalDiskSize = null;
/**
* Number of local disks
* @type {number || null}
*/
this.LocalDiskCount = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.LocalDiskType = 'LocalDiskType' in params ? params.LocalDiskType : null;
this.LocalDiskSize = 'LocalDiskSize' in params ? params.LocalDiskSize : null;
this.LocalDiskCount = 'LocalDiskCount' in params ? params.LocalDiskCount : null;
}
}
/**
* ModifyAutoBackUpStrategy request structure.
* @class
*/
class ModifyAutoBackUpStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Instance name.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Current policy name.
* @type {string || null}
*/
this.StrategyName = null;
/**
* Policy information.
* @type {CosBackup || null}
*/
this.CosBackup = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.StrategyName = 'StrategyName' in params ? params.StrategyName : null;
if (params.CosBackup) {
let obj = new CosBackup();
obj.deserialize(params.CosBackup)
this.CosBackup = obj;
}
}
}
/**
* Index lifecycle policy field
* @class
*/
class IndexPolicyField extends AbstractModel {
constructor(){
super();
/**
* Whether to enable the warm phase
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.WarmEnable = null;
/**
* Min age before data transitions to the warm phase
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.WarmMinAge = null;
/**
* Whether to enable the cold phase
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.ColdEnable = null;
/**
* Min age before data transitions to the cold phase
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.ColdMinAge = null;
/**
* Whether to enable the frozen phase
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.FrozenEnable = null;
/**
* Min age before data transitions to the frozen phase
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.FrozenMinAge = null;
/**
* /
Note: This field may return null, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.ColdAction = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.WarmEnable = 'WarmEnable' in params ? params.WarmEnable : null;
this.WarmMinAge = 'WarmMinAge' in params ? params.WarmMinAge : null;
this.ColdEnable = 'ColdEnable' in params ? params.ColdEnable : null;
this.ColdMinAge = 'ColdMinAge' in params ? params.ColdMinAge : null;
this.FrozenEnable = 'FrozenEnable' in params ? params.FrozenEnable : null;
this.FrozenMinAge = 'FrozenMinAge' in params ? params.FrozenMinAge : null;
this.ColdAction = 'ColdAction' in params ? params.ColdAction : null;
}
}
/**
* Specification information of a node type in the cluster (such as hot data node, warm data node, or dedicated primary node), including node type, number of nodes, node specification, disk type, and disk size. If `Type` is not specified, it will be a hot data node by default; if the node is a primary node, then the `DiskType` and `DiskSize` parameters will be ignored (as a primary node has no data disks)
* @class
*/
class NodeInfo extends AbstractModel {
constructor(){
super();
/**
* Number of nodes
* @type {number || null}
*/
this.NodeNum = null;
/**
* Node specification <li>ES.S1.SMALL2: 1-core 2 GB </li><li>ES.S1.MEDIUM4: 2-core 4 GB </li><li>ES.S1.MEDIUM8: 2-core 8 GB </li><li>ES.S1.LARGE16: 4-core 16 GB </li><li>ES.S1.2XLARGE32: 8-core 32 GB </li><li>ES.S1.4XLARGE32: 16-core 32 GB </li><li>ES.S1.4XLARGE64: 16-core 64 GB </li>
* @type {string || null}
*/
this.NodeType = null;
/**
* Node type<li>`hotData`: hot data node</li>
<li>`warmData`: warm data node</li>
<li>`dedicatedMaster`: dedicated master node</li>
Default value: `hotData`
* @type {string || null}
*/
this.Type = null;
/**
* Node disk type <li>CLOUD_SSD: SSD cloud storage </li><li>CLOUD_PREMIUM: Premium cloud disk </li>Default value: CLOUD_SSD
* @type {string || null}
*/
this.DiskType = null;
/**
* Node disk size in GB
* @type {number || null}
*/
this.DiskSize = null;
/**
* Local disk information
Note: this field may return null, indicating that no valid values can be obtained.
* @type {LocalDiskInfo || null}
*/
this.LocalDiskInfo = null;
/**
* Number of node disks
* @type {number || null}
*/
this.DiskCount = null;
/**
* Whether to encrypt node disk. 0: no (default); 1: yes.
* @type {number || null}
*/
this.DiskEncrypt = null;
/**
* CPU number
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.CpuNum = null;
/**
* Memory size in GB
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.MemSize = null;
/**
* /
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.DiskEnhance = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.NodeNum = 'NodeNum' in params ? params.NodeNum : null;
this.NodeType = 'NodeType' in params ? params.NodeType : null;
this.Type = 'Type' in params ? params.Type : null;
this.DiskType = 'DiskType' in params ? params.DiskType : null;
this.DiskSize = 'DiskSize' in params ? params.DiskSize : null;
if (params.LocalDiskInfo) {
let obj = new LocalDiskInfo();
obj.deserialize(params.LocalDiskInfo)
this.LocalDiskInfo = obj;
}
this.DiskCount = 'DiskCount' in params ? params.DiskCount : null;
this.DiskEncrypt = 'DiskEncrypt' in params ? params.DiskEncrypt : null;
this.CpuNum = 'CpuNum' in params ? params.CpuNum : null;
this.MemSize = 'MemSize' in params ? params.MemSize : null;
this.DiskEnhance = 'DiskEnhance' in params ? params.DiskEnhance : null;
}
}
/**
* UpdateIndex response structure.
* @class
*/
class UpdateIndexResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeAutoBackUpStrategy request structure.
* @class
*/
class DescribeAutoBackUpStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Instance name.
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* DescribeIndexMeta response structure.
* @class
*/
class DescribeIndexMetaResponse extends AbstractModel {
constructor(){
super();
/**
* Index metadata field
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {IndexMetaField || null}
*/
this.IndexMetaField = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.IndexMetaField) {
let obj = new IndexMetaField();
obj.deserialize(params.IndexMetaField)
this.IndexMetaField = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* UpdateInstance response structure.
* @class
*/
class UpdateInstanceResponse extends AbstractModel {
constructor(){
super();
/**
* Order ID
Note: This field may return `null`, indicating that no valid value was found.
* @type {string || null}
*/
this.DealName = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.DealName = 'DealName' in params ? params.DealName : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Operation details
* @class
*/
class OperationDetail extends AbstractModel {
constructor(){
super();
/**
* Original instance configuration information
* @type {Array.<KeyValue> || null}
*/
this.OldInfo = null;
/**
* Updated instance configuration information
* @type {Array.<KeyValue> || null}
*/
this.NewInfo = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.OldInfo) {
this.OldInfo = new Array();
for (let z in params.OldInfo) {
let obj = new KeyValue();
obj.deserialize(params.OldInfo[z]);
this.OldInfo.push(obj);
}
}
if (params.NewInfo) {
this.NewInfo = new Array();
for (let z in params.NewInfo) {
let obj = new KeyValue();
obj.deserialize(params.NewInfo[z]);
this.NewInfo.push(obj);
}
}
}
}
/**
* Cluster view data
* @class
*/
class ClusterView extends AbstractModel {
constructor(){
super();
/**
* Cluster health status
* @type {number || null}
*/
this.Health = null;
/**
* Whether the cluster is visible
* @type {number || null}
*/
this.Visible = null;
/**
* Whether the cluster encounters circuit breaking
* @type {number || null}
*/
this.Break = null;
/**
* Average disk usage
* @type {number || null}
*/
this.AvgDiskUsage = null;
/**
* Average memory usage
* @type {number || null}
*/
this.AvgMemUsage = null;
/**
* Average CPU usage
* @type {number || null}
*/
this.AvgCpuUsage = null;
/**
* Total disk size of the cluster
* @type {number || null}
*/
this.TotalDiskSize = null;
/**
* Types of nodes to receive client requests
* @type {Array.<string> || null}
*/
this.TargetNodeTypes = null;
/**
* Number of online nodes
* @type {number || null}
*/
this.NodeNum = null;
/**
* Total number of nodes
* @type {number || null}
*/
this.TotalNodeNum = null;
/**
* Number of data nodes
* @type {number || null}
*/
this.DataNodeNum = null;
/**
* Number of indices
* @type {number || null}
*/
this.IndexNum = null;
/**
* Number of documents
* @type {number || null}
*/
this.DocNum = null;
/**
* Used disk size (in bytes)
* @type {number || null}
*/
this.DiskUsedInBytes = null;
/**
* Number of shards
* @type {number || null}
*/
this.ShardNum = null;
/**
* Number of primary shards
* @type {number || null}
*/
this.PrimaryShardNum = null;
/**
* Number of relocating shards
* @type {number || null}
*/
this.RelocatingShardNum = null;
/**
* Number of initializing shards
* @type {number || null}
*/
this.InitializingShardNum = null;
/**
* Number of unassigned shards
* @type {number || null}
*/
this.UnassignedShardNum = null;
/**
* Total COS storage of an enterprise cluster, in GB
* @type {number || null}
*/
this.TotalCosStorage = null;
/**
* Name of the COS bucket that stores searchable snapshots of an enterprise cluster
Note: This field may return `null`, indicating that no valid value was found.
* @type {string || null}
*/
this.SearchableSnapshotCosBucket = null;
/**
* COS app ID of the searchable snapshots of an enterprise cluster
Note: This field may return `null`, indicating that no valid value was found.
* @type {string || null}
*/
this.SearchableSnapshotCosAppId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Health = 'Health' in params ? params.Health : null;
this.Visible = 'Visible' in params ? params.Visible : null;
this.Break = 'Break' in params ? params.Break : null;
this.AvgDiskUsage = 'AvgDiskUsage' in params ? params.AvgDiskUsage : null;
this.AvgMemUsage = 'AvgMemUsage' in params ? params.AvgMemUsage : null;
this.AvgCpuUsage = 'AvgCpuUsage' in params ? params.AvgCpuUsage : null;
this.TotalDiskSize = 'TotalDiskSize' in params ? params.TotalDiskSize : null;
this.TargetNodeTypes = 'TargetNodeTypes' in params ? params.TargetNodeTypes : null;
this.NodeNum = 'NodeNum' in params ? params.NodeNum : null;
this.TotalNodeNum = 'TotalNodeNum' in params ? params.TotalNodeNum : null;
this.DataNodeNum = 'DataNodeNum' in params ? params.DataNodeNum : null;
this.IndexNum = 'IndexNum' in params ? params.IndexNum : null;
this.DocNum = 'DocNum' in params ? params.DocNum : null;
this.DiskUsedInBytes = 'DiskUsedInBytes' in params ? params.DiskUsedInBytes : null;
this.ShardNum = 'ShardNum' in params ? params.ShardNum : null;
this.PrimaryShardNum = 'PrimaryShardNum' in params ? params.PrimaryShardNum : null;
this.RelocatingShardNum = 'RelocatingShardNum' in params ? params.RelocatingShardNum : null;
this.InitializingShardNum = 'InitializingShardNum' in params ? params.InitializingShardNum : null;
this.UnassignedShardNum = 'UnassignedShardNum' in params ? params.UnassignedShardNum : null;
this.TotalCosStorage = 'TotalCosStorage' in params ? params.TotalCosStorage : null;
this.SearchableSnapshotCosBucket = 'SearchableSnapshotCosBucket' in params ? params.SearchableSnapshotCosBucket : null;
this.SearchableSnapshotCosAppId = 'SearchableSnapshotCosAppId' in params ? params.SearchableSnapshotCosAppId : null;
}
}
/**
* Instance tag information
* @class
*/
class TagInfo extends AbstractModel {
constructor(){
super();
/**
* Tag key
* @type {string || null}
*/
this.TagKey = null;
/**
* Tag value
* @type {string || null}
*/
this.TagValue = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TagKey = 'TagKey' in params ? params.TagKey : null;
this.TagValue = 'TagValue' in params ? params.TagValue : null;
}
}
/**
* CreateIndex response structure.
* @class
*/
class CreateIndexResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DeleteAutoBackUpStrategy request structure.
* @class
*/
class DeleteAutoBackUpStrategyRequest extends AbstractModel {
constructor(){
super();
/**
* Instance name.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Policy name.
* @type {Array.<string> || null}
*/
this.StrategyName = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.StrategyName = 'StrategyName' in params ? params.StrategyName : null;
}
}
/**
* Kibana view data
* @class
*/
class KibanaView extends AbstractModel {
constructor(){
super();
/**
* Kibana node IP
* @type {string || null}
*/
this.Ip = null;
/**
* Node disk size
* @type {number || null}
*/
this.DiskSize = null;
/**
* Disk usage
* @type {number || null}
*/
this.DiskUsage = null;
/**
* Node memory size
* @type {number || null}
*/
this.MemSize = null;
/**
* Memory usage
* @type {number || null}
*/
this.MemUsage = null;
/**
* Number of node CPUs
* @type {number || null}
*/
this.CpuNum = null;
/**
* CPU usage
* @type {number || null}
*/
this.CpuUsage = null;
/**
* Availability zone
* @type {string || null}
*/
this.Zone = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Ip = 'Ip' in params ? params.Ip : null;
this.DiskSize = 'DiskSize' in params ? params.DiskSize : null;
this.DiskUsage = 'DiskUsage' in params ? params.DiskUsage : null;
this.MemSize = 'MemSize' in params ? params.MemSize : null;
this.MemUsage = 'MemUsage' in params ? params.MemUsage : null;
this.CpuNum = 'CpuNum' in params ? params.CpuNum : null;
this.CpuUsage = 'CpuUsage' in params ? params.CpuUsage : null;
this.Zone = 'Zone' in params ? params.Zone : null;
}
}
/**
* Public network ACL information of ES
* @class
*/
class EsPublicAcl extends AbstractModel {
constructor(){
super();
/**
* Access blocklist
* @type {Array.<string> || null}
*/
this.BlackIpList = null;
/**
* Access allowlist
* @type {Array.<string> || null}
*/
this.WhiteIpList = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.BlackIpList = 'BlackIpList' in params ? params.BlackIpList : null;
this.WhiteIpList = 'WhiteIpList' in params ? params.WhiteIpList : null;
}
}
/**
* Backing index metadata fields
* @class
*/
class BackingIndexMetaField extends AbstractModel {
constructor(){
super();
/**
* Backing index name
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.IndexName = null;
/**
* Backing index status
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.IndexStatus = null;
/**
* Backing index size
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {number || null}
*/
this.IndexStorage = null;
/**
* Current lifecycle phase of backing index
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.IndexPhrase = null;
/**
* Backing index creation time
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.IndexCreateTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.IndexName = 'IndexName' in params ? params.IndexName : null;
this.IndexStatus = 'IndexStatus' in params ? params.IndexStatus : null;
this.IndexStorage = 'IndexStorage' in params ? params.IndexStorage : null;
this.IndexPhrase = 'IndexPhrase' in params ? params.IndexPhrase : null;
this.IndexCreateTime = 'IndexCreateTime' in params ? params.IndexCreateTime : null;
}
}
/**
* Information of the IK plugin dictionary
* @class
*/
class DictInfo extends AbstractModel {
constructor(){
super();
/**
* Dictionary key value
* @type {string || null}
*/
this.Key = null;
/**
* Dictionary name
* @type {string || null}
*/
this.Name = null;
/**
* Dictionary size in B
* @type {number || null}
*/
this.Size = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Key = 'Key' in params ? params.Key : null;
this.Name = 'Name' in params ? params.Name : null;
this.Size = 'Size' in params ? params.Size : null;
}
}
/**
* RestartInstance response structure.
* @class
*/
class RestartInstanceResponse extends AbstractModel {
constructor(){
super();
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* `OperationDetail` uses an array of this structure to describe the old and new configuration information
* @class
*/
class KeyValue extends AbstractModel {
constructor(){
super();
/**
* Key
* @type {string || null}
*/
this.Key = null;
/**
* Value
* @type {string || null}
*/
this.Value = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Key = 'Key' in params ? params.Key : null;
this.Value = 'Value' in params ? params.Value : null;
}
}
/**
* RestartKibana request structure.
* @class
*/
class RestartKibanaRequest extends AbstractModel {
constructor(){
super();
/**
* ES instance ID
* @type {string || null}
*/
this.InstanceId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
}
}
/**
* CreateInstance response structure.
* @class
*/
class CreateInstanceResponse extends AbstractModel {
constructor(){
super();
/**
* Instance ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* Order ID
Note: This field may return `null`, indicating that no valid value was found.
* @type {string || null}
*/
this.DealName = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.DealName = 'DealName' in params ? params.DealName : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Index configuration fields
* @class
*/
class IndexSettingsField extends AbstractModel {
constructor(){
super();
/**
* Number of primary shards
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.NumberOfShards = null;
/**
* Number of replica shards
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.NumberOfReplicas = null;
/**
* Index refresh interval
Note: This field may return `null`, indicating that no valid value can be obtained.
* @type {string || null}
*/
this.RefreshInterval = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.NumberOfShards = 'NumberOfShards' in params ? params.NumberOfShards : null;
this.NumberOfReplicas = 'NumberOfReplicas' in params ? params.NumberOfReplicas : null;
this.RefreshInterval = 'RefreshInterval' in params ? params.RefreshInterval : null;
}
}
/**
* DescribeAutoBackUpStrategy response structure.
* @class
*/
class DescribeAutoBackUpStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Policy information.
* @type {Array.<CosBackup> || null}
*/
this.CosBackupList = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.CosBackupList) {
this.CosBackupList = new Array();
for (let z in params.CosBackupList) {
let obj = new CosBackup();
obj.deserialize(params.CosBackupList[z]);
this.CosBackupList.push(obj);
}
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribeInstanceLogs request structure.
* @class
*/
class DescribeInstanceLogsRequest extends AbstractModel {
constructor(){
super();
/**
* Cluster instance ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* Log type. Default value: 1
<li>1: primary log</li>
<li>2: search slow log</li>
<li>3: index slow log</li>
<li>4: GC log</li>
* @type {number || null}
*/
this.LogType = null;
/**
* Search keyword, which supports LUCENE syntax, such as `level:WARN`, `ip:1.1.1.1`, and `message:test-index`
* @type {string || null}
*/
this.SearchKey = null;
/**
* Log start time in the format of YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53
* @type {string || null}
*/
this.StartTime = null;
/**
* Log end time in the format of YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53
* @type {string || null}
*/
this.EndTime = null;
/**
* Pagination start value. Default value: 0
* @type {number || null}
*/
this.Offset = null;
/**
* Number of entries per page. Default value: 100. Maximum value: 100
* @type {number || null}
*/
this.Limit = null;
/**
* Time sorting order. Default value: 0
<li>0: descending</li>
<li>1: ascending</li>
* @type {number || null}
*/
this.OrderByType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.LogType = 'LogType' in params ? params.LogType : null;
this.SearchKey = 'SearchKey' in params ? params.SearchKey : null;
this.StartTime = 'StartTime' in params ? params.StartTime : null;
this.EndTime = 'EndTime' in params ? params.EndTime : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.OrderByType = 'OrderByType' in params ? params.OrderByType : null;
}
}
/**
* UpdateDictionaries request structure.
* @class
*/
class UpdateDictionariesRequest extends AbstractModel {
constructor(){
super();
/**
* ES instance ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* COS address of the main dictionary for the IK analyzer
* @type {Array.<string> || null}
*/
this.IkMainDicts = null;
/**
* COS address of the stopword dictionary for the IK analyzer
* @type {Array.<string> || null}
*/
this.IkStopwords = null;
/**
* COS address of the synonym dictionary
* @type {Array.<string> || null}
*/
this.Synonym = null;
/**
* COS address of the QQ dictionary
* @type {Array.<string> || null}
*/
this.QQDict = null;
/**
* `0` (default): Install, `1`: Delete
* @type {number || null}
*/
this.UpdateType = null;
/**
* Whether to force restart the cluster. The default value is `false`.
* @type {boolean || null}
*/
this.ForceRestart = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.IkMainDicts = 'IkMainDicts' in params ? params.IkMainDicts : null;
this.IkStopwords = 'IkStopwords' in params ? params.IkStopwords : null;
this.Synonym = 'Synonym' in params ? params.Synonym : null;
this.QQDict = 'QQDict' in params ? params.QQDict : null;
this.UpdateType = 'UpdateType' in params ? params.UpdateType : null;
this.ForceRestart = 'ForceRestart' in params ? params.ForceRestart : null;
}
}
/**
* UpdateRequestTargetNodeTypes request structure.
* @class
*/
class UpdateRequestTargetNodeTypesRequest extends AbstractModel {
constructor(){
super();
/**
* Instance ID.
* @type {string || null}
*/
this.InstanceId = null;
/**
* A list of node types used to receive requests.
* @type {Array.<string> || null}
*/
this.TargetNodeTypes = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.TargetNodeTypes = 'TargetNodeTypes' in params ? params.TargetNodeTypes : null;
}
}
/**
* Details of AZs in multi-AZ deployment mode
* @class
*/
class ZoneDetail extends AbstractModel {
constructor(){
super();
/**
* AZ
* @type {string || null}
*/
this.Zone = null;
/**
* Subnet ID
* @type {string || null}
*/
this.SubnetId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Zone = 'Zone' in params ? params.Zone : null;
this.SubnetId = 'SubnetId' in params ? params.SubnetId : null;
}
}
/**
* ModifyAutoBackUpCommonInfo request structure.
* @class
*/
class ModifyAutoBackUpCommonInfoRequest extends AbstractModel {
constructor(){
super();
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
}
}
/**
* The maintenance time slot of the cluster
* @class
*/
class OperationDuration extends AbstractModel {
constructor(){
super();
/**
* Maintenance period, which can be one or more days from Monday to Sunday. Valid values: [0, 6].
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<number> || null}
*/
this.Periods = null;
/**
* The maintenance start time
* @type {string || null}
*/
this.TimeStart = null;
/**
* The maintenance end time
* @type {string || null}
*/
this.TimeEnd = null;
/**
* The time zone expressed in UTC.
* @type {string || null}
*/
this.TimeZone = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Periods = 'Periods' in params ? params.Periods : null;
this.TimeStart = 'TimeStart' in params ? params.TimeStart : null;
this.TimeEnd = 'TimeEnd' in params ? params.TimeEnd : null;
this.TimeZone = 'TimeZone' in params ? params.TimeZone : null;
}
}
/**
* Node view data
* @class
*/
class NodeView extends AbstractModel {
constructor(){
super();
/**
* Node ID
* @type {string || null}
*/
this.NodeId = null;
/**
* Node IP
* @type {string || null}
*/
this.NodeIp = null;
/**
* Whether the node is visible
* @type {number || null}
*/
this.Visible = null;
/**
* Whether the node encounters circuit breaking
* @type {number || null}
*/
this.Break = null;
/**
* Node disk size
* @type {number || null}
*/
this.DiskSize = null;
/**
* Disk usage
* @type {number || null}
*/
this.DiskUsage = null;
/**
* Node memory size (in GB)
* @type {number || null}
*/
this.MemSize = null;
/**
* Memory usage
* @type {number || null}
*/
this.MemUsage = null;
/**
* Number of node CPUs
* @type {number || null}
*/
this.CpuNum = null;
/**
* CPU usage
* @type {number || null}
*/
this.CpuUsage = null;
/**
* Availability zone
* @type {string || null}
*/
this.Zone = null;
/**
* Node role
* @type {string || null}
*/
this.NodeRole = null;
/**
* Node HTTP IP
* @type {string || null}
*/
this.NodeHttpIp = null;
/**
* JVM memory usage
* @type {number || null}
*/
this.JvmMemUsage = null;
/**
* Number of node shards
* @type {number || null}
*/
this.ShardNum = null;
/**
* ID list of node disks
* @type {Array.<string> || null}
*/
this.DiskIds = null;
/**
* Whether a hidden availability zone
* @type {boolean || null}
*/
this.Hidden = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.NodeId = 'NodeId' in params ? params.NodeId : null;
this.NodeIp = 'NodeIp' in params ? params.NodeIp : null;
this.Visible = 'Visible' in params ? params.Visible : null;
this.Break = 'Break' in params ? params.Break : null;
this.DiskSize = 'DiskSize' in params ? params.DiskSize : null;
this.DiskUsage = 'DiskUsage' in params ? params.DiskUsage : null;
this.MemSize = 'MemSize' in params ? params.MemSize : null;
this.MemUsage = 'MemUsage' in params ? params.MemUsage : null;
this.CpuNum = 'CpuNum' in params ? params.CpuNum : null;
this.CpuUsage = 'CpuUsage' in params ? params.CpuUsage : null;
this.Zone = 'Zone' in params ? params.Zone : null;
this.NodeRole = 'NodeRole' in params ? params.NodeRole : null;
this.NodeHttpIp = 'NodeHttpIp' in params ? params.NodeHttpIp : null;
this.JvmMemUsage = 'JvmMemUsage' in params ? params.JvmMemUsage : null;
this.ShardNum = 'ShardNum' in params ? params.ShardNum : null;
this.DiskIds = 'DiskIds' in params ? params.DiskIds : null;
this.Hidden = 'Hidden' in params ? params.Hidden : null;
}
}
/**
* DescribeIndexList request structure.
* @class
*/
class DescribeIndexListRequest extends AbstractModel {
constructor(){
super();
/**
* Index type. `auto`: Automated; `normal`: General.
* @type {string || null}
*/
this.IndexType = null;
/**
* ES cluster ID
* @type {string || null}
*/
this.InstanceId = null;
/**
* Index name. `null` indicates that all indexes are requested.
* @type {string || null}
*/
this.IndexName = null;
/**
* Username for cluster access
* @type {string || null}
*/
this.Username = null;
/**
* Password for cluster access
* @type {string || null}
*/
this.Password = null;
/**
* The starting position of paging
* @type {number || null}
*/
this.Offset = null;
/**
* The number of results per page
* @type {number || null}
*/
this.Limit = null;
/**
* Sorting condition field, which can be `IndexName`, `IndexStorage`, or `IndexCreateTime`.
* @type {string || null}
*/
this.OrderBy = null;
/**
* Filtering by index status
* @type {Array.<string> || null}
*/
this.IndexStatusList = null;
/**
* Sorting mode, which can be `asc` and `desc`.
* @type {string || null}
*/
this.Order = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.IndexType = 'IndexType' in params ? params.IndexType : null;
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.IndexName = 'IndexName' in params ? params.IndexName : null;
this.Username = 'Username' in params ? params.Username : null;
this.Password = 'Password' in params ? params.Password : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.Limit = 'Limit' in params ? params.Limit : null;
this.OrderBy = 'OrderBy' in params ? params.OrderBy : null;
this.IndexStatusList = 'IndexStatusList' in params ? params.IndexStatusList : null;
this.Order = 'Order' in params ? params.Order : null;
}
}
/**
* Auto-backup to COS for ES
* @class
*/
class CosBackup extends AbstractModel {
constructor(){
super();
/**
* Whether to enable auto-backup to COS
* @type {boolean || null}
*/
this.IsAutoBackup = null;
/**
* Auto-backup time (accurate down to the hour), such as "22:00"
* @type {string || null}
*/
this.BackupTime = null;
/**
* Backup snapshot prefix.
* @type {string || null}
*/
this.SnapshotName = null;
/**
* Valid values: 0 (Tencent Cloud repository) and 1 (customer repository).
* @type {number || null}
*/
this.EsRepositoryType = null;
/**
* Managed snapshot repository name.
* @type {string || null}
*/
this.PaasEsRepository = null;
/**
* Customer snapshot repository name.
* @type {string || null}
*/
this.UserEsRepository = null;
/**
* COS storage folder directory.
* @type {string || null}
*/
this.CosBasePath = null;
/**
* Snapshot storage cycle in days.
* @type {number || null}
*/
this.StorageDuration = null;
/**
* Auto backup frequency in hours.
* @type {number || null}
*/
this.AutoBackupInterval = null;
/**
* Backup lock. Valid values: 0 (not locked) and 1 (locked).
* @type {number || null}
*/
this.CosRetention = null;
/**
* Lock expiration date, such as 2022-12-10T08:34:48.000Z.
* @type {string || null}
*/
this.RetainUntilDate = null;
/**
* Lock grace period.
* @type {number || null}
*/
this.RetentionGraceTime = null;
/**
* Cross-region backup. Valid values: 0 (disabled) and 1 (enabled).
* @type {number || null}
*/
this.RemoteCos = null;
/**
* Region name for cross-region backup, such as ap-guangzhou.
* @type {string || null}
*/
this.RemoteCosRegion = null;
/**
* Policy name.
* @type {string || null}
*/
this.StrategyName = null;
/**
* Backup index list. If left empty, it means to back up all indexes.
* @type {string || null}
*/
this.Indices = null;
/**
*
* @type {number || null}
*/
this.MultiAz = null;
/**
* Policy creation time.
* @type {string || null}
*/
this.CreateTime = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.IsAutoBackup = 'IsAutoBackup' in params ? params.IsAutoBackup : null;
this.BackupTime = 'BackupTime' in params ? params.BackupTime : null;
this.SnapshotName = 'SnapshotName' in params ? params.SnapshotName : null;
this.EsRepositoryType = 'EsRepositoryType' in params ? params.EsRepositoryType : null;
this.PaasEsRepository = 'PaasEsRepository' in params ? params.PaasEsRepository : null;
this.UserEsRepository = 'UserEsRepository' in params ? params.UserEsRepository : null;
this.CosBasePath = 'CosBasePath' in params ? params.CosBasePath : null;
this.StorageDuration = 'StorageDuration' in params ? params.StorageDuration : null;
this.AutoBackupInterval = 'AutoBackupInterval' in params ? params.AutoBackupInterval : null;
this.CosRetention = 'CosRetention' in params ? params.CosRetention : null;
this.RetainUntilDate = 'RetainUntilDate' in params ? params.RetainUntilDate : null;
this.RetentionGraceTime = 'RetentionGraceTime' in params ? params.RetentionGraceTime : null;
this.RemoteCos = 'RemoteCos' in params ? params.RemoteCos : null;
this.RemoteCosRegion = 'RemoteCosRegion' in params ? params.RemoteCosRegion : null;
this.StrategyName = 'StrategyName' in params ? params.StrategyName : null;
this.Indices = 'Indices' in params ? params.Indices : null;
this.MultiAz = 'MultiAz' in params ? params.MultiAz : null;
this.CreateTime = 'CreateTime' in params ? params.CreateTime : null;
}
}
/**
* ModifyAutoBackUpStrategy response structure.
* @class
*/
class ModifyAutoBackUpStrategyResponse extends AbstractModel {
constructor(){
super();
/**
* Valid values: true (success) and false (failure).
* @type {boolean || null}
*/
this.Status = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;