tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
1,993 lines (1,868 loc) • 124 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 返回的回复, 支持多个。 */
declare interface Choice {
/** 返回的回复。 */
Message?: OutputMessage;
}
/** 切片对象信息 */
declare interface Chunk {
/** chunk索引。切片顺序 id。 */
Index?: number;
/** chunk内容。 */
Content?: string;
}
/** 文档分片配置 */
declare interface ChunkConfig {
/** 最大分片长度 */
MaxChunkSize?: number;
/** 分隔符列表 */
Delimiters?: string[];
/** 相邻切片重合字符数,需要小于分片长度 */
ChunkOverlap?: number;
}
/** 文档切片异步任务 */
declare interface ChunkConfigAsync {
/** 最大分片长度 */
MaxChunkSize?: number;
}
/** 切片文档信息 */
declare interface ChunkDocument {
/** 文件类型,支持 MD,TXT 格式。 */
FileType?: string;
/** 文本原文,使用字符串格式输入。 */
FileContent?: string;
}
/** 文档信息 */
declare interface Document {
/** 文件类型。支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2支持的文件大小:- PDF、DOC、DOCX、PPT、PPTX 支持100M- MD、TXT、XLS、XLSX、CSV 支持10M- 其他支持20M */
FileType: string;
/** 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性,使用腾讯云COS 文件地址。 */
FileUrl?: string;
/** 文件的 base64 值,携带 MineType前缀信息。编码后的后的文件不超过 10M。支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。支持的图片像素:单边介于20-10000px之间。 */
FileContent?: string;
/** 文件名称,当使用 base64上传的时候使用。 */
FileName?: string;
/** 文档的起始页码 */
FileStartPageNumber?: number;
/** 文档的结束页码 */
FileEndPageNumber?: number;
}
/** 文档切片用量 */
declare interface DocumentChunkUsage {
/** 解析页面数量 */
PageNumber?: number;
/** 消耗 token数量 */
TotalTokens?: number;
}
/** 文档解析配置 */
declare interface DocumentParseConfig {
/** 0:图片以链接形式返回1:返回图片中提取的文本内容 */
ImageResponseType?: number;
}
/** 向量内容 */
declare interface EmbeddingData {
/** embedding 内容 */
Embedding?: number[] | null;
/** 索引序号 */
Index?: number | null;
}
/** 会话内容,按对话时间从旧到新在数组中排列,长度受模型窗口大小限制。 */
declare interface Message {
/** 角色, ‘system', ‘user','assistant'或者'tool', 在message中, 除了system,其他必须是user与assistant交替(一问一答) */
Role?: string;
/** 具体文本内容 */
Content?: string;
}
/** 联网搜索选项。 */
declare interface OnlineSearchOptions {
/** 搜索引擎。支持 bing 和 sogou。 */
Engine?: string;
}
/** 会话内容,按对话时间从旧到新在数组中排列,长度受模型窗口大小限制。 */
declare interface OutputMessage {
/** 角色 */
Role?: string;
/** 文本内容 */
Content?: string;
/** 推理内容 */
ReasoningContent?: string;
}
/** 消耗页数 */
declare interface PageUsage {
/** 消耗总页数 */
TotalPages?: number;
}
/** 文档信息 */
declare interface ParseDocument {
/** 文件类型。支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2支持的文件大小:- PDF、DOC、DOCX、PPT、PPTX 支持100M- MD、TXT、XLS、XLSX、CSV 支持10M- 其他支持20M */
FileType: string;
/** 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性,使用腾讯云COS 文件地址。 */
FileUrl?: string;
/** 文件的 base64 值,携带 MineType前缀信息。编码后的后的文件不超过 10M。支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。支持的图片像素:单边介于20-10000px之间。 */
FileContent?: string;
/** 文档解析配置 */
DocumentParseConfig?: DocumentParseConfig;
/** 文档的起始页码 */
FileStartPageNumber?: number;
/** 文档的结束页码 */
FileEndPageNumber?: number;
}
/** 输出结果 */
declare interface RerankResult {
/** 对应的doc在输入候选doc数组中的位置索引值 */
Index?: number | null;
/** 相似度分数 */
RelevanceScore?: number | null;
/** doc原文内容 */
Document?: string | null;
}
/** token使用量 */
declare interface TokenUsage {
/** 表示prompt的tokens数,多次返回中保持不变 */
PromptTokens?: number;
/** 回答的token总数,在流式返回中,表示到目前为止所有completion的tokens总数,多次返回中持续累加 */
CompletionTokens?: number;
/** 表示prompt_tokens和completion_tokens之和 */
TotalTokens?: number;
}
/** token消耗总数 */
declare interface Usage {
/** tokens总数 */
TotalTokens?: number | null;
}
/** 搜索结果网页信息。 */
declare interface WebContent {
/** 搜素问题 */
Query?: string;
/** 标题 */
Title?: string;
/** 链接 */
Url?: string;
/** 时间 */
Time?: string;
/** 网页内容 */
Content?: string;
/** 切片索引 */
ChunkIndex?: string;
/** 分数 */
Score?: string;
}
declare interface ChatCompletionsRequest {
/** 会话内容,按对话时间从旧到新在数组中排列,长度受模型窗口大小限制。 */
Messages: Message[];
/** 模型名称,可选模型列表:hunyuan-turbo,hunyuan-large,hunyuan-large-longcontext,hunyuan-standard,hunyuan-standard-256K,deepseek-r1,deepseek-v3,deepseek-r1-distill-qwen-32b。 */
ModelName: string;
/** 是否以流式接口的形式返回数据,默认true。 */
Stream?: boolean;
/** 取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果 。 */
TopP?: number;
/** 取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果 。 */
Temperature?: number;
/** 是否开启联网搜索。默认为 false。 */
OnlineSearch?: boolean;
/** 当 OnlineSearch 为 true 时,指定的搜索引擎,默认为 bing。 */
OnlineSearchOptions?: OnlineSearchOptions;
}
declare interface ChatCompletionsResponse {
/** 此次请求的id */
Id?: string;
/** 回复内容 */
Choices?: Choice[];
/** token使用量 */
Usage?: TokenUsage;
/** 联网搜索结果。 */
OnlineSearchContent?: WebContent[] | null;
/** 唯一请求 ID,每次请求都会返回。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 */
RequestId?: string;
}
declare interface ChunkDocumentAsyncRequest {
/** 文件信息。 */
Document: Document;
/** 模型名称,可选模型列表:doc-tree-chunk。 */
ModelName: string;
/** 文件切片配置。 */
Config?: ChunkConfigAsync;
}
declare interface ChunkDocumentAsyncResponse {
/** 任务 ID */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ChunkDocumentRequest {
/** 切片文件信息。 */
Document: ChunkDocument;
/** 模型名称,可选模型列表:doc-chunk。 */
ModelName: string;
/** 文件切片配置。 */
Config?: ChunkConfig;
}
declare interface ChunkDocumentResponse {
/** 无 */
Chunks?: Chunk[];
/** token消耗量 */
Usage?: Usage;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetDocumentChunkResultRequest {
/** 任务 ID */
TaskId: string;
}
declare interface GetDocumentChunkResultResponse {
/** 任务状态,-1:失败,0:运行中,1:成功。 */
Status?: number;
/** 切片结果文件。 */
DocumentChunkResultUrl?: string;
/** Token用量。 */
Usage?: DocumentChunkUsage;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetDocumentParseResultRequest {
/** 任务 Id */
TaskId: string;
}
declare interface GetDocumentParseResultResponse {
/** 任务状态,-1:失败,0:运行中,1:成功。 */
Status?: number;
/** 结果文件。 */
DocumentParseResultUrl?: string;
/** 失败的页码。 */
FailedPages?: number[] | null;
/** 消耗页数 */
Usage?: PageUsage;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetTextEmbeddingRequest {
/** 模型名称,可选模型列表:bge-base-zh-v1.5,conan-embedding-v1,bge-m3,KaLM-embedding-multilingual-mini-v1。 */
ModelName: string;
/** 需进行向量化的文本集。 */
Texts: string[];
}
declare interface GetTextEmbeddingResponse {
/** 结果集 */
Data?: EmbeddingData[];
/** 向量化消耗的token数量。 */
Usage?: Usage;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ParseDocumentAsyncRequest {
/** 文件信息。 */
Document: Document;
/** 模型名称,可选模型列表:doc-llm。 */
ModelName: string;
}
declare interface ParseDocumentAsyncResponse {
/** 任务 id */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ParseDocumentRequest {
/** 文件信息 */
Document: ParseDocument;
/** 模型名称,doc-llm。 */
ModelName: string;
}
declare interface ParseDocumentResponse {
/** 进度:0-100。 */
Progress?: string;
/** 解析文件结果。 */
DocumentParseResultUrl?: string;
/** 失败页码。 */
FailedPages?: number[];
/** 消耗页数 */
Usage?: PageUsage;
/** 唯一请求 ID,每次请求都会返回。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 */
RequestId?: string;
}
declare interface RunRerankRequest {
/** 模型名称,可选模型列表:bge-reranker-large,bge-reranker-v2-m3。 */
ModelName: string;
/** 查询文本。 */
Query: string;
/** 待排序的候选doc列表。 */
Documents: string[];
/** 排序返回的top文档数量, 如果没有指定则返回全部候选doc,如果指定的top_n值大于输入的候选doc数量,返回全部doc。 */
TopN?: number;
/** 返回的排序结果列表里面是否返回每一条document原文,默认值False。 */
ReturnDocuments?: boolean;
}
declare interface RunRerankResponse {
/** 输出结果集。 */
Data?: RerankResult[];
/** 消耗token数量。 */
Usage?: Usage;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare namespace V20180416 {
type VersionHeader = { headers: { 'X-TC-Version': '2018-04-16' } }
/** cvm 自动扩盘参数 */
interface AutoScaleDiskInfo {
/** 节点类型 hotData,warmData */
NodeType?: string | null;
/** 0:百分比扩容;1:绝对值扩容 */
ScaleType?: number | null;
/** 触发阈值,单位%,例如80% */
Threshold?: number | null;
/** 触发持续时间,单位分钟,例如60 */
Duration?: number | null;
/** 每次扩容比例,单位%,例如20% */
PercentSize?: number | null;
/** 绝对值扩容,单位GB,例如100GB */
FixSize?: number | null;
/** 扩容上限,单位GB,例如500GB */
MaxSize?: number | null;
}
/** 后备索引元数据字段 */
interface BackingIndexMetaField {
/** 后备索引名 */
IndexName?: string | null;
/** 后备索引状态 */
IndexStatus?: string | null;
/** 后备索引存储大小 */
IndexStorage?: number | null;
/** 后备索引当前生命周期 */
IndexPhrase?: string | null;
/** 后备索引创建时间 */
IndexCreateTime?: string | null;
}
/** 集群维度视图数据 */
interface ClusterView {
/** 集群健康状态 */
Health?: number;
/** 集群是否可见 */
Visible: number;
/** 集群是否熔断 */
Break: number;
/** 平均磁盘使用率 */
AvgDiskUsage: number;
/** 平均内存使用率 */
AvgMemUsage: number;
/** 平均cpu使用率 */
AvgCpuUsage: number;
/** 集群总存储大小 */
TotalDiskSize: number;
/** 客户端请求节点 */
TargetNodeTypes: 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名称 */
SearchableSnapshotCosBucket: string | null;
/** 企业版集群可搜索快照cos所属appid */
SearchableSnapshotCosAppId: string | null;
}
/** 普通索引信息列表 */
interface CommonIndexInfo {
/** 普通索引名 */
IndexName?: string | null;
/** 分片状态 */
IsShardComplete?: number | null;
}
/** ES cos自动备份信息 */
interface CosBackup {
/** 是否开启cos自动备份 */
IsAutoBackup: boolean;
/** 自动备份执行时间(精确到小时), e.g. "22:00" */
BackupTime: string;
/** 0 腾讯云仓库; 1 客户仓库 */
EsRepositoryType?: number;
/** 客户快照仓库名称 */
UserEsRepository?: string;
/** 快照存储周期 单位天 */
StorageDuration?: number;
/** 自动备份频率单位小时 */
AutoBackupInterval?: number;
}
/** 无 */
interface CosSnapShotInfo {
/** cos 桶名 */
CosBucket?: string | null;
/** base path */
BasePath?: string | null;
/** 快照名 */
SnapshotName?: string | null;
/** 状态 */
State?: string | null;
/** 快照版本 */
Version?: string | null;
/** 普通[{"DataStreamName":"ilm-history-5","Is索引信息列表 */
CommonIndexArr?: CommonIndexInfo[] | null;
/** 自治索引信息列表 */
DataStreamArr?: DataStreamInfo[] | null;
}
/** 自治索引信息 */
interface DataStreamInfo {
/** 自治索引名 */
DataStreamName?: string | null;
/** 分片状态 */
IsShardComplete?: number | null;
}
/** 插件信息 */
interface DescribeInstancePluginInfo {
/** 插件名 */
PluginName?: string;
/** 插件版本 */
PluginVersion?: string;
/** 插件描述 */
PluginDesc?: string;
/** 插件状态:-2 已卸载 -1 卸载中 0 安装中 1 已安装 */
Status?: number;
/** 插件是否可卸载 */
Removable?: boolean;
/** 0:系统插件 */
PluginType?: number;
/** 插件变更时间 */
PluginUpdateTime?: string;
}
/** 数据接入信息 */
interface DiData {
/** 数据接入id */
DiId?: string | null;
/** 数据接入创建时间 */
CreateTime?: string | null;
/** 数据接入状态,0处理中,1正常,-2删除中,-3已删除 */
Status?: number | null;
/** cvm数据源信息 */
DiDataSourceCvm?: DiDataSourceCvm | null;
/** tke数据源信息 */
DiDataSourceTke?: DiDataSourceTke | null;
/** serverless目的端信息 */
DiDataSinkServerless?: DiDataSinkServerless | null;
/** 数据接入类型 */
DiDataSourceType?: string | null;
}
/** 数据接入serverless目的端信息 */
interface DiDataSinkServerless {
/** serverless实例id */
ServerlessId?: string | null;
}
/** 数据接入cvm数据源信息 */
interface DiDataSourceCvm {
/** vpc id */
VpcId?: string | null;
/** 采集路径列表 */
LogPaths?: string[] | null;
/** cvm实例信息列表 */
CvmInstances?: DiDataSourceCvmInstance[] | null;
/** 采集器id */
CollectorId?: string | null;
}
/** 数据接入cvm实例信息 */
interface DiDataSourceCvmInstance {
/** cvm实例id */
InstanceId?: string | null;
/** vpc id */
VpcId?: string | null;
/** 子网id */
SubnetId?: string | null;
/** 错误信息 */
ErrMsg?: string | null;
}
/** 数据接入tke数据源信息 */
interface DiDataSourceTke {
/** vpc id */
VpcId?: string | null;
/** tke实例id */
TkeId?: string | null;
/** 采集器id */
CollectorId?: string | null;
/** 采集源名称 */
CollectorName?: string | null;
/** 采集器类型 */
CollectorType?: string | null;
/** 采集器版本 */
CollectorVersion?: string | null;
/** tke包含的命名空间 */
IncludeNamespaces?: string[] | null;
/** tke不包含的命名空间 */
ExcludeNamespaces?: string[] | null;
/** tke pod标签名 */
PodLabelKeys?: string[] | null;
/** tke pod标签值 */
PodLabelValues?: string[] | null;
/** tke容器名称 */
ContainerName?: string | null;
/** tke采集器beat配置 */
ConfigContent?: string | null;
/** / */
InputType?: string | null;
/** TKE 日志采集路径 */
InputPath?: string | null;
}
/** 数据接入cvm数据源 */
interface DiSourceCvm {
/** 数据源所属vpc id,创建后不允许修改 */
VpcId?: string;
/** cvm列表 */
CvmIds?: string[];
/** 采集路径列表,支持通配符 */
LogPaths?: string[];
}
/** 数据接入tke数据源 */
interface DiSourceTke {
/** 数据源所属vpc id,创建后不允许修改 */
VpcId?: string;
/** tke实例id,创建后不允许修改 */
TkeId?: string;
/** tke包含的命名空间 */
IncludeNamespaces?: string[];
/** tke不包含的命名空间 */
ExcludeNamespaces?: string[];
/** tke容器名称 */
ContainerName?: string;
/** tke日志内容过滤 */
LogFilters?: string;
/** tke beats配置项 */
ConfigContent?: string;
/** tke pod标签 */
PodLabel?: DiSourceTkePodLabel[];
/** / */
InputType?: string;
/** tke 日志采集路径 */
InputPath?: string;
}
/** tke pod标签 */
interface DiSourceTkePodLabel {
/** 标签key */
Key?: string | null;
/** 标签value */
Value?: string | null;
}
/** 智能运维支持的诊断项和元信息 */
interface DiagnoseJobMeta {
/** 智能运维诊断项英文名 */
JobName: string;
/** 智能运维诊断项中文名 */
JobZhName: string;
/** 智能运维诊断项描述 */
JobDescription: string;
}
/** 智能运维诊断项结果 */
interface DiagnoseJobResult {
/** 诊断项名 */
JobName: string;
/** 诊断项状态:-2失败,-1待重试,0运行中,1成功 */
Status: number;
/** 诊断项得分 */
Score: number;
/** 诊断摘要 */
Summary: string;
/** 诊断建议 */
Advise: string;
/** 诊断详情 */
Detail: string;
/** 诊断指标详情 */
MetricDetails: MetricDetail[] | null;
/** 诊断日志详情 */
LogDetails: LogDetail[] | null;
/** 诊断配置详情 */
SettingDetails: SettingDetail[] | null;
}
/** 智能运维诊断结果 */
interface DiagnoseResult {
/** ES实例ID */
InstanceId: string;
/** 诊断报告ID */
RequestId: string;
/** 诊断触发时间 */
CreateTime: string;
/** 诊断是否完成 */
Completed: boolean;
/** 诊断总得分 */
Score: number;
/** 诊断类型,2 定时诊断,3 客户手动触发诊断 */
JobType: number;
/** 诊断参数,如诊断时间,诊断索引等 */
JobParam: JobParam;
/** 诊断项结果列表 */
JobResults: DiagnoseJobResult[];
}
/** ik插件词典信息 */
interface DictInfo {
/** 词典键值 */
Key: string;
/** 词典名称 */
Name: string;
/** 词典大小,单位B */
Size: number;
}
/** 智能运维指标维度 */
interface Dimension {
/** 智能运维指标维度Key */
Key: string;
/** 智能运维指标维度值 */
Value: string;
}
/** 置放群组异步任务维护的时间段 */
interface EnableScheduleOperationDuration {
/** 支持开启异步任务的日期 */
Periods?: string[] | null;
/** 支持开启异步的开始时间 */
TimeStart?: string | null;
/** 支持开启异步的结束时间 */
TimeEnd?: string | null;
/** 支持开启异步的时区 */
TimeZone?: string | null;
}
/** ES集群配置项 */
interface EsAcl {
/** kibana访问黑名单 */
BlackIpList?: string[];
/** kibana访问白名单 */
WhiteIpList?: string[];
}
/** 配置组信息 */
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;
}
/** ES 词库信息 */
interface EsDictionaryInfo {
/** 启用词词典列表 */
MainDict: DictInfo[];
/** 停用词词典列表 */
Stopwords: DictInfo[];
/** QQ分词词典列表 */
QQDict: DictInfo[];
/** 同义词词典列表 */
Synonym: DictInfo[];
/** 更新词典类型 */
UpdateType: string;
/** ansj启用词词典列表 */
AnsjMain?: DictInfo[] | null;
/** ansj停用词词典列表 */
AnsjStop?: DictInfo[] | null;
/** ansj歧义词库列表 */
AnsjAmbiguity?: DictInfo[] | null;
/** ansj同义词词典列表 */
AnsjSynonyms?: DictInfo[] | null;
}
/** ES公网访问控制信息 */
interface EsPublicAcl {
/** 访问黑名单 */
BlackIpList?: string[];
/** 访问白名单 */
WhiteIpList?: string[];
}
/** 索引备份失败的数据结构 */
interface Failures {
/** 备份失败的索引名称 */
Index?: string | null;
/** 快照失败的分片号 */
ShardId?: number | null;
/** 快照失败的原因 */
Reason?: string | null;
/** 快照失败的状态 */
Status?: string | null;
}
/** 节点Gpu信息 */
interface GpuInfo {
/** Gpu块数 */
GpuCount?: number;
/** Gpu类型 */
GpuType?: string;
}
/** 索引元数据字段 */
interface IndexMetaField {
/** 索引类型 */
IndexType?: string | null;
/** 索引名 */
IndexName?: string | null;
/** 索引元数据JSON */
IndexMetaJson?: string | null;
/** 索引状态 */
IndexStatus?: string | null;
/** 索引存储大小,单位Byte */
IndexStorage?: number | null;
/** 索引创建时间 */
IndexCreateTime?: string | null;
/** 后备索引 */
BackingIndices?: BackingIndexMetaField[] | null;
/** 索引所属集群ID */
ClusterId?: string | null;
/** 索引所属集群名 */
ClusterName?: string | null;
/** 索引所属集群版本 */
ClusterVersion?: string | null;
/** 索引生命周期字段 */
IndexPolicyField?: IndexPolicyField | null;
/** 索引自治字段 */
IndexOptionsField?: IndexOptionsField | null;
/** 索引配置字段 */
IndexSettingsField?: IndexSettingsField | null;
/** 索引别名字段 */
IndexAliasesField?: string[] | null;
/** 索引所属集群APP ID */
AppId?: number | null;
/** 索引文档数 */
IndexDocs?: number | null;
}
/** 索引自治字段 */
interface IndexOptionsField {
/** 过期时间 */
ExpireMaxAge?: string | null;
/** 过期大小 */
ExpireMaxSize?: string | null;
/** 滚动周期 */
RolloverMaxAge?: string | null;
/** 是否开启动态滚动 */
RolloverDynamic?: string | null;
/** 是否开启动态分片 */
ShardNumDynamic?: string | null;
/** 时间分区字段 */
TimestampField?: string | null;
/** 写入模式 */
WriteMode?: string | null;
}
/** 索引生命周期字段 */
interface IndexPolicyField {
/** 是否开启warm阶段 */
WarmEnable?: string | null;
/** warm阶段转入时间 */
WarmMinAge?: string | null;
/** 是否开启cold阶段 */
ColdEnable?: string | null;
/** cold阶段转入时间 */
ColdMinAge?: string | null;
/** 是否开启frozen阶段 */
FrozenEnable?: string | null;
/** frozen阶段转入时间 */
FrozenMinAge?: string | null;
/** / */
ColdAction?: string | null;
}
/** 索引配置字段 */
interface IndexSettingsField {
/** 索引主分片数 */
NumberOfShards?: string | null;
/** 索引副本分片数 */
NumberOfReplicas?: string | null;
/** 索引刷新频率 */
RefreshInterval?: string | null;
}
/** 实例详细信息 */
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:已销毁, -4:隔离中,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;
/** 节点规格ES.S1.SMALL2:1核2GES.S1.MEDIUM4:2核4GES.S1.MEDIUM8:2核8GES.S1.LARGE16:4核16GES.S1.2XLARGE32:8核32GES.S1.4XLARGE32:16核32GES.S1.4XLARGE64:16核64G */
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?: TagInfo[];
/** License类型oss:开源版basic:基础版platinum:白金版默认值platinum */
LicenseType?: string;
/** 是否为冷热集群true: 冷热集群false: 非冷热集群 */
EnableHotWarmMode?: boolean | null;
/** 温节点规格ES.S1.SMALL2:1核2GES.S1.MEDIUM4:2核4GES.S1.MEDIUM8:2核8GES.S1.LARGE16:4核16GES.S1.2XLARGE32:8核32GES.S1.4XLARGE32:16核32GES.S1.4XLARGE64:16核64G */
WarmNodeType?: string | null;
/** 温节点个数 */
WarmNodeNum?: number | null;
/** 温节点CPU核数 */
WarmCpuNum?: number | null;
/** 温节点内存内存大小,单位GB */
WarmMemSize?: number | null;
/** 温节点磁盘类型 */
WarmDiskType?: string | null;
/** 温节点磁盘大小,单位GB */
WarmDiskSize?: number | null;
/** 集群节点信息列表 */
NodeInfoList?: NodeInfo[] | null;
/** Es公网地址 */
EsPublicUrl?: string | null;
/** 多可用区网络信息 */
MultiZoneInfo?: ZoneDetail[] | null;
/** 部署模式0:单可用区1:多可用区,北京、上海、上海金融、广州、南京、香港、新加坡、法兰克福(白名单控制) */
DeployMode?: number | null;
/** ES公网访问状态OPEN:开启CLOSE:关闭 */
PublicAccess?: string | null;
/** ES公网访问控制配置 */
EsPublicAcl?: EsAcl;
/** Kibana内网地址 */
KibanaPrivateUrl?: string | null;
/** Kibana公网访问状态OPEN:开启CLOSE:关闭 */
KibanaPublicAccess?: string | null;
/** Kibana内网访问状态OPEN:开启CLOSE:关闭 */
KibanaPrivateAccess?: string | null;
/** 6.8(及以上版本)基础版是否开启xpack security认证1:不开启2:开启 */
SecurityType?: number | null;
/** 场景化模板类型:0、不开启;1、通用场景;2、日志场景;3、搜索场景 */
SceneType?: number | null;
/** Kibana配置项 */
KibanaConfig?: string | null;
/** Kibana节点信息 */
KibanaNodeInfo?: KibanaNodeInfo | null;
/** 可视化节点配置 */
WebNodeTypeInfo?: WebNodeTypeInfo | null;
/** JDK类型,oracle或kona */
Jdk?: string | null;
/** 集群网络通讯协议 */
Protocol?: string | null;
/** 安全组id */
SecurityGroups?: string[] | null;
/** 冷节点规格ES.S1.SMALL2:1核2GES.S1.MEDIUM4:2核4GES.S1.MEDIUM8:2核8GES.S1.LARGE16:4核16GES.S1.2XLARGE32:8核32GES.S1.4XLARGE32:16核32GES.S1.4XLARGE64:16核64G */
ColdNodeType?: string | null;
/** 冷节点个数 */
ColdNodeNum?: number | null;
/** 冷节点CPU核数 */
ColdCpuNum?: number | null;
/** 冷节点内存大小,单位GB */
ColdMemSize?: number | null;
/** 冷节点磁盘类型 */
ColdDiskType?: string | null;
/** 冷节点磁盘大小,单位GB */
ColdDiskSize?: number | null;
/** 冻节点规格ES.S1.SMALL2:1核2GES.S1.MEDIUM4:2核4GES.S1.MEDIUM8:2核8GES.S1.LARGE16:4核16GES.S1.2XLARGE32:8核32GES.S1.4XLARGE32:16核32GES.S1.4XLARGE64:16核64G */
FrozenNodeType?: string | null;
/** 冻节点个数 */
FrozenNodeNum?: number | null;
/** 冻节点CPU核数 */
FrozenCpuNum?: number | null;
/** 冻节点内存大小,单位GB */
FrozenMemSize?: number | null;
/** 冻节点磁盘类型 */
FrozenDiskType?: string | null;
/** 冻节点磁盘大小,单位GB */
FrozenDiskSize?: number | null;
/** 集群健康状态 -1 未知;0 Green; 1 Yellow; 2 Red */
HealthStatus?: number | null;
/** https集群内网url */
EsPrivateUrl?: string | null;
/** https集群内网域名 */
EsPrivateDomain?: string | null;
/** 集群的配置组信息 */
EsConfigSets?: EsConfigSetInfo[] | null;
/** 集群可维护时间段 */
OperationDuration?: OperationDuration | null;
/** web节点列表 */
OptionalWebServiceInfos?: OptionalWebServiceInfo[] | null;
/** 自治索引开关 */
AutoIndexEnabled?: boolean | null;
/** 是否支持存储计算分离 */
EnableHybridStorage?: boolean | null;
/** 流程进度 */
ProcessPercent?: number | null;
/** Kibana的alerting外网告警策略OPEN:开启CLOSE:关闭 */
KibanaAlteringPublicAccess?: string | null;
/** 本月是否有内核可以更新:false-无,true-有 */
HasKernelUpgrade?: boolean | null;
/** cdcId,使用cdc子网时传递 */
CdcId?: string | null;
/** kibana内网vip */
KibanaPrivateVip?: string | null;
/** 自定义kibana内网url */
CustomKibanaPrivateUrl?: string | null;
/** 节点出站访问详细信息 */
OutboundPublicAcls?: OutboundPublicAcl[] | null;
/** 网络连接方案 */
NetConnectScheme?: string | null;
/** 置放群组相关参数 */
DisasterRecoverGroupAffinity?: number | null;
/** 子产品ID枚举值: 开源版:"sp_es_io2", 基础版:"sp_es_basic",白金版:"sp_es_platinum",企业版:"sp_es_enterprise",CDC白金版:"sp_es_cdc_platinum",日志增强版:"sp_es_enlogging",tsearch:"sp_tsearch_io2",logstash:"sp_es_logstash" ,可以为空,为空的时候后台取LicenseType映射该字段 */
SubProductCode?: string | null;
/** 存算分离cos用量,单位M */
CosBucketStorageSize?: number | null;
/** 读写分离模式:0-不开启,1-本地读写分离,2-远端读写分离 */
ReadWriteMode?: number | null;
/** 是否有置放群组异步调度任务 */
EnableScheduleRecoverGroup?: boolean | null;
/** 异步调度任务的时间 */
EnableScheduleOperationDuration?: EnableScheduleOperationDuration | null;
/** 开启集群保护:OPEN-开启,CLOSE-关闭 */
EnableDestroyProtection?: string | null;
/** kibana内网访问地址 */
ShowKibanaIpPort?: string;
/** 是否为CDZLite可用区 */
IsCdzLite?: boolean;
}
/** ES集群日志详细信息 */
interface InstanceLog {
/** 日志时间 */
Time?: string;
/** 日志级别 */
Level?: string;
/** 集群节点ip */
Ip?: string;
/** 日志内容 */
Message?: string;
/** 集群节点ID */
NodeID?: string;
}
/** 智能运维诊断参数 */
interface JobParam {
/** 诊断项列表 */
Jobs: string[] | null;
/** 诊断索引 */
Indices: string;
/** 历史诊断时间 */
Interval: number;
}
/** OperationDetail使用此结构的数组描述新旧配置 */
interface KeyValue {
/** 键 */
Key?: string;
/** 值 */
Value?: string;
}
/** 实例Kibana节点相关信息 */
interface KibanaNodeInfo {
/** Kibana节点规格 */
KibanaNodeType: string;
/** Kibana节点个数 */
KibanaNodeNum: number;
/** Kibana节点CPU数 */
KibanaNodeCpuNum: number;
/** Kibana节点内存GB */
KibanaNodeMemSize: number;
/** Kibana节点磁盘类型 */
KibanaNodeDiskType: string;
/** Kibana节点磁盘大小 */
KibanaNodeDiskSize: number;
}
/** kibana公网域名白名单参数 */
interface KibanaPublicAcl {
/** kibana访问白名单 */
WhiteIpList?: string[];
}
/** Kibana视图数据 */
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;
}
/** 节点本地盘信息 */
interface LocalDiskInfo {
/** 本地盘类型LOCAL_SATA:大数据型NVME_SSD:高IO型 */
LocalDiskType: string;
/** 本地盘单盘大小 */
LocalDiskSize: number;
/** 本地盘块数 */
LocalDiskCount: number;
}
/** 智能运维日志详情 */
interface LogDetail {
/** 日志异常名 */
Key: string;
/** 日志异常处理建议 */
Advise: string;
/** 日志异常名出现次数 */
Count: number;
}
/** Logstash绑定的ES集群信息 */
interface LogstashBindedES {
/** ES集群ID */
ESInstanceId: string;
/** ES集群用户名 */
ESUserName: string;
/** ES集群密码 */
ESPassword: string;
}
/** Logstash扩展文件信息 */
interface LogstashExtendedFile {
/** 扩展文件名称 */
Name: string;
/** 扩展文件大小,单位B */
Size: number;
}
/** Logstash实例详细信息 */
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;
/** 节点规格LOGSTASH.S1.SMALL2:1核2GLOGSTASH.S1.MEDIUM4:2核4GLOGSTASH.S1.MEDIUM8:2核8GLOGSTASH.S1.LARGE16:4核16GLOGSTASH.S1.2XLARGE32:8核32GLOGSTASH.S1.4XLARGE32:16核32GLOGSTASH.S1.4XLARGE64:16核64G */
NodeType?: string;
/** 节点个数 */
NodeNum?: number;
/** 节点磁盘类型 */
DiskType?: string;
/** 节点磁盘大小,单位GB */
DiskSize?: number;
/** Logstash版本号 */
LogstashVersion?: string;
/** License类型oss:开源版xpack:基础版默认值xpack */
LicenseType?: string;
/** 实例创建时间 */
CreateTime?: string;
/** 实例最后修改操作时间 */
UpdateTime?: string;
/** 实例到期时间 */
Deadline?: string;
/** 实例节点类型 */
Nodes?: LogstashNodeInfo[];
/** 实例绑定的ES集群ID */
BindedESInstanceId?: string;
/** 实例的YML配置 */
YMLConfig?: string | null;
/** 扩展文件列表 */
ExtendedFiles?: LogstashExtendedFile[] | null;
/** 可维护时间段 */
OperationDuration?: OperationDuration | null;
/** CPU数量 */
CpuNum?: number | null;
/** 实例标签信息 */
TagList?: TagInfo[] | null;
/** 内存大小 */
MemSize?: number | null;
/** 部署模式,0:单可用区、1:多可用区 */
DeployMode?: number;
/** 多可用区部署时可用区的详细信息 */
MultiZoneInfo?: ZoneDetail[];
}
/** Logstash节点信息 */
interface LogstashNodeInfo {
/** 节点ID */
NodeId?: string;
/** 节点IP */
Ip?: string;
/** 节点端口 */
Port?: number;
/** 节点所在zone */
Zone?: string;
}
/** Logstash管道信息 */
interface LogstashPipeline {
/** 管道ID */
PipelineId?: string;
/** 管道描述信息 */
PipelineDesc?: string | null;
/** 管道配置内容 */
Config?: string;
/** 管道的Worker数量 */
Workers?: number | null;
/** 管道批处理大小 */
BatchSize?: number | null;
/** 管道批处理延迟 */
BatchDelay?: number | null;
/** 管道缓冲队列类型 */
QueueType?: string | null;
/** 管道缓冲队列大小 */
QueueMaxBytes?: string | null;
/** 管道缓冲队列检查点写入数 */
QueueCheckPointWrites?: number | null;
}
/** Logstash管道信息 */
interface LogstashPipelineInfo {
/** 管道ID */
PipelineId?: string;
/** 管道描述信息 */
PipelineDesc?: string | null;
/** 管道配置内容 */
Config?: string;
/** 管道状态 */
Status?: number | null;
/** 管道的Worker数量 */
Workers?: number | null;
/** 管道批处理大小 */
BatchSize?: number | null;
/** 管道批处理延迟 */
BatchDelay?: number | null;
/** 管道缓冲队列类型 */
QueueType?: string | null;
/** 管道缓冲队列大小 */
QueueMaxBytes?: string | null;
/** 管道缓冲队列检查点写入数 */
QueueCheckPointWrites?: number | null;
/** 创建时间 */
CreateTime?: string | null;
/** 更新时间 */
UpdateTime?: string | null;
}
/** 实例专用主节点相关信息 */
interface MasterNodeInfo {
/** 是否启用了专用主节点 */
EnableDedicatedMaster?: boolean;
/** 专用主节点规格ES.S1.SMALL2:1核2GES.S1.MEDIUM4:2核4GES.S1.MEDIUM8:2核8GES.S1.LARGE16:4核16GES.S1.2XLARGE32:8核32GES.S1.4XLARGE32:16核32GES.S1.4XLARGE64:16核64G */
MasterNodeType?: string;
/** 专用主节点个数 */
MasterNodeNum?: number;
/** 专用主节点CPU核数 */
MasterNodeCpuNum?: number;
/** 专用主节点内存大小,单位GB */
MasterNodeMemSize?: number;
/** 专用主节点磁盘大小,单位GB */
MasterNodeDiskSize?: number;
/** 专用主节点磁盘类型 */
MasterNodeDiskType?: string;
}
/** 智能运维指标 */
interface Metric {
/** 指标维度族 */
Dimensions: Dimension[];
/** 指标值 */
Value: number;
}
/** 全部指标数据 */
interface MetricAllData {
/** 索引流量 */
IndexTraffic?: number;
/** 存储大小 */
Storage?: number;
/** 读请求次数 */
ReadReqTimes?: number;
/** 写请求次数 */
WriteReqTimes?: number;
/** 文档数量 */
DocCount?: number;
}
/** 智能运维指标详情 */
interface MetricDetail {
/** 指标详情名 */
Key: string;
/** 指标详情值 */
Metrics: Metric[];
}
/** 指标数据map */
interface MetricMapByIndexId {
/** 实例id */
IndexId?: string;
/** 指标数据 */
MetricAllData?: MetricAllData;
}
/** 集群中一种节点类型(如热数据节点,冷数据节点,专用主节点等)的规格描述信息,包括节点类型,节点个数,节点规格,磁盘类型,磁盘大小等, Type不指定时默认为热数据节点;如果节点为master节点,则DiskType和DiskSize参数会被忽略(主节点无数据盘) */
interface NodeInfo {
/** 节点数量 */
NodeNum: number;
/** 节点规格ES.S1.SMALL2:1核2GES.S1.MEDIUM4:2核4GES.S1.MEDIUM8:2核8GES.S1.LARGE16:4核16GES.S1.2XLARGE32:8核32GES.S1.4XLARGE32:16核32GES.S1.4XLARGE64:16核64G */
NodeType: string;
/** 节点类型hotData: 热数据节点warmData: 冷数据节点dedicatedMaster: 专用主节点默认值为hotData */
Type?: string;
/** 节点磁盘类型CLOUD_SSD:SSD云硬盘CLOUD_PREMIUM:高硬能云硬盘默认值CLOUD_SSD */
DiskType?: string;
/** 节点磁盘容量(单位GB) */
DiskSize?: number;
/** 节点本地盘信息 */
LocalDiskInfo?: LocalDiskInfo | null;
/** 节点磁盘块数 */
DiskCount?: number;
/** 节点磁盘是否加密 0: 不加密,1: 加密;默认不加密 */
DiskEncrypt?: number;
/** cpu数目 */
CpuNum?: number | null;
/** 内存大小,单位GB */
MemSize?: number | null;
/** / */
DiskEnhance?: number | null;
/** 节点Gpu信息 */
GpuInfo?: GpuInfo | null;
}
/** 节点维度视图数据 */
interface NodeView {
/** 节点ID */
NodeId?: string;
/** 节点IP */
NodeIp?: string;
/** 节点是否可见 */
Visible?: number;
/** 是否熔断 */
Break?: number;
/** 节点总磁盘大小 */
DiskSize?: number;
/** 磁盘使用率 */
DiskUsage?: number;
/** 节点内存大小,单位GB */
MemSize?: number;
/** 内存使用率 */
MemUsage?: number;
/** 节点cpu个数 */
CpuNum?: number;
/** cpu使用率 */
CpuUsage?: number;
/** 可用区 */
Zone?: string;
/** 节点角色 */
NodeRole?: string;
/** 节点HTTP IP */
NodeHttpIp?: string;
/** JVM内存使用率 */
JvmMemUsage?: number;
/** 节点分片数 */
ShardNum?: number;
/** 节点上磁盘ID列表 */
DiskIds?: string[];
/** 是否为隐藏可用区 */
Hidden?: boolean;
/** 是否充当协调节点的角色 */
IsCoordinationNode?: boolean;
/** CVM运行状态 */
CVMStatus?: string;
/** cvm绑定的置放群组的id */
CVMDisasterRecoverGroupId?: string | null;
/** cvm绑定置放群组的状态。2: 已绑定;1: 绑定中;0: 未开启 */
CVMDisasterRecoverGroupStatus?: number | null;
}
/** ES集群操作详细信息 */
interface Operation {
/** 操作唯一id */
Id?: number;
/** 操作开始时间 */
StartTime?: string;
/** 操作类型 */
Type?: string;
/** 操作详情 */
Detail?: OperationDetail;
/** 操作结果 */
Result?: string;
/** 流程任务信息 */
Tasks?: TaskDetail[];
/** 操作进度 */
Progress?: number;
/** 回滚标记, 0未回滚 ,1回滚中,2已回滚 */
RollbackTag?: number;
/** 操作者Uin */
SubAccountUin?: string | null;
/** 自动扩容标识:0-非自动,1-自动 */
AutoScaleTag?: number;
}
/** 操作详情 */
interface OperationDetail {
/** 实例原始配置信息 */
OldInfo: KeyValue[];
/** 实例更新后配置信息 */
NewInfo: KeyValue[];
}
/** 集群可运维时间 */
interface OperationDuration {
/** 维护周期,表示周一到周日,可取值[0, 6] */
Periods: number[] | null;
/** 维护开始时间 */
TimeStart: string;
/** 维护结束时间 */
TimeEnd: string;
/** 时区,以UTC形式表示 */
TimeZone: string;
}
/** 集群可运维时间 */
interface OperationDurationUpdated {
/** 维护周期,表示周一到周日,可取值[0, 6] */
Periods: number[];
/** 维护开始时间 */
TimeStart: string;
/** 维护结束时间 */
TimeEnd: string;
/** 时区,以UTC形式表示 */
TimeZone: string;
/** ES集群ID数组 */
MoreInstances?: string[];
}
/** 可选web组件信息 */
interface OptionalWebServiceInfo {
/** 类型 */
Type?: string | null;
/** 状态 */
Status?: number | null;
/** 公网url */
PublicUrl?: string | null;
/** 内网url */
PrivateUrl?: string | null;
/** 公网访问权限 */
PublicAccess?: string | null;
/** 内网访问权限 */
PrivateAccess?: string | null;
/** 版本号 */
Version?: string | null;
/** web服务内网vip */
PrivateVip?: string | null;
/** 自定义cerebro内网url */
CustomPrivateUrl?: string | null;
}
/** 节点出站访问信息 */
interface OutboundPublicAcl {
/** 允许节点出站访问的节点类型 */
NodeType: string | null;
/** 允许节点出站访问的白名单 */
WhiteHostList?: string[] | null;
}
/** 任务进度详情 */
interface ProcessDetail {
/** 已完成数量 */
Completed?: number | null;
/** 剩余数量 */
Remain?: number | null;
/** 总数量 */
Total?: number | null;
/** 任务类型:60:重启型任务70:分片迁移型任务80:节点变配任务 */
TaskType?: number | null;
}
/** 创建serverless索引时创建数据接入 */
interface ServerlessDi {
/** 数据链路采集源类型,如cvm_collector、tke_collector */
DiSourceType?: string;
/** cvm数据源 */
DiSourceCvm?: DiSourceCvm;
/** tke数据源 */
DiSourceTke?: DiSourceTke;
}
/** 索引元数据字段 */
interface ServerlessIndexMetaField {
/** 索引所属集群APP ID */
AppId?: number | null;
/** 索引名 */
IndexName?: string | null;
/** 索引元数据JSON */
IndexMetaJson?: string | null;
/** 索引文档数 */
IndexDocs?: number | null;
/** 索引存储大小,单位Byte */
IndexStorage?: number | null;
/** 索引创建时间 */
IndexCreateTime?: string | null;
/** 索引实例ID */
InstanceId?: string | null;
/** 索引自治字段 */
IndexOptionsField?: ServerlessIndexOptionsField | null;
/** 索引配置字段 */
IndexSettingsField?: ServerlessIndexSettingsField | null;
/** 索引所属连接相关信息 */
IndexNetworkField?: ServerlessIndexNetworkField | null;
/** Kibana公网域名 */
KibanaUrl?: string | null;
/** Kibana内网域名 */
KibanaPrivateUrl?: string | null;
/** 索引内网访问地址 */
IndexAccessUrl?: string | null;
/** 状态 */
Status?: number | null;
/** 索引空间ID */
SpaceId?: string | null;
/** 索引空间名 */
SpaceName?: string | null;
/** 存储类型 */
StorageType?: number | null;
/** 标签信息 */
TagList?: TagInfo[];
/** 索引流量,单位byte */
IndexTraffic?: number | null;
}
/** Serverless实例,网络、索引、kibana等连接信息 */
interface ServerlessIndexNetworkField {
/** 地域 */
Region?: string | null;
/** 区域 */
Zone?: string | null;
/** vpc唯一ID */
VpcUid?: string | null;
/** 子网唯一ID */
SubnetUid?: string | null;
/** 用户名 */
Username?: string | null;
/** 密码 */
Password?: string | null;
}
/** 索引自治字段 */
interface ServerlessIndexOptionsField {
/** 过期时间 */
ExpireMaxAge?: string | null;
/** 时间分区字段 */
TimestampField?: string | null;
/** 标准存储时长 */
SinkCycleAge?: string | null;
/** 标准存储时长 */
StandardStorageAge?: string | null;
}
/** 索引配置字段 */
interface ServerlessIndexSettingsField {
/** 索引主分片数 */
NumberOfShards?: string | null;
/** 索引刷新频率 */
RefreshInterval?: string | null;
/** 自定义参数 */
CustomSetting?: string;
}
/** Serverless索引空间信息 */
interface ServerlessSpace {
/** Serverless索引空间ID */
SpaceId?: string;
/** Serverless索引空间名 */
SpaceName?: string;
/** Serverless索引空间状态,0正常,-1已删除 */
Status?: number;
/** 创建日期 */
CreateTime?: string;
/** 空间内索引数量 */
IndexCount?: number;
/** kibana公网uri */
KibanaUrl?: string | null;
/** kibana内网url */
KibanaPrivateUrl?: string | null;
/** 空间内网访问地址 */
IndexAccessUrl?: string | null;
/** 空间白名单 */
KibanaPublicAcl?: EsAcl | null;
/** 空间检索分析域名 */
KibanaEmbedUrl?: string | null;
/** 数据联路 */
DiDataList?: DiData | null;
/** 空间vpc信息 */
VpcInfo?: VpcInfo[] | null;
/** 地域 */
Region?: string | null;
/** 可用区 */
Zone?: string | null;
/** kibana公网开关,0关闭,1开启 */
EnableKibanaPublicAccess?: number | null;
/** kibana内网开关,0关闭,1开启 */
EnableKibanaPrivateAccess?: number | null;
/** 空间所属appid */
AppId?: number | null;
/** //默认en, 可选zh-CN */
KibanaLanguage?: string | null;
/** 0 */
ClusterType?: number | null;
/** 空间标签信息 */
TagList?: TagInfo[] | null;
}
/** ServerlessSpaceUser */
interface ServerlessSpaceUser {
/** 用户名 */
Username?: string | null;
/** 用户密码 */
Password?: string | null;
/** 创建时间 */
CreateTime?: string | null;
/** 用户状态 */
Status?: number | null;
/** 有权限的索引数组 */
IndicesScope?: string[] | null;
/** 权限类型 */
PrivilegeType?: number | null;
}
/** 智能运维集群配置详情 */
interface SettingDetail {
/** 配置key */
Key: string;
/** 配置当前值 */
Value: string;
/** 配置处理建议 */
Advise: string;
}
/** 集群快照数据结构 */
interface Snapshots {
/** 快照名称 */
SnapshotName?: string | null;
/** 快照Uuid */
Uuid?: string | null;
/** 仓库名称 */
Repository?: string | null;
/** 该快照所属集群的版本号 */
Version?: string | null;
/** 备份的索引列表 */
Indices?: string[] | null;
/** 备份的datastream列表 */
DataStreams?: string[] | null;
/** 备份的状态FAILED 备份失败IN_PROGRESS 备份执行中PARTIAL 备份部分成功,部分失败,备份失败的索引和原因会在Failures字段中展示SUCCESS 备份成功 */
State?: string | null;
/** 快照备份的开始时间 */
StartTime?: string | null;
/** 快照备份的结束时间 */
EndTime?: string | null;
/** 快照备份的耗时时间 */
DurationInMillis?: number | null;
/** 备份的总分片数 */
TotalShards?: number | null;
/** 备份失败的分片数量 */
FailedShards?: number | null;
/** 备份成功的分片数量 */
SuccessfulShards?: number | null;
/** 备份失败的索引分片和失败原因 */
Failures?: Failures[] | null;
/** 是否用户备份 */
UserBackUp?: string | null;
}
/** 实例操作记录流程任务中的子任务信息(如升级检查任务中的各个检查项) */
interface SubTaskDetail {
/** 子任务名 */
Name?: string;
/** 子任务结果 */
Result?: boolean;
/** 子任务错误信息 */
ErrMsg?: string;
/** 子任务类型 */
Type?: string;
/** 子任务状态,0处理中 1成功 -1失败 */
Status?: number;
/** 升级检查失败的索引名 */
FailedIndices?: string[];
/** 子任务结束时间 */
FinishTime?: string;
/** 子任务等级,1警告 2失败 */
Level?: number;
}
/** 实例标签信息 */
interface TagInfo {
/** 标签键 */
TagKey: string;
/** 标签值 */
TagValue: string;
}
/** 实例操作记录中的流程任务信息 */
interface TaskDetail {
/** 任务名 */
Name?: string;
/** 任务进度 */
Progress?: number;
/** 任务完成时间 */
FinishTime?: string;
/** 子任务 */
SubTasks?: SubTaskDetail[];
/** 任务花费时间 */
ElapsedTime?: number | null;
/** 任务进度详情 */
ProcessInfo?: ProcessDetail | null;
}
/** vpc信息 */
interface VpcInfo {
/** vpcId信息 */
VpcId?: string | null;
/** SubnetId信息 */
SubnetId?: string | null;
/** VpcUid信息 */
VpcUid?: number | null;
/** SubnetUid 信息 */
SubnetUid?: number | null;
/** 可用ip数量 */
AvailableIpAddressCount?: number | null;
}
/** 可视化节点配置 */
interface WebNodeTypeInfo {
/** 可视化节点个数,固定为1 */
NodeNum: number;
/** 可视化节点规格 */
NodeType: string;
}
/** 多可用区部署时可用区的详细信息 */
interface ZoneDetail {
/** 可用区 */
Zone: string;
/** 子网ID */
SubnetId: string;
/** 是否为隐藏可用区 */
Hidden?: boolean;
}
interface CheckMigrateIndexMetaDataRequest {
/** 索引 id */
ServerlessId: string;
/** 快照名 */
Snapshot: string;
/** Cos桶名 */
CosBucket?: string;
/** BasePath路径 */
BasePath?: string;
/** 云上集群名 */
ClusterInstanceId?: string;
/** 普通索引名列表 */
CommonIndexArr?: string[];
/** 自治索引名列表 */
DataStreamArr?: string[];
}
interface CheckMigrateIndexMetaDataResponse {
/** 不存在于目标索引时间字段相同的字段 */
MappingTimeFieldCheckFailedIndexArr?: string[];
/** @timestamp不为date类型,与目标索引时间字段冲突 */
MappingTimeTypeCheckFailedIndexArr?: string[];
/** 索引的创建时间不在 serverless的存储周期内 */
SettingCheckFailedIndexArr?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateClusterSnapshotRequest {
/** 实例名称 */
InstanceId: string;
/** 快照名称 */
SnapshotName: string;
/** 索引名称 */
Indices?: string;
}
interface CreateClusterSnapshotResponse {
/** 实例名称 */
InstanceId?: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateCosMigrateToServerlessInstanceRequest {
/** 快照名 */
Snapshot: string;
/** 索引 id */
ServerlessId: string;
/** cos 桶名 */
CosBucket?: string;
/** BasePath 路径 */
BasePath?: string;
/** 云上集群 id */
ClusterInstanceId?: string;
/** 待迁移普通索引名列表 */
CommonIndexArr?: string[];
/** 待迁移自治索引名列表 */
DataStreamArr?: string[];
}
interface CreateCosMigrateToServerlessInstanceResponse {
/** 迁移 taskid */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateIndexRequest {
/** ES集群ID */
InstanceId: string;
/** 创建的索引类型。auto:自治索引;normal:普通索引 */
IndexType: string;
/** 创建的索引名 */
IndexName: string;
/** 【必填】创建的索引元数据JSON,如mappings、settings */
IndexMetaJson: string;
/** 集群访问用户名 */
Username?: string;
/** 集群访问密码 */
Password?: string;
}
interface CreateIndexResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
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;
/** 计费类型PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费默认值POSTPAID_BY_HOUR */
ChargeType?: string;
/** 包年包月购买时长(单位由参数TimeUnit决定) */
ChargePeriod?: number;
/** 自动续费标识RENEW_FLAG_AUTO:自动续费RENEW_FLAG_MANUAL:不自动续费,用户手动续费ChargeType为PREPAID时需要设置,如不传递该参数,普通用户默认不自动续费,SVIP用户自动续费 */
RenewFlag?: string;
/** 已废弃请使用NodeInfoList节点规格ES.S1.SMALL2:1核2GES.S1.MEDIUM4:2核4GES.S1.MEDIUM8:2核8GES.S1.LARGE16:4核16GES.S1.2XLARGE32:8核32GES.S1.4XLARGE32:16核32GES.S1.4XLARGE64:16核64G */
NodeType?: string;
/** 已废弃请使用NodeInfoList节点磁盘类型CLOUD_SSD:SSD云硬盘CLOUD_PREMIUM:高性能云硬盘 CLOUD_HSSD:增强型SSD云硬盘 CLOUD_BSSD:通用型SSD云硬盘默认值CLOUD_SSD */
DiskType?: string;
/** 已废弃请使用NodeInfoList节点磁盘容量(单位GB) */
DiskSize?: number;
/** 计费时长单位(ChargeType为PREPAID时需要设置,默认值为“m”,表示月,当前只支持“m”) */
TimeUnit?: string;
/** 是否自动使用代金券0:不自动使用1:自动使用默认值0 */
AutoVoucher?: number;
/** 代金券ID列表(目前仅支持指定一张代金券) */
VoucherIds?: string[];
/** 已废弃请使用NodeInfoList是否创建专用主节点true:开启专用主节点false:不开启专用主节点默认值false */
EnableDedicatedMaster?: boolean;
/** 已废弃请使用NodeInfoList专用主节点个数(只支持3个和5个,EnableDedicatedMaster为true时该值必传) */
MasterNodeNum?: number;
/** 已废弃请使用NodeInfoList专用主节点类型(EnableDedicatedMaster为true时必传)ES.S1.SMALL2:1核2GES.S1.MEDIUM4:2核4GES.S1.MEDIUM8:2核8GES.S1.LARGE16:4核16GES.S1.2XLARGE32:8核32GES.S1.4XLARGE32:16核32GES.S1.4XLARGE64:16核64G */
MasterNodeType?: string;
/** 已废弃请使用NodeInfoList专用主节点磁盘大小(单位GB,非必传,若传递则必须为50,暂不支持自定义) */
MasterNodeDiskSize?: number;
/** 集群配置文件中的ClusterName(系统默认配置为实例ID,暂不支持自定义) */
ClusterNameInConf?: string;
/** 集群部署方式0:单可用区部署1:多可用区部署,北京、上海、上海金融、广州、南京、香港、新加坡、法兰克福(白名单控制)默认为0 */
DeployMode?: number;
/** 多可用区部署时可用区的详细信息(DeployMode为1时必传) */
MultiZoneInfo?: ZoneDetail[];
/** License类型oss:开源版basic:基础版platinum:白金版默认值platinum */
LicenseType?: string;
/** 节点信息列表, 用于描述集群各类节点的规格信息如节点类型,节点个数,节点规格,磁盘类型,磁盘大小等 */
NodeInfoList?: NodeInfo[];
/** 节点标签信息列表 */
TagList?: TagInfo[];
/** 6.8(及以上版本)基础版是否开启xpack security认证1:不开启2:开启 */
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;
/** 置放群组亲和度,范围[0,10],0表示不开启 */
DisasterRecoverGroupAffinity?: number;
/** 子产品ID枚举值: 开源版:"sp_es_io2", 基础版:"sp_es_basic",白金版:"sp_es_platinum",企业版:"sp_es_enterprise",CDC白金版:"sp_es_cdc_platinum",日志增强版:"sp_es_enlogging",tsearch:"sp_tsearch_io2",logstash:"sp_es_logstash" ,可以为空,为空的时候后台取LicenseType映射该字段 */
SubProductCode?: string;
/** 读写分离模式:0-不开启,1-本地读写分离,2-远端读写分离 */
ReadWriteMode?: number;
/** 置放群组是否开启异步任务 */
EnableScheduleRecoverGroup?: boolean;
/** 置放群组开启异步任务的可维护时间段 */
EnableScheduleOperationDuration?: EnableScheduleOperationDuration;
/** 自动扩盘参数列表 */
AutoScaleDiskInfoList?: AutoScaleDiskInfo[];
/** 是否开启kibana公网访问,不传默认开启 */
EnableKibanaPublicAccess?: string;
}
interface CreateInstanceResponse {
/** 实例ID */
InstanceId?: string;
/** 订单号 */
DealName?: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
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;
/** 计费类型PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费默认值POSTPAID_BY_HOUR */
ChargeType?: string;
/** 包年包月购买时长(单位由参数TimeUnit决定) */
ChargePeriod?: number;
/** 计费时长单位(ChargeType为PREPAID时需要设置,默认值为“m”,表示月,当前只支持“m”) */
TimeUnit?: string;
/** 是否自动使用代金券0:不自动使用1:自动使用默认值0 */
AutoVoucher?: number;
/** 代金券ID列表(目前仅支持指定一张代金券) */
VoucherIds?: string[];
/** 自动续费标识RENEW_FLAG_AUTO:自动续费RENEW_FLAG_MANUAL:不自动续费,用户手动续费ChargeType为PREPAID时需要设置,如不传递该参数,普通用户默认不自动续费,SVIP用户自动续费 */
RenewFlag?: string;
/** 节点规格LOGSTASH.S1.SMALL2:1核2GLOGSTASH.S1.MEDIUM4:2核4GLOGSTASH.S1.MEDIUM8:2核8GLOGSTASH.S1.LARGE16:4核16GLOGSTASH.S1.2XLARGE32:8核32GLOGSTASH.S1.4XLARGE32:16核32GLOGSTASH.S1.4XLARGE64:16核64G */
NodeType?: string;
/** 节点磁盘类型CLOUD_SSD:SSD云硬盘CL