@nocobase/plugin-verification

/** * CheckDataEngineConfigPairsValidity返回参数结构体 */ export interface CheckDataEngineConfigPairsValidityResponse { /** * 参数有效性：ture:有效，false:至少存在一个无效参数； */ IsAvailable?: boolean; /** * 无效参数集合注意：此字段可能返回 null，表示取不到有效值。 */ UnavailableConfig?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeResultDownload返回参数结构体 */ export interface DescribeResultDownloadResponse { /** * 下载文件路径注意：此字段可能返回 null，表示取不到有效值。 */ Path: string; /** * 任务状态 init | queue | format | compress | success| timeout | error */ Status: string; /** * 任务异常原因注意：此字段可能返回 null，表示取不到有效值。 */ Reason: string; /** * 临时AK 注意：此字段可能返回 null，表示取不到有效值。 */ SecretId: string; /** * 临时SK 注意：此字段可能返回 null，表示取不到有效值。 */ SecretKey: string; /** * 临时Token 注意：此字段可能返回 null，表示取不到有效值。 */ Token: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * python-spark镜像信息。 */ export interface PythonSparkImage { /** * spark镜像唯一id */ SparkImageId: string; /** * 集群小版本镜像id */ ChildImageVersionId: string; /** * spark镜像名称 */ SparkImageVersion: string; /** * spark镜像描述信息注意：此字段可能返回 null，表示取不到有效值。 */ Description: string; /** * 创建时间 */ CreateTime: string; /** * 更新时间 */ UpdateTime: string; } /** * DescribeDatabases请求参数结构体 */ export interface DescribeDatabasesRequest { /** * 返回数量，默认为10，最大值为100。 */ Limit?: number; /** * 数据偏移量，从0开始，默认为0。 */ Offset?: number; /** * 模糊匹配，库名关键字。 */ KeyWord?: string; /** * 数据源唯名称，该名称可以通过DescribeDatasourceConnection接口查询到。默认为DataLakeCatalog */ DatasourceConnectionName?: string; /** * 排序字段，CreateTime：创建时间，Name：数据库名称 */ Sort?: string; /** * 排序类型：false：降序（默认）、true：升序 */ Asc?: boolean; } /** * 元数据基本对象 */ export interface Asset { /** * 主键注意：此字段可能返回 null，表示取不到有效值。 */ Id?: number; /** * 名称注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 对象GUID值注意：此字段可能返回 null，表示取不到有效值。 */ Guid?: string; /** * 数据目录注意：此字段可能返回 null，表示取不到有效值。 */ Catalog?: string; /** * 描述信息 */ Description?: string; /** * 对象owner */ Owner?: string; /** * 对象owner账户 */ OwnerAccount?: string; /** * 权限 */ PermValues?: Array<KVPair>; /** * 附加属性 */ Params?: Array<KVPair>; /** * 附加业务属性 */ BizParams?: Array<KVPair>; /** * 数据版本 */ DataVersion?: number; /** * 创建时间 */ CreateTime?: string; /** * 修改时间 */ ModifiedTime?: string; /** * 数据源主键 */ DatasourceId?: number; } /** * CreateUser请求参数结构体 */ export interface CreateUserRequest { /** * 需要授权的子用户uin，可以通过腾讯云控制台右上角 → “账号信息” → “账号ID进行查看”。 */ UserId: string; /** * 用户描述信息，方便区分不同用户 */ UserDescription?: string; /** * 绑定到用户的权限集合 */ PolicySet?: Array<Policy>; /** * 用户类型。ADMIN：管理员 COMMON：一般用户。当用户类型为管理员的时候，不能设置权限集合和绑定的工作组集合，管理员默认拥有所有权限。该参数不填默认为COMMON */ UserType?: string; /** * 绑定到用户的工作组ID集合。 */ WorkGroupIds?: Array<number | bigint>; /** * 用户别名，字符长度小50 */ UserAlias?: string; } /** * ModifyGovernEventRule返回参数结构体 */ export interface ModifyGovernEventRuleResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNotebookSessions请求参数结构体 */ export interface DescribeNotebookSessionsRequest { /** * DLC Spark作业引擎名称 */ DataEngineName: string; /** * Session状态，包含：not_started（未启动）、starting（已启动）、idle（等待输入）、busy(正在运行statement)、shutting_down（停止）、error（异常）、dead（已退出）、killed（被杀死）、success（正常停止） */ State?: Array<string>; /** * 排序字段（默认按创建时间） */ SortFields?: Array<string>; /** * 排序字段：true：升序、false：降序（默认） */ Asc?: boolean; /** * 分页参数，默认10 */ Limit?: number; /** * 分页参数，默认0 */ Offset?: number; } /** * SmartOptimizerLifecyclePolicy */ export interface SmartOptimizerLifecyclePolicy { /** * 生命周期启用注意：此字段可能返回 null，表示取不到有效值。 */ LifecycleEnable?: string; /** * 过期时间注意：此字段可能返回 null，表示取不到有效值。 */ Expiration?: number; /** * 是否删表注意：此字段可能返回 null，表示取不到有效值。 */ DropTable?: boolean; } /** * DescribeDMSDatabase返回参数结构体 */ export interface DescribeDMSDatabaseResponse { /** * 数据库名称注意：此字段可能返回 null，表示取不到有效值。 */ Name: string; /** * schema名称注意：此字段可能返回 null，表示取不到有效值。 */ SchemaName: string; /** * 存储地址注意：此字段可能返回 null，表示取不到有效值。 */ Location: string; /** * 数据对象注意：此字段可能返回 null，表示取不到有效值。 */ Asset: Asset; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 策略集合 */ export interface Policys { /** * 策略集合注意：此字段可能返回 null，表示取不到有效值。 */ PolicySet: Array<Policy>; /** * 策略总数注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; } /** * DropDMSDatabase请求参数结构体 */ export interface DropDMSDatabaseRequest { /** * 数据库名称 */ Name: string; /** * 是否删除数据 */ DeleteData?: boolean; /** * 是否级联删除 */ Cascade?: boolean; } /** * 按批提交Statement运行SQL任务。 */ export interface NotebookSessionStatementBatchInformation { /** * 任务详情列表注意：此字段可能返回 null，表示取不到有效值。 */ NotebookSessionStatementBatch?: Array<NotebookSessionStatementInfo>; /** * 当前批任务是否运行完成注意：此字段可能返回 null，表示取不到有效值。 */ IsAvailable?: boolean; /** * Session唯一标识注意：此字段可能返回 null，表示取不到有效值。 */ SessionId?: string; /** * Batch唯一标识注意：此字段可能返回 null，表示取不到有效值。 */ BatchId?: string; } /** * DescribeTables返回参数结构体 */ export interface DescribeTablesResponse { /** * 数据表对象列表。 */ TableList?: Array<TableResponseInfo>; /** * 实例总数。 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDataEngineEvents返回参数结构体 */ export interface DescribeDataEngineEventsResponse { /** * 事件详细信息注意：此字段可能返回 null，表示取不到有效值。 */ Events: Array<HouseEventsInfo>; /** * 分页号注意：此字段可能返回 null，表示取不到有效值。 */ Page: number; /** * 分页大小注意：此字段可能返回 null，表示取不到有效值。 */ Size: number; /** * 总页数注意：此字段可能返回 null，表示取不到有效值。 */ TotalPages: number; /** * 总条数注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Spark批作业集群Session资源配置模板； */ export interface SessionResourceTemplate { /** * driver规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge 注意：此字段可能返回 null，表示取不到有效值。 */ DriverSize?: string; /** * executor规格：small,medium,large,xlarge；内存型(引擎类型)：m.small,m.medium,m.large,m.xlarge 注意：此字段可能返回 null，表示取不到有效值。 */ ExecutorSize?: string; /** * 指定executor数量，最小值为1，最大值小于集群规格注意：此字段可能返回 null，表示取不到有效值。 */ ExecutorNums?: number; /** * 指定executor max数量（动态配置场景下），最小值为1，最大值小于集群规格（当ExecutorMaxNumbers小于ExecutorNums时，改值设定为ExecutorNums）注意：此字段可能返回 null，表示取不到有效值。 */ ExecutorMaxNumbers?: number; } /** * DescribeDMSPartitions请求参数结构体 */ export interface DescribeDMSPartitionsRequest { /** * 数据库名 */ DatabaseName: string; /** * 表名称 */ TableName: string; /** * schema名称 */ SchemaName?: string; /** * 名称 */ Name?: string; /** * 单个分区名称，精准匹配 */ Values?: Array<string>; /** * 多个分区名称，精准匹配 */ PartitionNames?: Array<string>; /** * 多个分区字段的匹配，模糊匹配 */ PartValues?: Array<string>; /** * 过滤SQL */ Filter?: string; /** * 最大分区数量 */ MaxParts?: number; /** * 翻页跳过数量 */ Offset?: number; /** * 页面数量 */ Limit?: number; /** * 表达式 */ Expression?: string; } /** * DescribeDMSTable返回参数结构体 */ export interface DescribeDMSTableResponse { /** * 基础对象注意：此字段可能返回 null，表示取不到有效值。 */ Asset: Asset; /** * 视图文本注意：此字段可能返回 null，表示取不到有效值。 */ ViewOriginalText: string; /** * 视图文本注意：此字段可能返回 null，表示取不到有效值。 */ ViewExpandedText: string; /** * hive维护版本注意：此字段可能返回 null，表示取不到有效值。 */ Retention: number; /** * 存储对象注意：此字段可能返回 null，表示取不到有效值。 */ Sds: DMSSds; /** * 分区列注意：此字段可能返回 null，表示取不到有效值。 */ PartitionKeys: Array<DMSColumn>; /** * 分区注意：此字段可能返回 null，表示取不到有效值。 */ Partitions: Array<DMSPartition>; /** * 表类型注意：此字段可能返回 null，表示取不到有效值。 */ Type: string; /** * 数据库名称注意：此字段可能返回 null，表示取不到有效值。 */ DbName: string; /** * Schame名称注意：此字段可能返回 null，表示取不到有效值。 */ SchemaName: string; /** * 存储大小注意：此字段可能返回 null，表示取不到有效值。 */ StorageSize: number; /** * 记录数量注意：此字段可能返回 null，表示取不到有效值。 */ RecordCount: number; /** * 生命周期注意：此字段可能返回 null，表示取不到有效值。 */ LifeTime: number; /** * 最后访问时间注意：此字段可能返回 null，表示取不到有效值。 */ LastAccessTime: string; /** * 数据更新时间注意：此字段可能返回 null，表示取不到有效值。 */ DataUpdateTime: string; /** * 结构更新时间注意：此字段可能返回 null，表示取不到有效值。 */ StructUpdateTime: string; /** * 列注意：此字段可能返回 null，表示取不到有效值。 */ Columns: Array<DMSColumn>; /** * 表名称注意：此字段可能返回 null，表示取不到有效值。 */ Name: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateTasksInOrder请求参数结构体 */ export interface CreateTasksInOrderRequest { /** * 数据库名称。如果SQL语句中有数据库名称，优先使用SQL语句中的数据库，否则使用该参数指定的数据库。 */ DatabaseName: string; /** * SQL任务信息 */ Tasks: TasksInfo; /** * 数据源名称，默认为COSDataCatalog */ DatasourceConnectionName?: string; } /** * CreateDatabase请求参数结构体 */ export interface CreateDatabaseRequest { /** * 数据库基础信息 */ DatabaseInfo: DatabaseInfo; /** * 数据源名称，默认为DataLakeCatalog */ DatasourceConnectionName?: string; } /** * DescribeDMSTables返回参数结构体 */ export interface DescribeDMSTablesResponse { /** * DMS元数据列表信息注意：此字段可能返回 null，表示取不到有效值。 */ TableList: Array<DMSTableInfo>; /** * 统计值注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAdvancedStoreLocation返回参数结构体 */ export interface DescribeAdvancedStoreLocationResponse { /** * 是否启用高级设置：0-否，1-是 */ Enable: number; /** * 查询结果保存cos路径 */ StoreLocation: string; /** * 是否有托管存储权限 */ HasLakeFs: boolean; /** * 托管存储状态，HasLakeFs等于true时，该值才有意义注意：此字段可能返回 null，表示取不到有效值。 */ LakeFsStatus: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTablesName返回参数结构体 */ export interface DescribeTablesNameResponse { /** * 数据表名称对象列表。 */ TableNameList?: Array<string>; /** * 实例总数。 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAdvancedStoreLocation请求参数结构体 */ export declare type DescribeAdvancedStoreLocationRequest = null; /** * CancelNotebookSessionStatementBatch返回参数结构体 */ export interface CancelNotebookSessionStatementBatchResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SparkSQL批任务信息 */ export interface BatchSqlTask { /** * SQL子任务唯一标识注意：此字段可能返回 null，表示取不到有效值。 */ TaskId?: string; /** * 运行SQL 注意：此字段可能返回 null，表示取不到有效值。 */ ExecuteSQL?: string; /** * 任务信息，成功则返回：Task Success!，失败则返回异常信息注意：此字段可能返回 null，表示取不到有效值。 */ Message?: string; } /** * UpdateDataEngine请求参数结构体 */ export interface UpdateDataEngineRequest { /** * 资源大小 */ Size: number; /** * 最小资源 */ MinClusters: number; /** * 最大资源 */ MaxClusters: number; /** * 开启自动刷新：true：开启、false（默认）：关闭 */ AutoResume: boolean; /** * 数据引擎名称 */ DataEngineName: string; /** * 相关信息 */ Message: string; /** * 是否自定挂起集群：false（默认）：不自动挂起、true：自动挂起 */ AutoSuspend?: boolean; /** * 定时启停集群策略：0（默认）：关闭定时策略、1：开启定时策略（注：定时启停策略与自动挂起策略互斥） */ CrontabResumeSuspend?: number; /** * 定时启停策略，复杂类型：包含启停时间、挂起集群策略 */ CrontabResumeSuspendStrategy?: CrontabResumeSuspendStrategy; /** * 单个集群最大并发任务数，默认5 */ MaxConcurrency?: number; /** * 可容忍的排队时间，默认0。当任务排队的时间超过可容忍的时间时可能会触发扩容。如果该参数为0，则表示一旦有任务排队就可能立即触发扩容。 */ TolerableQueueTime?: number; /** * 集群自动挂起时间 */ AutoSuspendTime?: number; /** * spark jar 包年包月集群是否开启弹性 */ ElasticSwitch?: boolean; /** * spark jar 包年包月集群弹性上限 */ ElasticLimit?: number; /** * Spark批作业集群Session资源配置模板 */ SessionResourceTemplate?: SessionResourceTemplate; } /** * SmartOptimizerWrittenPolicy */ export declare type SmartOptimizerWrittenPolicy = null; /** * DescribeSparkAppJobs请求参数结构体 */ export interface DescribeSparkAppJobsRequest { /** * 返回结果按照该字段排序 */ SortBy?: string; /** * 正序或者倒序，例如：desc */ Sorting?: string; /** * 过滤条件，如下支持的过滤类型，传参Name应为其一:spark-job-name（作业名称），spark-job-id（作业id），spark-app-type（作业类型，1：批任务，2：流任务，4：SQL作业），user-name（创建人），key-word（作业名称或ID关键词模糊搜索） */ Filters?: Array<Filter>; /** * 更新时间起始点，支持格式：yyyy-MM-dd HH:mm:ss */ StartTime?: string; /** * 更新时间截止点，支持格式：yyyy-MM-dd HH:mm:ss */ EndTime?: string; /** * 查询列表偏移量, 默认值0 */ Offset?: number; /** * 查询列表限制数量, 默认值100 */ Limit?: number; } /** * DeleteNotebookSession请求参数结构体 */ export interface DeleteNotebookSessionRequest { /** * Session唯一标识 */ SessionId: string; } /** * CreateDMSTable返回参数结构体 */ export interface CreateDMSTableResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSparkSessionBatchSQL请求参数结构体 */ export interface DescribeSparkSessionBatchSQLRequest { /** * SparkSQL唯一标识 */ BatchId: string; } /** * SmartOptimizerPolicy */ export interface SmartOptimizerPolicy { /** * 是否继承注意：此字段可能返回 null，表示取不到有效值。 */ Inherit?: string; /** * ResourceInfo 注意：此字段可能返回 null，表示取不到有效值。 */ Resources?: Array<ResourceInfo>; /** * SmartOptimizerWrittenPolicy 注意：此字段可能返回 null，表示取不到有效值。 */ Written?: SmartOptimizerWrittenPolicy; /** * SmartOptimizerLifecyclePolicy 注意：此字段可能返回 null，表示取不到有效值。 */ Lifecycle?: SmartOptimizerLifecyclePolicy; /** * SmartOptimizerIndexPolicy 注意：此字段可能返回 null，表示取不到有效值。 */ Index?: SmartOptimizerIndexPolicy; } /** * SparkSQL批任务运行日志 */ export interface SparkSessionBatchLog { /** * 日志步骤：BEG/CS/DS/DSS/DSF/FINF/RTO/CANCEL/CT/DT/DTS/DTF/FINT/EXCE 注意：此字段可能返回 null，表示取不到有效值。 */ Step?: string; /** * 时间注意：此字段可能返回 null，表示取不到有效值。 */ Time?: string; /** * 日志提示注意：此字段可能返回 null，表示取不到有效值。 */ Message?: string; /** * 日志操作注意：此字段可能返回 null，表示取不到有效值。 */ Operate?: Array<SparkSessionBatchLogOperate>; } /** * ModifyUserType请求参数结构体 */ export interface ModifyUserTypeRequest { /** * 用户ID */ UserId: string; /** * 用户要修改到的类型，ADMIN：管理员，COMMON：一般用户。 */ UserType: string; } /** * NotebookSessionStatement详情。 */ export interface NotebookSessionStatementInfo { /** * 完成时间戳注意：此字段可能返回 null，表示取不到有效值。 */ Completed: number; /** * 开始时间戳注意：此字段可能返回 null，表示取不到有效值。 */ Started: number; /** * 完成进度，百分制注意：此字段可能返回 null，表示取不到有效值。 */ Progress: number; /** * Session Statement唯一标识 */ StatementId: string; /** * Session Statement状态，包含：waiting（排队中）、running（运行中）、available（正常）、error（异常）、cancelling（取消中）、cancelled（已取消） */ State: string; /** * Statement输出信息注意：此字段可能返回 null，表示取不到有效值。 */ OutPut: StatementOutput; /** * 批任务id 注意：此字段可能返回 null，表示取不到有效值。 */ BatchId?: string; /** * 运行语句注意：此字段可能返回 null，表示取不到有效值。 */ Code?: string; /** * 任务ID 注意：此字段可能返回 null，表示取不到有效值。 */ TaskId?: string; } /** * Elasticsearch数据源的详细信息 */ export interface ElasticsearchInfo { /** * 数据源ID 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId?: string; /** * 数据源名称注意：此字段可能返回 null，表示取不到有效值。 */ InstanceName?: string; /** * 用户名注意：此字段可能返回 null，表示取不到有效值。 */ User?: string; /** * 密码，需要base64编码注意：此字段可能返回 null，表示取不到有效值。 */ Password?: string; /** * 数据源的VPC和子网信息注意：此字段可能返回 null，表示取不到有效值。 */ Location?: DatasourceConnectionLocation; /** * 默认数据库名称注意：此字段可能返回 null，表示取不到有效值。 */ DbName?: string; /** * 访问Elasticsearch的ip、端口信息注意：此字段可能返回 null，表示取不到有效值。 */ ServiceInfo?: Array<IpPortPair>; } /** * UpdateDataEngineConfig返回参数结构体 */ export interface UpdateDataEngineConfigResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserRoles返回参数结构体 */ export interface DescribeUserRolesResponse { /** * 符合列举条件的总数量 */ Total?: number; /** * 用户角色信息 */ UserRoles?: Array<UserRole>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateExportTask请求参数结构体 */ export interface CreateExportTaskRequest { /** * 数据来源，lakefsStorage、taskResult */ InputType: string; /** * 导出任务输入配置 */ InputConf: Array<KVPair>; /** * 导出任务输出配置 */ OutputConf: Array<KVPair>; /** * 目标数据源的类型，目前支持导出到cos */ OutputType?: string; } /** * CreateDMSTable请求参数结构体 */ export interface CreateDMSTableRequest { /** * 基础对象 */ Asset?: Asset; /** * 表类型 */ Type?: string; /** * 数据库名称 */ DbName?: string; /** * 存储大小 */ StorageSize?: number; /** * 记录数量 */ RecordCount?: number; /** * 生命周期 */ LifeTime?: number; /** * 数据更新时间 */ DataUpdateTime?: string; /** * 结构更新时间 */ StructUpdateTime?: string; /** * 最后访问时间 */ LastAccessTime?: string; /** * 存储对象 */ Sds?: DMSSds; /** * 列 */ Columns?: Array<DMSColumn>; /** * 分区键值 */ PartitionKeys?: Array<DMSColumn>; /** * 视图文本 */ ViewOriginalText?: string; /** * 视图文本 */ ViewExpandedText?: string; /** * 分区 */ Partitions?: Array<DMSPartition>; /** * 表名称 */ Name?: string; } /** * DMSTable基本信息 */ export interface DMSTable { /** * 视图文本注意：此字段可能返回 null，表示取不到有效值。 */ ViewOriginalText?: string; /** * 视图文本注意：此字段可能返回 null，表示取不到有效值。 */ ViewExpandedText?: string; /** * hive维护版本注意：此字段可能返回 null，表示取不到有效值。 */ Retention?: number; /** * 存储对象注意：此字段可能返回 null，表示取不到有效值。 */ Sds?: DMSSds; /** * 分区列注意：此字段可能返回 null，表示取不到有效值。 */ PartitionKeys?: Array<DMSColumn>; /** * 分区注意：此字段可能返回 null，表示取不到有效值。 */ Partitions?: Array<DMSPartition>; /** * 表类型注意：此字段可能返回 null，表示取不到有效值。 */ Type?: string; /** * 数据库名称注意：此字段可能返回 null，表示取不到有效值。 */ DbName?: string; /** * Schema名称注意：此字段可能返回 null，表示取不到有效值。 */ SchemaName?: string; /** * 存储大小注意：此字段可能返回 null，表示取不到有效值。 */ StorageSize?: number; /** * 记录数量注意：此字段可能返回 null，表示取不到有效值。 */ RecordCount?: number; /** * 生命周期注意：此字段可能返回 null，表示取不到有效值。 */ LifeTime?: number; /** * 最后访问时间注意：此字段可能返回 null，表示取不到有效值。 */ LastAccessTime?: string; /** * 数据更新时间注意：此字段可能返回 null，表示取不到有效值。 */ DataUpdateTime?: string; /** * 结构更新时间注意：此字段可能返回 null，表示取不到有效值。 */ StructUpdateTime?: string; /** * 列注意：此字段可能返回 null，表示取不到有效值。 */ Columns?: Array<DMSColumn>; /** * 表名注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; } /** * ModifyWorkGroup返回参数结构体 */ export interface ModifyWorkGroupResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * hive类型数据源的信息 */ export interface HiveInfo { /** * hive metastore的地址 */ MetaStoreUrl: string; /** * hive数据源类型，代表数据储存的位置，COS或者HDFS */ Type: string; /** * 数据源所在的私有网络信息 */ Location: DatasourceConnectionLocation; /** * 如果类型为HDFS，需要传一个用户名 */ User?: string; /** * 如果类型为HDFS，需要选择是否高可用 */ HighAvailability?: boolean; /** * 如果类型为COS，需要填写COS桶连接 */ BucketUrl?: string; /** * json字符串。如果类型为HDFS，需要填写该字段 */ HdfsProperties?: string; /** * Hive的元数据库信息注意：此字段可能返回 null，表示取不到有效值。 */ Mysql?: MysqlInfo; /** * emr集群Id 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId?: string; /** * emr集群名称注意：此字段可能返回 null，表示取不到有效值。 */ InstanceName?: string; /** * EMR集群中hive组件的版本号注意：此字段可能返回 null，表示取不到有效值。 */ HiveVersion?: string; /** * Kerberos详细信息注意：此字段可能返回 null，表示取不到有效值。 */ KerberosInfo?: KerberosInfo; /** * 是否开启Kerberos 注意：此字段可能返回 null，表示取不到有效值。 */ KerberosEnable?: boolean; } /** * DescribeNotebookSessionStatementSqlResult请求参数结构体 */ export interface DescribeNotebookSessionStatementSqlResultRequest { /** * 任务唯一ID */ TaskId: string; /** * 返回结果的最大行数，范围0~1000，默认为1000. */ MaxResults?: number; /** * 上一次请求响应返回的分页信息。第一次可以不带，从头开始返回数据，每次返回MaxResults字段设置的数据量。 */ NextToken?: string; } /** * CreateTable返回参数结构体 */ export interface CreateTableResponse { /** * 生成的建表执行语句对象。 */ Execution?: Execution; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTaskResult请求参数结构体 */ export interface DescribeTaskResultRequest { /** * 任务唯一ID */ TaskId: string; /** * 上一次请求响应返回的分页信息。第一次可以不带，从头开始返回数据，每次返回MaxResults字段设置的数据量。 */ NextToken?: string; /** * 返回结果的最大行数，范围0~1000，默认为1000. */ MaxResults?: number; } /** * UpdateUserDataEngineConfig请求参数结构体 */ export interface UpdateUserDataEngineConfigRequest { /** * 引擎ID */ DataEngineId: string; /** * 引擎配置项 */ DataEngineConfigPairs?: Array<DataEngineConfigPair>; /** * 作业引擎资源配置模版 */ SessionResourceTemplate?: SessionResourceTemplate; } /** * RollbackDataEngineImage请求参数结构体 */ export interface RollbackDataEngineImageRequest { /** * 引擎ID */ DataEngineId: string; /** * 检查是否能回滚的接口返回的FromRecordId参数 */ FromRecordId?: string; /** * 检查是否能回滚的接口返回的ToRecordId参数 */ ToRecordId?: string; } /** * QueryResult返回参数结构体 */ export interface QueryResultResponse { /** * 任务Id */ TaskId: string; /** * 结果数据 */ ResultSet: string; /** * schema */ ResultSchema: Array<Column>; /** * 分页信息注意：此字段可能返回 null，表示取不到有效值。 */ NextToken: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据治理规则 */ export interface DataGovernPolicy { /** * 治理规则类型，Customize: 自定义；Intelligence: 智能治理注意：此字段可能返回 null，表示取不到有效值。 */ RuleType?: string; /** * 治理引擎注意：此字段可能返回 null，表示取不到有效值。 */ GovernEngine?: string; } /** * CreateWorkGroup返回参数结构体 */ export interface CreateWorkGroupResponse { /** * 工作组Id，全局唯一 */ WorkGroupId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEngineUsageInfo返回参数结构体 */ export interface DescribeEngineUsageInfoResponse { /** * 集群总规格 */ Total?: number; /** * 已占用集群规格 */ Used?: number; /** * 剩余集群规格 */ Available?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWorkGroupInfo返回参数结构体 */ export interface DescribeWorkGroupInfoResponse { /** * 工作组详细信息注意：此字段可能返回 null，表示取不到有效值。 */ WorkGroupInfo: WorkGroupDetailInfo; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTables请求参数结构体 */ export interface DescribeTablesRequest { /** * 列出该数据库下所属数据表。 */ DatabaseName: string; /** * 返回数量，默认为10，最大值为100。 */ Limit?: number; /** * 数据偏移量，从0开始，默认为0。 */ Offset?: number; /** * 过滤条件，如下支持的过滤类型，传参Name应为其一 table-name - String - （过滤条件）数据表名称,形如：table-001。 table-id - String - （过滤条件）table id形如：12342。 */ Filters?: Array<Filter>; /** * 指定查询的数据源名称，默认为DataLakeCatalog */ DatasourceConnectionName?: string; /** * 起始时间：用于对更新时间的筛选，格式为yyyy-mm-dd HH:MM:SS */ StartTime?: string; /** * 终止时间：用于对更新时间的筛选，格式为yyyy-mm-dd HH:MM:SS */ EndTime?: string; /** * 排序字段，支持：CreateTime（创建时间）、UpdateTime（更新时间）、StorageSize（存储空间）、RecordCount（行数）、Name（表名称）（不传则默认按name升序） */ Sort?: string; /** * 排序字段，false：降序（默认）；true：升序 */ Asc?: boolean; /** * table type，表类型查询,可用值:EXTERNAL_TABLE,INDEX_TABLE,MANAGED_TABLE,MATERIALIZED_VIEW,TABLE,VIEW,VIRTUAL_VIEW */ TableType?: string; /** * 筛选字段-表格式：不传（默认）为查全部；LAKEFS：托管表；ICEBERG：非托管iceberg表；HIVE：非托管hive表；OTHER：非托管其它； */ TableFormat?: string; } /** * CreateStoreLocation请求参数结构体 */ export interface CreateStoreLocationRequest { /** * 计算结果存储cos路径，如：cosn://bucketname/ */ StoreLocation: string; } /** * DescribeLakeFsInfo返回参数结构体 */ export interface DescribeLakeFsInfoResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetOptimizerPolicy返回参数结构体 */ export interface GetOptimizerPolicyResponse { /** * 智能优化策略 */ SmartOptimizerPolicy?: SmartOptimizerPolicy; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTable请求参数结构体 */ export interface DescribeTableRequest { /** * 查询对象表名称 */ TableName: string; /** * 查询表所在的数据库名称。 */ DatabaseName: string; /** * 查询表所在的数据源名称 */ DatasourceConnectionName?: string; } /** * 权限对象 */ export interface Policy { /** * 需要授权的数据库名，填*代表当前Catalog下所有数据库。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定数据库。 */ Database: string; /** * 需要授权的数据源名称，管理员级别下只支持填*（代表该级别全部资源）；数据源级别和数据库级别鉴权的情况下，只支持填COSDataCatalog或者*；在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意：如果是对用户自定义数据源进行鉴权，DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。 */ Catalog: string; /** * 需要授权的表名，填*代表当前Database下所有表。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定数据表。 */ Table: string; /** * 授权的权限操作，对于不同级别的鉴权提供不同操作。管理员权限：ALL，不填默认为ALL；数据连接级鉴权：CREATE；数据库级别鉴权：ALL、CREATE、ALTER、DROP；数据表权限：ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意：在数据表权限下，指定的数据源不为COSDataCatalog的时候，只支持SELECT操作。 */ Operation: string; /** * 授权类型，现在支持八种授权类型：ADMIN:管理员级别鉴权 DATASOURCE：数据连接级别鉴权 DATABASE：数据库级别鉴权 TABLE：表级别鉴权 VIEW：视图级别鉴权 FUNCTION：函数级别鉴权 COLUMN：列级别鉴权 ENGINE：数据引擎鉴权。不填默认为管理员级别鉴权。 */ PolicyType?: string; /** * 需要授权的函数名，填*代表当前Catalog下所有函数。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别时只允许填空，其他类型下可以任意指定函数。注意：此字段可能返回 null，表示取不到有效值。 */ Function?: string; /** * 需要授权的视图，填*代表当前Database下所有视图。当授权类型为管理员级别时，只允许填“*”，当授权类型为数据连接级别、数据库级别时只允许填空，其他类型下可以任意指定视图。注意：此字段可能返回 null，表示取不到有效值。 */ View?: string; /** * 需要授权的列，填*代表当前所有列。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。 */ Column?: string; /** * 需要授权的数据引擎，填*代表当前所有引擎。当授权类型为管理员级别时，只允许填“*” 注意：此字段可能返回 null，表示取不到有效值。 */ DataEngine?: string; /** * 用户是否可以进行二次授权。当为true的时候，被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false 注意：此字段可能返回 null，表示取不到有效值。 */ ReAuth?: boolean; /** * 权限来源，入参不填。USER：权限来自用户本身；WORKGROUP：权限来自绑定的工作组注意：此字段可能返回 null，表示取不到有效值。 */ Source?: string; /** * 授权模式，入参不填。COMMON：普通模式；SENIOR：高级模式。注意：此字段可能返回 null，表示取不到有效值。 */ Mode?: string; /** * 操作者，入参不填。注意：此字段可能返回 null，表示取不到有效值。 */ Operator?: string; /** * 权限创建的时间，入参不填注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * 权限所属工作组的ID，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。注意：此字段可能返回 null，表示取不到有效值。 */ SourceId?: number; /** * 权限所属工作组的名称，只有当该权限的来源为工作组时才会有值。即仅当Source字段的值为WORKGROUP时该字段才有值。注意：此字段可能返回 null，表示取不到有效值。 */ SourceName?: string; /** * 策略ID 注意：此字段可能返回 null，表示取不到有效值。 */ Id?: number; } /** * UpdateUserDataEngineConfig返回参数结构体 */ export interface UpdateUserDataEngineConfigResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateTasks请求参数结构体 */ export interface CreateTasksRequest { /** * 数据库名称。如果SQL语句中有数据库名称，优先使用SQL语句中的数据库，否则使用该参数指定的数据库（注：当提交建库sql时，该字段传空字符串）。 */ DatabaseName: string; /** * SQL任务信息 */ Tasks: TasksInfo; /** * 数据源名称，默认为DataLakeCatalog */ DatasourceConnectionName?: string; /** * 计算引擎名称，不填任务提交到默认集群 */ DataEngineName?: string; } /** * SuspendResumeDataEngine请求参数结构体 */ export interface SuspendResumeDataEngineRequest { /** * 虚拟集群名称 */ DataEngineName: string; /** * 操作类型 suspend/resume */ Operate: string; } /** * DescribeSparkAppJobs返回参数结构体 */ export interface DescribeSparkAppJobsResponse { /** * spark作业列表详情 */ SparkAppJobs?: Array<SparkJobInfo>; /** * spark作业总数 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询表信息对象 */ export interface TableResponseInfo { /** * 数据表基本信息。 */ TableBaseInfo?: TableBaseInfo; /** * 数据表列信息。注意：此字段可能返回 null，表示取不到有效值。 */ Columns?: Array<Column>; /** * 数据表分块信息。注意：此字段可能返回 null，表示取不到有效值。 */ Partitions?: Array<Partition>; /** * 数据存储路径。注意：此字段可能返回 null，表示取不到有效值。 */ Location?: string; /** * 数据表属性信息。注意：此字段可能返回 null，表示取不到有效值。 */ Properties?: Array<Property>; /** * 数据表更新时间, 单位: ms。注意：此字段可能返回 null，表示取不到有效值。 */ ModifiedTime?: string; /** * 数据表创建时间,单位: ms。注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * 数据格式。注意：此字段可能返回 null，表示取不到有效值。 */ InputFormat?: string; /** * 数据表存储大小（单位：Byte）注意：此字段可能返回 null，表示取不到有效值。 */ StorageSize?: number; /** * 数据表行数注意：此字段可能返回 null，表示取不到有效值。 */ RecordCount?: number; /** * xxxx 注意：此字段可能返回 null，表示取不到有效值。 */ MapMaterializedViewName?: string; /** * 访问热点注意：此字段可能返回 null，表示取不到有效值。 */ HeatValue?: number; } /** * ModifyUserType返回参数结构体 */ export interface ModifyUserTypeResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDataEnginePythonSparkImages请求参数结构体 */ export interface DescribeDataEnginePythonSparkImagesRequest { /** * 集群镜像小版本ID */ ChildImageVersionId: string; } /** * CancelSparkSessionBatchSQL请求参数结构体 */ export interface CancelSparkSessionBatchSQLRequest { /** * 批任务唯一标识 */ BatchId: string; } /** * 任务概览 */ export interface TasksOverview { /** * 正在排队的任务个数 */ TaskQueuedCount: number; /** * 初始化的任务个数 */ TaskInitCount: number; /** * 正在执行的任务个数 */ TaskRunningCount: number; /** * 当前时间范围的总任务个数 */ TotalTaskCount: number; } /** * CreateDatabase返回参数结构体 */ export interface CreateDatabaseResponse { /** * 生成的建库执行语句对象。 */ Execution?: Execution; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DropDMSPartitions返回参数结构体 */ export interface DropDMSPartitionsResponse { /** * 状态 */ Status: boolean; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DropDMSTable返回参数结构体 */ export interface DropDMSTableResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatasourceConnection请求参数结构体 */ export interface DescribeDatasourceConnectionRequest { /** * 连接ID列表，指定要查询的连接ID */ DatasourceConnectionIds?: Array<string>; /** * 过滤条件，当前支持的过滤键为：DatasourceConnectionName（数据源连接名）。 DatasourceConnectionType （数据源连接连接类型） */ Filters?: Array<Filter>; /** * 偏移量，默认为0 */ Offset?: number; /** * 返回数量，默认20，最大值100 */ Limit?: number; /** * 排序字段，支持如下字段类型，create-time（默认，创建时间）、update-time（更新时间） */ SortBy?: string; /** * 排序方式，desc表示正序，asc表示反序，默认为desc */ Sorting?: string; /** * 筛选字段：起始时间 */ StartTime?: string; /** * 筛选字段：截止时间 */ EndTime?: string; /** * 连接名称列表，指定要查询的连接名称 */ DatasourceConnectionNames?: Array<string>; /** * 连接类型，支持Mysql/HiveCos/Kafka/DataLakeCatalog */ DatasourceConnectionTypes?: Array<string>; /** * 返回指定hive版本的数据源，该参数指定后，会过滤掉该参数指定版本以外的hive数据源，非hive数据源正常返回 */ HiveVersion?: Array<string>; } /** * CheckDataEngineImageCanBeUpgrade请求参数结构体 */ export interface CheckDataEngineImageCanBeUpgradeRequest { /** * 集群id */ DataEngineId: string; } /** * CreateResultDownload请求参数结构体 */ export interface CreateResultDownloadRequest { /** * 查询结果任务Id */ TaskId: string; /** * 下载格式 */ Format: string; /** * 是否重新生成下载文件，仅当之前任务为 Timout | Error 时有效 */ Force?: boolean; } /** * DescribeNotebookSessionStatementSqlResult返回参数结构体 */ export interface DescribeNotebookSessionStatementSqlResultResponse { /** * 任务Id */ TaskId?: string; /** * 结果数据 */ ResultSet?: string; /** * schema */ ResultSchema?: Array<Column>; /** * 分页信息注意：此字段可能返回 null，表示取不到有效值。 */ NextToken?: string; /** * 存储结果地址注意：此字段可能返回 null，表示取不到有效值。 */ OutputPath?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUser请求参数结构体 */ export interface ModifyUserRequest { /** * 用户Id，和CAM侧Uin匹配 */ UserId: string; /** * 用户描述 */ UserDescription: string; } /** * LakeFileSystem使用的临时token */ export interface LakeFileSystemToken { /** * Token使用的临时密钥的ID */ SecretId?: string; /** * Token使用的临时密钥 */ SecretKey?: string; /** * Token信息 */ Token?: string; /** * 过期时间 */ ExpiredTime?: number; /** * 颁布时间 */ IssueTime?: number; } /** * AddDMSPartitions返回参数结构体 */ export interface AddDMSPartitionsResponse { /** * 成功数量 */ Total: number; /** * 分区值 */ Partitions: Array<DMSPartition>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CancelNotebookSessionStatement请求参数结构体 */ export interface CancelNotebookSessionStatementRequest { /** * Session唯一标识 */ SessionId: string; /** * Session Statement唯一标识 */ StatementId: string; } /** * Spark监控数据 */ export interface SparkMonitorMetrics { /** * shuffle写溢出到COS数据量，单位：byte 注意：此字段可能返回 null，表示取不到有效值。 */ ShuffleWriteBytesCos?: number; /** * shuffle写数据量，单位：byte 注意：此字段可能返回 null，表示取不到有效值。 */ ShuffleWriteBytesTotal?: number; } /** * CreateDMSDatabase返回参数结构体 */ export interface CreateDMSDatabaseResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateStoreLocation返回参数结构体 */ export interface CreateStoreLocationResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTablesName请求参数结构体 */ export interface DescribeTablesNameRequest { /** * 列出该数据库下所属数据表。 */ DatabaseName: string; /** * 返回数量，默认为10，最大值为100。 */ Limit?: number; /** * 数据偏移量，从0开始，默认为0。 */ Offset?: number; /** * 过滤条件，如下支持的过滤类型，传参Name应为其一 table-name - String - （过滤条件）数据表名称,形如：table-001。 table-id - String - （过滤条件）table id形如：12342。 */ Filters?: Array<Filter>; /** * 指定查询的数据源名称，默认为DataLakeCatalog */ DatasourceConnectionName?: string; /** * 起始时间：用于对更新时间的筛选，格式为yyyy-mm-dd HH:MM:SS */ StartTime?: string; /** * 终止时间：用于对更新时间的筛选，格式为yyyy-mm-dd HH:MM:SS */ EndTime?: string; /** * 排序字段，支持：CreateTime（创建时间）、UpdateTime（更新时间）、StorageSize（存储空间）、RecordCount（行数）、Name（表名称）（不传则默认按name升序） */ Sort?: string; /** * 排序字段，false：降序（默认）；true：升序 */ Asc?: boolean; /** * table type，表类型查询,可用值:EXTERNAL_TABLE,INDEX_TABLE,MANAGED_TABLE,MATERIALIZED_VIEW,TABLE,VIEW,VIRTUAL_VIEW */ TableType?: string; /** * 筛选字段-表格式：不传（默认）为查全部；LAKEFS：托管表；ICEBERG：非托管iceberg表；HIVE：非托管hive表；OTHER：非托管其它； */ TableFormat?: string; } /** * 工作组信息 */ export interface WorkGroupInfo { /** * 查询到的工作组唯一Id */ WorkGroupId: number; /** * 工作组名称 */ WorkGroupName: string; /** * 工作组描述注意：此字段可能返回 null，表示取不到有效值。 */ WorkGroupDescription: string; /** * 工作组关联的用户数量 */ UserNum: number; /** * 工作组关联的用户集合注意：此字段可能返回 null，表示取不到有效值。 */ UserSet: Array<UserMessage>; /** * 工作组绑定的权限集合注意：此字段可能返回 null，表示取不到有效值。 */ PolicySet: Array<Policy>; /** * 工作组的创建人 */ Creator: string; /** * 工作组的创建时间，形如2021-07-28 16:19:32 */ CreateTime: string; } /** * SwitchDataEngine请求参数结构体 */ export interface SwitchDataEngineRequest { /** * 主集群名称 */ DataEngineName: string; /** * 是否开启备集群 */ StartStandbyCluster: boolean; } /** * ModifyUser返回参数结构体 */ export interface ModifyUserResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteScript返回参数结构体 */ export interface DeleteScriptResponse { /** * 删除的脚本数量 */ ScriptsAffected: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 任务类型，任务如SQL查询等。 */ export interface Task { /** * SQL查询任务 */ SQLTask?: SQLTask; /** * Spark SQL查询任务 */ SparkSQLTask?: SQLTask; } /** * 引擎配置信息 */ export interface DataEngineConfigInstanceInfo { /** * 引擎ID 注意：此字段可能返回 null，表示取不到有效值。 */ DataEngineId?: string; /** * 用户自定义配置项集合 */ DataEngineConfigPairs?: Array<DataEngineConfigPair>; /** * 作业集群资源参数配置模板 */ SessionResourceTemplate?: SessionResourceTemplate; } /** * 定时启停策略信息 */ export interface CrontabResumeSuspendStrategy { /** * 定时拉起时间：如：周一8点注意：此字段可能返回 null，表示取不到有效值。 */ ResumeTime?: string; /** * 定时挂起时间：如：周一20点注意：此字段可能返回 null，表示取不到有效值。 */ SuspendTime?: string; /** * 挂起配置：0（默认）：等待任务结束后挂起、1：强制挂起注意：此字段可能返回 null，表示取不到有效值。 */ SuspendStrategy?: number; } /** * notebook session列表信息。 */ export interface NotebookSessions { /** * 类型，当前支持：spark、pyspark、sparkr、sql */ Kind?: string; /** * Session唯一标识 */ SessionId?: string; /** * 代理用户，默认为root 注意：此字段可能返回 null，表示取不到有效值。 */ ProxyUser?: string; /** * Session状态，包含：not_started（未启动）、starting（已启动）、idle（等待输入）、busy(正在运行statement)、shutting_down（停止）、error（异常）、dead（已退出）、killed（被杀死）、success（正常停止） */ State?: string; /** * Spark任务返回的AppId 注意：此字段可能返回 null，表示取不到有效值。 */ SparkAppId?: string; /** * Session名称 */ Name?: string; /** * Session创建时间 */ CreateTime?: string; /** * 引擎名称 */ DataEngineName?: string; /** * 最新的运行时间注意：此字段可能返回 null，表示取不到有效值。 */ LastRunningTime?: string; /** * 创建者 */ Creator?: string; /** * spark ui地址注意：此字段可能返回 null，表示取不到有效值。 */ SparkUiUrl?: string; } /** * CreateNotebookSessionStatementSupportBatchSQL请求参数结构体 */ export interface CreateNotebookSessionStatementSupportBatchSQLRequest { /** * Session唯一标识 */ SessionId: string; /** * 执行的代码 */ Code: string; /** * 类型，当前支持：sql */ Kind: string; /** * 是否保存运行结果 */ SaveResult: boolean; } /** * DetachWorkGroupPolicy返回参数结构体 */ export interface DetachWorkGroupPolicyResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSparkSessionBatchSqlLog返回参数结构体 */ export interface DescribeSparkSessionBatchSqlLogResponse { /** * 状态：0：运行中、1：成功、2：失败、3：取消、4：超时； */ State?: number; /** * 日志信息列表注意：此字段可能返回 null，表示取不到有效值。 */ LogSet?: Array<SparkSessionBatchLog>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SwitchDataEngine返回参数结构体 */ export interface SwitchDataEngineResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLakeFsInfo请求参数结构体 */ export declare type DescribeLakeFsInfoRequest = null; /** * DescribeUserInfo请求参数结构体 */ export interface DescribeUserInfoRequest { /** * 用户Id */ UserId?: string; /** * 查询的信息类型，Group：工作组 DataAuth：数据权限 EngineAuth:引擎权限 */ Type?: string; /** * 查询的过滤条件。当Type为Group时，支持Key为workgroup-name的模糊搜索；当Type为DataAuth时，支持key： policy-type：权限类型。 policy-source：数据来源。 data-name：库表的模糊搜索。当Type为EngineAuth时，支持key： policy-type：权限类型。 policy-source：数据来源。 engine-name：库表的模糊搜索。 */ Filters?: Array<Filter>; /** * 排序字段。当Type为Group时，支持create-time、group-name 当Type为DataAuth时，支持create-time 当Type为EngineAuth时，支持create-time */ SortBy?: string; /** * 排序方式，desc表示正序，asc表示反序，默认为asc */ Sorting?: string; /** * 返回数量，默认20，最大值100 */ Limit?: number; /** * 偏移量，默认为0 */ Offset?: number; } /** * DescribeUserType返回参数结构体 */ export interface DescribeUserTypeResponse { /** * 用户类型。ADMIN：管理员 COMMON：普通用户注意：此字段可能返回 null，表示取不到有效值。 */ UserType: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteUser返回参数结构体 */ export interface DeleteUserResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeForbiddenTablePro请求参数结构体 */ export declare type DescribeForbiddenTableProRequest = null; /** * CreateDataEngine返回参数结构体 */ export interface CreateDataEngineResponse { /** * 虚拟引擎id */ DataEngineId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDataEngine请求参数结构体 */ export interface DescribeDataEngineRequest { /** * House名称 */ DataEngineName: string; } /** * CreateNotebookSession请求参数结构体 */ export interface CreateNotebookSessionRequest { /** * Session名称 */ Name: string; /** * 类型，当前支持：spark、pyspark、sparkr、sql */ Kind: string; /** * DLC Spark作业引擎名称 */ DataEngineName: string; /** * session文件地址，当前支持：cosn://和lakefs://两种路径 */ ProgramDependentFiles?: Array<string>; /** * 依赖的jar程序地址，当前支持：cosn://和lakefs://两种路径 */ ProgramDependentJars?: Array<string>; /** * 依赖的python程序地址，当前支持：cosn://和lakefs://两种路径 */ ProgramDependentPython?: Array<string>; /** * 依赖的pyspark虚拟环境地址，当前支持：cosn://和lakefs://两种路径 */ ProgramArchives?: Array<string>; /** * 指定的Driver规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu） */ DriverSize?: string; /** * 指定的Executor规格，当前支持：small（默认，1cu）、medium（2cu）、large（4cu）、xlarge（8cu） */ ExecutorSize?: string; /** * 指定的Executor数量，默认为1 */ ExecutorNumbers?: number; /** * Session相关配置，当前支持： 1. dlc.eni: 用户配置的eni网关信息，可以通过该字段设置； 2. dlc.role.arn: 用户配置的roleArn鉴权策略配置信息，可以通过该字段设置； 3. dlc.sql.set.config: 用户配置的集群配置信息，可以通过该字段设置； */ Arguments?: Array<KVPair>; /** * 代理用户，默认为root */ ProxyUser?: string; /** * 指定的Session超时时间，单位秒，默认3600秒 */ TimeoutInSecond?: number; /** * 指定的Executor数量（最大值），默认为1，当开启动态分配有效，若未开启，则该值等于ExecutorNumbers */ ExecutorMaxNumbers?: number; /** * 指定spark版本名称，当前任务使用该spark镜像运行 */ SparkImage?: string; /** * 是否继承集群的资源类配置：0：自定义（默认），1：继承集群； */ IsInherit?: number; } /** * Kerberos详细信息 */ export interface KerberosInfo { /** * Krb5Conf文件值 */ Krb5Conf?: string; /** * KeyTab文件值 */ KeyTab?: string; /** * 服务主体 */ ServicePrincipal?: string; } /** * CreateDataEngine请求参数结构体 */ export interface CreateDataEngineRequest { /** * 引擎类型spark/presto */ EngineType: string; /** * 虚拟集群名称 */ DataEngineName: string; /** * 集群类型 spark_private/presto_private/presto_cu/spark_cu */ ClusterType: string; /** * 计费模式 0=共享模式 1=按量计费 2=包年包月 */ Mode: number; /** * 是否自动启动集群 */ AutoResume: boolean; /** * 最小资源 */ MinClusters?: number; /** * 最大资源 */ MaxClusters?: number; /** * 是否为默认虚拟集群 * @deprecated */ DefaultDataEngine?: boolean; /** * VPC网段 */ CidrBlock?: string; /** * 描述信息 */ Message?: string; /** * 集群规模 */ Size?: number; /** * 计费类型，后付费：0，预付费：1。当前只支持后付费，不填默认为后付费。 */ PayMode?: number; /** * 资源使用时长，后付费：固定填3600，预付费：最少填1，代表购买资源一个月，最长不超过120。默认1 */ TimeSpan?: number; /** * 资源使用时长的单位，后付费：s，预付费：m。默认为s */ TimeUnit?: string; /** * 资源的自动续费标志。后付费无需续费，固定填0；预付费下：0表示手动续费、1代表自动续费、2代表不续费，在0下如果是大客户，会自动帮大客户续费。默认为0 */ AutoRenew?: number; /** * 创建资源的时候需要绑定的标签信息 */ Tags?: Array<TagInfo>; /** * 是否自定挂起集群：false（默认）：不自动挂起、true：自动挂起 */ AutoSuspend?: boolean; /** * 定时启停集群策略：0（默认）：关闭定时策略、1：开启定时策略（注：定时启停策略与自动挂起策略互斥） */ CrontabResumeSuspend?: number; /** * 定时启停策略，复杂类型：包含启停时间、挂起集群策略 */ CrontabResumeSuspendStrategy?: CrontabResumeSuspendStrategy; /** * 引擎执行任务类型，有效值：SQL/BATCH，默认为SQL */ EngineExecType?: string; /** * 单个集群最大并发任务数，默认5 */ MaxConcurrency?: number; /** * 可容忍的排队时间，默认0。当任务排队的时间超过可容忍的时间时可能会触发扩容。如果该参数为0，则表示一旦有任务排队就可能立即触发扩容。 */ TolerableQueueTime?: number; /** * 集群自动挂起时间，默认10分钟 */ AutoSuspendTime?: number; /** * 资源类型。Standard_CU：标准型；Memory_CU：内存型 */ ResourceType?: string; /** * 集群高级配置 */ DataEngineConfigPairs?: Array<DataEngineConfigPair>; /** * 集群镜像版本名字。如SuperSQL-P 1.1;SuperSQL-S 3.2等,不传，默认创建最新镜像版本的集群 */ ImageVersionName?: string; /** * 主集群名称，创建容灾集群时指定 */ MainClusterName?: string; /** * spark jar 包年包月集群是否开启弹性 */ ElasticSwitch?: boolean; /** * spark jar 包年包月集群弹性上限 */ ElasticLimit?: number; /** * spark作业集群session资源配置模板 */ SessionResourceTemplate?: SessionResourceTemplate; /** * 自动授权 */ AutoAuthorization?: boolean; /** * 引擎网络ID */ EngineNetworkId?: string; /** * 引擎世代，SuperSQL：代表supersql引擎，Native：代表标准引擎。默认值为SuperSQL */ EngineGeneration?: string; } /** * DescribeNotebookSession请求参数结构体 */ export interface DescribeNotebookSessionRequest { /** * Session唯一标识 */ SessionId: string; } /** * UpgradeDataEngineImage请求参数结构体 */ export interface UpgradeDataEngineImageRequest { /** * 引擎ID */ DataEngineId: string; } /** * CSV类型数据格式 */ export interface CSV { /** * 压缩格式，["Snappy", "Gzip", "None"选一]。 */ CodeCompress?: string; /** * CSV序列化及反序列化数据结构。 */ CSVSerde?: CSVSerde; /** * 标题行，默认为0。 */ HeadLines?: number; /** * 格式，默认值为CSV */ Format?: string; } /** * CreateNotebookSessionStatement请求参数结构体 */ export interface CreateNotebookSessionStatementRequest { /** * Session唯一标识 */ SessionId: string; /** * 执行的代码 */ Code: string; /** * 类型，当前支持：spark、pyspark、sparkr、sql */ Kind: string; } /** * DescribeUsers请求参数结构体 */ export interface DescribeUsersRequest { /** * 指定查询的子用户uin，用户需要通过CreateUser接口创建。 */ UserId?: string; /** * 偏移量，默认为0 */ Offset?: number; /** * 返回数量，默认20，最大值100 */ Limit?: number; /** * 排序字段，支持如下字段类型，create-time */ SortBy?: string; /** * 排序方式，desc表示正序，asc表示反序，