@nocobase/plugin-verification

/** * 实例操作记录中的流程任务信息 */ export interface TaskDetail { /** * 任务名 */ Name: string; /** * 任务进度 */ Progress: number; /** * 任务完成时间 */ FinishTime: string; /** * 子任务 */ SubTasks: Array<SubTaskDetail>; /** * 任务花费时间注意：此字段可能返回 null，表示取不到有效值。 */ ElapsedTime: number; /** * 任务进度详情注意：此字段可能返回 null，表示取不到有效值。 */ ProcessInfo?: ProcessDetail; } /** * RestartLogstashInstance请求参数结构体 */ export interface RestartLogstashInstanceRequest { /** * 实例ID */ InstanceId: string; /** * 重启类型，0全量重启，1滚动重启 */ Type?: number; } /** * DescribeInstanceOperations请求参数结构体 */ export interface DescribeInstanceOperationsRequest { /** * 集群实例ID */ InstanceId: string; /** * 起始时间, e.g. "2019-03-07 16:30:39" */ StartTime: string; /** * 结束时间, e.g. "2019-03-30 20:18:03" */ EndTime: string; /** * 分页起始值 */ Offset: number; /** * 分页大小 */ Limit: number; } /** * Logstash实例详细信息 */ export interface LogstashInstanceInfo { /** * 实例ID */ InstanceId: string; /** * 实例名称 */ InstanceName: string; /** * 地域 */ Region: string; /** * 可用区 */ Zone: string; /** * 用户ID */ AppId: number; /** * 用户UIN */ Uin: string; /** * 实例所属VPC的ID */ VpcId: string; /** * 实例所属子网的ID */ SubnetId: string; /** * 实例状态，0:处理中,1:正常,-1停止,-2:销毁中,-3:已销毁 */ Status: number; /** * 实例计费模式。取值范围： PREPAID：表示预付费，即包年包月 POSTPAID_BY_HOUR：表示后付费，即按量计费 CDHPAID：CDH付费，即只对CDH计费，不对CDH上的实例计费。 */ ChargeType: string; /** * 包年包月购买时长,单位:月 */ ChargePeriod: number; /** * 自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 */ RenewFlag: string; /** * 节点规格<li>LOGSTASH.S1.SMALL2：1核2G</li><li>LOGSTASH.S1.MEDIUM4：2核4G</li><li>LOGSTASH.S1.MEDIUM8：2核8G</li><li>LOGSTASH.S1.LARGE16：4核16G</li><li>LOGSTASH.S1.2XLARGE32：8核32G</li><li>LOGSTASH.S1.4XLARGE32：16核32G</li><li>LOGSTASH.S1.4XLARGE64：16核64G</li> */ NodeType: string; /** * 节点个数 */ NodeNum: number; /** * 节点磁盘类型 */ DiskType: string; /** * 节点磁盘大小，单位GB */ DiskSize: number; /** * Logstash版本号 */ LogstashVersion: string; /** * License类型<li>oss：开源版</li><li>xpack：基础版</li>默认值xpack */ LicenseType: string; /** * 实例创建时间 */ CreateTime: string; /** * 实例最后修改操作时间 */ UpdateTime: string; /** * 实例到期时间 */ Deadline: string; /** * 实例节点类型 */ Nodes: Array<LogstashNodeInfo>; /** * 实例绑定的ES集群ID */ BindedESInstanceId: string; /** * 实例的YML配置注意：此字段可能返回 null，表示取不到有效值。 */ YMLConfig: string; /** * 扩展文件列表注意：此字段可能返回 null，表示取不到有效值。 */ ExtendedFiles: Array<LogstashExtendedFile>; /** * 可维护时间段注意：此字段可能返回 null，表示取不到有效值。 */ OperationDuration: OperationDuration; /** * CPU数量注意：此字段可能返回 null，表示取不到有效值。 */ CpuNum: number; /** * 实例标签信息注意：此字段可能返回 null，表示取不到有效值。 */ TagList: Array<TagInfo>; /** * 内存大小注意：此字段可能返回 null，表示取不到有效值。 */ MemSize: number; } /** * 操作详情 */ export interface OperationDetail { /** * 实例原始配置信息 */ OldInfo: Array<KeyValue>; /** * 实例更新后配置信息 */ NewInfo: Array<KeyValue>; } /** * DiagnoseInstance返回参数结构体 */ export interface DiagnoseInstanceResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ES公网访问控制信息 */ export interface EsPublicAcl { /** * 访问黑名单 */ BlackIpList?: Array<string>; /** * 访问白名单 */ WhiteIpList?: Array<string>; } /** * ik插件词典信息 */ export interface DictInfo { /** * 词典键值 */ Key: string; /** * 词典名称 */ Name: string; /** * 词典大小，单位B */ Size: number; } /** * DescribeDiagnose返回参数结构体 */ export interface DescribeDiagnoseResponse { /** * 诊断报告个数 */ Total?: number; /** * 诊断报告列表 */ DiagnoseResults?: Array<DiagnoseResult>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLogstashInstanceLogs返回参数结构体 */ export interface DescribeLogstashInstanceLogsResponse { /** * 返回的日志条数 */ TotalCount: number; /** * 日志详细信息列表 */ InstanceLogList: Array<InstanceLog>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateInstance返回参数结构体 */ export interface CreateInstanceResponse { /** * 实例ID */ InstanceId?: string; /** * 订单号注意：此字段可能返回 null，表示取不到有效值。 */ DealName?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceLogs请求参数结构体 */ export interface DescribeInstanceLogsRequest { /** * 集群实例ID */ InstanceId: string; /** * 日志类型，默认值为1 <li>1, 主日志</li> <li>2, 搜索慢日志</li> <li>3, 索引慢日志</li> <li>4, GC日志</li> */ LogType?: number; /** * 搜索词，支持LUCENE语法，如 level:WARN、ip:1.1.1.1、message:test-index等 */ SearchKey?: string; /** * 日志开始时间，格式为YYYY-MM-DD HH:MM:SS, 如2019-01-22 20:15:53 */ StartTime?: string; /** * 日志结束时间，格式为YYYY-MM-DD HH:MM:SS, 如2019-01-22 20:15:53 */ EndTime?: string; /** * 分页起始值, 默认值为0 */ Offset?: number; /** * 分页大小，默认值为100，最大值100 */ Limit?: number; /** * 时间排序方式，默认值为0 <li>0, 降序</li> <li>1, 升序</li> */ OrderByType?: number; } /** * DeleteLogstashPipelines返回参数结构体 */ export interface DeleteLogstashPipelinesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例标签信息 */ export interface TagInfo { /** * 标签键 */ TagKey: string; /** * 标签值 */ TagValue: string; } /** * OperationDetail使用此结构的数组描述新旧配置 */ export interface KeyValue { /** * 键 */ Key: string; /** * 值 */ Value: string; } /** * UpdateLogstashPipelineDesc返回参数结构体 */ export interface UpdateLogstashPipelineDescResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstances返回参数结构体 */ export interface DescribeInstancesResponse { /** * 返回的实例个数 */ TotalCount?: number; /** * 实例详细信息列表 */ InstanceList?: Array<InstanceInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceLogs返回参数结构体 */ export interface DescribeInstanceLogsResponse { /** * 返回的日志条数 */ TotalCount?: number; /** * 日志详细信息列表 */ InstanceLogList?: Array<InstanceLog>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 索引元数据字段 */ export interface IndexMetaField { /** * 索引类型注意：此字段可能返回 null，表示取不到有效值。 */ IndexType?: string; /** * 索引名注意：此字段可能返回 null，表示取不到有效值。 */ IndexName?: string; /** * 索引元数据JSON 注意：此字段可能返回 null，表示取不到有效值。 */ IndexMetaJson?: string; /** * 索引状态注意：此字段可能返回 null，表示取不到有效值。 */ IndexStatus?: string; /** * 索引存储大小，单位Byte 注意：此字段可能返回 null，表示取不到有效值。 */ IndexStorage?: number; /** * 索引创建时间注意：此字段可能返回 null，表示取不到有效值。 */ IndexCreateTime?: string; /** * 后备索引注意：此字段可能返回 null，表示取不到有效值。 */ BackingIndices?: Array<BackingIndexMetaField>; /** * 索引所属集群ID 注意：此字段可能返回 null，表示取不到有效值。 */ ClusterId?: string; /** * 索引所属集群名注意：此字段可能返回 null，表示取不到有效值。 */ ClusterName?: string; /** * 索引所属集群版本注意：此字段可能返回 null，表示取不到有效值。 */ ClusterVersion?: string; /** * 索引生命周期字段注意：此字段可能返回 null，表示取不到有效值。 */ IndexPolicyField?: IndexPolicyField; /** * 索引自治字段注意：此字段可能返回 null，表示取不到有效值。 */ IndexOptionsField?: IndexOptionsField; /** * 索引配置字段注意：此字段可能返回 null，表示取不到有效值。 */ IndexSettingsField?: IndexSettingsField; /** * 索引所属集群APP ID 注意：此字段可能返回 null，表示取不到有效值。 */ AppId?: number; /** * 索引文档数注意：此字段可能返回 null，表示取不到有效值。 */ IndexDocs?: number; } /** * DiagnoseInstance请求参数结构体 */ export interface DiagnoseInstanceRequest { /** * ES实例ID */ InstanceId: string; /** * 需要触发的诊断项 */ DiagnoseJobs?: Array<string>; /** * 需要诊断的索引，支持通配符 */ DiagnoseIndices?: string; } /** * Logstash绑定的ES集群信息 */ export interface LogstashBindedES { /** * ES集群ID */ ESInstanceId: string; /** * ES集群用户名 */ ESUserName: string; /** * ES集群密码 */ ESPassword: string; } /** * UpdateDiagnoseSettings请求参数结构体 */ export interface UpdateDiagnoseSettingsRequest { /** * ES实例ID */ InstanceId: string; /** * 0：开启智能运维；-1：关闭智能运维 */ Status?: number; /** * 智能运维每天定时巡检时间，时间格式为HH:00:00，例如15:00:00 */ CronTime?: string; } /** * DescribeInstanceOperations返回参数结构体 */ export interface DescribeInstanceOperationsResponse { /** * 操作记录总数 */ TotalCount?: number; /** * 操作记录 */ Operations?: Array<Operation>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 索引自治字段 */ export interface IndexOptionsField { /** * 过期时间注意：此字段可能返回 null，表示取不到有效值。 */ ExpireMaxAge?: string; /** * 过期大小注意：此字段可能返回 null，表示取不到有效值。 */ ExpireMaxSize?: string; /** * 滚动周期注意：此字段可能返回 null，表示取不到有效值。 */ RolloverMaxAge?: string; /** * 是否开启动态滚动注意：此字段可能返回 null，表示取不到有效值。 */ RolloverDynamic?: string; /** * 是否开启动态分片注意：此字段可能返回 null，表示取不到有效值。 */ ShardNumDynamic?: string; /** * 时间分区字段注意：此字段可能返回 null，表示取不到有效值。 */ TimestampField?: string; /** * 写入模式注意：此字段可能返回 null，表示取不到有效值。 */ WriteMode?: string; } /** * UpdateRequestTargetNodeTypes返回参数结构体 */ export interface UpdateRequestTargetNodeTypesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 智能运维诊断参数 */ export interface JobParam { /** * 诊断项列表注意：此字段可能返回 null，表示取不到有效值。 */ Jobs: Array<string>; /** * 诊断索引 */ Indices: string; /** * 历史诊断时间 */ Interval: number; } /** * DeleteLogstashInstance返回参数结构体 */ export interface DeleteLogstashInstanceResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Logstash管道信息 */ export interface LogstashPipeline { /** * 管道ID */ PipelineId: string; /** * 管道描述信息注意：此字段可能返回 null，表示取不到有效值。 */ PipelineDesc: string; /** * 管道配置内容 */ Config: string; /** * 管道的Worker数量注意：此字段可能返回 null，表示取不到有效值。 */ Workers: number; /** * 管道批处理大小注意：此字段可能返回 null，表示取不到有效值。 */ BatchSize: number; /** * 管道批处理延迟注意：此字段可能返回 null，表示取不到有效值。 */ BatchDelay: number; /** * 管道缓冲队列类型注意：此字段可能返回 null，表示取不到有效值。 */ QueueType: string; /** * 管道缓冲队列大小注意：此字段可能返回 null，表示取不到有效值。 */ QueueMaxBytes: string; /** * 管道缓冲队列检查点写入数注意：此字段可能返回 null，表示取不到有效值。 */ QueueCheckPointWrites: number; } /** * 实例操作记录流程任务中的子任务信息（如升级检查任务中的各个检查项） */ export interface SubTaskDetail { /** * 子任务名 */ Name: string; /** * 子任务结果 */ Result: boolean; /** * 子任务错误信息 */ ErrMsg: string; /** * 子任务类型 */ Type: string; /** * 子任务状态，0处理中 1成功 -1失败 */ Status: number; /** * 升级检查失败的索引名 */ FailedIndices: Array<string>; /** * 子任务结束时间 */ FinishTime: string; /** * 子任务等级，1警告 2失败 */ Level: number; } /** * 智能运维支持的诊断项和元信息 */ export interface DiagnoseJobMeta { /** * 智能运维诊断项英文名 */ JobName: string; /** * 智能运维诊断项中文名 */ JobZhName: string; /** * 智能运维诊断项描述 */ JobDescription: string; } /** * 配置组信息 */ export interface EsConfigSetInfo { /** * 配置组类型，如ldap,ad等 */ Type: string; /** * "{\"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\"}" */ EsConfig: string; } /** * GetRequestTargetNodeTypes返回参数结构体 */ export interface GetRequestTargetNodeTypesResponse { /** * 接收请求的目标节点类型列表 */ TargetNodeTypes?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ES集群操作详细信息 */ export interface Operation { /** * 操作唯一id */ Id: number; /** * 操作开始时间 */ StartTime: string; /** * 操作类型 */ Type: string; /** * 操作详情 */ Detail: OperationDetail; /** * 操作结果 */ Result: string; /** * 流程任务信息 */ Tasks: Array<TaskDetail>; /** * 操作进度 */ Progress: number; /** * 操作者Uin 注意：此字段可能返回 null，表示取不到有效值。 */ SubAccountUin?: string; } /** * ES集群日志详细信息 */ export interface InstanceLog { /** * 日志时间 */ Time: string; /** * 日志级别 */ Level: string; /** * 集群节点ip */ Ip: string; /** * 日志内容 */ Message: string; /** * 集群节点ID */ NodeID?: string; } /** * 智能运维诊断结果 */ export interface DiagnoseResult { /** * ES实例ID */ InstanceId: string; /** * 诊断报告ID */ RequestId: string; /** * 诊断触发时间 */ CreateTime: string; /** * 诊断是否完成 */ Completed: boolean; /** * 诊断总得分 */ Score: number; /** * 诊断类型，2 定时诊断，3 客户手动触发诊断 */ JobType: number; /** * 诊断参数，如诊断时间，诊断索引等 */ JobParam: JobParam; /** * 诊断项结果列表 */ JobResults: Array<DiagnoseJobResult>; } /** * 智能运维日志详情 */ export interface LogDetail { /** * 日志异常名 */ Key: string; /** * 日志异常处理建议 */ Advise: string; /** * 日志异常名出现次数 */ Count: number; } /** * DescribeIndexMeta返回参数结构体 */ export interface DescribeIndexMetaResponse { /** * 索引元数据字段注意：此字段可能返回 null，表示取不到有效值。 */ IndexMetaField?: IndexMetaField; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StartLogstashPipelines请求参数结构体 */ export interface StartLogstashPipelinesRequest { /** * 实例ID */ InstanceId: string; /** * 管道ID列表 */ PipelineIds: Array<string>; } /** * GetDiagnoseSettings返回参数结构体 */ export interface GetDiagnoseSettingsResponse { /** * 智能运维诊断项和元信息 */ DiagnoseJobMetas?: Array<DiagnoseJobMeta>; /** * 0：开启智能运维；-1：关闭智能运维 */ Status?: number; /** * 智能运维每天定时巡检时间 */ CronTime?: string; /** * 智能运维当天已手动触发诊断次数 */ Count?: number; /** * 智能运维每天最大可手动触发次数 */ MaxCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Kibana视图数据 */ export interface KibanaView { /** * Kibana节点IP */ Ip: string; /** * 节点总磁盘大小 */ DiskSize: number; /** * 磁盘使用率 */ DiskUsage: number; /** * 节点内存大小 */ MemSize: number; /** * 内存使用率 */ MemUsage: number; /** * 节点cpu个数 */ CpuNum: number; /** * cpu使用率 */ CpuUsage: number; /** * 可用区 */ Zone: string; /** * ts-0noqayxu-az6-hot-03222010-0 */ NodeId?: string; } /** * 索引配置字段 */ export interface IndexSettingsField { /** * 索引主分片数注意：此字段可能返回 null，表示取不到有效值。 */ NumberOfShards?: string; /** * 索引副本分片数注意：此字段可能返回 null，表示取不到有效值。 */ NumberOfReplicas?: string; /** * 索引刷新频率注意：此字段可能返回 null，表示取不到有效值。 */ RefreshInterval?: string; } /** * UpgradeLicense返回参数结构体 */ export interface UpgradeLicenseResponse { /** * 订单号注意：此字段可能返回 null，表示取不到有效值。 */ DealName?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Logstash扩展文件信息 */ export interface LogstashExtendedFile { /** * 扩展文件名称 */ Name: string; /** * 扩展文件大小，单位B */ Size: number; } /** * UpdateLogstashInstance请求参数结构体 */ export interface UpdateLogstashInstanceRequest { /** * 实例ID */ InstanceId: string; /** * 实例节点数量 */ NodeNum?: number; /** * 实例YML配置 */ YMLConfig?: string; /** * 实例绑定的ES集群信息 */ BindedES?: LogstashBindedES; /** * 实例名称 */ InstanceName?: string; /** * 扩展文件列表 */ ExtendedFiles?: Array<LogstashExtendedFile>; /** * 实例规格 */ NodeType?: string; /** * 节点磁盘容量 */ DiskSize?: number; /** * 可维护时间段 */ OperationDuration?: OperationDurationUpdated; } /** * UpdateRequestTargetNodeTypes请求参数结构体 */ export interface UpdateRequestTargetNodeTypesRequest { /** * 实例ID */ InstanceId: string; /** * 接收请求的目标节点类型列表 */ TargetNodeTypes: Array<string>; } /** * DescribeLogstashInstances返回参数结构体 */ export interface DescribeLogstashInstancesResponse { /** * 返回的实例个数 */ TotalCount: number; /** * 实例详细信息列表 */ InstanceList: Array<LogstashInstanceInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteInstance返回参数结构体 */ export interface DeleteInstanceResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 智能运维集群配置详情 */ export interface SettingDetail { /** * 配置key */ Key: string; /** * 配置当前值 */ Value: string; /** * 配置处理建议 */ Advise: string; } /** * DescribeLogstashInstanceOperations返回参数结构体 */ export interface DescribeLogstashInstanceOperationsResponse { /** * 操作记录总数 */ TotalCount: number; /** * 操作记录 */ Operations: Array<Operation>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateIndex请求参数结构体 */ export interface CreateIndexRequest { /** * ES集群ID */ InstanceId: string; /** * 创建的索引类型。auto：自治索引；normal：普通索引 */ IndexType: string; /** * 创建的索引名 */ IndexName: string; /** * 【必填】创建的索引元数据JSON，如mappings、settings */ IndexMetaJson?: string; /** * 集群访问用户名 */ Username?: string; /** * 集群访问密码 */ Password?: string; } /** * Logstash管道信息 */ export interface LogstashPipelineInfo { /** * 管道ID */ PipelineId: string; /** * 管道描述信息注意：此字段可能返回 null，表示取不到有效值。 */ PipelineDesc: string; /** * 管道配置内容 */ Config: string; /** * 管道状态注意：此字段可能返回 null，表示取不到有效值。 */ Status: number; /** * 管道的Worker数量注意：此字段可能返回 null，表示取不到有效值。 */ Workers: number; /** * 管道批处理大小注意：此字段可能返回 null，表示取不到有效值。 */ BatchSize: number; /** * 管道批处理延迟注意：此字段可能返回 null，表示取不到有效值。 */ BatchDelay: number; /** * 管道缓冲队列类型注意：此字段可能返回 null，表示取不到有效值。 */ QueueType: string; /** * 管道缓冲队列大小注意：此字段可能返回 null，表示取不到有效值。 */ QueueMaxBytes: string; /** * 管道缓冲队列检查点写入数注意：此字段可能返回 null，表示取不到有效值。 */ QueueCheckPointWrites: number; } /** * UpdatePlugins请求参数结构体 */ export interface UpdatePluginsRequest { /** * 实例ID */ InstanceId: string; /** * 需要安装的插件名列表 */ InstallPluginList?: Array<string>; /** * 需要卸载的插件名列表 */ RemovePluginList?: Array<string>; /** * 是否强制重启，默认值false */ ForceRestart?: boolean; /** * 是否重新安装，默认值false */ ForceUpdate?: boolean; /** * 0：系统插件 */ PluginType?: number; } /** * 智能运维指标维度 */ export interface Dimension { /** * 智能运维指标维度Key */ Key: string; /** * 智能运维指标维度值 */ Value: string; } /** * InquirePriceRenewInstance请求参数结构体 */ export interface InquirePriceRenewInstanceRequest { /** * 集群实例Id */ InstanceId: string; } /** * UpdateJdk返回参数结构体 */ export interface UpdateJdkResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 智能运维指标 */ export interface Metric { /** * 指标维度族 */ Dimensions: Array<Dimension>; /** * 指标值 */ Value: number; } /** * UpdateInstance返回参数结构体 */ export interface UpdateInstanceResponse { /** * 订单号注意：此字段可能返回 null，表示取不到有效值。 */ DealName?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteIndex请求参数结构体 */ export interface DeleteIndexRequest { /** * ES集群ID */ InstanceId: string; /** * 删除的索引类型。auto：自治索引；normal：普通索引 */ IndexType: string; /** * 删除的索引名 */ IndexName: string; /** * 集群访问用户名 */ Username?: string; /** * 集群访问密码 */ Password?: string; /** * 后备索引名 */ BackingIndexName?: string; } /** * DescribeViews请求参数结构体 */ export interface DescribeViewsRequest { /** * 集群实例ID */ InstanceId: string; } /** * DescribeIndexList返回参数结构体 */ export interface DescribeIndexListResponse { /** * 索引元数据字段注意：此字段可能返回 null，表示取不到有效值。 */ IndexMetaFields?: Array<IndexMetaField>; /** * 查询总数注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StartLogstashPipelines返回参数结构体 */ export interface StartLogstashPipelinesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLogstashInstanceOperations请求参数结构体 */ export interface DescribeLogstashInstanceOperationsRequest { /** * 实例ID */ InstanceId: string; /** * 起始时间, e.g. "2019-03-07 16:30:39" */ StartTime?: string; /** * 结束时间, e.g. "2019-03-30 20:18:03" */ EndTime?: string; /** * 分页起始值 */ Offset?: number; /** * 分页大小 */ Limit?: number; } /** * 插件信息 */ export interface DescribeInstancePluginInfo { /** * 插件名 */ PluginName: string; /** * 插件版本 */ PluginVersion: string; /** * 插件描述 */ PluginDesc: string; /** * 插件状态：-2 已卸载 -1 卸载中 0 安装中 1 已安装 */ Status: number; /** * 插件是否可卸载 */ Removable: boolean; /** * 0：系统插件 */ PluginType: number; /** * 插件变更时间 */ PluginUpdateTime: string; } /** * CreateLogstashInstance返回参数结构体 */ export interface CreateLogstashInstanceResponse { /** * 实例ID */ InstanceId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SaveAndDeployLogstashPipeline请求参数结构体 */ export interface SaveAndDeployLogstashPipelineRequest { /** * 实例ID */ InstanceId: string; /** * 实例管道信息 */ Pipeline: LogstashPipeline; /** * 操作类型<li>1：只保存</li><li>2：保存并部署</li> */ OpType?: number; } /** * 集群维度视图数据 */ export interface ClusterView { /** * 集群健康状态 */ Health?: number; /** * 集群是否可见 */ Visible: number; /** * 集群是否熔断 */ Break: number; /** * 平均磁盘使用率 */ AvgDiskUsage: number; /** * 平均内存使用率 */ AvgMemUsage: number; /** * 平均cpu使用率 */ AvgCpuUsage: number; /** * 集群总存储大小 */ TotalDiskSize: number; /** * 客户端请求节点 */ TargetNodeTypes: Array<string>; /** * 在线节点数 */ NodeNum: number; /** * 总节点数 */ TotalNodeNum: number; /** * 数据节点数 */ DataNodeNum: number; /** * 索引数 */ IndexNum: number; /** * 文档数 */ DocNum: number; /** * 磁盘已使用字节数 */ DiskUsedInBytes: number; /** * 分片个数 */ ShardNum: number; /** * 主分片个数 */ PrimaryShardNum: number; /** * 迁移中的分片个数 */ RelocatingShardNum: number; /** * 初始化中的分片个数 */ InitializingShardNum: number; /** * 未分配的分片个数 */ UnassignedShardNum: number; /** * 企业版COS存储容量大小，单位GB */ TotalCosStorage: number; /** * 企业版集群可搜索快照cos存放的bucket名称注意：此字段可能返回 null，表示取不到有效值。 */ SearchableSnapshotCosBucket: string; /** * 企业版集群可搜索快照cos所属appid 注意：此字段可能返回 null，表示取不到有效值。 */ SearchableSnapshotCosAppId: string; } /** * CreateIndex返回参数结构体 */ export interface CreateIndexResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquirePriceRenewInstance返回参数结构体 */ export interface InquirePriceRenewInstanceResponse { /** * 刊例价，即集群原始价格 */ OriginalPrice?: number; /** * 折后价 */ DiscountPrice?: number; /** * 折扣，如65折 */ Discount?: number; /** * 货币，如CNY代表人民币 */ Currency?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLogstashPipelines请求参数结构体 */ export interface DeleteLogstashPipelinesRequest { /** * 实例ID */ InstanceId: string; /** * 管道ID列表 */ PipelineIds?: Array<string>; } /** * RestartKibana请求参数结构体 */ export interface RestartKibanaRequest { /** * ES实例ID */ InstanceId: string; } /** * SaveAndDeployLogstashPipeline返回参数结构体 */ export interface SaveAndDeployLogstashPipelineResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateDictionaries请求参数结构体 */ export interface UpdateDictionariesRequest { /** * ES实例ID */ InstanceId: string; /** * 安装时填IK分词主词典COS地址，删除时填词典名如test.dic */ IkMainDicts?: Array<string>; /** * 安装时填IK分词停用词词典COS地址，删除时填词典名如test.dic */ IkStopwords?: Array<string>; /** * 安装时填同义词词典COS地址，删除时填词典名如test.dic */ Synonym?: Array<string>; /** * 安装时填QQ分词词典COS地址，删除时填词典名如test.dic */ QQDict?: Array<string>; /** * 0：安装；1：删除。默认值0 */ UpdateType?: number; /** * 是否强制重启集群。默认值false */ ForceRestart?: boolean; } /** * 集群可运维时间 */ export interface OperationDuration { /** * 维护周期，表示周一到周日，可取值[0, 6] 注意：此字段可能返回 null，表示取不到有效值。 */ Periods: Array<number | bigint>; /** * 维护开始时间 */ TimeStart: string; /** * 维护结束时间 */ TimeEnd: string; /** * 时区，以UTC形式表示 */ TimeZone: string; } /** * UpgradeLicense请求参数结构体 */ export interface UpgradeLicenseRequest { /** * 实例ID */ InstanceId: string; /** * License类型<li>oss：开源版</li><li>basic：基础版</li><li>platinum：白金版</li>默认值platinum */ LicenseType: string; /** * 是否自动使用代金券<li>0：不自动使用</li><li>1：自动使用</li>默认值0 */ AutoVoucher?: number; /** * 代金券ID列表（目前仅支持指定一张代金券） */ VoucherIds?: Array<string>; /** * 6.8（及以上版本）基础版是否开启xpack security认证<li>1：不开启</li><li>2：开启</li><li>不传参时会默认维持原状，传参时需注意只能由不开启变为开启，无法由开启变为不开启</li> */ BasicSecurityType?: number; /** * 是否强制重启<li>true强制重启</li><li>false不强制重启</li> 默认值false */ ForceRestart?: boolean; } /** * DescribeIndexList请求参数结构体 */ export interface DescribeIndexListRequest { /** * 索引类型。auto：自治索引；normal：普通索引 */ IndexType: string; /** * ES集群ID */ InstanceId?: string; /** * 索引名，若填空则获取所有索引 */ IndexName?: string; /** * 集群访问用户名 */ Username?: string; /** * 集群访问密码 */ Password?: string; /** * 分页起始位置 */ Offset?: number; /** * 一页展示数量 */ Limit?: number; /** * 排序字段，支持索引名：IndexName、索引存储量：IndexStorage、索引创建时间：IndexCreateTime */ OrderBy?: string; /** * 过滤索引状态 */ IndexStatusList?: Array<string>; /** * 排序顺序，支持asc、desc，默认为desc 数据格式"asc","desc" */ Order?: string; } /** * 集群中一种节点类型（如热数据节点，冷数据节点，专用主节点等）的规格描述信息，包括节点类型，节点个数，节点规格，磁盘类型，磁盘大小等, Type不指定时默认为热数据节点；如果节点为master节点，则DiskType和DiskSize参数会被忽略（主节点无数据盘） */ export interface NodeInfo { /** * 节点数量 */ NodeNum: number; /** * 节点规格<li>ES.S1.SMALL2：1核2G</li><li>ES.S1.MEDIUM4：2核4G</li><li>ES.S1.MEDIUM8：2核8G</li><li>ES.S1.LARGE16：4核16G</li><li>ES.S1.2XLARGE32：8核32G</li><li>ES.S1.4XLARGE32：16核32G</li><li>ES.S1.4XLARGE64：16核64G</li> */ NodeType: string; /** * 节点类型<li>hotData: 热数据节点</li> <li>warmData: 冷数据节点</li> <li>dedicatedMaster: 专用主节点</li> 默认值为hotData */ Type?: string; /** * 节点磁盘类型<li>CLOUD_SSD：SSD云硬盘</li><li>CLOUD_PREMIUM：高硬能云硬盘</li>默认值CLOUD_SSD */ DiskType?: string; /** * 节点磁盘容量（单位GB） */ DiskSize?: number; /** * 节点本地盘信息注意：此字段可能返回 null，表示取不到有效值。 */ LocalDiskInfo?: LocalDiskInfo; /** * 节点磁盘块数 */ DiskCount?: number; /** * 节点磁盘是否加密 0: 不加密，1: 加密；默认不加密 */ DiskEncrypt?: number; /** * cpu数目注意：此字段可能返回 null，表示取不到有效值。 */ CpuNum?: number; /** * 内存大小，单位GB 注意：此字段可能返回 null，表示取不到有效值。 */ MemSize?: number; /** * / 注意：此字段可能返回 null，表示取不到有效值。 */ DiskEnhance?: number; } /** * ES cos自动备份信息 */ export interface CosBackup { /** * 是否开启cos自动备份 */ IsAutoBackup: boolean; /** * 自动备份执行时间（精确到小时）, e.g. "22:00" */ BackupTime: string; } /** * DescribeLogstashPipelines返回参数结构体 */ export interface DescribeLogstashPipelinesResponse { /** * 管道总数 */ TotalCount: number; /** * 管道列表 */ LogstashPipelineList: Array<LogstashPipelineInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 集群可运维时间 */ export interface OperationDurationUpdated { /** * 维护周期，表示周一到周日，可取值[0, 6] */ Periods: Array<number | bigint>; /** * 维护开始时间 */ TimeStart: string; /** * 维护结束时间 */ TimeEnd: string; /** * 时区，以UTC形式表示 */ TimeZone: string; /** * ES集群ID数组 */ MoreInstances?: Array<string>; } /** * CreateInstance请求参数结构体 */ export interface CreateInstanceRequest { /** * 可用区 */ Zone: string; /** * 实例版本（支持"5.6.4"、"6.4.3"、"6.8.2"、"7.5.1"、"7.10.1"） */ EsVersion: string; /** * 私有网络ID */ VpcId: string; /** * 子网ID */ SubnetId: string; /** * 访问密码（密码需8到16位，至少包括两项（[a-z,A-Z],[0-9]和[-!@#$%&^*+=_:;,.?]的特殊符号） */ Password: string; /** * 实例名称（1-50 个英文、汉字、数字、连接线-或下划线_） */ InstanceName?: string; /** * 已废弃请使用NodeInfoList 节点数量（2-50个） */ NodeNum?: number; /** * 计费类型<li>PREPAID：预付费，即包年包月</li><li>POSTPAID_BY_HOUR：按小时后付费</li>默认值POSTPAID_BY_HOUR */ ChargeType?: string; /** * 包年包月购买时长（单位由参数TimeUnit决定） */ ChargePeriod?: number; /** * 自动续费标识<li>RENEW_FLAG_AUTO：自动续费</li><li>RENEW_FLAG_MANUAL：不自动续费，用户手动续费</li>ChargeType为PREPAID时需要设置，如不传递该参数，普通用户默认不自动续费，SVIP用户自动续费 */ RenewFlag?: string; /** * 已废弃请使用NodeInfoList 节点规格<li>ES.S1.SMALL2：1核2G</li><li>ES.S1.MEDIUM4：2核4G</li><li>ES.S1.MEDIUM8：2核8G</li><li>ES.S1.LARGE16：4核16G</li><li>ES.S1.2XLARGE32：8核32G</li><li>ES.S1.4XLARGE32：16核32G</li><li>ES.S1.4XLARGE64：16核64G</li> */ NodeType?: string; /** * 已废弃请使用NodeInfoList 节点磁盘类型<li>CLOUD_SSD：SSD云硬盘</li><li>CLOUD_PREMIUM：高性能云硬盘</li><li> CLOUD_HSSD：增强型SSD云硬盘</li><li> CLOUD_BSSD：通用型SSD云硬盘</li>默认值CLOUD_SSD */ DiskType?: string; /** * 已废弃请使用NodeInfoList 节点磁盘容量（单位GB） */ DiskSize?: number; /** * 计费时长单位（ChargeType为PREPAID时需要设置，默认值为“m”，表示月，当前只支持“m”） */ TimeUnit?: string; /** * 是否自动使用代金券<li>0：不自动使用</li><li>1：自动使用</li>默认值0 */ AutoVoucher?: number; /** * 代金券ID列表（目前仅支持指定一张代金券） */ VoucherIds?: Array<string>; /** * 已废弃请使用NodeInfoList 是否创建专用主节点<li>true：开启专用主节点</li><li>false：不开启专用主节点</li>默认值false */ EnableDedicatedMaster?: boolean; /** * 已废弃请使用NodeInfoList 专用主节点个数（只支持3个和5个，EnableDedicatedMaster为true时该值必传） */ MasterNodeNum?: number; /** * 已废弃请使用NodeInfoList 专用主节点类型（EnableDedicatedMaster为true时必传）<li>ES.S1.SMALL2：1核2G</li><li>ES.S1.MEDIUM4：2核4G</li><li>ES.S1.MEDIUM8：2核8G</li><li>ES.S1.LARGE16：4核16G</li><li>ES.S1.2XLARGE32：8核32G</li><li>ES.S1.4XLARGE32：16核32G</li><li>ES.S1.4XLARGE64：16核64G</li> */ MasterNodeType?: string; /** * 已废弃请使用NodeInfoList 专用主节点磁盘大小（单位GB，非必传，若传递则必须为50，暂不支持自定义） */ MasterNodeDiskSize?: number; /** * 集群配置文件中的ClusterName（系统默认配置为实例ID，暂不支持自定义） */ ClusterNameInConf?: string; /** * 集群部署方式<li>0：单可用区部署</li><li>1：多可用区部署，北京、上海、上海金融、广州、南京、香港、新加坡、法兰克福（白名单控制）</li>默认为0 */ DeployMode?: number; /** * 多可用区部署时可用区的详细信息(DeployMode为1时必传) */ MultiZoneInfo?: Array<ZoneDetail>; /** * License类型<li>oss：开源版</li><li>basic：基础版</li><li>platinum：白金版</li>默认值platinum */ LicenseType?: string; /** * 节点信息列表，用于描述集群各类节点的规格信息如节点类型，节点个数，节点规格，磁盘类型，磁盘大小等 */ NodeInfoList?: Array<NodeInfo>; /** * 节点标签信息列表 */ TagList?: Array<TagInfo>; /** * 6.8（及以上版本）基础版是否开启xpack security认证<li>1：不开启</li><li>2：开启</li> */ BasicSecurityType?: number; /** * 场景化模板类型 0：不启用 1：通用 2：日志 3：搜索 */ SceneType?: number; /** * 可视化节点配置 */ WebNodeTypeInfo?: WebNodeTypeInfo; /** * 创建https集群，默认是http */ Protocol?: string; /** * 可维护时间段 */ OperationDuration?: OperationDuration; /** * 是否开启存算分离 */ EnableHybridStorage?: boolean; /** * 是否开启essd 增强型云盘 */ DiskEnhance?: number; /** * 是否开启智能巡检 */ EnableDiagnose?: boolean; /** * cdcId，使用cdc子网时传递 */ CdcId?: string; } /** * CreateLogstashInstance请求参数结构体 */ export interface CreateLogstashInstanceRequest { /** * 实例名称（1-50 个英文、汉字、数字、连接线-或下划线_） */ InstanceName: string; /** * 可用区 */ Zone: string; /** * 实例版本（支持"6.8.13"、"7.10.1"） */ LogstashVersion: string; /** * 私有网络ID */ VpcId: string; /** * 子网ID */ SubnetId: string; /** * 节点数量（2-50个） */ NodeNum?: number; /** * 计费类型<li>PREPAID：预付费，即包年包月</li><li>POSTPAID_BY_HOUR：按小时后付费</li>默认值POSTPAID_BY_HOUR */ ChargeType?: string; /** * 包年包月购买时长（单位由参数TimeUnit决定） */ ChargePeriod?: number; /** * 计费时长单位（ChargeType为PREPAID时需要设置，默认值为“m”，表示月，当前只支持“m”） */ TimeUnit?: string; /** * 是否自动使用代金券<li>0：不自动使用</li><li>1：自动使用</li>默认值0 */ AutoVoucher?: number; /** * 代金券ID列表（目前仅支持指定一张代金券） */ VoucherIds?: Array<string>; /** * 自动续费标识<li>RENEW_FLAG_AUTO：自动续费</li><li>RENEW_FLAG_MANUAL：不自动续费，用户手动续费</li>ChargeType为PREPAID时需要设置，如不传递该参数，普通用户默认不自动续费，SVIP用户自动续费 */ RenewFlag?: string; /** * 节点规格<li>LOGSTASH.S1.SMALL2：1核2G</li><li>LOGSTASH.S1.MEDIUM4：2核4G</li><li>LOGSTASH.S1.MEDIUM8：2核8G</li><li>LOGSTASH.S1.LARGE16：4核16G</li><li>LOGSTASH.S1.2XLARGE32：8核32G</li><li>LOGSTASH.S1.4XLARGE32：16核32G</li><li>LOGSTASH.S1.4XLARGE64：16核64G</li> */ NodeType?: string; /** * 节点磁盘类型<li>CLOUD_SSD：SSD云硬盘</li><li>CLOUD_PREMIUM：高硬能云硬盘</li>默认值CLOUD_SSD */ DiskType?: string; /** * 节点磁盘容量（单位GB） */ DiskSize?: number; /** * License类型<li>oss：开源版</li><li>xpack：xpack版</li>默认值xpack */ LicenseType?: string; /** * 标签信息列表 */ TagList?: Array<TagInfo>; /** * 可维护时间段 */ OperationDuration?: OperationDuration; } /** * UpdateDictionaries返回参数结构体 */ export interface UpdateDictionariesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例详细信息 */ export interface InstanceInfo { /** * 实例ID */ InstanceId?: string; /** * 实例名称 */ InstanceName?: string; /** * 地域 */ Region?: string; /** * 可用区 */ Zone?: string; /** * 用户ID */ AppId?: number; /** * 用户UIN */ Uin?: string; /** * 实例所属VPC的UID */ VpcUid?: string; /** * 实例所属子网的UID */ SubnetUid?: string; /** * 实例状态，0:处理中,1:正常,-1停止,-2:销毁中,-3:已销毁, 2:创建集群时初始化中 */ Status?: number; /** * 自动续费标识。取值范围： RENEW_FLAG_AUTO：自动续费 RENEW_FLAG_MANUAL：不自动续费默认取值： RENEW_FLAG_DEFAULT：不自动续费若该参数指定为 RENEW_FLAG_AUTO，在账户余额充足的情况下，实例到期后将按月自动续费。 */ RenewFlag?: string; /** * 实例计费模式。取值范围： PREPAID：表示预付费，即包年包月 POSTPAID_BY_HOUR：表示后付费，即按量计费 CDHPAID：CDH付费，即只对CDH计费，不对CDH上的实例计费。 */ ChargeType?: string; /** * 包年包月购买时长,单位:月 */ ChargePeriod?: number; /** * 节点规格<li>ES.S1.SMALL2：1核2G</li><li>ES.S1.MEDIUM4：2核4G</li><li>ES.S1.MEDIUM8：2核8G</li><li>ES.S1.LARGE16：4核16G</li><li>ES.S1.2XLARGE32：8核32G</li><li>ES.S1.4XLARGE32：16核32G</li><li>ES.S1.4XLARGE64：16核64G</li> */ NodeType?: string; /** * 节点个数 */ NodeNum?: number; /** * 节点CPU核数 */ CpuNum?: number; /** * 节点内存大小，单位GB */ MemSize?: number; /** * 节点磁盘类型 */ DiskType?: string; /** * 节点磁盘大小，单位GB */ DiskSize?: number; /** * ES域名 */ EsDomain?: string; /** * ES VIP */ EsVip?: string; /** * ES端口 */ EsPort?: number; /** * Kibana访问url */ KibanaUrl?: string; /** * ES版本号 */ EsVersion?: string; /** * ES配置项 */ EsConfig?: string; /** * Kibana访问控制配置 */ EsAcl?: EsAcl; /** * 实例创建时间 */ CreateTime?: string; /** * 实例最后修改操作时间 */ UpdateTime?: string; /** * 实例到期时间 */ Deadline?: string; /** * 实例类型（实例类型标识，当前只有1,2两种） */ InstanceType?: number; /** * Ik分词器配置 */ IkConfig?: EsDictionaryInfo; /** * 专用主节点配置 */ MasterNodeInfo?: MasterNodeInfo; /** * cos自动备份配置 */ CosBackup?: CosBackup; /** * 是否允许cos自动备份 */ AllowCosBackup?: boolean; /** * 实例拥有的标签列表 */ TagList?: Array<TagInfo>; /** * License类型<li>oss：开源版</li><li>basic：基础版</li><li>platinum：白金版</li>默认值platinum */ LicenseType?: string; /** * 是否为冷热集群<li>true: 冷热集群</li><li>false: 非冷热集群</li> 注意：此字段可能返回 null，表示取不到有效值。 */ EnableHotWarmMode?: boolean; /** * 温节点规格<li>ES.S1.SMALL2：1核2G</li><li>ES.S1.MEDIUM4：2核4G</li><li>ES.S1.MEDIUM8：2核8G</li><li>ES.S1.LARGE16：4核16G</li><li>ES.S1.2XLARGE32：8核32G</li><li>ES.S1.4XLARGE32：16核32G</li><li>ES.S1.4XLARGE64：16核64G</li> 注意：此字段可能返回 null，表示取不到有效值。 */ WarmNodeType?: string; /** * 温节点个数注意：此字段可能返回 null，表示取不到有效值。 */ WarmNodeNum?: number; /** * 温节点CPU核数注意：此字段可能返回 null，表示取不到有效值。 */ WarmCpuNum?: number; /** * 温节点内存内存大小，单位GB 注意：此字段可能返回 null，表示取不到有效值。 */ WarmMemSize?: number; /** * 温节点磁盘类型注意：此字段可能返回 null，表示取不到有效值。 */ WarmDiskType?: string; /** * 温节点磁盘大小，单位GB 注意：此字段可能返回 null，表示取不到有效值。 */ WarmDiskSize?: number; /** * 集群节点信息列表注意：此字段可能返回 null，表示取不到有效值。 */ NodeInfoList?: Array<NodeInfo>; /** * Es公网地址注意：此字段可能返回 null，表示取不到有效值。 */ EsPublicUrl?: string; /** * 多可用区网络信息注意：此字段可能返回 null，表示取不到有效值。 */ MultiZoneInfo?: Array<ZoneDetail>; /** * 部署模式<li>0：单可用区</li><li>1：多可用区，北京、上海、上海金融、广州、南京、香港、新加坡、法兰克福（白名单控制）</li> 注意：此字段可能返回 null，表示取不到有效值。 */ DeployMode?: number; /** * ES公网访问状态<li>OPEN：开启</li><li>CLOSE：关闭注意：此字段可能返回 null，表示取不到有效值。 */ PublicAccess?: string; /** * ES公网访问控制配置 */ EsPublicAcl?: EsAcl; /** * Kibana内网地址注意：此字段可能返回 null，表示取不到有效值。 */ KibanaPrivateUrl?: string; /** * Kibana公网访问状态<li>OPEN：开启</li><li>CLOSE：关闭注意：此字段可能返回 null，表示取不到有效值。 */ KibanaPublicAccess?: string; /** * Kibana内网访问状态<li>OPEN：开启</li><li>CLOSE：关闭注意：此字段可能返回 null，表示取不到有效值。 */ KibanaPrivateAccess?: string; /** * 6.8（及以上版本）基础版是否开启xpack security认证<li>1：不开启</li><li>2：开启</li> 注意：此字段可能返回 null，表示取不到有效值。 */ SecurityType?: number; /** * 场景化模板类型：0、不开启；1、通用场景；2、日志场景；3、搜索场景注意：此字段可能返回 null，表示取不到有效值。 */ SceneType?: number; /** * Kibana配置项注意：此字段可能返回 null，表示取不到有效值。 */ KibanaConfig?: string; /** * Kibana节点信息注意：此字段可能返回 null，表示取不到有效值。 */ KibanaNodeInfo?: KibanaNodeInfo; /** * 可视化节点配置注意：此字段可能返回 null，表示取不到有效值。 */ WebNodeTypeInfo?: WebNodeTypeInfo; /** * JDK类型，oracle或kona 注意：此字段可能返回 null，表示取不到有效值。 */ Jdk?: string; /** * 集群网络通讯协议注意：此字段可能返回 null，表示取不到有效值。 */ Protocol?: string; /** * 安全组id 注意：此字段可能返回 null，表示取不到有效值。 */ SecurityGroups?: Array<string>; /** * 冷节点规格<li>ES.S1.SMALL2：1核2G</li><li>ES.S1.MEDIUM4：2核4G</li><li>ES.S1.MEDIUM8：2核8G</li><li>ES.S1.LARGE16：4核16G</li><li>ES.S1.2XLARGE32：8核32G</li><li>ES.S1.4XLARGE32：16核32G</li><li>ES.S1.4XLARGE64：16核64G</li> 注意：此字段可能返回 null，表示取不到有效值。 */ ColdNodeType?: string; /** * 冷节点个数注意：此字段可能返回 null，表示取不到有效值。 */ ColdNodeNum?: number; /** * 冷节点CPU核数注意：此字段可能返回 null，表示取不到有效值。 */ ColdCpuNum?: number; /** * 冷节点内存大小，单位GB 注意：此字段可能返回 null，表示取不到有效值。 */ ColdMemSize?: number; /** * 冷节点磁盘类型注意：此字段可能返回 null，表示取不到有效值。 */ ColdDiskType?: string; /** * 冷节点磁盘大小，单位GB 注意：此字段可能返回 null，表示取不到有效值。 */ ColdDiskSize?: number; /** * 冻节点规格<li>ES.S1.SMALL2：1核2G</li><li>ES.S1.MEDIUM4：2核4G</li><li>ES.S1.MEDIUM8：2核8G</li><li>ES.S1.LARGE16：4核16G</li><li>ES.S1.2XLARGE32：8核32G</li><li>ES.S1.4XLARGE32：16核32G</li><li>ES.S1.4XLARGE64：16核64G</li> 注意：此字段可能返回 null，表示取不到有效值。 */ FrozenNodeType?: string; /** * 冻节点个数注意：此字段可能返回 null，表示取不到有效值。 */ FrozenNodeNum?: number; /** * 冻节点CPU核数注意：此字段可能返回 null，表示取不到有效值。 */ FrozenCpuNum?: number; /** * 冻节点内存大小，单位GB 注意：此字段可能返回 null，表示取不到有效值。 */ FrozenMemSize?: number; /** * 冻节点磁盘类型注意：此字段可能返回 null，表示取不到有效值。 */ FrozenDiskType?: string; /** * 冻节点磁盘大小，单位GB 注意：此字段可能返回 null，表示取不到有效值。 */ FrozenDiskSize?: number; /** * 集群健康状态 -1 未知；0 Green; 1 Yellow; 2 Red 注意：此字段可能返回 null，表示取不到有效值。 */ HealthStatus?: number; /** * https集群内网url 注意：此字段可能返回 null，表示取不到有效值。 */ EsPrivateUrl?: string; /** * https集群内网域名注意：此字段可能返回 null，表示取不到有效值。 */ EsPrivateDomain?: string; /** * 集群的配置组信息注意：此字段可能返回 null，表示取不到有效值。 */ EsConfigSets?: Array<EsConfigSetInfo>; /** * 集群可维护时间段注意：此字段可能返回 null，表示取不到有效值。 */ OperationDuration?: OperationDuration; /** * web节点列表注意：此字段可能返回 null，表示取不到有效值。 */ OptionalWebServiceInfos?: Array<OptionalWebServiceInfo>; /** * 自治索引开关注意：此字段可能返回 null，表示取不到有效值。 */ AutoIndexEnabled?: boolean; /** * 是否支持存储计算分离注意：此字段可能返回 null，表示取不到有效值。 */ EnableHybridStorage?: boolean; /** * 流程进度注意：此字段可能返回 null，表示取不到有效值。 */ ProcessPercent?: number; /** * Kibana的alerting外网告警策略<li>OPEN：开启</li><li>CLOSE：关闭注意：此字段可能返回 null，表示取不到有效值。 */ KibanaAlteringPublicAccess?: string; /** * 本月是否有内核可以更新：false-无，true-有注意：此字段可能返回 null，表示取不到有效值。 */ HasKernelUpgrade?: boolean; /** * cdcId，使用cdc子网时传递注意：此字段可能返回 null，表示取不到有效值。 */ CdcId?: string; /** * kibana内网vip 注意：此字段可能返回 null，表示取不到有效值。 */ KibanaPrivateVip?: string; /** * 自定义kibana内网url 注意：此字段可能返回 null，表示取不到有效值。 */ CustomKibanaPrivateUrl?: string; } /** * DeleteIndex返回参数结构体 */ export interface DeleteIndexResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdatePlugins返回参数结构体 */ export interface UpdatePluginsResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstances请求参数结构体 */ export interface DescribeInstancesRequest { /** * 集群实例所属可用区，不传则默认所有可用区 */ Zone?: string; /** * 集群实例ID列表 */ InstanceIds?: Array<string>; /** * 集群实例名称列表 */ InstanceNames?: Array<string>; /** * 分页起始值, 默认值0 */ Offset?: number; /** * 分页大小，默认值20 */ Limit?: number; /** * 排序字段<li>1：实例ID</li><li>2：实例名称</li><li>3：可用区</li><li>4：创建时间</li>若orderByKey未传递则按创建时间降序排序 */ OrderByKey?: number; /** * 排序方式<li>0：升序</li><li>1：降序</li>若传递了orderByKey未传递orderByType, 则默认升序 */ OrderByType?: number; /** * 节点标签信息列表 */ TagList?: Array<TagInfo>; /** * 私有网络vip列表 */ IpList?: Array<string>; /** * 可用区列表 */ ZoneList?: Array<string>; /** * 健康状态筛列表:0表示绿色，1表示黄色，2表示红色,-1表示未知 */ HealthStatus?: Array<number | bigint>; /** * Vpc列表筛选项 */ VpcIds?: Array<string>; } /** * ES 词库信息 */ export interface EsDictionaryInfo { /** * 启用词词典列表 */ MainDict: Array<DictInfo>; /** * 停用词词典列表 */ Stopwords: Array<DictInfo>; /** * QQ分词词典列表 */ QQDict: Array<DictInfo>; /** * 同义词词典列表 */ Synonym: Array<DictInfo>; /** * 更新词典类型 */ UpdateType: string; } /** * DescribeLogstashPipelines请求参数结构体 */ export interface DescribeLogstashPipelinesRequest { /** * 实例ID */ InstanceId: string; } /** * RestartNodes请求参数结构体 */ export interface RestartNodesRequest { /** * 集群实例ID */ InstanceId: string; /** * 节点名称列表 */ NodeNames: Array<string>; /** * 是否强制重启 */ ForceRestart?: boolean; /** * 可选重启模式"in-place","blue-green"，分别表示重启，蓝绿重启；默认值为"in-place" */ RestartMode?: string; /** * 节点状态，在蓝绿模式中使用；离线节点蓝绿有风险 */ IsOffline?: boolean; } /** * GetRequestTargetNodeTypes请求参数结构体 */ export interface GetRequestTargetNodeTypesRequest { /** * 实例ID */ InstanceId: string; } /** * ModifyEsVipSecurityGroup请求参数结构体 */ export interface ModifyEsVipSecurityGroupRequest { /** * es集群的实例id */ InstanceId: string; /** * 安全组id列表 */ SecurityGroupIds?: Array<string>; } /** * 任务进度详情 */ export interface ProcessDetail { /** * 已完成数量注意：此字段可能返回 null，表示取不到有效值。 */ Completed?: number; /** * 剩余数量注意：此字段可能返回 null，表示取不到有效值。 */ Remain?: number; /** * 总数量注意：此字段可能返回 null，表示取不到有效值。 */ Total?: number; /** * 任务类型： 60：重启型任务 70：分片迁移型任务 80：节点变配任务注意：此字段可能返回 null，表示取不到有效值。 */ TaskType?: number; } /** * DescribeLogstashInstances请求参数结构体 */ export interface DescribeLogstashInstancesRequest { /** * 实例所属可用区，不传则默认所有可用区 */ Zone?: string; /** * 实例ID列表 */ InstanceIds?: Array<string>; /** * 实例名称列表 */ InstanceNames?: Array<string>; /** * 分页起始值, 默认值0 */ Offset?: number; /** * 分页大小，默认值20 */ Limit?: number; /** * 排序字段<li>1：实例ID</li><li>2：实例名称</li><li>3：可用区</li><li>4：创建时间</li>若orderKey未传递则按创建时间降序排序 */ OrderByKey?: number; /** * 排序方式<li>0：升序</li><li>1：降序</li>若传递了orderByKey未传递orderByType, 则默认升序 */ OrderByType?: number; /** * VpcId 筛选项 */ VpcIds?: Array<string>; /** * 标签信息列表 */ TagList?: Array<TagInfo>; } /** * 实例专用主节点相关信息 */ export interface MasterNodeInfo { /** * 是否启用了专用主节点 */ EnableDedicatedMaster: boolean; /** * 专用主节点规格<li>ES.S1.SMALL2：1核2G</li><li>ES.S1.MEDIUM4：2核4G</li><li>ES.S1.MEDIUM8：2核8G</li><li>ES.S1.LARGE16：4核16G</li><li>ES.S1.2XLARGE32：8核32G</li><li>ES.S1.4XLARGE32：16核32G</li><li>ES.S1.4XLARGE64：16核64G</li> */ MasterNodeType: string; /** * 专用主节点个数 */ MasterNodeNum: number; /** * 专用主节点CPU核数 */ MasterNodeCpuNum: number; /** * 专用主节点内存大小，单位GB */ MasterNodeMemSize: number; /** * 专用主节点磁盘大小，单位GB */ MasterNodeDiskSize: number; /** * 专用主节点磁盘类型 */ MasterNodeDiskType: string; } /** * DeleteInstance请求参数结构体 */ export interface DeleteInstanceRequest { /** * 实例ID */ InstanceId: string; } /** * 智能运维指标详情 */ export interface MetricDetail { /** * 指标详情名 */ Key: string; /** * 指标详情值 */ Metrics: Array<Metric>; } /** * UpgradeInstance返回参数结构体 */ export interface UpgradeInstanceResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeIndexMeta请求参数结构体 */ export interface DescribeIndexMetaRequest { /** * ES集群ID */ InstanceId: string; /** * 索引类型。auto：自治索引；normal：普通索引 */ IndexType: string; /** * 索引名，若填空则获取所有索引 */ IndexName: string; /** * 集群访问用户名 */ Username?: string;