tencentcloud-sdk-nodejs
Version:
2,796 lines • 205 kB
TypeScript
/**
* UpdateLogstashInstance请求参数结构体
*/
export interface UpdateLogstashInstanceRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 实例节点数量
*/
NodeNum?: number;
/**
* 实例YML配置
*/
YMLConfig?: string;
/**
* 客户自定义dns配置
*/
UserDnsIp?: string;
/**
* 实例绑定的ES集群信息
*/
BindedES?: LogstashBindedES;
/**
* 实例名称
*/
InstanceName?: string;
/**
* 扩展文件列表
*/
ExtendedFiles?: Array<LogstashExtendedFile>;
/**
* 实例规格
*/
NodeType?: string;
/**
* 节点磁盘容量
*/
DiskSize?: number;
/**
* 可维护时间段
*/
OperationDuration?: OperationDurationUpdated;
/**
* 多可用区部署
*/
MultiZoneInfo?: Array<ZoneDetail>;
}
/**
* 实例操作记录中的流程任务信息
*/
export interface TaskDetail {
/**
* 任务名
*/
Name?: string;
/**
* 任务进度
*/
Progress?: number;
/**
* 任务完成时间
*/
FinishTime?: string;
/**
* 子任务
*/
SubTasks?: Array<SubTaskDetail>;
/**
* 任务花费时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ElapsedTime?: number;
/**
* 任务进度详情
注意:此字段可能返回 null,表示取不到有效值。
*/
ProcessInfo?: ProcessDetail;
}
/**
* ServerlessSpaceUser
*/
export interface ServerlessSpaceUser {
/**
* 用户名
注意:此字段可能返回 null,表示取不到有效值。
*/
Username?: string;
/**
* 用户密码
注意:此字段可能返回 null,表示取不到有效值。
*/
Password?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 用户状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* 有权限的索引数组
注意:此字段可能返回 null,表示取不到有效值。
*/
IndicesScope?: Array<string>;
/**
* 权限类型
注意:此字段可能返回 null,表示取不到有效值。
*/
PrivilegeType?: number;
}
/**
* 索引配置字段
*/
export interface ServerlessIndexSettingsField {
/**
* 索引主分片数
注意:此字段可能返回 null,表示取不到有效值。
*/
NumberOfShards?: string;
/**
* 索引刷新频率
注意:此字段可能返回 null,表示取不到有效值。
*/
RefreshInterval?: string;
/**
* 自定义参数
*/
CustomSetting?: string;
}
/**
* RestartLogstashInstance请求参数结构体
*/
export interface RestartLogstashInstanceRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 重启类型,0全量重启,1滚动重启
*/
Type?: number;
}
/**
* updateInstance使用的额外的EsConfig和JvmHeapConfig
*/
export interface OtherConfig {
/**
* es的yml额外配置
*/
EsConfig?: string;
/**
* es的jvm heap config
*/
JvmHeapConfig?: string;
}
/**
* 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;
/**
* 部署模式,0:单可用区、1:多可用区
*/
DeployMode?: number;
/**
* 多可用区部署时可用区的详细信息
*/
MultiZoneInfo?: Array<ZoneDetail>;
/**
* 客户自定义dns配置
注意:此字段可能返回 null,表示取不到有效值。
*/
UserDnsIp?: string;
}
/**
* 操作详情
*/
export interface OperationDetail {
/**
* 实例原始配置信息
*/
OldInfo: Array<KeyValue>;
/**
* 实例更新后配置信息
*/
NewInfo: Array<KeyValue>;
}
/**
* DiagnoseInstance返回参数结构体
*/
export interface DiagnoseInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateServerlessInstance请求参数结构体
*/
export interface CreateServerlessInstanceRequest {
/**
* 索引名,需以-AppId结尾
*/
IndexName: string;
/**
* 可用区
*/
Zone?: string;
/**
* 私有网络ID
*/
VpcId?: string;
/**
* 子网ID
*/
SubnetId?: string;
/**
* 创建的索引元数据JSON,如mappings、settings
*/
IndexMetaJson?: string;
/**
* 创建索引的空间ID
*/
SpaceId?: string;
/**
* 创建索引的用户名
*/
Username?: string;
/**
* 创建索引的密码
*/
Password?: string;
/**
* 创建数据接入
*/
ServerlessDi?: ServerlessDi;
/**
* 是否自行添加白名单ip
*/
AutoGetIp?: number;
/**
* 标签信息
*/
TagList?: Array<TagInfo>;
/**
* kibana公网白名单
*/
KibanaWhiteIpList?: Array<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。
*/
RequestId?: string;
}
/**
* DescribeLogstashInstanceLogs返回参数结构体
*/
export interface DescribeLogstashInstanceLogsResponse {
/**
* 返回的日志条数
*/
TotalCount?: number;
/**
* 日志详细信息列表
*/
InstanceLogList?: Array<InstanceLog>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateInstance返回参数结构体
*/
export interface CreateInstanceResponse {
/**
* <p>实例ID</p>
*/
InstanceId?: string;
/**
* <p>订单号</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
DealName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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;
/**
* 日志级别
*/
LogLevels?: Array<string>;
/**
* 节点ID
*/
NodeIds?: Array<string>;
/**
* 慢日志索引名
*/
IndexName?: string;
/**
* 慢日志索引分片
*/
ShardId?: string;
/**
* 慢日志查询耗时
*/
QueryCost?: number;
}
/**
* RestoreClusterSnapshot返回参数结构体
*/
export interface RestoreClusterSnapshotResponse {
/**
* <p>集群实例id</p>
*/
InstanceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAutoBackUpCommonInfo请求参数结构体
*/
export type ModifyAutoBackUpCommonInfoRequest = null;
/**
* DeleteLogstashPipelines返回参数结构体
*/
export interface DeleteLogstashPipelinesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSpaceKibanaTools请求参数结构体
*/
export interface DescribeSpaceKibanaToolsRequest {
/**
* space的ID
*/
SpaceId: string;
}
/**
* 实例标签信息
*/
export interface TagInfo {
/**
* 标签键
*/
TagKey: string;
/**
* 标签值
*/
TagValue: string;
}
/**
* DescribeClusterSnapshot请求参数结构体
*/
export interface DescribeClusterSnapshotRequest {
/**
* 集群实例Id,格式:es-xxxx
*/
InstanceId: string;
/**
* 快照仓库名称
*/
RepositoryName?: string;
/**
* 集群快照名称
*/
SnapshotName?: string;
}
/**
* 指标数据map
*/
export interface MetricMapByIndexId {
/**
* 实例id
*/
IndexId?: string;
/**
* 指标数据
*/
MetricAllData?: MetricAllData;
}
/**
* UpdateInstancePublicAccess返回参数结构体
*/
export interface UpdateInstancePublicAccessResponse {
/**
* 订单号
注意:此字段可能返回 null,表示取不到有效值。
*/
DealName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAutoScaleDiskInfo返回参数结构体
*/
export interface DescribeAutoScaleDiskInfoResponse {
/**
* 自动扩盘参数列表
*/
AutoScaleDiskInfoList?: Array<AutoScaleDiskInfo>;
/**
* 0 修改中; 1 正常
*/
Status?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstances返回参数结构体
*/
export interface DescribeInstancesResponse {
/**
* 返回的实例个数
*/
TotalCount?: number;
/**
* 实例详细信息列表
*/
InstanceList?: Array<InstanceInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstanceLogs返回参数结构体
*/
export interface DescribeInstanceLogsResponse {
/**
* 返回的日志条数
*/
TotalCount?: number;
/**
* 日志详细信息列表
*/
InstanceLogList?: Array<InstanceLog>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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;
/**
* 索引别名字段
注意:此字段可能返回 null,表示取不到有效值。
*/
IndexAliasesField?: Array<string>;
/**
* 索引所属集群APP ID
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId?: number;
/**
* 索引文档数
注意:此字段可能返回 null,表示取不到有效值。
*/
IndexDocs?: number;
}
/**
* UpdateServerlessSpace请求参数结构体
*/
export interface UpdateServerlessSpaceRequest {
/**
* Serveless索引空间ID
*/
SpaceId: string;
/**
* Serveless索引空间名
*/
SpaceName?: string;
/**
* kibana内网开关
*/
KibanaPrivateAccess?: string;
/**
* kibana公网开关
*/
KibanaPublicAccess?: string;
/**
* kibana公网白名单
*/
KibanaPublicAcl?: EsAcl;
}
/**
* 实例专用主节点相关信息
*/
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;
}
/**
* DiagnoseInstance请求参数结构体
*/
export interface DiagnoseInstanceRequest {
/**
* ES实例ID
*/
InstanceId: string;
/**
* 需要触发的诊断项
*/
DiagnoseJobs?: Array<string>;
/**
* 需要诊断的索引,支持通配符
*/
DiagnoseIndices?: string;
}
/**
* TKE命名空间
*/
export interface Namespaces {
/**
* 包含的命名空间的列表,单个命名空间支持小写字母、数字、连接符-、下划线_,最多支持63个字符
*/
Include: Array<string>;
/**
* 不包含的命名空间列表,单个命名空间支持小写字母、数字、连接符-、下划线_,最多支持63个字符
*/
Exclude: Array<string>;
}
/**
* RequestInstancesByGet返回参数结构体
*/
export interface RequestInstancesByGetResponse {
/**
* <p>集群返回信息</p>
*/
Detail?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
}
/**
* DeleteServerlessInstance返回参数结构体
*/
export interface DeleteServerlessInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 索引生命周期字段
*/
export interface IndexPolicyField {
/**
* 是否开启warm阶段
注意:此字段可能返回 null,表示取不到有效值。
*/
WarmEnable?: string;
/**
* warm阶段转入时间
注意:此字段可能返回 null,表示取不到有效值。
*/
WarmMinAge?: string;
/**
* 是否开启cold阶段
注意:此字段可能返回 null,表示取不到有效值。
*/
ColdEnable?: string;
/**
* cold阶段转入时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ColdMinAge?: string;
/**
* 是否开启frozen阶段
注意:此字段可能返回 null,表示取不到有效值。
*/
FrozenEnable?: string;
/**
* frozen阶段转入时间
注意:此字段可能返回 null,表示取不到有效值。
*/
FrozenMinAge?: string;
/**
* /
注意:此字段可能返回 null,表示取不到有效值。
*/
ColdAction?: string;
}
/**
* DescribeInstanceOperations返回参数结构体
*/
export interface DescribeInstanceOperationsResponse {
/**
* 操作记录总数
*/
TotalCount?: number;
/**
* 操作记录
*/
Operations?: Array<Operation>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLogstashViews返回参数结构体
*/
export interface DescribeLogstashViewsResponse {
/**
* Logstash节点维度视图
*/
NodesView?: Array<LogstashNodeView>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCosBackupStrategyViews请求参数结构体
*/
export interface DescribeCosBackupStrategyViewsRequest {
/**
* <p>集群实例ID</p>
*/
InstanceId?: Array<string>;
}
/**
* DescribeUpgrade请求参数结构体
*/
export interface DescribeUpgradeRequest {
/**
* <p>需要升级的实例ID</p>
*/
InstanceId: string;
}
/**
* 索引自治字段
*/
export interface IndexOptionsField {
/**
* <p>过期时间</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpireMaxAge?: string;
/**
* <p>过期大小</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpireMaxSize?: string;
/**
* <p>滚动周期</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
RolloverMaxAge?: string;
/**
* <p>是否开启动态滚动</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
RolloverDynamic?: string;
/**
* <p>是否开启动态分片</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ShardNumDynamic?: string;
/**
* <p>时间分区字段</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
TimestampField?: string;
/**
* <p>写入模式</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
WriteMode?: string;
/**
* <p>是否开启完全卸载</p><p>枚举值:</p><ul><li>true: 开启完全卸载</li><li>false: 关闭完全卸载</li></ul>
*/
FullOffloadedEnable?: string;
/**
* <p>完全卸载生命周期</p>
*/
FullOffloadedMaxAge?: string;
/**
* <p>完全卸载后备索引取回后生命周期</p>
*/
FullOffloadedRetrieveMaxAge?: string;
}
/**
* DescribeRegions返回参数结构体
*/
export interface DescribeRegionsResponse {
/**
* 地域总数
*/
TotalCount?: number;
/**
* 地域详细信息
*/
RegionSet?: Array<RegionsData>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateRequestTargetNodeTypes返回参数结构体
*/
export interface UpdateRequestTargetNodeTypesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 可用区资源描述
*/
export interface ZoneResource {
/**
* 可用区名称
*/
ZoneName: string;
/**
* 是否可售
*/
Available: boolean;
/**
* 节点规格资源列表
*/
NodeTypeList: Array<NodeTypeResource>;
/**
* 可用节点机型族列表
*/
AvailNodeFamilies: Array<string>;
}
/**
* UpgradeInstance请求参数结构体
*/
export interface UpgradeInstanceRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 目标ES版本,支持:”6.4.3“, "6.8.2","7.5.1", "7.10.1", "7.14.2"
*/
EsVersion: string;
/**
* 是否只做升级检查,默认值为false
*/
CheckOnly?: boolean;
/**
* 目标商业特性版本:<li>oss 开源版</li><li>basic 基础版</li>当前仅在5.6.4升级6.x版本时使用,默认值为basic
*/
LicenseType?: string;
/**
* 6.8(及以上版本)基础版是否开启xpack security认证<li>1:不开启</li><li>2:开启</li>
*/
BasicSecurityType?: number;
/**
* 升级方式:<li>scale 蓝绿变更</li><li>restart 滚动重启</li>默认值为scale
*/
UpgradeMode?: string;
/**
* 升级版本前是否对集群进行备份,默认不备份
*/
CosBackup?: boolean;
/**
* 滚动模式时,是否跳过检查,进行强制重启。默认值为false
*/
SkipCheckForceRestart?: boolean;
/**
* cvm延迟上架参数
*/
CvmDelayOnlineTime?: number;
/**
* 分片迁移并发数
*/
ShardAllocationConcurrents?: number;
/**
* 分片迁移并发速度
*/
ShardAllocationBytes?: number;
/**
* 是否开启置放群组异步任务
*/
EnableScheduleRecoverGroup?: boolean;
/**
* 置放群组异步任务时间段
*/
EnableScheduleOperationDuration?: EnableScheduleOperationDuration;
}
/**
* 智能运维诊断参数
*/
export interface JobParam {
/**
* 诊断项列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Jobs: Array<string>;
/**
* 诊断索引
*/
Indices: string;
/**
* 历史诊断时间
*/
Interval: number;
}
/**
* 索引备份失败的数据结构
*/
export interface Failures {
/**
* 备份失败的索引名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Index?: string;
/**
* 快照失败的分片号
注意:此字段可能返回 null,表示取不到有效值。
*/
ShardId?: number;
/**
* 快照失败的原因
注意:此字段可能返回 null,表示取不到有效值。
*/
Reason?: string;
/**
* 快照失败的状态
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: string;
}
/**
* DeleteLogstashInstance返回参数结构体
*/
export interface DeleteLogstashInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 智能运维支持的诊断项和元信息
*/
export interface DiagnoseJobMeta {
/**
* 智能运维诊断项英文名
*/
JobName: string;
/**
* 智能运维诊断项中文名
*/
JobZhName: string;
/**
* 智能运维诊断项描述
*/
JobDescription: string;
}
/**
* DescribeEventDataDetail返回参数结构体
*/
export interface DescribeEventDataDetailResponse {
/**
* 异常事件详情
*/
EventDataDetail?: EventDataDetail;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* cvm 自动扩盘参数
*/
export interface AutoScaleDiskInfo {
/**
* 节点类型 hotData,warmData
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeType?: string;
/**
* 0:百分比扩容;1:绝对值扩容
注意:此字段可能返回 null,表示取不到有效值。
*/
ScaleType?: number;
/**
* 触发阈值,单位%,例如80%
注意:此字段可能返回 null,表示取不到有效值。
*/
Threshold?: number;
/**
* 触发持续时间,单位分钟,例如60
注意:此字段可能返回 null,表示取不到有效值。
*/
Duration?: number;
/**
* 每次扩容比例,单位%,例如20%
注意:此字段可能返回 null,表示取不到有效值。
*/
PercentSize?: number;
/**
* 绝对值扩容,单位GB,例如100GB
注意:此字段可能返回 null,表示取不到有效值。
*/
FixSize?: number;
/**
* 扩容上限,单位GB,例如500GB
注意:此字段可能返回 null,表示取不到有效值。
*/
MaxSize?: number;
}
/**
* CreateServerlessSpaceV2返回参数结构体
*/
export interface CreateServerlessSpaceV2Response {
/**
* 空间ID
*/
SpaceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUpgrade返回参数结构体
*/
export interface DescribeUpgradeResponse {
/**
* <p>可以升级到的大版本</p>
*/
EsVersions?: Array<string>;
/**
* <p>可以升级到的商业特性</p>
*/
EsLicenses?: Array<string>;
/**
* <p>可以升级到的子产品</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
EsSubProducts?: Array<string>;
/**
* <p>可以升级到的商业特性</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
EsRealLicenses?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteClusterSnapshot请求参数结构体
*/
export interface DeleteClusterSnapshotRequest {
/**
* 集群实例Id,格式:es-xxxx
*/
InstanceId: string;
/**
* 快照仓库名称
*/
RepositoryName: string;
/**
* 集群快照名称
*/
SnapshotName: string;
}
/**
* Serverless索引空间信息
*/
export interface ServerlessSpace {
/**
* <p>Serverless索引空间ID</p>
*/
SpaceId?: string;
/**
* <p>Serverless索引空间名</p>
*/
SpaceName?: string;
/**
* <p>Serverless索引空间状态</p><p>枚举值:</p><ul><li>0: 创建中</li><li>1: 正常</li><li>2: 流程中</li><li>-3: 已删除</li><li>-4: 隔离中</li></ul>
*/
Status?: number;
/**
* <p>创建日期</p>
*/
CreateTime?: string;
/**
* <p>空间内索引数量</p>
*/
IndexCount?: number;
/**
* <p>kibana公网uri</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
KibanaUrl?: string;
/**
* <p>kibana内网url</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
KibanaPrivateUrl?: string;
/**
* <p>空间内网访问地址</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
IndexAccessUrl?: string;
/**
* <p>空间白名单</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
KibanaPublicAcl?: EsAcl;
/**
* <p>空间检索分析域名</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
KibanaEmbedUrl?: string;
/**
* <p>数据联路</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
DiDataList?: DiData;
/**
* <p>空间vpc信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcInfo?: Array<VpcInfo>;
/**
* <p>地域</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Region?: string;
/**
* <p>可用区</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone?: string;
/**
* <p>kibana公网开关,0关闭,1开启</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableKibanaPublicAccess?: number;
/**
* <p>kibana内网开关,0关闭,1开启</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableKibanaPrivateAccess?: number;
/**
* <p>空间所属appid</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId?: number;
/**
* <p>//默认en, 可选zh-CN</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
KibanaLanguage?: string;
/**
* <p>0</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterType?: number;
/**
* <p>空间标签信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
TagList?: Array<TagInfo>;
/**
* <p>是否开启mcp服务</p>
*/
EnableMcpAccess?: number;
/**
* <p>mcp的访问地址</p>
*/
McpAccess?: string;
}
/**
* CheckMigrateIndexMetaData返回参数结构体
*/
export interface CheckMigrateIndexMetaDataResponse {
/**
* 不存在于目标索引时间字段相同的字段
*/
MappingTimeFieldCheckFailedIndexArr?: Array<string>;
/**
* @timestamp不为date类型,与目标索引时间字段冲突
*/
MappingTimeTypeCheckFailedIndexArr?: Array<string>;
/**
* 索引的创建时间不在 serverless的存储周期内
*/
SettingCheckFailedIndexArr?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 支持的地域名
*/
export interface RegionsData {
/**
* 地域英文名
*/
Region: string;
/**
* 地域中文名
*/
RegionName: string;
}
/**
* DescribeDiagnose请求参数结构体
*/
export interface DescribeDiagnoseRequest {
/**
* ES实例ID
*/
InstanceId: string;
/**
* 报告日期,格式20210301
*/
Date?: string;
/**
* 报告返回份数
*/
Limit?: number;
}
/**
* 全部指标数据
*/
export interface MetricAllData {
/**
* 索引流量
*/
IndexTraffic?: number;
/**
* 存储大小
*/
Storage?: number;
/**
* 读请求次数
*/
ReadReqTimes?: number;
/**
* 写请求次数
*/
WriteReqTimes?: number;
/**
* 文档数量
*/
DocCount?: number;
}
/**
* 配置组信息
*/
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。
*/
RequestId?: string;
}
/**
* QueryZoneResource请求参数结构体
*/
export interface QueryZoneResourceRequest {
/**
* 要检查的可用区
*/
Zones: Array<string>;
/**
* 操作类型(create数据节点创建,masterCreate专用主节点创建,scaleUp数据节点纵向扩容,masterAdd添加专用主节点,masterScaleUp专用主节点纵向扩容)
*/
OptType: string;
/**
* 实例ID(变配检查需要传递)
*/
InstanceId?: string;
/**
* 集群部署方式
<li>0, 单可用区部署</li>
<li>1, 多可用区部署</li>
*/
DeployMode?: number;
/**
* 计费类型<li>PREPAID:预付费,即包年包月</li><li>POSTPAID_BY_HOUR:按小时后付费</li>
*/
ChargeType?: string;
/**
* ES版本号如5.6.4,6.4.3,6.8.2,7.5.1
*/
EsVersion?: string;
/**
* cdcId,使用cdc子网时传递
*/
CdcId?: string;
}
/**
* UpdateJdk请求参数结构体
*/
export interface UpdateJdkRequest {
/**
* ES实例ID
*/
InstanceId: string;
/**
* Jdk类型,支持kona和oracle
*/
Jdk?: string;
/**
* Gc类型,支持g1和cms
*/
Gc?: string;
/**
* 是否强制重启
*/
ForceRestart?: boolean;
}
/**
* forcemerge任务信息
*/
export interface CrontabTaskInfo {
/**
* forcemerge任务id
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskId?: number;
/**
* 集群地域
注意:此字段可能返回 null,表示取不到有效值。
*/
RegionId?: number;
/**
* 集群id
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: number;
/**
* forcemerge任务名称
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskName?: string;
/**
* 任务类型
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskType?: string;
/**
* 任务执行时间
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskTime?: string;
/**
* 执行forcemerge的索引
注意:此字段可能返回 null,表示取不到有效值。
*/
Target?: string;
/**
* 上次执行时间
注意:此字段可能返回 null,表示取不到有效值。
*/
LastExecTime?: string;
/**
* 状态
注意:此字段可能返回 null,表示取不到有效值。
*/
State?: string;
/**
* 任务状态
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskStatus?: number;
/**
* 创建任务时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 任务更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: string;
/**
* 任务详情
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskDetail?: string;
/**
* 是否只合并有deleted标记的索引,对应ES _forcemerge API中的only_expunge_deletes参数,默认值false
注意:此字段可能返回 null,表示取不到有效值。
*/
OnlyExpungeDeletes?: boolean;
/**
* 最大合并Segment数量,对应ES _forcemerge API中的max_num_segments参数
注意:此字段可能返回 null,表示取不到有效值。
*/
MaxMumSegments?: number;
}
/**
* ES集群操作详细信息
*/
export interface Operation {
/**
* <p>操作唯一id</p>
*/
Id?: number;
/**
* <p>操作开始时间</p>
*/
StartTime?: string;
/**
* <p>操作类型</p>
*/
Type?: string;
/**
* <p>操作详情</p>
*/
Detail?: OperationDetail;
/**
* <p>操作结果</p>
*/
Result?: string;
/**
* <p>流程任务信息</p>
*/
Tasks?: Array<TaskDetail>;
/**
* <p>操作进度</p>
*/
Progress?: number;
/**
* <p>回滚标记, 0未回滚 ,1回滚中,2已回滚</p>
*/
RollbackTag?: number;
/**
* <p>操作者Uin</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
SubAccountUin?: string;
/**
* <p>自动扩容标识:0-非自动,1-自动</p>
*/
AutoScaleTag?: number;
/**
* <p>流程异常原因</p>
*/
SuspendedReason?: string;
}
/**
* 数据接入cvm数据源信息
*/
export interface DiDataSourceCvm {
/**
* vpc id
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* 采集路径列表
注意:此字段可能返回 null,表示取不到有效值。
*/
LogPaths?: Array<string>;
/**
* cvm实例信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
CvmInstances?: Array<DiDataSourceCvmInstance>;
/**
* 采集器id
注意:此字段可能返回 null,表示取不到有效值。
*/
CollectorId?: string;
}
/**
* UpdateIpTraceStatus请求参数结构体
*/
export interface UpdateIpTraceStatusRequest {
/**
* 集群ID
*/
InstanceId?: string;
/**
* IP溯源配置开关
*/
OpenIpTrace?: boolean;
/**
* IP溯源开启持续时间,单位:秒
*/
DurationTime?: number;
/**
* IP溯源配置
*/
IpTraceConfig?: IpTraceConfig;
/**
* 是否过滤kibana节点IP
*/
FilterKibanaIp?: boolean;
}
/**
* ES集群日志详细信息
*/
export interface InstanceLog {
/**
* 日志时间
*/
Time?: string;
/**
* 日志级别
*/
Level?: string;
/**
* 集群节点ip
*/
Ip?: string;
/**
* 日志内容
*/
Message?: string;
/**
* 集群节点ID
*/
NodeID?: string;
/**
* 慢日志索引名
*/
IndexName?: string;
/**
* 慢日志索引分片
*/
Shard?: string;
/**
* 慢日志索引查询耗时
*/
QueryCost?: 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;
}
/**
* CreateIndex返回参数结构体
*/
export interface CreateIndexResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeServerlessSpaceUser返回参数结构体
*/
export interface DescribeServerlessSpaceUserResponse {
/**
* 用户数组
*/
ServerlessSpaceUsers?: Array<ServerlessSpaceUser>;
/**
* 用户总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 智能运维日志详情
*/
export interface LogDetail {
/**
* 日志异常名
*/
Key: string;
/**
* 日志异常处理建议
*/
Advise: string;
/**
* 日志异常名出现次数
*/
Count: number;
}
/**
* CreateCollector请求参数结构体
*/
export interface CreateCollectorRequest {
/**
* 采集器名称(1-50 个英文、汉字、数字、连接线-或下划线_)
*/
CollectorName: string;
/**
* 采集器版本(支持"6.8.15"、"7.10.2")
*/
CollectorVersion: string;
/**
* 采集器类型(支持filebeat、metricbeat、heartbeat、auditbeat、packetbeat)
*/
CollectorType: string;
/**
* 采集器输出的ES实例信息
*/
OutputInstance: CollectorOutputInstance;
/**
* 采集器配置
*/
CollectorConfigs?: Array<CollectorConfigInfo>;
/**
* 采集器下发的CVM实例ID列表
*/
CVMInstanceIds?: Array<string>;
/**
* 采集目标类型,CVM或者TKE
*/
TargetType?: string;
/**
* 容器集群ID,采集目标为TKE时必填
*/
ContainerClusterId?: string;
/**
* 采集器配置,采集目标为TKE时必填
*/
CollectorTargets?: Array<CollectorTarget>;
/**
* 标签信息
*/
TagList?: Array<TagInfo>;
}
/**
* DescribeAutoBackUpStrategy请求参数结构体
*/
export interface DescribeAutoBackUpStrategyRequest {
/**
* 实例名称
*/
InstanceId: string;
}
/**
* 无
*/
export interface CosSnapShotInfo {
/**
* cos 桶名
注意:此字段可能返回 null,表示取不到有效值。
*/
CosBucket?: string;
/**
* base path
注意:此字段可能返回 null,表示取不到有效值。
*/
BasePath?: string;
/**
* 快照名
注意:此字段可能返回 null,表示取不到有效值。
*/
SnapshotName?: string;
/**
* 状态
注意:此字段可能返回 null,表示取不到有效值。
*/
State?: string;
/**
* 快照版本
注意:此字段可能返回 null,表示取不到有效值。
*/
Version?: string;
/**
* 普通[{"DataStreamName":"ilm-history-5","Is索引信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
CommonIndexArr?: Array<CommonIndexInfo>;
/**
* 自治索引信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
DataStreamArr?: Array<DataStreamInfo>;
}
/**
* DescribeIndexMeta返回参数结构体
*/
export interface DescribeIndexMetaResponse {
/**
* 索引元数据字段
注意:此字段可能返回 null,表示取不到有效值。
*/
IndexMetaField?: IndexMetaField;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLogstashViews请求参数结构体
*/
export interface DescribeLogstashViewsRequest {
/**
* longstash集群ID
*/
LogstashInstanceId: string;
}
/**
* StartLogstashPipelines请求参数结构体
*/
export interface StartLogstashPipelinesRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 管道ID列表
*/
PipelineIds: Array<string>;
}
/**
* DescribeServerlessMetrics请求参数结构体
*/
export interface DescribeServerlessMetricsRequest {
/**
* space空间id
*/
SpaceId?: string;
/**
* index索引id
*/
IndexId?: string;
/**
* 指标类型,暂时只支持Storage(存储大小),AllMetric(所有存储指标:索引流量、存储大小、文档数量、读请求和写请求)
*/
MetricType?: Array<string>;
/**
* 时间长度类型DurationType(1: 3小时, 2: 昨天1天,3: 今日0点到现在)
*/
DurationType?: number;
/**
* 索引数据
*/
BatchIndexList?: Array<string>;
}
/**
* GetDiagnoseSettings返回参数结构体
*/
export interface GetDiagnoseSettingsResponse {
/**
* 智能运维诊断项和元信息
*/
DiagnoseJobMetas?: Array<DiagnoseJobMeta>;
/**
* 0:开启智能运维;-1:关闭智能运维
*/
Status?: number;
/**
* 智能运维每天定时巡检时间
*/
CronTime?: string;
/**
* 智能运维当天已手动触发诊断次数
*/
Count?: number;
/**
* 智能运维每天最大可手动触发次数
*/
MaxCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAutoBackUpStrategy请求参数结构体
*/
export interface ModifyAutoBackUpStrategyRequest {
/**
* 实例名称
*/
InstanceId: string;
/**
* 当前策略名称
*/
StrategyName: string;
/**
* 策略信息
*/
CosBackup: CosBackup;
}
/**
* CreateServerlessSpaceV2请求参数结构体
*/
export interface CreateServerlessSpaceV2Request {
/**
* vpc信息
*/
VpcInfo: Array<VpcInfo>;
/**
* 索引空间名
*/
SpaceName?: string;
/**
* 空间名称
*/
Zone?: string;
/**
* 白名单列表
*/
KibanaWhiteIpList?: Array<string>;
/**
* 空间id
*/
ZoneId?: number;
/**
* 标签信息
*/
TagList?: Array<TagInfo>;
}
/**
* 容器日志采集配置
*/
export interface CollectorTarget {
/**
* 采集配置名称
*/
TargetName: string;
/**
* 命名空间列表,包括Include包含和Exclude不包含选项,两者都为空时等同于全部命名空间(包含当前所有的以及未来创建的)。
注意:此字段可能返回 null,表示取不到有效值。
*/
Namespaces?: Namespaces;
/**
* Pod标签列表
注意:此字段可能返回 null,表示取不到有效值。
*/
PodLabels?: Array<PodLabel>;
/**
* 容器名称,支持小写字母、数字、连接符-、下划线_,最多支持63个字符
注意:此字段可能返回 null,表示取不到有效值。
*/
ContainerName?: string;
/**
* ES索引名称前缀,如果当前采集配置下的容器日志输出到ES集群,则使用该字段作为ES索引名称的前缀,支持大小写字母、数字、连接符-、下划线_,最多支持50个字符
注意:此字段可能返回 null,表示取不到有效值。
*/
IndexPrefix?: string;
/**
* 日志内容过滤,以逗号分隔,支持大小写字母、数字、连接符-、下划线_以及逗号,最多支持50个字符
注意:此字段可能返回 null,表示取不到有效值。
*/
LogFilters?: string;
/**
* 高级配置,可自定义采集规则,最多支持2048个字符
注意:此字段可能返回 null,表示取不到有效值。
*/
ConfigContent?: string;
/**
* Ckafka实例的Topic
注意:此字段可能返回 null,表示取不到有效值。
*/
KafkaTopic?: string;
/**
* ES索引名称,如果当前采集配置下的容器日志输出到ES集群,则使用该字段作为ES索引名称,支持大小写字母、数字、连接符-、下划线_,最多支持50个字符
注意:此字段可能返回 null,表示取不到有效值。
*/
IndexAlias?: string;
/**
* /
注意:此字段可能返回 null,表示取不到有效值。
*/
InputType?: string;
/**
* 日志采集host路径
注意:此字段可能返回 null,表示取不到有效值。
*/
InputPath?: string;
/**
* inputs.tail_files
注意:此字段可能返回 null,表示取不到有效值。
*/
InputsTailFiles?: boolean;
}
/**
* DeleteServerlessSpaceUser返回参数结构体
*/
export interface DeleteServerlessSpaceUserResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据接入信息
*/
export interface DiData {
/**
* 数据接入id
注意:此字段可能返回 null,表示取不到有效值。
*/
DiId?: string;
/**
* 数据接入创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 数据接入状态,0处理中,1正常,-2删除中,-3已删除
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: number;
/**
* cvm数据源信息
注意:此字段可能返回 null,表示取不到有效值。
*/
DiDataSourceCvm?: DiDataSourceCvm;
/**
* tke数据源信息
注意:此字段可能返回 null,表示取不到有效值。
*/
DiDataSourceTke?: DiDataSourceTke;
/**
* serverless目的端信息
注意:此字段可能返回 null,表示取不到有效值。
*/
DiDataSinkServerless?: DiDataSinkServerless;
/**
* 数据接入类型
注意:此字段可能返回 null,表示取不到有效值。
*/
DiDataSourceType?: string;
}
/**
* UpdateServerlessInstance返回参数结构体
*/
export interface UpdateServerlessInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RequestInstancesByGet请求参数结构体
*/
export interface RequestInstancesByGetRequest {
/**
* <p>集群id</p>
*/
InstanceId: string;
/**
* <p>请求路径</p>
*/
Uri?: string;
/**
* <p>调用方</p>
*/
Caller?: string;
}
/**
* DescribeForceMergeTask请求参数结构体
*/
export interface DescribeForceMergeTaskRequest {
/**
* 集群实例ID
*/
InstanceId: string;
/**
* 分页页数
*/
Offset?: number;
/**
* 每页展示记录条数
*/
Limit?: number;
}
/**
* QueryIpTraceLog返回参数结构体
*/
export interface QueryIpTraceLogResponse {
/**
* 总数
*/
Total?: number;
/**
* IP溯源日志列表
*/
IpTraceLogList?: Array<IpTraceLogEntry>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 事件类型详情结构
*/
export interface EventTypeInfo {
/**
* <p>事件类型</p>
*/
EventType?: number;
/**
* <p>事件名称</p>
*/
EventTypeName?: string;
}
/**
* 实例操作记录流程任务中的子任务信息(如升级检查任务中的各个检查项)
*/
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;
}
/**
* UpdateRequestTargetNodeTypes请求参数结构体
*/
export interface UpdateRequestTargetNodeTypesRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 接收请求的目标节点类型列表
*/
TargetNodeTypes: Array<string>;
}
/**
* DescribeLogstashInstances返回参数结构体
*/
export interface DescribeLogstashInstancesResponse {
/**
* 返回的实例个数
*/
TotalCount?: number;
/**
* 实例详细信息列表
*/
InstanceList?: Array<LogstashInstanceInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InstallInstanceModel请求参数结构体
*/
export interface InstallInstanceModelRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 客户上传到cos的模型地址,单次请求限制一个。cos文件为压缩文件,格式包括:zip、tgz和tar.gz
*/
UsrCosModelUrlList?: Array<string>;
/**
* 客户指定安装的模型名称,可为空,默认为模型文件名
*/
ModelNames?: Array<string>;
/**
* 模型使用的任务类型,包括:fill_mask, ner, question_answering, text_classification, text_embedding, text_expansion, text_similarity和zero_shot_classification,默认为text_embedding
*/
TaskTypes?: Array<string>;
/**
* HuggingFace模型名称
*/
HuggingFaceModelNames?: Array<string>;
/**
* 模型描述
*/
ModelDescription?: string;
/**
* 模型来源:UserModel、HuggingFace和PlatformModel
*/
ModelSourceType?: string;
/**
* 已上传的模型路径
*/
UploadedCosPaths?: Array<string>;
}
/**
* CreateAutoBackUpStrategy请求参数结构体
*/
export interface CreateAutoBackUpStrategyRequest {
/**
* 实例名称
*/
InstanceId: string;
/**
* 策略信息
*/
CosBackup: CosBackup;
}
/**
* DescribeRequestInstancePolicy返回参数结构体
*/
export interface DescribeRequestInstancePolicyResponse {
/**
* <p>GET路径可请求的命令合集</p>
*/
GetPaths?: Array<string>;
/**
* <p>POST路径可请求的命令合集</p>
*/
PostPaths?: Array<string>;
/**
* <p>PUT路径可请求的命令合集</p>
*/
PutPaths?: Array<string>;
/**
* <p>是否是默认的参数</p>
*/
IsDefault?: boolean;
/**
* <p>变更时间</p>
*/
UpdateTime?: string;
/**
* <p>变更人</p>
*/
Operator?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据接入serverless目的端信息
*/
export interface DiDataSinkServerless {
/**
* serverless实例id
注意:此字段可能返回 null,表示取不到有效值。
*/
ServerlessId?: string;
}
/**
* DescribeEventInfoList返回参数结构体
*/
export interface DescribeEventInfoListResponse {
/**
* <p>事件类型详情</p>
*/
EventTypeInfoList?: Array<EventTypeInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 磁盘上下限
*/
export interface NodeTypeDiskSizeRange {
/**
* 机器类型
*/
NodeType?: string;
/**
* 节点类型
*/
Type?: string;
/**
* 磁盘类型
*/
DiskType?: string;
/**
* 磁盘最小值
*/
Min?: number;
/**
* 中刻度值
*/
Med?: number;
/**
* 磁盘最大值
*/
Max?: number;
/**
* 磁盘最小个数
*/
DiskCountMin?: number;
/**
* 磁盘最大个数
*/
DiskCountMax?: number;
/**
* 是否加密盘
*/
DiskEncrypt?: number;
/**
* 是否增强
*/
DiskEnhance?: number;
/**
* 是否lvm
*/
IsLvm?: number;
/**
* 是否本地盘
*/
IsLocalDiskType?: boolean;
}
/**
* DeleteInstance返回参数结构体
*/
export interface DeleteInstanceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* vpc信息
*/
export interface VpcInfo {
/**
* vpcId信息
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* SubnetId信息
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId?: string;
/**
* VpcUid信息
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcUid?: number;
/**
* SubnetUid 信息
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetUid?: number;
/**
* 可用ip数量
注意:此字段可能返回 null,表示取不到有效值。
*/
AvailableIpAddressCount?: number;
}
/**
* RequestInstances请求参数结构体
*/
export type RequestInstancesRequest = null;
/**
* RestartKibana返回参数结构体
*/
export interface RestartKibanaResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRequestInstancePolicy请求参数结构体
*/
export interface DescribeRequestInstancePolicyRequest {
/**
* <p>集群id</p>
*/
InstanceId: string;
}
/**
* 智能运维集群配置详情
*/
export interface SettingDetail {
/**
* 配置key
*/
Key: string;
/**
* 配置当前值
*/
Value: string;
/**
* 配置处理建议
*/
Advise: string;
}
/**
* DescribeLogstashInstanceOperations返回参数结构体
*/
export interface DescribeLogstashInstanceOperationsResponse {
/**
* 操作记录总数
*/
TotalCount: number;
/**
* 操作记录
*/
Operations: Array<Operation>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: string;
}
/**
* UpdateIpTraceStatus返回参数结构体
*/
export interface UpdateIpTraceStatusResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdatePlugins请求参数结构体
*/
export interface UpdatePluginsRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 需要安装的插件名列表
*/
InstallPluginList?: Array<string>;
/**
* 需要卸载的插件名列表
*/
RemovePluginList?: Array<string>;
/**
* 是否强制重启,默认值false
*/
ForceRestart?: boolean;
/**
* 是否重新安装,默认值false
*/
ForceUpdate?: boolean;
/**
* 0:系统插件
*/
PluginType?: number;
}
/**
* StopLogstashPipelines返回参数结构体
*/
export interface StopLogstashPipelinesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestoreClusterSnapshot请求参数结构体
*/
export interface RestoreClusterSnapshotRequest {
/**
* <p>集群实例Id,格式:es-xxxx</