Auto capacity expansion parameter for cvm
Used by actions: CreateInstance, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeType | String | No | Node type. Valid values: hotData, warmData. |
| ScaleType | Integer | No | 0: Percentage-based scale-out; 1: Absolute value-based scale-out |
| Threshold | Integer | No | Trigger threshold. Unit: %. For example, 80%. |
| Duration | Integer | No | Trigger duration in minutes, for example, 60 |
| PercentSize | Integer | No | Expansion ratio per time, unit: %, for example, 20% |
| FixSize | Integer | No | Absolute value-based scale-out, in GB, for example, 100 GB |
| MaxSize | Integer | No | Capacity limit for scale-out, in GB, for example, 500 GB |
Backup index metadata field
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Description |
|---|---|---|
| IndexName | String | Backing index name |
| IndexStatus | String | Backup index status |
| IndexStorage | Integer | Backup index storage size |
| IndexPhrase | String | Backup index current lifecycle |
| IndexCreateTime | String | Backup index creation time |
| IndexUuid | String | Index Uuid |
Cluster dimension view data
Used by actions: DescribeViews.
| Name | Type | Description |
|---|---|---|
| Health | Float | Cluster health status |
| Visible | Float | Whether the cluster is visible |
| Break | Float | Whether to fuse the cluster |
| AvgDiskUsage | Float | Average Disk Usage |
| AvgMemUsage | Float | Average memory utilization |
| AvgCpuUsage | Float | Average CPU Usage |
| TotalDiskSize | Integer | Total storage size of a cluster. |
| TargetNodeTypes | Array of String | Client request node |
| NodeNum | Integer | Number of online nodes |
| TotalNodeNum | Integer | Total number of nodes |
| DataNodeNum | Integer | Number of Data Nodes |
| IndexNum | Integer | Index count |
| DocNum | Integer | Number of documents |
| DiskUsedInBytes | Integer | Used bytes of the disk |
| ShardNum | Integer | Number of shards |
| PrimaryShardNum | Integer | Number of primary shards |
| RelocatingShardNum | Integer | Number of migrating shards |
| InitializingShardNum | Integer | Number of initializing shards. |
| UnassignedShardNum | Integer | Number of unassigned shards |
| TotalCosStorage | Integer | Enterprise Edition COS storage capacity size in GB |
| SearchableSnapshotCosBucket | String | bucket name for storing cos searchable snapshots in the Enterprise Edition cluster |
| SearchableSnapshotCosAppId | String | App ID of the cos bucket for searchable snapshots in the Enterprise Edition cluster |
ES cos auto backup information
Used by actions: CreateAutoBackUpStrategy, DescribeAutoBackUpStrategy, DescribeInstances, ModifyAutoBackUpStrategy, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| IsAutoBackup | Boolean | Yes | Whether to enable cos automatic backup |
| BackupTime | String | Yes | Automatic backup execution time (accurate to the hour), e.g. "22:00" |
| SnapshotName | String | No | Backup snapshot prefix |
| EsRepositoryType | Integer | No | 0 (Tencent Cloud repository); 1 (customer repository) |
| PaasEsRepository | String | No | Managed snapshot repository name. |
| UserEsRepository | String | No | Customer snapshot repository name |
| CosBasePath | String | No | cos storage folder directory |
| StorageDuration | Integer | No | Snapshot storage cycle in days |
| AutoBackupInterval | Integer | No | Auto backup frequency in hours. |
| CosRetention | Integer | No | Backup lock. Valid values: 0 (not locked) and 1 (locked). |
| RetainUntilDate | String | No | Lock expiration date, such as 2022-12-10T08:34:48.000Z. |
| RetentionGraceTime | Integer | No | Lock grace period |
| RemoteCos | Integer | No | Cross-region backup. Valid values: 0 (disabled) and 1 (enabled). |
| RemoteCosRegion | String | No | Region name for cross-regional backup, such as ap-guangzhou. |
| StrategyName | String | No | Policy name. |
| Indices | String | No | Backup index list. If left empty, it means to back up all indexes. |
| MultiAz | Integer | No | cos multi-AZ backup. 0: single AZ; 1: multi-AZ |
| MaxSnapshotPerSec | String | No | Maximum speed of write to the repository per node max_snapshot_bytes_per_sec, default 40m |
| MaxRestorePerSec | String | No | Maximum speed of reading the repository per node max_restore_bytes_per_sec. Default is 40m before 710, and default unlimited from 710 onwards |
| CreateTime | String | No | Policy creation time |
| InstanceId | String | No | Instance ID. |
ik plug-in dictionary information
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Dictionary key-value |
| Name | String | Yes | Dictionary name |
| Size | Integer | Yes | Dictionary size. Unit: B. |
Placement group async task maintenance time period
Used by actions: CreateInstance, DescribeInstances, RestartNodes, UpdateInstance, UpgradeInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Periods | Array of String | No | Date when enabling an asynchronous task is supported |
| TimeStart | String | No | Enable async start time |
| TimeEnd | String | No | Supports enabling asynchronous termination time |
| TimeZone | String | No | Enable async time zone |
ES cluster configuration item
Used by actions: DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| BlackIpList | Array of String | No | kibana access blocklist |
| WhiteIpList | Array of String | No | kibana access allowlist |
Configuration group information
Used by actions: DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Configuration group type, for example, ldap and ad |
| EsConfig | String | Yes | "{"order":0,"url":"ldap://10.0.1.72:389","bind_dn":"cn=admin,dc=tencent,dc=com","user_search.base_dn":"dc=tencent,dc=com","user_search.filter":"(cn={0})","group_search.base_dn":"dc=tencent,dc=com"}" |
ES library information
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| MainDict | Array of DictInfo | Yes | List of enabled word dictionaries |
| Stopwords | Array of DictInfo | Yes | List of stopword dictionaries |
| QQDict | Array of DictInfo | Yes | List of QQ word segmentation dictionaries |
| Synonym | Array of DictInfo | Yes | List of synonym dictionaries |
| UpdateType | String | Yes | Update the dictionary type |
| AnsjMain | Array of DictInfo | No | List of ansj enabled word dictionaries |
| AnsjStop | Array of DictInfo | No | List of ansj stopword dictionaries |
| AnsjAmbiguity | Array of DictInfo | No | List of ansj ambiguity lexicons |
| AnsjSynonyms | Array of DictInfo | No | List of ansj synonym dictionaries |
ES public network access control information
Used by actions: UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| BlackIpList | Array of String | No | Access the blocklist |
| WhiteIpList | Array of String | No | Access allowlist |
Gpu information of the node
Used by actions: CreateInstance, DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| GpuCount | Integer | No | Number of Gpu blocks |
| GpuType | String | No | GPU type. |
Index metadata field
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Description |
|---|---|---|
| IndexType | String | Index type |
| IndexName | String | Index name |
| IndexMetaJson | String | JSON-formatted index metadata |
| IndexStatus | String | Index status |
| IndexStorage | Integer | Index storage size in bytes |
| IndexCreateTime | String | Index creation time |
| BackingIndices | Array of BackingIndexMetaField | Backup index |
| ClusterId | String | Cluster ID of the index |
| ClusterName | String | Cluster name of the index |
| ClusterVersion | String | Version number of the cluster to which the index belongs |
| IndexPolicyField | IndexPolicyField | Index lifecycle field |
| IndexOptionsField | IndexOptionsField | Index autonomous field |
| IndexSettingsField | IndexSettingsField | Index configuration field |
| IndexAliasesField | Array of String | Index alias field |
| AppId | Integer | APP ID of the cluster to which the index belongs |
| IndexDocs | Integer | Number of indexed documents |
Index autonomous field
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Required | Description |
|---|---|---|---|
| ExpireMaxAge | String | No | Expiration time. |
| ExpireMaxSize | String | No | Expiration size |
| RolloverMaxAge | String | No | Rollover period |
| RolloverDynamic | String | No | Whether to enable dynamic scrolling |
| ShardNumDynamic | String | No | Whether to enable dynamic sharding |
| TimestampField | String | No | Time partition field |
| WriteMode | String | No | Write mode |
| FullOffloadedEnable | String | No | Whether to enable complete uninstallation Enumeration values:
|
| FullOffloadedMaxAge | String | No | Full uninstall lifecycle |
| FullOffloadedRetrieveMaxAge | String | No | Completely uninstall the lifecycle after backup index retrieval |
Index lifecycle field
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Required | Description |
|---|---|---|---|
| WarmEnable | String | No | Whether the warm phase is enabled |
| WarmMinAge | String | No | Transfer time to the warm phase |
| ColdEnable | String | No | Whether the cold phase is enabled |
| ColdMinAge | String | No | Transfer time to the cold phase |
| FrozenEnable | String | No | Whether the frozen phase is enabled |
| FrozenMinAge | String | No | Time of transfer to the frozen stage |
| ColdAction | String | No | / |
Index configuration field
Used by actions: DescribeIndexList, DescribeIndexMeta.
| Name | Type | Required | Description |
|---|---|---|---|
| NumberOfShards | String | No | Number of index primary shards |
| NumberOfReplicas | String | No | Replica shard count of an index |
| RefreshInterval | String | No | Index refresh frequency |
Instance details
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| InstanceName | String | Instance name. |
| Region | String | Region. |
| Zone | String | AZ. |
| AppId | Integer | uid |
| Uin | String | User UIN. |
| VpcUid | String | UID of the VPC to which the instance belongs |
| SubnetUid | String | UID of the subnet to which the instance belongs |
| Status | Integer | Instance status. 0: processing, 1: normal, -1: stopped, -2: being destroyed, -3: terminated, -4: isolated, 2: initializing when creating a cluster |
| RenewFlag | String | Auto-renewal flag. Value range: |
| ChargeType | String | Instance billing mode. Value ranges: PREPAID: prepaid mode, i.e., monthly subscription. POSTPAID_BY_HOUR: postpaid, i.e., pay-as-you-go. CDHPAID: CDH-paid mode, i.e., only charges for CDH, without charging for instances on CDH. |
| ChargePeriod | Integer | Annual and monthly subscription duration, unit: month |
| NodeType | String | Node specification |
| NodeNum | Integer | Number of nodes |
| CpuNum | Integer | Number of node CPU cores. |
| MemSize | Integer | Node memory size (GB). |
| DiskType | String | Node disk type |
| DiskSize | Integer | Node disk size (GB). |
| EsDomain | String | ES domain name |
| EsVip | String | ES VIP |
| EsPort | Integer | ES port |
| KibanaUrl | String | Kibana access url |
| EsVersion | String | ES version number |
| EsConfig | String | ES configuration item |
| EsAcl | EsAcl | Kibana Access Control Configuration |
| CreateTime | String | Instance creation time |
| UpdateTime | String | Last modification time of the instance |
| Deadline | String | Instance expiration time |
| InstanceType | Integer | Instance type (instance type flag, currently only 1 and 2) |
| IkConfig | EsDictionaryInfo | Ik analyzer configuration |
| MasterNodeInfo | MasterNodeInfo | Dedicated master node configuration |
| CosBackup | CosBackup | cos automatic backup configuration |
| AllowCosBackup | Boolean | Whether cos automatic backup is allowed |
| TagList | Array of TagInfo | Tag list of the instance |
| LicenseType | String | License type |
| RealLicenseType | String | License type |
| EnableHotWarmMode | Boolean | Whether it is a hot-cold cluster |
| WarmNodeType | String | Warm node specification |
| WarmNodeNum | Integer | Number of warm nodes |
| WarmCpuNum | Integer | Warm node CPU cores |
| WarmMemSize | Integer | Warm node memory size (GB). |
| WarmDiskType | String | Warm node disk type |
| WarmDiskSize | Integer | Warm node disk size (GB). |
| NodeInfoList | Array of NodeInfo | Cluster node information list |
| EsPublicUrl | String | Es public network address |
| MultiZoneInfo | Array of ZoneDetail | Multi-AZ network info |
| DeployMode | Integer | Deployment mode |
| PublicAccess | String | ES public access status |
| EsPublicAcl | EsAcl | ES public network access control configuration |
| KibanaPrivateUrl | String | Kibana private network address |
| KibanaPublicAccess | String | Kibana public access status |
| KibanaPrivateAccess | String | Kibana internal access status |
| SecurityType | Integer | Whether xpack security authentication is enabled for basic version 6.8 (and above versions) |
| SceneType | Integer | Scenario template type: 0, not enabled; 1, common scenarios; 2, log scenario; 3, search scenario |
| KibanaConfig | String | Kibana configuration item |
| KibanaNodeInfo | KibanaNodeInfo | Kibana node information |
| WebNodeTypeInfo | WebNodeTypeInfo | Visualize node configuration |
| Jdk | String | JDK type. Valid values: oracle, kona |
| Protocol | String | Cluster network communication protocol |
| SecurityGroups | Array of String | Security group id |
| ColdNodeType | String | Cold node specification |
| ColdNodeNum | Integer | Number of cold nodes |
| ColdCpuNum | Integer | Cold node CPU cores |
| ColdMemSize | Integer | Cold node memory size (GB). |
| ColdDiskType | String | Cold node disk type |
| ColdDiskSize | Integer | Cold node disk size (GB). |
| FrozenNodeType | String | Frozen node specification |
| FrozenNodeNum | Integer | Number of frozen nodes |
| FrozenCpuNum | Integer | Frozen node CPU cores |
| FrozenMemSize | Integer | Frozen node memory size (GB). |
| FrozenDiskType | String | Frozen node disk type |
| FrozenDiskSize | Integer | Frozen node disk size (GB). |
| HealthStatus | Integer | Cluster health status: -1 unknown; 0 Green; 1 Yellow; 2 Red |
| EsPrivateUrl | String | Intracluster network url for https. |
| EsPrivateDomain | String | https cluster private network domain name |
| EsConfigSets | Array of EsConfigSetInfo | Cluster configuration group information. |
| OperationDuration | OperationDuration | Cluster maintenance time slot |
| OptionalWebServiceInfos | Array of OptionalWebServiceInfo | web node list |
| AutoIndexEnabled | Boolean | Autonomous index switch |
| EnableHybridStorage | Boolean | Whether storage and computation separation is supported. |
| ProcessPercent | Float | Process progress. |
| KibanaAlteringPublicAccess | String | Kibana alerting public network alert policy |
| HasKernelUpgrade | Boolean | Whether there is a kernel update this month: false (no) and true (yes). |
| CdcId | String | cdcId, pass it when using a CDC subnet |
| KibanaPrivateVip | String | kibana intranet vip |
| CustomKibanaPrivateUrl | String | Customize the private network url of kibana |
| OutboundPublicAcls | Array of OutboundPublicAcl | Node outbound access detailed information. |
| NetConnectScheme | String | Network connection solution |
| DisasterRecoverGroupAffinity | Integer | Placement group related parameters |
| SubProductCode | String | Sub-product ID enumeration values: open source edition: "sp_es_io2", basic version: "sp_es_basic", platinum version: "sp_es_platinum", AI Search Enhancement Edition: "sp_es_aisearch", enterprise edition: "sp_es_enterprise", CDC platinum version: "sp_es_CDC_platinum", Log Enhancement Edition: "sp_es_enlogging", tsearch: "sp_tsearch_io2", logstash: "sp_es_logstash". It can be empty. When it is empty, the backend maps this field based on LicenseType. |
| CosBucketStorageSize | Integer | Storage-compute separation cos usage, Unit: M |
| ReadWriteMode | Integer | Read-write separation mode: 0: not enabled; 1: local read/write separation; 2: remote read/write separation. |
| EnableScheduleRecoverGroup | Boolean | Whether there is an asynchronous task scheduling for placement groups |
| EnableScheduleOperationDuration | EnableScheduleOperationDuration | The time when an asynchronous task is scheduled |
| EnableDestroyProtection | String | Cluster protection: OPEN: enable, CLOSE: disable |
| ShowKibanaIpPort | String | kibana intranet access address |
| IsCdzLite | Boolean | Whether it is a CDZLite availability zone |
| EsPrivateTcpUrl | String | Cluster private network tcp address |
| IsInRecycleBin | Boolean | Whether it is in the recycle bin Default value: false |
| RecycleLockEnabled | Boolean | Is locked in the recycle bin Default value: false |
| MayDestroyPoint | String | The time when termination is expected Parameter format: YYYY-MM-DD hh:mm:ss |
| DelayDestroyInterval | Integer | The time when termination is delayed Unit: day |
| EnableAutoReplace | Integer | Enable automatic replacement of unhealthy nodes. 0: disable, 1: enable |
| OpenMTLS | Integer | Enable mtls. 0: disable, 1: enable |
| ServerCertSource | String | Certificate type |
| OldEsVip | String | VIP pending migration for the cluster |
| OldEsPrivateTcpUrl | String | Cluster TCP address to be migrated |
| NeedOfflineOldNodesNotify | Boolean | Whether to take old nodes offline from the VIP |
ES cluster log details
Used by actions: DescribeInstanceLogs.
| Name | Type | Description |
|---|---|---|
| Time | String | Log time |
| Level | String | Log level |
| Ip | String | Cluster node IP address. |
| Message | String | Log content |
| NodeID | String | Cluster node ID. |
| IndexName | String | Slow log index name |
| Shard | String | Slow log index shards |
| QueryCost | String | Slow log index query time |
OperationDetail uses an array of this structure to describe the old and new configuration
Used by actions: DescribeInstanceOperations.
| Name | Type | Description |
|---|---|---|
| Key | String | Key. |
| Value | String | Value. |
Kibana node-related information of the instance
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| KibanaNodeType | String | Kibana node specification |
| KibanaNodeNum | Integer | Number of Kibana nodes |
| KibanaNodeCpuNum | Integer | Number of CPUs of the Kibana node |
| KibanaNodeMemSize | Integer | Kibana node memory in GB |
| KibanaNodeDiskType | String | Kibana node disk type |
| KibanaNodeDiskSize | Integer | Kibana node disk size |
Kibana view data
Used by actions: DescribeViews.
| Name | Type | Description |
|---|---|---|
| Ip | String | Kibana node IP |
| DiskSize | Integer | Total node disk size |
| DiskUsage | Float | Disk utilization rate |
| MemSize | Integer | Node memory size |
| MemUsage | Float | Memory usage rate |
| CpuNum | Integer | Number of CPUs on the node |
| CpuUsage | Float | cpu utilization |
| Zone | String | AZ. |
| NodeId | String | ts-0noqayxu-az6-hot-03222010-0 |
| UserIp | String | Client-side Ip info |
Local disk information of the node
Used by actions: CreateInstance, DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| LocalDiskType | String | Yes | Local disk type |
| LocalDiskSize | Integer | Yes | Single local disk size |
| LocalDiskCount | Integer | Yes | Number of local disk blocks |
Instance-dedicated primary node-related information
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| EnableDedicatedMaster | Boolean | Whether the dedicated master node is enabled or not |
| MasterNodeType | String | Dedicated primary node specification |
| MasterNodeNum | Integer | Number of dedicated primary nodes |
| MasterNodeCpuNum | Integer | Number of CPU cores of the dedicated master node |
| MasterNodeMemSize | Integer | Dedicated primary node memory size, in GB. |
| MasterNodeDiskSize | Integer | Dedicated primary node disk size in GB |
| MasterNodeDiskType | String | Dedicated primary node disk type |
Specification description information of a node type in the cluster (such as hot data node, cold data node, dedicated master node), including node type, number of nodes, node specification, disk type, and disk size. If Type is not specified, it defaults to hot data node. If the node is a master node, the DiskType and DiskSize parameters will be ignored (the primary node has no data disk).
Used by actions: CreateInstance, DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeNum | Integer | Yes | Number of nodes. |
| NodeType | String | Yes | Node specification |
| Type | String | No | Node type Enumeration values:
|
| DiskType | String | No | Node disk type |
| DiskSize | Integer | No | Node disk capacity (GB) |
| LocalDiskInfo | LocalDiskInfo | No | Node local disk information. |
| DiskCount | Integer | No | Number of node disk blocks |
| DiskEncrypt | Integer | No | Whether the node disk is encrypted. 0: no encryption; 1: encryption; not encrypted by default |
| KmsKeyId | String | No | Custom encryption key id |
| KmsKeyName | String | No | Custom encryption key name |
| CpuNum | Integer | No | Number of CPUs |
| MemSize | Integer | No | Memory size, in GB. |
| DiskEnhance | Integer | No | Additional hard disk performance |
| GpuInfo | GpuInfo | No | Gpu information of the node |
Node dimension view data
Used by actions: DescribeViews.
| Name | Type | Description |
|---|---|---|
| NodeId | String | Node ID. |
| NodeIp | String | Node IP |
| Visible | Float | Whether the node is visible |
| Break | Float | Whether to fuse |
| DiskSize | Integer | Total node disk size |
| DiskUsage | Float | Disk utilization rate |
| MemSize | Integer | Node memory size (unit: GB) |
| MemUsage | Float | Memory usage rate |
| CpuNum | Integer | Number of CPUs on the node |
| CpuUsage | Float | CPU utilization |
| Zone | String | AZ. |
| NodeRole | String | Node role |
| NodeHttpIp | String | Node HTTP IP |
| JvmMemUsage | Float | JVM memory usage rate |
| ShardNum | Integer | Number of shards per node |
| DiskIds | Array of String | Disk ID list on node |
| Hidden | Boolean | Whether it is a hidden AZ |
| IsCoordinationNode | Boolean | Whether to act as the coordination node role |
| CVMStatus | String | CVM running state |
| CVMDisasterRecoverGroupId | String | id of the placement group bound to the cvm |
| CVMDisasterRecoverGroupStatus | Integer | Status of the placement group bound to the cvm. 2: Bound; 1: Binding; 0: Not enabled |
Detailed ES cluster operation information
Used by actions: DescribeInstanceOperations.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Unique id of the operation |
| StartTime | String | Operation start time. |
| Type | String | Operation type. |
| Detail | OperationDetail | Operation details. |
| Result | String | Operation result. |
| Tasks | Array of TaskDetail | Process task info |
| Progress | Float | Operation progress. |
| RollbackTag | Integer | Rollback tag. 0: not rolled back, 1: rolling back, 2: rolled back |
| SubAccountUin | String | Operator Uin |
| AutoScaleTag | Integer | Auto scaling flag. Valid values: 0 (non-auto) and 1 (auto). |
| SuspendedReason | String | Process exception cause |
Operation details.
Used by actions: DescribeInstanceOperations.
| Name | Type | Description |
|---|---|---|
| OldInfo | Array of KeyValue | Original configuration message of the instance |
| NewInfo | Array of KeyValue | Configuration message after the instance update |
Cluster maintainability time
Used by actions: CreateInstance, DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Periods | Array of Integer | Yes | Maintenance period, which refers to Monday to Sunday. Valid values: [0, 6]. |
| TimeStart | String | Yes | Maintenance start time |
| TimeEnd | String | Yes | Maintenance end time. |
| TimeZone | String | Yes | Time zone in UTC format |
Cluster maintainability time
Used by actions: UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Periods | Array of Integer | Yes | Maintenance period, which refers to Monday to Sunday. Valid values: [0, 6]. |
| TimeStart | String | Yes | Maintenance start time |
| TimeEnd | String | Yes | Maintenance end time. |
| TimeZone | String | Yes | Time zone in UTC format |
| MoreInstances | Array of String | No | ES cluster ID array |
Optional web component information
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| Type | String | Type. |
| Status | Integer | Status. |
| PublicUrl | String | Public url |
| PrivateUrl | String | Private network url |
| PublicAccess | String | Public access permissions |
| PrivateAccess | String | Private network access permission |
| Version | String | Version |
| PrivateVip | String | Intranet vip of the web service |
| CustomPrivateUrl | String | Custom url of cerebro on the private network |
Additional EsConfig and JvmHeapConfig used by updateInstance
Used by actions: UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| EsConfig | String | No | Additional yml configuration for es |
| JvmHeapConfig | String | No | jvm heap configuration of es |
Node outbound access information
Used by actions: DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeType | String | Yes | Node types with permission for node outbound access |
| WhiteHostList | Array of String | No | Allowlist for outbound access from nodes |
Task progress details
Used by actions: DescribeInstanceOperations.
| Name | Type | Description |
|---|---|---|
| Completed | Integer | Number of completed |
| Remain | Integer | Remaining quantity |
| Total | Integer | Total quantity. |
| TaskType | Integer | Task type: |
| EstimatedTimeRemaining | Integer | Estimated remaining time Unit: seconds |
Subtask information in the process task of the instance operation record (for example, each check item in the upgrade check task)
Used by actions: DescribeInstanceOperations.
| Name | Type | Description |
|---|---|---|
| Name | String | Subtask name |
| Result | Boolean | Subtask result |
| ErrMsg | String | Subtask error message |
| Type | String | Subtask type |
| Status | Integer | Subtask status. 0: processing, 1: success, -1: failure |
| FailedIndices | Array of String | Index name that failed the upgrade check |
| FinishTime | String | Subtask end time |
| Level | Integer | Subtask level. 1: warning; 2: failure |
Instance tag information.
Used by actions: CreateInstance, DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key. |
| TagValue | String | Yes | Tag value. |
Process task information in the instance operation record
Used by actions: DescribeInstanceOperations.
| Name | Type | Description |
|---|---|---|
| Name | String | Task Name |
| Progress | Float | Task progress |
| FinishTime | String | Task completion time |
| SubTasks | Array of SubTaskDetail | Subtask |
| ElapsedTime | Integer | Time taken by the task |
| ProcessInfo | ProcessDetail | Task progress details |
Visualize node configuration
Used by actions: CreateInstance, DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| NodeNum | Integer | Yes | Number of nodes to visualize, fixed as 1 |
| NodeType | String | Yes | Visualize node specifications |
Detailed information of availability zones in multi-AZ deployment
Used by actions: CreateInstance, DescribeInstances, UpdateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| Zone | String | Yes | AZ. |
| SubnetId | String | Yes | Subnet ID. |
| Hidden | Boolean | No | Whether it is a hidden AZ |
피드백