/** * CheckDataEngineConfigPairsValidity返回参数结构体 */ export interface CheckDataEngineConfigPairsValidityResponse { /** * 参数有效性:ture:有效,false:至少存在一个无效参数; */ IsAvailable?: boolean; /** * 无效参数集合 */ UnavailableConfig?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeResultDownload返回参数结构体 */ export interface DescribeResultDownloadResponse { /** * 下载文件路径 */ Path?: string; /** * 任务状态 init | queue | format | compress | success| timeout | error */ Status?: string; /** * 任务异常原因 */ Reason?: string; /** * 临时SecretId */ SecretId?: string; /** * 临时SecretKey */ SecretKey?: string; /** * 临时Token */ Token?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 引擎的访问信息 */ export interface AccessInfo { /** * 访问引擎的方法 注意:此字段可能返回 null,表示取不到有效值。 */ AccessType?: string; /** * 访问引擎的url,内部的部分参数需要根据实际情况替换 注意:此字段可能返回 null,表示取不到有效值。 */ AccessConnectionInfos?: Array; } /** * 引擎网络信息 */ export interface EngineNetworkInfo { /** * 引擎网络名字 注意:此字段可能返回 null,表示取不到有效值。 */ EngineNetworkName?: string; /** * 引擎网络状态,0--初始化,2--可用,-1--已删除 注意:此字段可能返回 null,表示取不到有效值。 */ EngineNetworkState?: number; /** * 引擎网络cidr 注意:此字段可能返回 null,表示取不到有效值。 */ EngineNetworkCidr?: string; /** * 引擎网络ID 注意:此字段可能返回 null,表示取不到有效值。 */ EngineNetworkId?: string; /** * 创建时间 注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: number; /** * 更新时间 注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: number; /** * 私有连接个数 注意:此字段可能返回 null,表示取不到有效值。 */ PrivateLinkNumber?: number; /** * 计算引擎个数 注意:此字段可能返回 null,表示取不到有效值。 */ EngineNumber?: number; /** * 网关信息 注意:此字段可能返回 null,表示取不到有效值。 */ GateWayInfo?: Array; } /** * 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; /** * 查询类型:all:全部数据(默认)、permission:有权限的数据 注意:此字段需要开启白名单使用,如果需要使用,请提交工单联系我们。 */ DescribeType?: string; } /** * 元数据基本对象 */ 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; /** * 附加属性 */ Params?: Array; /** * 附加业务属性 */ BizParams?: Array; /** * 数据版本 */ DataVersion?: number; /** * 创建时间 */ CreateTime?: string; /** * 修改时间 */ ModifiedTime?: string; /** * 数据源主键 */ DatasourceId?: number; } /** * DescribeDataMaskStrategies返回参数结构体 */ export interface DescribeDataMaskStrategiesResponse { /** * 总数据脱敏策略数 */ TotalCount?: number; /** * 数据脱敏策略列表 */ Strategies?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * python-spark镜像信息。 */ export interface PythonSparkImage { /** * spark镜像唯一id */ SparkImageId?: string; /** * 集群小版本镜像id */ ChildImageVersionId?: string; /** * spark镜像名称 */ SparkImageVersion?: string; /** * spark镜像描述信息 */ Description?: string; /** * 创建时间 */ CreateTime?: string; /** * 更新时间 */ UpdateTime?: string; } /** * DLC分区信息查询返回数据结构 */ export interface MixedTablePartitions { /** * 数据表格式 */ TableFormat?: string; /** * 分区总数 */ TotalSize?: number; /** * 分页查询的游标信息,在获取下一页信息时需要回传到服务端 */ NextCursor?: string; /** * iceberg表分区信息 */ IcebergPartitions?: Array; /** * hive表分区信息 */ HivePartitions?: Array; } /** * ModifyGovernEventRule返回参数结构体 */ export interface ModifyGovernEventRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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; /** * 排序字段(默认按创建时间) */ SortFields?: Array; /** * 排序字段:true:升序、false:降序(默认) */ Asc?: boolean; /** * 分页参数,默认10 */ Limit?: number; /** * 分页参数,默认0 */ Offset?: number; /** * 过滤类型,支持如下的过滤类型,传参Name应为以下其中一个, engine-generation - String(引擎时代: supersql:supersql引擎,native:标准引擎):notebook-keyword - String(数据引擎名称或sessionid或sessionname的模糊搜索) */ Filters?: Array; } /** * SmartOptimizerLifecyclePolicy */ export interface SmartOptimizerLifecyclePolicy { /** * 生命周期启用 */ LifecycleEnable?: string; /** * 过期时间 */ Expiration?: number; /** * 是否删表,该字段废弃已使用,用TableExpiration策略替代 * @deprecated */ DropTable?: boolean; /** * 过期字段 */ ExpiredField?: string; /** * 过期字段格式 */ ExpiredFieldFormat?: string; } /** * DescribeDMSDatabase返回参数结构体 */ export interface DescribeDMSDatabaseResponse { /** * 数据库名称 */ Name?: string; /** * schema名称 */ SchemaName?: string; /** * 存储地址 */ Location?: string; /** * 数据对象 */ Asset?: Asset; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTaskList返回参数结构体 */ export interface DescribeTaskListResponse { /** * 任务对象列表。 */ TaskList?: Array; /** * 实例总数。 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 策略集合 */ export interface Policys { /** * 策略集合 注意:此字段可能返回 null,表示取不到有效值。 */ PolicySet?: Array; /** * 策略总数 */ TotalCount?: number; } /** * DropDMSDatabase请求参数结构体 */ export interface DropDMSDatabaseRequest { /** * 数据库名称 */ Name: string; /** * 是否删除数据 */ DeleteData?: boolean; /** * 是否级联删除 */ Cascade?: boolean; /** * 数据源连接名 */ DatasourceConnectionName?: string; } /** * 按批提交Statement运行SQL任务。 */ export interface NotebookSessionStatementBatchInformation { /** * 任务详情列表 注意:此字段可能返回 null,表示取不到有效值。 */ NotebookSessionStatementBatch?: Array; /** * 当前批任务是否运行完成 */ IsAvailable?: boolean; /** * Session唯一标识 */ SessionId?: string; /** * Batch唯一标识 注意:此字段可能返回 null,表示取不到有效值。 */ BatchId?: string; } /** * DescribeTables返回参数结构体 */ export interface DescribeTablesResponse { /** * 数据表对象列表。 */ TableList?: Array; /** * 实例总数。 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDataEngineEvents返回参数结构体 */ export interface DescribeDataEngineEventsResponse { /** * 事件详细信息 注意:此字段可能返回 null,表示取不到有效值。 */ Events?: Array; /** * 分页号 */ Page?: number; /** * 分页大小 */ Size?: number; /** * 总页数 */ TotalPages?: number; /** * 总条数 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Spark批作业集群Session资源配置模板; */ export interface SessionResourceTemplate { /** * driver规格:small,medium,large,xlarge;内存型(引擎类型):m.small,m.medium,m.large,m.xlarge */ DriverSize?: string; /** * executor规格:small,medium,large,xlarge;内存型(引擎类型):m.small,m.medium,m.large,m.xlarge */ ExecutorSize?: string; /** * 指定executor数量,最小值为1,最大值小于集群规格 */ ExecutorNums?: number; /** * 指定executor max数量(动态配置场景下),最小值为1,最大值小于集群规格(当ExecutorMaxNumbers小于ExecutorNums时,改值设定为ExecutorNums) */ ExecutorMaxNumbers?: number; /** * 运行时参数 */ RunningTimeParameters?: Array; } /** * DeleteNativeSparkSession返回参数结构体 */ export interface DeleteNativeSparkSessionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 引擎资源弹性伸缩计划 */ export interface ElasticPlan { /** * 最小集群数 */ MinElasticClusters?: number; /** * 最大集群数 */ MaxElasticClusters?: number; /** * 最大排队时间 */ TolerableQueueTime?: number; /** * 开始时间,Once格式:yyyy-MM-dd HH:mm:ss; 非Once格式: HH:mm:ss */ StartTime?: string; /** * 结束时间,Once格式:yyyy-MM-dd HH:mm:ss; 非Once格式: HH:mm:ss */ EndTime?: string; /** * 分时弹性上限 */ ElasticLimit?: number; } /** * DescribeDMSPartitions请求参数结构体 */ export interface DescribeDMSPartitionsRequest { /** * 数据库名 */ DatabaseName: string; /** * 表名称 */ TableName: string; /** * schema名称 */ SchemaName?: string; /** * 名称 */ Name?: string; /** * 单个分区名称,精准匹配 */ Values?: Array; /** * 多个分区名称,精准匹配 */ PartitionNames?: Array; /** * 多个分区字段的匹配,模糊匹配 */ PartValues?: Array; /** * 过滤SQL */ Filter?: string; /** * 最大分区数量 */ MaxParts?: number; /** * 翻页跳过数量 */ Offset?: number; /** * 页面数量 */ Limit?: number; /** * 表达式 */ Expression?: string; /** * 数据源连接名 */ DatasourceConnectionName?: string; } /** * DescribeDMSTable返回参数结构体 */ export interface DescribeDMSTableResponse { /** * 基础对象 */ Asset?: Asset; /** * 视图文本 */ ViewOriginalText?: string; /** * 视图文本 */ ViewExpandedText?: string; /** * hive维护版本 */ Retention?: number; /** * 存储对象 */ Sds?: DMSSds; /** * 分区列 注意:此字段可能返回 null,表示取不到有效值。 */ PartitionKeys?: Array; /** * 分区 注意:此字段可能返回 null,表示取不到有效值。 */ Partitions?: Array; /** * 表类型 */ Type?: string; /** * 数据库名称 */ DbName?: string; /** * Schame名称 */ SchemaName?: string; /** * 存储大小 */ StorageSize?: number; /** * 记录数量 */ RecordCount?: number; /** * 生命周期 */ LifeTime?: number; /** * 最后访问时间 */ LastAccessTime?: string; /** * 数据更新时间 */ DataUpdateTime?: string; /** * 结构更新时间 */ StructUpdateTime?: string; /** * 列 注意:此字段可能返回 null,表示取不到有效值。 */ Columns?: Array; /** * 表名称 */ Name?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateTasksInOrder请求参数结构体 */ export interface CreateTasksInOrderRequest { /** * 数据库名称。如果SQL语句中有数据库名称,优先使用SQL语句中的数据库,否则使用该参数指定的数据库。 */ DatabaseName: string; /** * SQL任务信息 */ Tasks: TasksInfo; /** * 数据源名称,默认为COSDataCatalog */ DatasourceConnectionName?: string; } /** * UpdateStandardEngineResourceGroupConfigInfo返回参数结构体 */ export interface UpdateStandardEngineResourceGroupConfigInfoResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 集群Session配置信息. */ export interface DataEngineImageSessionParameter { /** * 配置id */ ParameterId: string; /** * 小版本镜像ID */ ChildImageVersionId: string; /** * 集群类型:SparkSQL/PrestoSQL/SparkBatch */ EngineType: string; /** * 参数key */ KeyName: string; /** * Key描述信息 注意:此字段可能返回 null,表示取不到有效值。 */ KeyDescription: string; /** * value类型 */ ValueType: string; /** * value长度限制 注意:此字段可能返回 null,表示取不到有效值。 */ ValueLengthLimit: string; /** * value正则限制 注意:此字段可能返回 null,表示取不到有效值。 */ ValueRegexpLimit: string; /** * value默认值 注意:此字段可能返回 null,表示取不到有效值。 */ ValueDefault: string; /** * 是否为公共版本:1:公共;2:私有 */ IsPublic: number; /** * 配置类型:1:session配置(默认);2:common配置;3:cluster配置 */ ParameterType: number; /** * 提交方式:User(用户)、BackGround(后台) */ SubmitMethod: string; /** * 操作者 注意:此字段可能返回 null,表示取不到有效值。 */ Operator: string; /** * 插入时间 */ InsertTime: string; /** * 更新时间 */ UpdateTime: string; } /** * CreateDatabase请求参数结构体 */ export interface CreateDatabaseRequest { /** * 数据库基础信息 */ DatabaseInfo: DatabaseInfo; /** * 数据源名称,默认为DataLakeCatalog */ DatasourceConnectionName?: string; } /** * DescribeDMSTables返回参数结构体 */ export interface DescribeDMSTablesResponse { /** * DMS元数据列表信息 注意:此字段可能返回 null,表示取不到有效值。 */ TableList?: Array; /** * 统计值 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 任务依赖包信息 */ export interface DependencyPackage { /** * 依赖包类型 注意:此字段可能返回 null,表示取不到有效值。 */ PackageSource?: string; /** * 依赖包信息 注意:此字段可能返回 null,表示取不到有效值。 */ MavenPackage?: string; /** * 依赖包仓库 注意:此字段可能返回 null,表示取不到有效值。 */ MavenRepository?: string; /** * maven包exclusion信息 注意:此字段可能返回 null,表示取不到有效值。 */ MavenExclusion?: string; /** * pypi包信息 注意:此字段可能返回 null,表示取不到有效值。 */ PypiPackage?: string; /** * pypi索引地址 注意:此字段可能返回 null,表示取不到有效值。 */ PypiIndexUrl?: string; /** * 文件包的类型 注意:此字段可能返回 null,表示取不到有效值。 */ PackageType?: string; /** * 文件包的路径 注意:此字段可能返回 null,表示取不到有效值。 */ PackagePath?: string; } /** * 数据脱敏策略信息 */ export interface DataMaskStrategy { /** * 策略ID 注意:此字段可能返回 null,表示取不到有效值。 */ StrategyId?: string; /** * 用户AppId 注意:此字段可能返回 null,表示取不到有效值。 */ UserAppId?: string; /** * 用户Uin 注意:此字段可能返回 null,表示取不到有效值。 */ Uin?: string; /** * 操作用户子账号uin 注意:此字段可能返回 null,表示取不到有效值。 */ SubAccountUin?: string; /** * 策略名称 注意:此字段可能返回 null,表示取不到有效值。 */ StrategyName?: string; /** * MASK_SHOW_FIRST_4; MASK_SHOW_LAST_4;MASK_HASH; MASK_DATE_SHOW_YEAR; MASK_NULL; MASK_DEFAULT 等 注意:此字段可能返回 null,表示取不到有效值。 */ StrategyType?: string; /** * 策略描述 注意:此字段可能返回 null,表示取不到有效值。 */ StrategyDesc?: string; /** * 用户组策略列表 注意:此字段可能返回 null,表示取不到有效值。 */ Groups?: Array; /** * 用户子账号uin列表,按;拼接 注意:此字段可能返回 null,表示取不到有效值。 */ Users?: string; /** * 1: 生效中; 0:已删除 注意:此字段可能返回 null,表示取不到有效值。 */ State?: number; /** * 策略创建时间,毫秒时间戳 注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: number; /** * 策略更新时间,毫秒时间戳 注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: number; } /** * DescribeAdvancedStoreLocation返回参数结构体 */ export interface DescribeAdvancedStoreLocationResponse { /** * 是否启用高级设置:0-否,1-是 */ Enable?: number; /** * 查询结果保存cos路径 */ StoreLocation?: string; /** * 是否有托管存储权限 */ HasLakeFs?: boolean; /** * 托管存储状态,HasLakeFs等于true时,该值才有意义 */ LakeFsStatus?: string; /** * 托管存储桶类型 */ BucketType?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTablesName返回参数结构体 */ export interface DescribeTablesNameResponse { /** * 数据表名称对象列表。 */ TableNameList?: Array; /** * 实例总数。 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAdvancedStoreLocation请求参数结构体 */ export type DescribeAdvancedStoreLocationRequest = null; /** * CancelNotebookSessionStatementBatch返回参数结构体 */ export interface CancelNotebookSessionStatementBatchResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 混合表中,change表的数据保存时间,单位为天 */ export interface SmartOptimizerChangeTablePolicy { /** * change表的数据保存时间,单位为天 */ DataRetentionTime?: number; } /** * SparkSQL批任务信息 */ export interface BatchSqlTask { /** * SQL子任务唯一标识 */ TaskId?: string; /** * 运行SQL */ ExecuteSQL?: string; /** * 任务信息,成功则返回:Task Success!,失败则返回异常信息 */ Message?: string; } /** * 引擎资源弹性伸缩策略 */ export interface ScheduleElasticityConf { /** * 是否开启弹性伸缩:true/false */ ScheduledElasticityEnabled?: boolean; /** * 调度类型:ONCE(一次性调度),DAILY(每日调度),WEEKLY(每周调度),MONTHLY(每月调度) */ ScheduleType?: string; /** * 调度日期:WEEKLY传:1~7; MONTHLY传:1~31;其它类型不传 */ ScheduleDays?: Array; /** * 调度时区 */ TimeZone?: string; /** * 弹性伸缩计划 */ ElasticPlans?: Array; } /** * CreateNotebookSession请求参数结构体 */ export interface CreateNotebookSessionRequest { /** * Session名称 */ Name: string; /** * 类型,当前支持:spark、pyspark、sparkr、sql */ Kind: string; /** * DLC Spark作业引擎名称 */ DataEngineName: string; /** * session文件地址,当前支持:cosn://和lakefs://两种路径 */ ProgramDependentFiles?: Array; /** * 依赖的jar程序地址,当前支持:cosn://和lakefs://两种路径 */ ProgramDependentJars?: Array; /** * 依赖的python程序地址,当前支持:cosn://和lakefs://两种路径 */ ProgramDependentPython?: Array; /** * 依赖的pyspark虚拟环境地址,当前支持:cosn://和lakefs://两种路径 */ ProgramArchives?: Array; /** * 指定的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; /** * 代理用户,默认为root */ ProxyUser?: string; /** * 指定的Session超时时间,单位秒,默认3600秒 */ TimeoutInSecond?: number; /** * 指定的Executor数量(最大值),默认为1,当开启动态分配有效,若未开启,则该值等于ExecutorNumbers */ ExecutorMaxNumbers?: number; /** * 指定spark版本名称,当前任务使用该spark镜像运行 */ SparkImage?: string; /** * 是否继承集群的资源类配置:0:自定义(默认),1:继承集群; */ IsInherit?: number; } /** * UnboundDatasourceHouse请求参数结构体 */ export interface UnboundDatasourceHouseRequest { /** * 网络配置名称 */ NetworkConnectionName?: string; } /** * DeleteUserVpcConnection返回参数结构体 */ export interface DeleteUserVpcConnectionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetOptimizerPolicy请求参数结构体 */ export interface SetOptimizerPolicyRequest { /** * 优化策略 */ SmartPolicy: SmartPolicy; } /** * 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; /** * 引擎资源弹性伸缩策略 */ ScheduleElasticityConf?: ScheduleElasticityConf; } /** * SmartOptimizerWrittenPolicy */ export interface SmartOptimizerWrittenPolicy { /** * none/enable/disable/default */ WrittenEnable?: string; /** * 用户自定义高级参数 注意:此字段可能返回 null,表示取不到有效值。 */ AdvancePolicy?: WrittenAdvancePolicy; } /** * 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; /** * 更新时间起始点,支持格式: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。 */ RequestId?: string; } /** * 查询视图信息对象 */ export interface ViewResponseInfo { /** * 视图基本信息。 */ ViewBaseInfo?: ViewBaseInfo; /** * 视图列信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Columns?: Array; /** * 视图属性信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Properties?: Array; /** * 视图创建时间。 */ CreateTime?: string; /** * 视图更新时间。 */ ModifiedTime?: string; } /** * DescribeSparkSessionBatchSQL请求参数结构体 */ export interface DescribeSparkSessionBatchSQLRequest { /** * SparkSQL唯一标识 */ BatchId: string; /** * 用户自定义主键, 若不为空,则按照该值查询 */ CustomKey?: string; } /** * Location信息结构 */ export interface LocationInfo { /** * 桶名称 */ Bucket?: string; /** * location路径 */ DataLocation?: string; } /** * UpdateEngineResourceGroupNetworkConfigInfo请求参数结构体 */ export interface UpdateEngineResourceGroupNetworkConfigInfoRequest { /** * 引擎资源组ID */ EngineResourceGroupId: string; /** * 是否立即重启资源组生效,0--立即生效,1--只保持不重启生效 */ IsEffectiveNow: number; /** * 资源组绑定的网络配置名称集合 */ NetworkConfigNames?: Array; } /** * SmartOptimizerPolicy */ export interface SmartOptimizerPolicy { /** * 是否继承 */ Inherit?: string; /** * 数据治理资源 注意:此字段可能返回 null,表示取不到有效值。 */ Resources?: Array; /** * 数据重写策略 注意:此字段可能返回 null,表示取不到有效值。 */ Written?: SmartOptimizerWrittenPolicy; /** * 数据过期策略 注意:此字段可能返回 null,表示取不到有效值。 */ Lifecycle?: SmartOptimizerLifecyclePolicy; /** * SmartOptimizerIndexPolicy 注意:此字段可能返回 null,表示取不到有效值。 */ Index?: SmartOptimizerIndexPolicy; /** * SmartOptimizerChangeTablePolicy 注意:此字段可能返回 null,表示取不到有效值。 */ ChangeTable?: SmartOptimizerChangeTablePolicy; /** * 表过期策略 */ TableExpiration?: TableExpirationPolicy; } /** * UnboundDatasourceHouse返回参数结构体 */ export interface UnboundDatasourceHouseResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserInfo返回参数结构体 */ export interface DescribeUserInfoResponse { /** * 用户详细信息 注意:此字段可能返回 null,表示取不到有效值。 */ UserInfo?: UserDetailInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTaskList请求参数结构体 */ export interface DescribeTaskListRequest { /** * 返回数量,默认为10,最大值为100。 */ Limit?: number; /** * 偏移量,默认为0。 */ Offset?: number; /** * 过滤条件,如下支持的过滤类型,传参Name应为以下其中一个,其中task-id支持最大50个过滤个数,其他过滤参数支持的总数不超过5个。 task-id - String - (任务ID准确过滤)task-id取值形如:e386471f-139a-4e59-877f-50ece8135b99。 task-state - String - (任务状态过滤)取值范围 0(初始化), 1(运行中), 2(成功), -1(失败)。 task-sql-keyword - String - (SQL语句关键字模糊过滤)取值形如:DROP TABLE。 task-operator- string (子uin过滤) task-kind - string (任务类型过滤) */ Filters?: Array; /** * 排序字段,支持如下字段类型,create-time(创建时间,默认)、update-time(更新时间) */ SortBy?: string; /** * 排序方式,desc表示正序,asc表示反序, 默认为asc。 */ Sorting?: string; /** * 起始时间点,格式为yyyy-mm-dd HH:MM:SS。默认为45天前的当前时刻 */ StartTime?: string; /** * 结束时间点,格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天],支持最近45天数据查询。默认为当前时刻 */ EndTime?: string; /** * 数据引擎名称,用于筛选 */ DataEngineName?: string; /** * spark引擎资源组名称 */ ResourceGroupName?: string; /** * 引擎id列表 */ HouseIds?: Array; } /** * ModifyUserType请求参数结构体 */ export interface ModifyUserTypeRequest { /** * 用户ID */ UserId: string; /** * 用户要修改到的类型,ADMIN:管理员,COMMON:一般用户。 */ UserType: string; /** * 用户来源类型TencentAccount(普通腾讯云用户) / EntraAccount(微软用户) */ AccountType?: string; } /** * NotebookSessionStatement详情。 */ export interface NotebookSessionStatementInfo { /** * 完成时间戳 */ Completed?: number; /** * 开始时间戳 */ Started?: number; /** * 完成进度,百分制 */ Progress?: number; /** * Session Statement唯一标识 */ StatementId?: string; /** * Session Statement状态,包含:waiting(排队中)、running(运行中)、available(正常)、error(异常)、cancelling(取消中)、cancelled(已取消) */ State?: string; /** * Statement输出信息 注意:此字段可能返回 null,表示取不到有效值。 */ OutPut?: StatementOutput; /** * 批任务id */ BatchId?: string; /** * 运行语句 */ Code?: string; /** * 任务ID */ TaskId?: string; } /** * CreateImportTask请求参数结构体 */ export interface CreateImportTaskRequest { /** * 数据来源,cos */ InputType: string; /** * 输入配置 */ InputConf: Array; /** * 输出配置 */ OutputConf: Array; /** * 目标数据源的类型,目前支持导入到托管存储,即lakefsStorage */ OutputType?: string; } /** * DescribeDataMaskStrategies请求参数结构体 */ export interface DescribeDataMaskStrategiesRequest { /** * 分页参数,单页返回数据量,默认10 */ Limit?: number; /** * 分页参数,数据便偏移量,默认0 */ Offset?: number; /** * 过滤字段,strategy-name: 按策略名称搜索 */ Filters?: Array; } /** * UpdateDataMaskStrategy返回参数结构体 */ export interface UpdateDataMaskStrategyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteUsersFromWorkGroup返回参数结构体 */ export interface DeleteUsersFromWorkGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDLCCatalogAccess返回参数结构体 */ export interface DescribeDLCCatalogAccessResponse { /** * 总数 */ TotalCount?: number; /** * DLCCatalog授权列表 */ Rows?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteTable返回参数结构体 */ export interface DeleteTableResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserRoles返回参数结构体 */ export interface DescribeUserRolesResponse { /** * 符合列举条件的总数量 */ Total?: number; /** * 用户角色信息 */ UserRoles?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateExportTask请求参数结构体 */ export interface CreateExportTaskRequest { /** * 数据来源,lakefsStorage、taskResult */ InputType: string; /** * 导出任务输入配置 */ InputConf: Array; /** * 导出任务输出配置 */ OutputConf: Array; /** * 目标数据源的类型,目前支持导出到cos */ OutputType?: string; } /** * CreateDMSTable请求参数结构体 */ export interface CreateDMSTableRequest { /** * 基础对象 */ Asset?: Asset; /** * 表类型:EXTERNAL_TABLE, VIRTUAL_VIEW, MATERIALIZED_VIEW */ Type?: string; /** * 数据库名称 */ DbName?: string; /** * 存储大小 */ StorageSize?: number; /** * 记录数量 */ RecordCount?: number; /** * 生命周期 */ LifeTime?: number; /** * 数据更新时间 */ DataUpdateTime?: string; /** * 结构更新时间 */ StructUpdateTime?: string; /** * 最后访问时间 */ LastAccessTime?: string; /** * 存储对象 */ Sds?: DMSSds; /** * 列 */ Columns?: Array; /** * 分区键值 */ PartitionKeys?: Array; /** * 视图文本 */ ViewOriginalText?: string; /** * 视图文本 */ ViewExpandedText?: string; /** * 分区 */ Partitions?: Array; /** * 表名称 */ Name?: string; /** * 数据源连接名 */ DatasourceConnectionName?: string; } /** * DMSTable基本信息 */ export interface DMSTable { /** * 视图文本 注意:此字段可能返回 null,表示取不到有效值。 */ ViewOriginalText?: string; /** * 视图文本 注意:此字段可能返回 null,表示取不到有效值。 */ ViewExpandedText?: string; /** * hive维护版本 注意:此字段可能返回 null,表示取不到有效值。 */ Retention?: number; /** * 存储对象 注意:此字段可能返回 null,表示取不到有效值。 */ Sds?: DMSSds; /** * 分区列 注意:此字段可能返回 null,表示取不到有效值。 */ PartitionKeys?: Array; /** * 分区 注意:此字段可能返回 null,表示取不到有效值。 */ Partitions?: Array; /** * 表类型 注意:此字段可能返回 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; /** * 表名 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; } /** * CreateSparkSubmitTask返回参数结构体 */ export interface CreateSparkSubmitTaskResponse { /** * 批作业ID */ BatchId?: string; /** * 批任务ID,用改ID进行任务的查询与删除等 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateEngineResourceGroupNetworkConfigInfo返回参数结构体 */ export interface UpdateEngineResourceGroupNetworkConfigInfoResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserRegisterTime请求参数结构体 */ export type DescribeUserRegisterTimeRequest = null; /** * AttachDataMaskPolicy请求参数结构体 */ export interface AttachDataMaskPolicyRequest { /** * 要绑定的数据脱敏策略权限对象集合 */ DataMaskStrategyPolicySet?: Array; } /** * 元数据存储描述属性 */ export interface DMSSds { /** * 存储地址 注意:此字段可能返回 null,表示取不到有效值。 */ Location?: string; /** * 输入格式 注意:此字段可能返回 null,表示取不到有效值。 */ InputFormat?: string; /** * 输出格式 注意:此字段可能返回 null,表示取不到有效值。 */ OutputFormat?: string; /** * bucket数量 注意:此字段可能返回 null,表示取不到有效值。 */ NumBuckets?: number; /** * 是是否压缩 注意:此字段可能返回 null,表示取不到有效值。 */ Compressed?: boolean; /** * 是否有子目录 注意:此字段可能返回 null,表示取不到有效值。 */ StoredAsSubDirectories?: boolean; /** * 序列化lib 注意:此字段可能返回 null,表示取不到有效值。 */ SerdeLib?: string; /** * 序列化名称 注意:此字段可能返回 null,表示取不到有效值。 */ SerdeName?: string; /** * 桶名称 注意:此字段可能返回 null,表示取不到有效值。 */ BucketCols?: Array; /** * 序列化参数 注意:此字段可能返回 null,表示取不到有效值。 */ SerdeParams?: Array; /** * 附加参数 注意:此字段可能返回 null,表示取不到有效值。 */ Params?: Array; /** * 列排序(Expired) 注意:此字段可能返回 null,表示取不到有效值。 */ SortCols?: DMSColumnOrder; /** * 列 注意:此字段可能返回 null,表示取不到有效值。 */ Cols?: Array; /** * 列排序字段 注意:此字段可能返回 null,表示取不到有效值。 */ SortColumns?: Array; } /** * 开通了第三方访问的用户信息 */ export interface OpendThirdAccessUserInfo { /** * id信息 */ Id?: number; /** * 用户主UIN */ Uin?: string; /** * 用户AppId */ AppId?: string; /** * 开通时间 */ CreateTime?: string; } /** * DescribeDataEnginesScaleDetail返回参数结构体 */ export interface DescribeDataEnginesScaleDetailResponse { /** * 引擎规格统计详细信息 注意:此字段可能返回 null,表示取不到有效值。 */ Scales?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDataMaskStrategy返回参数结构体 */ export interface CreateDataMaskStrategyResponse { /** * 策略id */ StrategyId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据优化引擎信息 */ export interface OptimizerEngineInfo { /** * 引擎资源名称 */ HouseName: string; /** * 引擎资源ID */ HouseId: string; /** * 该参数仅针对spark作业引擎有效,用于执行数据优化任务的资源大小,不填时将采用该引擎所有资源 注意:此字段可能返回 null,表示取不到有效值。 */ HouseSize?: number; } /** * CreateStandardEngineResourceGroup请求参数结构体 */ export interface CreateStandardEngineResourceGroupRequest { /** * 标准引擎资源组名称 */ EngineResourceGroupName: string; /** * 标准引擎名称 */ DataEngineName: string; /** * 自动启动,(任务提交自动拉起资源组)0-自动启动,1-不自动启动 */ AutoLaunch?: number; /** * 自动挂起资源组。0-自动挂起,1-不自动挂起 */ AutoPause?: number; /** * driver的cu规格: 当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu),内存型cu为cpu:men=1:8,m.small(1cu内存型)、m.medium(2cu内存型)、m.large(4cu内存型)、m.xlarge(8cu内存型) */ DriverCuSpec?: string; /** * executor的cu规格: 当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu),内存型cu为cpu:men=1:8,m.small(1cu内存型)、m.medium(2cu内存型)、m.large(4cu内存型)、m.xlarge(8cu内存型) */ ExecutorCuSpec?: string; /** * executor最小数量, */ MinExecutorNums?: number; /** * executor最大数量 */ MaxExecutorNums?: number; /** * 创建资源组后是否直接拉起,0-拉起,1-不拉起 */ IsLaunchNow?: number; /** * 自动挂起时间,单位分钟,取值范围在1-999(在无任务AutoPauseTime后,资源组自动挂起) */ AutoPauseTime?: number; /** * 资源组静态参数,需要重启资源组生效 */ StaticConfigPairs?: Array; /** * 资源组动态参数,下一个任务生效。 */ DynamicConfigPairs?: Array; /** * 任务并发数,默人是5个 */ MaxConcurrency?: number; /** * 网络配置名称 */ NetworkConfigNames?: Array; /** * 自定义镜像域名 */ PublicDomain?: string; /** * 自定义镜像实例id */ RegistryId?: string; /** * AI类型资源组的框架类型,machine-learning,python,spark-ml,不填默认为machine-learning */ FrameType?: string; /** * 镜像类型,bulit-in:内置,custom:自定义,不填默认为bulit-in */ ImageType?: string; /** * 镜像名称 */ ImageName?: string; /** * 镜像id */ ImageVersion?: string; /** * AI资源组有效,资源组可用资源上限,该值需要小于引擎资源上限 */ Size?: number; /** * 资源组场景 */ ResourceGroupScene?: string; /** * 自定义镜像所在地域 */ RegionName?: string; /** * python类型资源组python单机节点资源上限,该值要小于资源组的资源上限.small:1cu medium:2cu large:4cu xlarge:8cu 4xlarge:16cu 8xlarge:32cu 16xlarge:64cu,如果是高内存型资源,在类型前面加上m. */ PythonCuSpec?: string; /** * 仅SQL资源组资源配置模式,fast:快速模式,custom:自定义模式 */ SparkSpecMode?: string; /** * 仅SQL资源组资源上限,仅用于快速模块 */ SparkSize?: number; /** * GPUDriver规格 */ DriverGPUSpec?: number; /** * GPUExecutor规格 */ ExecutorGPUSpec?: number; /** * GPU上限 */ GPULimitSize?: number; /** * GPU规格 */ GPUSize?: number; /** * Pod GPU规格上限 */ PythonGPUSpec?: number; } /** * DescribeNotebookSessionStatementSqlResult请求参数结构体 */ export interface DescribeNotebookSessionStatementSqlResultRequest { /** * 任务唯一ID */ TaskId: string; /** * 返回结果的最大行数,范围0~1000,默认为1000. */ MaxResults?: number; /** * 上一次请求响应返回的分页信息。第一次可以不带,从头开始返回数据,每次返回MaxResults字段设置的数据量。 */ NextToken?: string; /** * 批次Id */ BatchId?: string; /** * 返回结果集中字段值长度截取,如果超过该长度则截取到该长度 */ DataFieldCutLen?: number; } /** * CreateSparkSubmitTask请求参数结构体 */ export interface CreateSparkSubmitTaskRequest { /** * 任务名称 */ TaskName: string; /** * 任务类型:当前支持1: BatchType, 2: StreamingType, 4: SQLType */ TaskType: number; /** * 引擎名称,当前仅支持Spark批作业集群 */ DataEngineName: string; /** * 指定运行的程序脚本路径,当前仅支持jar和py,对于SQLType该值设为空字符串 */ PackagePath: string; /** * 指定的鉴权信息 */ RoleArn: number; /** * 运行任务所需资源是否继承自集群上配置资源信息,0(默认,不继承)、1(继承,当设置为该值,则任务级资源配置可不额外指定) */ IsInherit: number; /** * jar任务时需要指定主程序 */ MainClass?: string; /** * 当前DriverSize规格仅支持(内存型集群则使用m前缀的枚举值): small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge */ DriverSize?: string; /** * 当前ExecutorSize规格仅支持(内存型集群则使用m前缀的枚举值): small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge */ ExecutorSize?: string; /** * 指定使用的executor数量,最小为1 */ ExecutorNumbers?: number; /** * 指定使用的executor最大数量, 当该值大于ExecutorNums则自动开启动态 */ ExecutorMaxNumbers?: number; /** * 提交任务的附加配置集合,当前支持Key包含:MAINARGS:程序入口参数,空格分割(SqlType任务通过该值指定base64加密后的sql)、SPARKCONFIG:Spark配置,以换行符分隔、ENI:Eni连接信息、DEPENDENCYPACKAGEPATH:依赖的程序包(--jars、--py-files:支持py/zip/egg等归档格式),多文件以逗号分隔、DEPENDENCYFILEPATH:依赖文件资源(--files: 非jar、zip),多文件以逗号分隔、DEPENDENCYARCHIVESPATH:依赖archives资源(--archives: 支持tar.gz/tgz/tar等归档格式),多文件以逗号分隔、MAXRETRIES:任务重试次数,非流任务默认为1、SPARKIMAGE:Spark镜像版本号,支持使用dlc镜像/用户自定的tcr镜像运行任务、SPARKIMAGEVERSION:Spark镜像版本名称,与SPARKIMAGE一一对应;SPARKPRESETCODE:base64后的notebook预置代码;SPARKENV:base64后的spark环境变量;SPARKGITINFO:base64后的git相关信息 */ CmdArgs?: Array; /** * 任务来源信息 */ SourceInfo?: Array; /** * ai资源组名称 */ ResourceGroupName?: string; } /** * CreateTable返回参数结构体 */ export interface CreateTableResponse { /** * 生成的建表执行语句对象。 */ Execution?: Execution; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListTaskJobLogName请求参数结构体 */ export interface ListTaskJobLogNameRequest { /** * 查询的taskId */ TaskId: string; /** * SparkSQL批任务唯一ID */ BatchId?: string; } /** * DeleteStandardEngineResourceGroup返回参数结构体 */ export interface DeleteStandardEngineResourceGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTaskResult请求参数结构体 */ export interface DescribeTaskResultRequest { /** * 任务唯一ID,仅支持30天内的任务 */ TaskId: string; /** * 上一次请求响应返回的分页信息。第一次可以不带,从头开始返回数据,每次返回MaxResults字段设置的数据量。 */ NextToken?: string; /** * 返回结果的最大行数,范围0~1000,默认为1000. */ MaxResults?: number; /** * 是否转化数据类型 */ IsTransformDataType?: boolean; /** * 返回结果集中字段长度截取,如果字段值长度超过该长度则截取到该长度 */ DataFieldCutLen?: number; } /** * UpdateUserDataEngineConfig请求参数结构体 */ export interface UpdateUserDataEngineConfigRequest { /** * 引擎ID */ DataEngineId: string; /** * 用户自定义引擎配置项集合。该参数需要传用户需要添加的全部配置项,例如,已有配置项k1:v1,添加k2:v2,需要传[k1:v1,k2:v2]。 */ DataEngineConfigPairs?: Array; /** * 作业引擎资源配置模板 */ SessionResourceTemplate?: SessionResourceTemplate; } /** * RollbackDataEngineImage请求参数结构体 */ export interface RollbackDataEngineImageRequest { /** * 引擎ID */ DataEngineId: string; /** * 检查是否能回滚的接口返回的FromRecordId参数 */ FromRecordId?: string; /** * 检查是否能回滚的接口返回的ToRecordId参数 */ ToRecordId?: string; } /** * DescribeUsers返回参数结构体 */ export interface DescribeUsersResponse { /** * 查询到的用户总数 */ TotalCount?: number; /** * 查询到的授权用户信息集合 */ UserSet?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RevokeDLCCatalogAccess请求参数结构体 */ export interface RevokeDLCCatalogAccessRequest { /** * VpcID */ VpcId: string; } /** * 数据治理规则 */ export interface DataGovernPolicy { /** * 治理规则类型,Customize: 自定义;Intelligence: 智能治理 */ RuleType?: string; /** * 治理引擎 */ GovernEngine?: string; } /** * CreateWorkGroup返回参数结构体 */ export interface CreateWorkGroupResponse { /** * 工作组Id,全局唯一 */ WorkGroupId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEngineUsageInfo返回参数结构体 */ export interface DescribeEngineUsageInfoResponse { /** * 集群总规格 */ Total?: number; /** * 已占用集群规格 */ Used?: number; /** * 剩余集群规格 */ Available?: number; /** * 剩余集群规格百分比 */ AvailPercent?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWorkGroupInfo返回参数结构体 */ export interface DescribeWorkGroupInfoResponse { /** * 工作组详细信息 注意:此字段可能返回 null,表示取不到有效值。 */ WorkGroupInfo?: WorkGroupDetailInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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; /** * 指定查询的数据源名称,默认为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; /** * 查询类型:all:全部数据(默认)、permission:有权限的数据 注意:此字段需要开启白名单使用,如果需要使用,请提交工单联系我们。 */ DescribeType?: string; } /** * CreateStoreLocation请求参数结构体 */ export interface CreateStoreLocationRequest { /** * 计算结果存储cos路径,如:cosn://bucketname/ */ StoreLocation: string; } /** * DescribeLakeFsInfo返回参数结构体 */ export interface DescribeLakeFsInfoResponse { /** * 托管存储信息 注意:此字段可能返回 null,表示取不到有效值。 */ LakeFsInfos?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyWorkGroup返回参数结构体 */ export interface ModifyWorkGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetOptimizerPolicy返回参数结构体 */ export interface GetOptimizerPolicyResponse { /** * 智能优化策略 */ SmartOptimizerPolicy?: SmartOptimizerPolicy; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeStandardEngineResourceGroupConfigInfo返回参数结构体 */ export interface DescribeStandardEngineResourceGroupConfigInfoResponse { /** * 总数 */ Total?: number; /** * 标准引擎资源组,配置相关信息 */ StandardEngineResourceGroupConfigInfos?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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; /** * 引擎类型 */ EngineGeneration?: string; /** * 需要授权的Model名,填 * 代表当前Database下所有表。当授权类型为管理员级别时,只允许填“*”,当授权类型为数据连接级别、数据库级别时只允许填空,其他类型下可以任意指定数据表。 */ Model?: string; /** * 权限来源是否为管理员 */ IsAdminPolicy?: boolean; } /** * DescribeTaskLog请求参数结构体 */ export interface DescribeTaskLogRequest { /** * 列表返回的Id */ TaskId: string; /** * 开始运行时间,unix时间戳(毫秒) */ StartTime: number; /** * 结束运行时间,unix时间戳(毫秒) */ EndTime: number; /** * 分页大小,最大1000,配合Context一起使用 */ Limit: number; /** * 下一次分页参数,第一次传空。透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时。 */ Context?: string; /** * 是否升序排列,true:升序排序,false:倒序,默认false,倒序排列 */ Asc?: boolean; /** * 预览日志的通用过滤条件 */ Filters?: Array; /** * SparkSQL任务唯一ID */ BatchId?: string; } /** * DescribeDataEnginesScaleDetail请求参数结构体 */ export interface DescribeDataEnginesScaleDetailRequest { /** * 引擎名称列表 */ DataEngineNames?: Array; /** * 开始时间,时间格式:yyyy-MM-dd HH:mm:ss,最长查询一个月内的记录 */ StartTime?: string; /** * 结束时间,时间格式:yyyy-MM-dd HH:mm:ss,最长查询一个月内的记录 */ EndTime?: string; } /** * DescribeEngineNetworks请求参数结构体 */ export interface DescribeEngineNetworksRequest { /** * 排序字段 */ SortBy?: string; /** * 升序,降序 */ Sorting?: string; /** * 过滤条件可选,engine-network-id--引擎网络ID,engine-network-state--引擎网络状态 */ Filters?: Array; /** * 数据条数 */ Limit?: number; /** * 偏移量 */ Offset?: number; } /** * CreateTasks请求参数结构体 */ export interface CreateTasksRequest { /** * 数据库名称。如果SQL语句中有数据库名称,优先使用SQL语句中的数据库,否则使用该参数指定的数据库(注:当提交建库sql时,该字段传空字符串)。 */ DatabaseName: string; /** * SQL任务信息 */ Tasks: TasksInfo; /** * 数据源名称,默认为DataLakeCatalog */ DatasourceConnectionName?: string; /** * 计算引擎名称,不填任务提交到默认集群 */ DataEngineName?: string; /** * spark集群资源组名称 */ ResourceGroupName?: string; /** * 是否使用multi- statement方式运行一批次任务,true: 是,false: 否 */ IsMultiStatement?: boolean; /** * 任务来源信息 */ SourceInfo?: Array; } /** * SuspendResumeDataEngine请求参数结构体 */ export interface SuspendResumeDataEngineRequest { /** * 虚拟集群名称 */ DataEngineName: string; /** * 操作类型 suspend/resume */ Operate: string; } /** * DescribeNetworkConnections返回参数结构体 */ export interface DescribeNetworkConnectionsResponse { /** * 总条数 */ TotalCount: number; /** * 网络配置列表 */ NetworkConnectionSet: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSparkAppJobs返回参数结构体 */ export interface DescribeSparkAppJobsResponse { /** * spark作业列表详情 */ SparkAppJobs?: Array; /** * spark作业总数 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询表信息对象 */ export interface TableResponseInfo { /** * 数据表基本信息。 */ TableBaseInfo?: TableBaseInfo; /** * 数据表列信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Columns?: Array; /** * 数据表分块信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Partitions?: Array; /** * 数据存储路径。 */ Location?: string; /** * 数据表属性信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Properties?: Array; /** * 数据表更新时间, 单位: ms。 */ ModifiedTime?: string; /** * 数据表创建时间,单位: ms。 */ CreateTime?: string; /** * 数据格式。 */ InputFormat?: string; /** * 数据表存储大小(单位:Byte) */ StorageSize?: number; /** * 数据表行数 */ RecordCount?: number; /** * xxxx */ MapMaterializedViewName?: string; /** * 访问热点 */ HeatValue?: number; /** * InputFormat的缩写 */ InputFormatShort?: string; } /** * UpdateUserDataEngineConfig返回参数结构体 */ export interface UpdateUserDataEngineConfigResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserType返回参数结构体 */ export interface ModifyUserTypeResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDataEnginePythonSparkImages请求参数结构体 */ export interface DescribeDataEnginePythonSparkImagesRequest { /** * 集群镜像小版本ID */ ChildImageVersionId: string; } /** * CancelSparkSessionBatchSQL请求参数结构体 */ export interface CancelSparkSessionBatchSQLRequest { /** * 批任务唯一标识 */ BatchId: string; /** * 用户自定义主键,若不为空,则使用该值进行查询 */ CustomKey?: string; } /** * CancelTasks请求参数结构体 */ export interface CancelTasksRequest { /** * 任务Id数组,全局唯一 */ TaskId: Array; /** * 配置信息,key-value数组,对外不可见。key1:AuthorityRole(鉴权角色,默认传SubUin,base64加密,仅在jdbc提交任务时使用) */ Config?: Array; } /** * 任务概览 */ export interface TasksOverview { /** * 正在排队的任务个数 */ TaskQueuedCount: number; /** * 初始化的任务个数 */ TaskInitCount: number; /** * 正在执行的任务个数 */ TaskRunningCount: number; /** * 当前时间范围的总任务个数 */ TotalTaskCount: number; } /** * 引擎资源组参数 配置项 */ export interface EngineResourceGroupConfigPair { /** * 配置项 注意:此字段可能返回 null,表示取不到有效值。 */ ConfigItem: string; /** * 配置项的值 注意:此字段可能返回 null,表示取不到有效值。 */ ConfigValue: string; } /** * CreateDatabase返回参数结构体 */ export interface CreateDatabaseResponse { /** * 生成的建库执行语句对象。 */ Execution?: Execution; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DropDMSPartitions返回参数结构体 */ export interface DropDMSPartitionsResponse { /** * 状态 */ Status?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateWorkGroup请求参数结构体 */ export interface CreateWorkGroupRequest { /** * 工作组名称 */ WorkGroupName: string; /** * 工作组描述 */ WorkGroupDescription?: string; /** * 工作组绑定的鉴权策略集合 */ PolicySet?: Array; /** * 需要绑定到工作组的用户Id集合 */ UserIds?: Array; } /** * UpdateDataMaskStrategy请求参数结构体 */ export interface UpdateDataMaskStrategyRequest { /** * 数据脱敏策略详情 */ Strategy?: DataMaskStrategyInfo; } /** * DescribeDatasourceConnection请求参数结构体 */ export interface DescribeDatasourceConnectionRequest { /** * 连接ID列表,指定要查询的连接ID */ DatasourceConnectionIds?: Array; /** * 过滤条件,当前支持的过滤键为:DatasourceConnectionName(数据源连接名)。 DatasourceConnectionType (数据源连接连接类型) */ Filters?: Array; /** * 偏移量,默认为0 */ Offset?: number; /** * 返回数量,默认20,最大值100 */ Limit?: number; /** * 排序字段,支持如下字段类型,create-time(默认,创建时间)、update-time(更新时间) */ SortBy?: string; /** * 排序方式,desc表示正序,asc表示反序, 默认为desc */ Sorting?: string; /** * 筛选字段:起始时间 */ StartTime?: string; /** * 筛选字段:截止时间 */ EndTime?: string; /** * 连接名称列表,指定要查询的连接名称 */ DatasourceConnectionNames?: Array; /** * 连接类型,支持Mysql/HiveCos/Kafka/DataLakeCatalog */ DatasourceConnectionTypes?: Array; /** * 返回指定hive版本的数据源,该参数指定后,会过滤掉该参数指定版本以外的hive数据源,非hive数据源正常返回 */ HiveVersion?: Array; } /** * CheckDataEngineImageCanBeUpgrade请求参数结构体 */ export interface CheckDataEngineImageCanBeUpgradeRequest { /** * 集群id */ DataEngineId: string; } /** * QueryInternalTableWarehouse请求参数结构体 */ export interface QueryInternalTableWarehouseRequest { /** * 库名 */ DatabaseName: string; /** * 表名 */ TableName: string; /** * catalog名称 */ DatasourceConnectionName?: string; } /** * CreateResultDownload请求参数结构体 */ export interface CreateResultDownloadRequest { /** * 查询结果任务Id */ TaskId: string; /** * 下载格式 */ Format: string; /** * 是否重新生成下载文件,仅当之前任务状态为 timeout | error 时有效 */ Force?: boolean; } /** * DescribeNotebookSessionStatementSqlResult返回参数结构体 */ export interface DescribeNotebookSessionStatementSqlResultResponse { /** * 任务Id */ TaskId?: string; /** * 结果数据 */ ResultSet?: string; /** * schema */ ResultSchema?: Array; /** * 分页信息 */ NextToken?: string; /** * 存储结果地址 */ OutputPath?: string; /** * 引擎计算耗时 */ UseTime?: number; /** * 结果条数 */ AffectRows?: number; /** * 数据扫描量 */ DataAmount?: number; /** * spark ui地址 */ UiUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * PauseStandardEngineResourceGroups请求参数结构体 */ export interface PauseStandardEngineResourceGroupsRequest { /** * 标准引擎资源组名称 */ EngineResourceGroupNames: Array; } /** * UpdateStandardEngineResourceGroupConfigInfo请求参数结构体 */ export interface UpdateStandardEngineResourceGroupConfigInfoRequest { /** * 引擎资源组名称 */ EngineResourceGroupName: string; /** * 需要更新的配置 */ UpdateConfContext: Array; /** * 是否立即重启资源组生效,0--立即生效,1--只保持不重启生效 */ IsEffectiveNow: number; } /** * ModifyUser请求参数结构体 */ export interface ModifyUserRequest { /** * 用户Id,和CAM侧Uin匹配 */ UserId: string; /** * 用户描述 */ UserDescription: string; /** * 用户来源类型TencentAccount(普通腾讯云用户) / EntraAccount(微软用户) */ AccountType?: string; } /** * DescribeTasksCostInfo返回参数结构体 */ export interface DescribeTasksCostInfoResponse { /** * 下一页的标识 */ SearchAfter?: string; /** * 返回的数据,字符串类型的二维数组,首行为列中文名称 */ Data?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddDMSPartitions返回参数结构体 */ export interface AddDMSPartitionsResponse { /** * 成功数量 */ Total?: number; /** * 分区值 */ Partitions?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CancelNotebookSessionStatement请求参数结构体 */ export interface CancelNotebookSessionStatementRequest { /** * Session唯一标识 */ SessionId: string; /** * Session Statement唯一标识 */ StatementId: string; } /** * 对指定参数的更新、增加、删除 */ export interface Param { /** * 参数key,例如: */ ConfigItem?: string; /** * 参数值 */ ConfigValue?: string; /** * 下发操作,支持:ADD、DELETE、MODIFY */ Operate?: string; } /** * UpdateStandardEngineResourceGroupBaseInfo请求参数结构体 */ export interface UpdateStandardEngineResourceGroupBaseInfoRequest { /** * 引擎资源组名称 */ EngineResourceGroupName: string; /** * 自动启动,(任务提交自动拉起资源组)0-自动启动,1-不自动启动 */ AutoLaunch: number; /** * 自动挂起资源组。0-自动挂起,1-不自动挂起 */ AutoPause: number; /** * 自动挂起时间,单位分钟,取值范围在1-999(在无任务AutoPauseTime后,资源组自动挂起) */ AutoPauseTime?: number; /** * 任务并发数 */ MaxConcurrency?: number; } /** * SparkSQL批任务日志操作信息。 */ export interface SparkSessionBatchLogOperate { /** * 操作提示 */ Text?: string; /** * 操作类型:COPY、LOG、UI、RESULT、List、TAB */ Operate?: string; /** * 补充信息:如:taskid、sessionid、sparkui等 注意:此字段可能返回 null,表示取不到有效值。 */ Supplement?: Array; } /** * DescribeTablePartitions请求参数结构体 */ export interface DescribeTablePartitionsRequest { /** * 数据目录名称 */ Catalog: string; /** * 数据库名称 */ Database: string; /** * 数据表名称 */ Table: string; /** * 查询偏移位置 */ Offset: number; /** * 当次查询的数量限制 */ Limit: number; /** * 模糊查询的分区名称 */ FuzzyPartition?: string; /** * 排序信息 */ Sorts?: Array; /** * 分页查询的游标信息 */ Cursor?: string; } /** * Spark监控数据 */ export interface SparkMonitorMetrics { /** * shuffle写溢出到COS数据量,单位:byte 注意:此字段可能返回 null,表示取不到有效值。 */ ShuffleWriteBytesCos?: number; /** * shuffle写数据量,单位:byte 注意:此字段可能返回 null,表示取不到有效值。 */ ShuffleWriteBytesTotal?: number; } /** * CreateDMSDatabase返回参数结构体 */ export interface CreateDMSDatabaseResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateStoreLocation返回参数结构体 */ export interface CreateStoreLocationResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * spark session batch SQL的消耗信息 */ export interface BatchSQLCostInfo { /** * 任务id */ BatchId?: string; /** * 引擎名称 */ DataEngineName?: string; /** * 引擎id */ DataEngineId?: string; /** * 本次消耗,单位cu */ Cost?: number; /** * 时间开销,秒 */ TimeCost?: number; /** * 操作者 */ Operator?: 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; /** * 指定查询的数据源名称,默认为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; /** * 工作组描述 */ WorkGroupDescription?: string; /** * 工作组关联的用户数量 */ UserNum?: number; /** * 工作组关联的用户集合 注意:此字段可能返回 null,表示取不到有效值。 */ UserSet?: Array; /** * 工作组绑定的权限集合 注意:此字段可能返回 null,表示取不到有效值。 */ PolicySet?: Array; /** * 工作组的创建人 */ Creator?: string; /** * 工作组的创建时间,形如2021-07-28 16:19:32 */ CreateTime?: string; } /** * SwitchDataEngine请求参数结构体 */ export interface SwitchDataEngineRequest { /** * 主集群名称 */ DataEngineName: string; /** * 是否开启备集群 */ StartStandbyCluster: boolean; } /** * DLC 数据目录访问权限 */ export interface DLCCatalogAccess { /** * VPCID */ VpcId: string; /** * 产品类型 */ Product: string; /** * 描述信息 */ Description?: string; /** * 创建时间 */ CreateTime?: string; } /** * ModifyUser返回参数结构体 */ export interface ModifyUserResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteScript返回参数结构体 */ export interface DeleteScriptResponse { /** * 删除的脚本数量 */ ScriptsAffected: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 任务类型,任务如SQL查询等。 */ export interface Task { /** * SQL查询任务 */ SQLTask?: SQLTask; /** * Spark SQL查询任务 */ SparkSQLTask?: SQLTask; } /** * 引擎配置信息 */ export interface DataEngineConfigInstanceInfo { /** * 引擎ID */ DataEngineId?: string; /** * 用户自定义配置项集合 */ DataEngineConfigPairs?: Array; /** * 作业集群资源参数配置模板 */ SessionResourceTemplate?: SessionResourceTemplate; } /** * 定时启停策略信息 */ export interface CrontabResumeSuspendStrategy { /** * 定时拉起时间:如:周一&周三8点 */ ResumeTime?: string; /** * 定时挂起时间:如:周一&周三20点 */ SuspendTime?: string; /** * 挂起配置:0(默认):等待任务结束后挂起、1:强制挂起 */ SuspendStrategy?: number; } /** * 表过期策略 */ export interface TableExpirationPolicy { /** * 是否启用策略 */ Enabled: boolean; /** * 表过期时间,单位:天 */ Expiration: number; } /** * vpc信息 */ export interface VpcInfo { /** * vpc Id */ VpcId?: string; /** * vpc子网 */ VpcCidrBlock?: string; /** * 规则Id */ RuleId?: number; /** * 权限组Id */ AccessGroupId?: string; } /** * 自定义参数 */ export interface CustomConfig { /** * 自定义参数名 */ ConfigKey?: string; /** * 自定义参数值 */ ConfigValue?: string; } /** * notebook session列表信息。 */ export interface NotebookSessions { /** * 类型,当前支持:spark、pyspark、sparkr、sql */ Kind?: string; /** * Session唯一标识 */ SessionId?: string; /** * 代理用户,默认为root */ ProxyUser?: string; /** * Session状态,包含:not_started(未启动)、starting(已启动)、idle(等待输入)、busy(正在运行statement)、shutting_down(停止)、error(异常)、dead(已退出)、killed(被杀死)、success(正常停止) */ State?: string; /** * Spark任务返回的AppId */ SparkAppId?: string; /** * Session名称 */ Name?: string; /** * Session创建时间 */ CreateTime?: string; /** * 引擎名称 */ DataEngineName?: string; /** * 最新的运行时间 */ LastRunningTime?: string; /** * 创建者 */ Creator?: string; /** * spark ui地址 */ SparkUiUrl?: string; /** * session类型,group:资源组session independent:独立资源session,不依赖资源组 */ SessionType?: string; /** * 引擎id */ DataEngineId?: string; /** * 资源组id */ ResourceGroupId?: string; /** * 资源组名字 */ ResourceGroupName?: string; } /** * CreateNotebookSessionStatementSupportBatchSQL请求参数结构体 */ export interface CreateNotebookSessionStatementSupportBatchSQLRequest { /** * Session唯一标识 */ SessionId: string; /** * 执行的代码 */ Code: string; /** * 类型,当前支持:sql */ Kind: string; /** * 是否保存运行结果 */ SaveResult: boolean; } /** * DetachWorkGroupPolicy返回参数结构体 */ export interface DetachWorkGroupPolicyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSparkSessionBatchSqlLog返回参数结构体 */ export interface DescribeSparkSessionBatchSqlLogResponse { /** * 状态:0:运行中、1:成功、2:失败、3:取消、4:超时; */ State?: number; /** * 日志信息列表 注意:此字段可能返回 null,表示取不到有效值。 */ LogSet?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SwitchDataEngine返回参数结构体 */ export interface SwitchDataEngineResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTaskResourceUsage请求参数结构体 */ export interface DescribeTaskResourceUsageRequest { /** * 任务 id */ TaskInstanceId: string; } /** * DescribeLakeFsInfo请求参数结构体 */ export type DescribeLakeFsInfoRequest = null; /** * CreateCHDFSBindingProduct返回参数结构体 */ export interface CreateCHDFSBindingProductResponse { /** * 绑定信息 */ MountPointAssociates?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserInfo请求参数结构体 */ export interface DescribeUserInfoRequest { /** * 用户Id */ UserId?: string; /** * 必传字段,查询的信息类型,Group:工作组 DataAuth:数据权限 EngineAuth:引擎权限 RowFilter:行级别权限 */ 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; /** * 排序字段。 当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; /** * 用户来源类型TencentAccount(普通腾讯云用户) / EntraAccount(微软用户) */ AccountType?: string; } /** * PauseStandardEngineResourceGroups返回参数结构体 */ export interface PauseStandardEngineResourceGroupsResponse { /** * 批量操作资源组时,操作失败的资源组相关信息 注意:此字段可能返回 null,表示取不到有效值。 */ OperateEngineResourceGroupFailMessages?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteStandardEngineResourceGroup请求参数结构体 */ export interface DeleteStandardEngineResourceGroupRequest { /** * 标准引擎资源组名称 */ EngineResourceGroupName: string; } /** * 网关基础信息,包括id,名称,规格和状态 */ export interface GatewayInfo { /** * 网关ID, 注意:此字段可能返回 null,表示取不到有效值。 */ GatewayId?: string; /** * 网关名称,全局唯一 注意:此字段可能返回 null,表示取不到有效值。 */ GatewayName?: string; /** * 网关的规格 注意:此字段可能返回 null,表示取不到有效值。 */ Size?: number; /** * -2已删除 -1失败 0初始化中 1挂起 2运行中 3准备删除 4删除中 5挂起中 6启动中 7隔离中 8隔离 9续费中 10变配中 11冲正中 注意:此字段可能返回 null,表示取不到有效值。 */ State?: number; /** * 计费模式 注意:此字段可能返回 null,表示取不到有效值。 */ PayMode?: number; /** * 模式 注意:此字段可能返回 null,表示取不到有效值。 */ Mode?: number; } /** * DescribeUserType返回参数结构体 */ export interface DescribeUserTypeResponse { /** * 用户类型。ADMIN:管理员 COMMON:普通用户 */ UserType?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteThirdPartyAccessUser请求参数结构体 */ export type DeleteThirdPartyAccessUserRequest = null; /** * DeleteUser返回参数结构体 */ export interface DeleteUserResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeForbiddenTablePro请求参数结构体 */ export type DescribeForbiddenTableProRequest = null; /** * CreateDataEngine返回参数结构体 */ export interface CreateDataEngineResponse { /** * 虚拟引擎id */ DataEngineId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AssociateDatasourceHouse返回参数结构体 */ export interface AssociateDatasourceHouseResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDataEngine请求参数结构体 */ export interface DescribeDataEngineRequest { /** * House名称 */ DataEngineName: string; } /** * 数据脱敏用户组信息 */ export interface GroupInfo { /** * 用户组ID */ WorkGroupId?: number; /** * 策略类型 */ StrategyType?: string; } /** * Kerberos详细信息 */ export interface KerberosInfo { /** * Krb5Conf文件值 */ Krb5Conf?: string; /** * KeyTab文件值 */ KeyTab?: string; /** * 服务主体 */ ServicePrincipal?: string; } /** * AssociateDatasourceHouse请求参数结构体 */ export interface AssociateDatasourceHouseRequest { /** * 网络配置名称 */ DatasourceConnectionName: string; /** * 数据源类型 */ DatasourceConnectionType: string; /** * 数据源网络配置 */ DatasourceConnectionConfig: DatasourceConnectionConfig; /** * 引擎名称,只允许绑定一个引擎 */ DataEngineNames: Array; /** * 网络类型,2-跨源型,4-增强型 */ NetworkConnectionType: number; /** * 网络配置描述 */ NetworkConnectionDesc?: 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; /** * 资源使用时长,后付费:固定填1,预付费:最少填1,代表购买资源一个月,最长不超过120。默认1 */ TimeSpan?: number; /** * 资源使用时长的单位,后付费:h,预付费:m。默认为h */ TimeUnit?: string; /** * 资源的自动续费标志。后付费无需续费,固定填0;预付费下:0表示手动续费、1代表自动续费、2代表不续费,在0下如果是大客户,会自动帮大客户续费。默认为0 */ AutoRenew?: number; /** * 创建资源的时候需要绑定的标签信息 */ Tags?: Array; /** * 是否自定挂起集群:false(默认):不自动挂起、true:自动挂起 */ AutoSuspend?: boolean; /** * 定时启停集群策略:0(默认):关闭定时策略、1:开启定时策略(注:定时启停策略与自动挂起策略互斥) */ CrontabResumeSuspend?: number; /** * 定时启停策略,复杂类型:包含启停时间、挂起集群策略 */ CrontabResumeSuspendStrategy?: CrontabResumeSuspendStrategy; /** * 引擎执行任务类型,有效值:SQL/BATCH,标准引擎默认为BATCH */ EngineExecType?: string; /** * 单个集群最大并发任务数,默认5 */ MaxConcurrency?: number; /** * 可容忍的排队时间,默认0。当任务排队的时间超过可容忍的时间时可能会触发扩容。如果该参数为0,则表示一旦有任务排队就可能立即触发扩容。 */ TolerableQueueTime?: number; /** * 集群自动挂起时间,默认10分钟 */ AutoSuspendTime?: number; /** * 资源类型。Standard_CU:标准型;Memory_CU:内存型 */ ResourceType?: string; /** * 集群高级配置 */ DataEngineConfigPairs?: Array; /** * 集群镜像版本名字。如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; } /** * DeleteDataMaskStrategy请求参数结构体 */ export interface DeleteDataMaskStrategyRequest { /** * 数据脱敏策略Id */ StrategyId?: 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表示反序, 默认为asc */ Sorting?: string; /** * 过滤条件,支持如下字段类型,user-type:根据用户类型过滤。user-keyword:根据用户名称过滤 */ Filters?: Array; /** * 用户来源类型TencentAccount(普通腾讯云用户) / EntraAccount(微软用户) */ AccountType?: string; } /** * CreateExportTask返回参数结构体 */ export interface CreateExportTaskResponse { /** * 任务id */ TaskId: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddUsersToWorkGroup请求参数结构体 */ export interface AddUsersToWorkGroupRequest { /** * 要操作的工作组和用户信息 */ AddInfo: UserIdSetOfWorkGroupId; } /** * CreateDataMaskStrategy请求参数结构体 */ export interface CreateDataMaskStrategyRequest { /** * 数据脱敏策略详情 */ Strategy?: DataMaskStrategyInfo; } /** * ModifyAdvancedStoreLocation请求参数结构体 */ export interface ModifyAdvancedStoreLocationRequest { /** * 查询结果保存cos路径 */ StoreLocation: string; /** * 是否启用高级设置:0-否,1-是 */ Enable: number; } /** * DescribeNotebookSessionLog请求参数结构体 */ export interface DescribeNotebookSessionLogRequest { /** * Session唯一标识 */ SessionId: string; /** * 分页参数,默认200 */ Limit?: number; /** * 分页参数,默认0 */ Offset?: number; } /** * 授权用户信息 */ export interface UserInfo { /** * 用户Id,和子用户uin相同 */ UserId?: string; /** * 用户描述信息,方便区分不同用户 */ UserDescription?: string; /** * 单独给用户绑定的权限集合 注意:此字段可能返回 null,表示取不到有效值。 */ PolicySet?: Array; /** * 当前用户的创建者 */ Creator?: string; /** * 创建时间,格式如2021-07-28 16:19:32 */ CreateTime?: string; /** * 关联的工作组集合 注意:此字段可能返回 null,表示取不到有效值。 */ WorkGroupSet?: Array; /** * 是否是主账号 */ IsOwner?: boolean; /** * 用户类型。ADMIN:管理员 COMMON:普通用户。 */ UserType?: string; /** * 用户别名 */ UserAlias?: string; /** * 账号类型 */ AccountType?: string; } /** * GetOptimizerPolicy请求参数结构体 */ export interface GetOptimizerPolicyRequest { /** * 策略描述 */ SmartPolicy: SmartPolicy; } /** * 用户信息集合 */ export interface Users { /** * 用户信息集合 注意:此字段可能返回 null,表示取不到有效值。 */ UserSet?: Array; /** * 用户总数 */ TotalCount?: number; } /** * 引擎配置 */ export interface DataEngineConfigPair { /** * 配置项 */ ConfigItem: string; /** * 配置值 */ ConfigValue: string; } /** * 合并策略sort类型的规则定义 */ export interface SortOrder { /** * sort的数据表列名称 */ Column?: string; /** * 按照升序或者降序进行排序 */ SortDirection?: string; /** * null值放在开头或者末尾 */ NullOrder?: string; } /** * SuspendResumeDataEngine返回参数结构体 */ export interface SuspendResumeDataEngineResponse { /** * 虚拟集群详细信息 */ DataEngineName?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据源连接的网络信息 */ export interface DatasourceConnectionLocation { /** * 数据连接所在Vpc实例Id,如“vpc-azd4dt1c”。 */ VpcId: string; /** * Vpc的IPv4 CIDR */ VpcCidrBlock: string; /** * 数据连接所在子网的实例Id,如“subnet-bthucmmy” */ SubnetId: string; /** * Subnet的IPv4 CIDR */ SubnetCidrBlock: string; } /** * AttachUserPolicy请求参数结构体 */ export interface AttachUserPolicyRequest { /** * 用户Id,和子用户uin相同,需要先使用CreateUser接口创建用户。可以使用DescribeUsers接口查看。 */ UserId: string; /** * 鉴权策略集合 */ PolicySet?: Array; /** * 用户来源类型TencentAccount(普通腾讯云用户) / EntraAccount(微软用户) */ AccountType?: string; } /** * CancelTask请求参数结构体 */ export interface CancelTaskRequest { /** * 任务Id,全局唯一 */ TaskId: string; } /** * 文本格式 */ export interface TextFile { /** * 文本类型,本参数取值为TextFile。 */ Format?: string; /** * 处理文本用的正则表达式。 */ Regex?: string; } /** * 工作组集合 */ export interface WorkGroups { /** * 工作组信息集合 注意:此字段可能返回 null,表示取不到有效值。 */ WorkGroupSet?: Array; /** * 工作组总数 */ TotalCount?: number; } /** * CreateNotebookSessionStatement返回参数结构体 */ export interface CreateNotebookSessionStatementResponse { /** * Session Statement详情 */ NotebookSessionStatement?: NotebookSessionStatementInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ListTaskJobLogName返回参数结构体 */ export interface ListTaskJobLogNameResponse { /** * 日志名称列表 */ Names?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusterMonitorInfos返回参数结构体 */ export interface DescribeClusterMonitorInfosResponse { /** * 集群监控信息列表 */ Info?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLakeFsTaskResult请求参数结构体 */ export interface DescribeLakeFsTaskResultRequest { /** * 需要访问的任务结果路径 */ FsPath: string; } /** * 非DLC产品CHDFS绑定 */ export interface OtherCHDFSBinding { /** * 产品名称 */ ProductName?: string; /** * 用户名称(该字段已废弃) */ SuperUser?: Array; /** * vpc配置信息 */ VpcInfo?: Array; /** * 是否与该桶绑定(该字段已废弃) */ IsBind?: boolean; } /** * AlterDMSTable请求参数结构体 */ export interface AlterDMSTableRequest { /** * 当前名称 */ CurrentName: string; /** * 当前数据库名称 */ CurrentDbName: string; /** * 基础对象 */ Asset?: Asset; /** * 表类型 */ Type?: string; /** * 数据库名称 */ DbName?: string; /** * 存储大小 */ StorageSize?: number; /** * 记录数量 */ RecordCount?: number; /** * 生命周期 */ LifeTime?: number; /** * 数据更新时间 */ DataUpdateTime?: string; /** * 结构更新时间 */ StructUpdateTime?: string; /** * 最后访问时间 */ LastAccessTime?: string; /** * 存储对象 */ Sds?: DMSSds; /** * 列 */ Columns?: Array; /** * 分区键值 */ PartitionKeys?: Array; /** * 视图文本 */ ViewOriginalText?: string; /** * 视图文本 */ ViewExpandedText?: string; /** * 分区 */ Partitions?: Array; /** * 当前表名 */ Name?: string; /** * 数据源连接名 */ DatasourceConnectionName?: string; } /** * DescribeDMSPartitions返回参数结构体 */ export interface DescribeDMSPartitionsResponse { /** * 分区信息 */ Partitions?: Array; /** * 总数 */ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateScript请求参数结构体 */ export interface CreateScriptRequest { /** * 脚本名称,最大不能超过255个字符。 */ ScriptName: string; /** * base64编码后的sql语句 */ SQLStatement: string; /** * 脚本描述, 不能超过50个字符 */ ScriptDesc?: string; /** * 数据库名称 */ DatabaseName?: string; } /** * DescribeUserVpcConnection请求参数结构体 */ export interface DescribeUserVpcConnectionRequest { /** * 引擎网络ID */ EngineNetworkId: string; /** * 引擎ID集合 */ DataEngineIds?: Array; /** * 终端节点ID集合 */ UserVpcEndpointIds?: Array; } /** * 数据表数据格式。 */ export interface DataFormat { /** * 文本格式,TextFile。 注意:此字段可能返回 null,表示取不到有效值。 */ TextFile?: TextFile; /** * 文本格式,CSV。 注意:此字段可能返回 null,表示取不到有效值。 */ CSV?: CSV; /** * 文本格式,Json。 注意:此字段可能返回 null,表示取不到有效值。 */ Json?: Other; /** * Parquet格式 注意:此字段可能返回 null,表示取不到有效值。 */ Parquet?: Other; /** * ORC格式 注意:此字段可能返回 null,表示取不到有效值。 */ ORC?: Other; /** * AVRO格式 注意:此字段可能返回 null,表示取不到有效值。 */ AVRO?: Other; } /** * DescribeNotebookSessionLog返回参数结构体 */ export interface DescribeNotebookSessionLogResponse { /** * 日志信息,默认获取最新的200条 */ Logs?: Array; /** * 分页参数,默认200 */ Limit?: number; /** * 分页参数,默认0 */ Offset?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeForbiddenTablePro返回参数结构体 */ export interface DescribeForbiddenTableProResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWorkGroupInfo请求参数结构体 */ export interface DescribeWorkGroupInfoRequest { /** * 工作组Id */ WorkGroupId?: number; /** * 查询信息类型:User:用户信息 DataAuth:数据权限 EngineAuth:引擎权限 */ Type?: string; /** * 查询的过滤条件。 当Type为User时,支持Key为user-name的模糊搜索; 当Type为DataAuth时,支持key: policy-type:权限类型。 policy-source:数据来源。 data-name:库表的模糊搜索。 当Type为EngineAuth时,支持key: policy-type:权限类型。 policy-source:数据来源。 engine-name:库表的模糊搜索。 */ Filters?: Array; /** * 排序字段。 当Type为User时,支持create-time、user-name 当Type为DataAuth时,支持create-time 当Type为EngineAuth时,支持create-time */ SortBy?: string; /** * 排序方式,desc表示正序,asc表示反序, 默认为asc */ Sorting?: string; /** * 返回数量,默认20,最大值100 */ Limit?: number; /** * 偏移量,默认为0 */ Offset?: number; } /** * DescribeOtherCHDFSBindingList请求参数结构体 */ export interface DescribeOtherCHDFSBindingListRequest { /** * 桶名 */ BucketId: string; } /** * CancelTask返回参数结构体 */ export interface CancelTaskResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 返回数据表的相关信息。 */ export interface TableInfo { /** * 数据表配置信息。 */ TableBaseInfo: TableBaseInfo; /** * 数据表格式。每次入参可选如下其一的KV结构,[TextFile,CSV,Json, Parquet, ORC, AVRD]。 */ DataFormat: DataFormat; /** * 数据表列信息。 */ Columns: Array; /** * 数据表分块信息。 */ Partitions: Array; /** * 数据存储路径。当前仅支持cos路径,格式如下:cosn://bucket-name/filepath。 */ Location: string; } /** * DescribeSparkSessionBatchSQL返回参数结构体 */ export interface DescribeSparkSessionBatchSQLResponse { /** * 状态:0:运行中、1:成功、2:失败、3:取消、4:超时; */ State?: number; /** * SQL子任务列表,仅展示运行完成的子任务,若某个任务运行失败,后续其它子任务不返回 注意:此字段可能返回 null,表示取不到有效值。 */ Tasks?: Array; /** * 非sql运行的异常事件信息,包含资源创建失败、调度异常,JOB超时等,正常运行下该Event值为空 */ Event?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeResourceGroupUsageInfo返回参数结构体 */ export interface DescribeResourceGroupUsageInfoResponse { /** * 资源上限 */ Total?: number; /** * 已占用资源 */ Used?: number; /** * 剩余可用资源 */ Available?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSparkSessionBatchSQLCost返回参数结构体 */ export interface DescribeSparkSessionBatchSQLCostResponse { /** * 任务消耗 注意:此字段可能返回 null,表示取不到有效值。 */ CostInfo?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTasksOverview返回参数结构体 */ export interface DescribeTasksOverviewResponse { /** * 各类任务个数大于0 */ TasksOverview?: TasksOverview; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Kafka连接信息 */ export interface KafkaInfo { /** * kafka实例Id */ InstanceId: string; /** * kafka数据源的网络信息 */ Location: DatasourceConnectionLocation; } /** * FavorInfo */ export interface FavorInfo { /** * 优先事项 */ Priority?: number; /** * Catalog名称 */ Catalog?: string; /** * DataBase名称 */ DataBase?: string; /** * Table名称 */ Table?: string; } /** * 任务实例。 */ export interface TaskFullRespInfo { /** * 任务所属Database的名称。 */ DatabaseName?: string; /** * 任务数据量。 */ DataAmount?: number; /** * 任务Id。 */ Id?: string; /** * 计算耗时,单位: ms */ UsedTime?: number; /** * 任务输出路径。 */ OutputPath?: string; /** * 任务创建时间。 */ CreateTime?: string; /** * 任务状态:0 初始化, 1 执行中, 2 执行成功,3 数据写入中,4 排队中。-1 执行失败,-3 已取消。 */ State?: number; /** * 任务SQL类型,DDL|DML等 */ SQLType?: string; /** * 任务SQL语句 */ SQL?: string; /** * 结果是否过期。 */ ResultExpired?: boolean; /** * 数据影响统计信息。 */ RowAffectInfo?: string; /** * 任务结果数据表。 注意:此字段可能返回 null,表示取不到有效值。 */ DataSet?: string; /** * 失败信息, 例如:errorMessage。该字段已废弃。 */ Error?: string; /** * 任务执行进度num/100(%) */ Percentage?: number; /** * 任务执行输出信息。 */ OutputMessage?: string; /** * 执行SQL的引擎类型 */ TaskType?: string; /** * 任务进度明细 注意:此字段可能返回 null,表示取不到有效值。 */ ProgressDetail?: string; /** * 任务结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: string; /** * 计算资源id 注意:此字段可能返回 null,表示取不到有效值。 */ DataEngineId?: string; /** * 执行sql的子uin 注意:此字段可能返回 null,表示取不到有效值。 */ OperateUin?: string; /** * 计算资源名字 注意:此字段可能返回 null,表示取不到有效值。 */ DataEngineName?: string; /** * 导入类型是本地导入还是cos 注意:此字段可能返回 null,表示取不到有效值。 */ InputType?: string; /** * 导入配置 注意:此字段可能返回 null,表示取不到有效值。 */ InputConf?: string; /** * 数据条数 注意:此字段可能返回 null,表示取不到有效值。 */ DataNumber?: number; /** * 查询数据能不能下载 注意:此字段可能返回 null,表示取不到有效值。 */ CanDownload?: boolean; /** * 用户别名 注意:此字段可能返回 null,表示取不到有效值。 */ UserAlias?: string; /** * spark应用作业名 注意:此字段可能返回 null,表示取不到有效值。 */ SparkJobName?: string; /** * spark应用作业Id 注意:此字段可能返回 null,表示取不到有效值。 */ SparkJobId?: string; /** * spark应用入口jar文件 注意:此字段可能返回 null,表示取不到有效值。 */ SparkJobFile?: string; /** * spark ui url 注意:此字段可能返回 null,表示取不到有效值。 */ UiUrl?: string; /** * 任务耗时,单位: ms 注意:此字段可能返回 null,表示取不到有效值。 */ TotalTime?: number; /** * spark app job执行task的程序入口参数 注意:此字段可能返回 null,表示取不到有效值。 */ CmdArgs?: string; /** * 集群镜像大版本名称 注意:此字段可能返回 null,表示取不到有效值。 */ ImageVersion?: string; /** * 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; /** * 任务公共指标数据 注意:此字段可能返回 null,表示取不到有效值。 */ CommonMetrics?: CommonMetrics; /** * spark任务指标数据 注意:此字段可能返回 null,表示取不到有效值。 */ SparkMonitorMetrics?: SparkMonitorMetrics; /** * presto任务指标数据 注意:此字段可能返回 null,表示取不到有效值。 */ PrestoMonitorMetrics?: PrestoMonitorMetrics; /** * 结果文件格式:默认为csv 注意:此字段可能返回 null,表示取不到有效值。 */ ResultFormat?: string; /** * 引擎类型,SparkSQL:SparkSQL 引擎;SparkBatch:Spark作业引擎;PrestoSQL:Presto引擎 注意:此字段可能返回 null,表示取不到有效值。 */ EngineTypeDetail?: string; /** * spark引擎资源组名称 注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupName?: string; /** * 任务来源信息,如thirdPartyApi,dataExploration, sparkAppTask等 */ Source?: string; /** * 子渠道信息,一般由第三方调用定义 */ SourceExtra?: string; /** * 创建人uin */ CreatorUin?: string; /** * 创建人名字 */ CreatorAlias?: string; /** * 引擎参数 */ CustomizedConf?: string; /** * 单位秒,累计 CPU* 秒 ( 累计 CPU * 时 = 累计 CPU* 秒/ 3600),统计参与计算所用 Spark Executor 每个 core 的 CPU 执行时长总和 示例值:4329 */ TaskTimeSum?: number; /** * 引擎执行时间 */ StageStartTime?: number; /** * 数据扫描条数 */ InputRecordsSum?: number; /** * 健康状态 */ AnalysisStatusType?: number; /** * 输出总行数 */ OutputRecordsSum?: number; /** * 输出总大小 */ OutputBytesSum?: number; /** * 输出文件个数 */ OutputFilesNum?: number; /** * 输出小文件个数 */ OutputSmallFilesNum?: number; /** * 数据shuffle行数 */ ShuffleReadRecordsSum?: number; /** * 数据shuffle大小 */ ShuffleReadBytesSum?: number; /** * spark作业id */ SparkAppId?: string; /** * 任务大类,DLC2.0中任务区分为两大类,sql任务和作业任务 */ TaskCategory?: string; /** * 任务名称 */ TaskName?: string; /** * 引擎类型,用做任务详情页跳转引擎tab */ EngineType?: string; /** * 引擎是否支持洞察数据采集 */ EngineHasListenerConfig?: boolean; /** * spark引擎资源组id */ ResourceGroupId?: string; /** * 任务计算耗时 */ JobTimeSum?: number; /** * 任务启动耗时 */ LaunchTime?: string; /** * Gpu Driver 规格 */ GpuDriverSize?: number; /** * Gpu Executor 规格 */ GpuExecutorSize?: number; } /** * DeleteDataEngine请求参数结构体 */ export interface DeleteDataEngineRequest { /** * 删除虚拟集群的名称数组 */ DataEngineNames: Array; } /** * SmartPolicyRequest */ export interface SmartPolicy { /** * 基础信息 注意:此字段可能返回 null,表示取不到有效值。 */ BaseInfo?: SmartPolicyBaseInfo; /** * 策略描述 注意:此字段可能返回 null,表示取不到有效值。 */ Policy?: SmartOptimizerPolicy; } /** * CreateSparkSessionBatchSQL返回参数结构体 */ export interface CreateSparkSessionBatchSQLResponse { /** * 批任务唯一标识 */ BatchId?: string; /** * Statement任务列表信息 注意:此字段可能返回 null,表示取不到有效值。 */ Statements?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDMSDatabase请求参数结构体 */ export interface DescribeDMSDatabaseRequest { /** * 数据库名称 */ Name?: string; /** * schema名称 */ SchemaName?: string; /** * 匹配规则,只支持填* */ Pattern?: string; /** * 数据源连接名 */ DatasourceConnectionName?: string; } /** * DescribeLakeFsDirSummary请求参数结构体 */ export type DescribeLakeFsDirSummaryRequest = null; /** * 数据格式其它类型。 */ export interface Other { /** * 枚举类型,默认值为Json,可选值为[Json, Parquet, ORC, AVRD]之一。 */ Format?: string; } /** * CreateSparkApp返回参数结构体 */ export interface CreateSparkAppResponse { /** * App唯一标识 */ SparkAppId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateTask返回参数结构体 */ export interface CreateTaskResponse { /** * 任务ID */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 绑定融合桶信息 */ export interface MountPointAssociates { /** * 桶Id */ BucketId?: string; /** * vpcId */ VpcId?: string; /** * 子网地址 */ VpcCidrBlock?: string; /** * 权限组Id */ AccessGroupId?: string; /** * 权限规则Id */ AccessRuleId?: number; } /** * AlterDMSPartition返回参数结构体 */ export interface AlterDMSPartitionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateStandardEngineResourceGroupResourceInfo返回参数结构体 */ export interface UpdateStandardEngineResourceGroupResourceInfoResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTable返回参数结构体 */ export interface DescribeTableResponse { /** * 数据表对象 */ Table?: TableResponseInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 任务 core 用量信息 */ export interface CoreInfo { /** * 时间戳(毫秒)数组 */ Timestamp?: Array; /** * core 用量 */ CoreUsage?: Array; } /** * DetachUserPolicy返回参数结构体 */ export interface DetachUserPolicyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 洞察分析结果返回体 */ export interface AnalysisTaskResults { /** * 任务Id */ Id?: string; /** * 任务创建时间,毫秒时间戳 */ InstanceStartTime?: number; /** * 任务结束时间,毫秒时间戳 */ InstanceCompleteTime?: number; /** * 任务状态:0 初始化, 1 执行中, 2 执行成功,3 数据写入中,4 排队中。-1 执行失败,-3 已取消。 */ State?: number; /** * 任务SQL语句 */ SQL?: string; /** * 计算资源名字 */ DataEngineName?: string; /** * 单位毫秒,引擎内执行耗时, 反映真正用于计算所需的耗时,即从 Spark 任务第一个 Task 开始执行到任务结束之间的耗时。 具体的:会统计任务的每个 Spark Stage 第一个 Task 到最后一个 Task 完成时长之和,不包含任务开始的排队耗时(即剔除从任务提交到 Spark Task 开始执行之间的调度等其他耗时),也不包含任务执行过程中多个 Spark Stage 之间因 executor 资源不足而等待执行 Task 所消耗的时间。 */ JobTimeSum?: number; /** * 单位秒,累计 CPU* 秒 ( 累计 CPU * 时 = 累计 CPU* 秒/ 3600),统计参与计算所用 Spark Executor 每个 core 的 CPU 执行时长总和 */ TaskTimeSum?: number; /** * 数据扫描总行数 */ InputRecordsSum?: number; /** * 数据扫描总 bytes */ InputBytesSum?: number; /** * 输出总行数 */ OutputRecordsSum?: number; /** * 输出总 bytes */ OutputBytesSum?: number; /** * shuffle read 总 bytes */ ShuffleReadBytesSum?: number; /** * shuffle read 总行数 */ ShuffleReadRecordsSum?: number; /** * 洞察结果类型分类,一个 json 数组,有如下几种类型:SPARK-StageScheduleDelay(资源抢占), SPARK-ShuffleFailure(Shuffle异常), SPARK-SlowTask(慢task), SPARK-DataSkew(数据倾斜), SPARK-InsufficientResource(磁盘或内存不足) */ AnalysisStatus?: string; /** * 任务输出文件总数 */ OutputFilesNum?: number; /** * 任务输出小文件总数 */ OutputSmallFilesNum?: number; } /** * UnbindWorkGroupsFromUser返回参数结构体 */ export interface UnbindWorkGroupsFromUserResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AlterDMSDatabase返回参数结构体 */ export interface AlterDMSDatabaseResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CancelNotebookSessionStatement返回参数结构体 */ export interface CancelNotebookSessionStatementResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DataEngine详细信息 */ export interface DataEngineInfo { /** * DataEngine名称 */ DataEngineName: string; /** * 引擎类型 spark/presto */ EngineType: string; /** * 集群资源类型 spark_private/presto_private/presto_cu/spark_cu */ ClusterType: string; /** * 引用ID */ QuotaId?: string; /** * 数据引擎状态 -2已删除 -1失败 0初始化中 1挂起 2运行中 3准备删除 4删除中 */ State?: number; /** * 创建时间 */ CreateTime?: number; /** * 更新时间 */ UpdateTime?: number; /** * 集群规格 注意:此字段可能返回 null,表示取不到有效值。 */ Size?: number; /** * 计费模式 0共享模式 1按量计费 2包年包月 */ Mode?: number; /** * 最小集群数 注意:此字段可能返回 null,表示取不到有效值。 */ MinClusters?: number; /** * 最大集群数 注意:此字段可能返回 null,表示取不到有效值。 */ MaxClusters?: number; /** * 是否自动恢复 注意:此字段可能返回 null,表示取不到有效值。 */ AutoResume?: boolean; /** * 自动恢复时间 注意:此字段可能返回 null,表示取不到有效值。 */ SpendAfter?: number; /** * 集群网段 注意:此字段可能返回 null,表示取不到有效值。 */ CidrBlock?: string; /** * 是否为默认引擎 注意:此字段可能返回 null,表示取不到有效值。 */ DefaultDataEngine?: boolean; /** * 返回信息 注意:此字段可能返回 null,表示取不到有效值。 */ Message?: string; /** * 引擎id */ DataEngineId?: string; /** * 操作者 */ SubAccountUin?: string; /** * 到期时间 */ ExpireTime?: string; /** * 隔离时间 */ IsolatedTime?: string; /** * 冲正时间 */ ReversalTime?: string; /** * 用户名称 注意:此字段可能返回 null,表示取不到有效值。 */ UserAlias?: string; /** * 标签对集合 注意:此字段可能返回 null,表示取不到有效值。 */ TagList?: Array; /** * 引擎拥有的权限 注意:此字段可能返回 null,表示取不到有效值。 */ Permissions?: Array; /** * 是否自定挂起集群:false(默认):不自动挂起、true:自动挂起 注意:此字段可能返回 null,表示取不到有效值。 */ AutoSuspend?: boolean; /** * 定时启停集群策略:0(默认):关闭定时策略、1:开启定时策略(注:定时启停策略与自动挂起策略互斥) 注意:此字段可能返回 null,表示取不到有效值。 */ CrontabResumeSuspend?: number; /** * 定时启停策略,复杂类型:包含启停时间、挂起集群策略 注意:此字段可能返回 null,表示取不到有效值。 */ CrontabResumeSuspendStrategy?: CrontabResumeSuspendStrategy; /** * 引擎执行任务类型,有效值:SQL/BATCH 注意:此字段可能返回 null,表示取不到有效值。 */ EngineExecType?: string; /** * 自动续费标志,0,初始状态,默认不自动续费,若用户有预付费不停服特权,自动续费。1:自动续费。2:明确不自动续费 注意:此字段可能返回 null,表示取不到有效值。 */ RenewFlag?: number; /** * 集群自动挂起时间 注意:此字段可能返回 null,表示取不到有效值。 */ AutoSuspendTime?: number; /** * 网络连接配置 注意:此字段可能返回 null,表示取不到有效值。 */ NetworkConnectionSet?: Array; /** * ui的跳转地址 注意:此字段可能返回 null,表示取不到有效值。 */ UiURL?: string; /** * 引擎的资源类型 注意:此字段可能返回 null,表示取不到有效值。 */ ResourceType?: string; /** * 集群镜像版本ID 注意:此字段可能返回 null,表示取不到有效值。 */ ImageVersionId?: string; /** * 集群镜像小版本ID 注意:此字段可能返回 null,表示取不到有效值。 */ ChildImageVersionId?: string; /** * 集群镜像版本名字 注意:此字段可能返回 null,表示取不到有效值。 */ ImageVersionName?: string; /** * 是否开启备集群 注意:此字段可能返回 null,表示取不到有效值。 */ StartStandbyCluster?: boolean; /** * spark jar 包年包月集群是否开启弹性 注意:此字段可能返回 null,表示取不到有效值。 */ ElasticSwitch?: boolean; /** * spark jar 包年包月集群弹性上限 注意:此字段可能返回 null,表示取不到有效值。 */ ElasticLimit?: number; /** * 是否为默认引擎 注意:此字段可能返回 null,表示取不到有效值。 */ DefaultHouse?: boolean; /** * 单个集群任务最大并发数 注意:此字段可能返回 null,表示取不到有效值。 */ MaxConcurrency?: number; /** * 任务排队上限时间 注意:此字段可能返回 null,表示取不到有效值。 */ TolerableQueueTime?: number; /** * 用户appid 注意:此字段可能返回 null,表示取不到有效值。 */ UserAppId?: number; /** * 用户uin 注意:此字段可能返回 null,表示取不到有效值。 */ UserUin?: string; /** * SessionResourceTemplate 注意:此字段可能返回 null,表示取不到有效值。 */ SessionResourceTemplate?: SessionResourceTemplate; /** * 自动授权开关 注意:此字段可能返回 null,表示取不到有效值。 */ AutoAuthorization?: boolean; /** * 引擎版本,支持Native/SuperSQL 注意:此字段可能返回 null,表示取不到有效值。 */ EngineGeneration?: string; /** * 引擎详细类型,支持:SparkSQL/SparkBatch/PrestoSQL/Kyuubi 注意:此字段可能返回 null,表示取不到有效值。 */ EngineTypeDetail?: string; /** * 引擎网络ID 注意:此字段可能返回 null,表示取不到有效值。 */ EngineNetworkId?: string; /** * 标准引擎关联的资源组个数 注意:此字段可能返回 null,表示取不到有效值。 */ EngineResourceGroupCount?: number; /** * 引擎当前使用量(Cu) 注意:此字段可能返回 null,表示取不到有效值。 */ EngineResourceUsedCU?: number; /** * 引擎的访问信息 注意:此字段可能返回 null,表示取不到有效值。 */ AccessInfos?: Array; /** * 引擎所在网络名称 注意:此字段可能返回 null,表示取不到有效值。 */ EngineNetworkName?: string; /** * 是否使用预留池 注意:此字段可能返回 null,表示取不到有效值。 */ IsPoolMode?: string; /** * 是否支持AI,false: 不支持;true:支持 注意:此字段可能返回 null,表示取不到有效值。 */ IsSupportAI?: boolean; /** * 网关id 注意:此字段可能返回 null,表示取不到有效值。 */ GatewayId?: string; /** * 网关状态 注意:此字段可能返回 null,表示取不到有效值。 */ GatewayState?: number; /** * 是否能执行AI任务 注意:此字段可能返回 null,表示取不到有效值。 */ IsAIGateway?: boolean; /** * 1:AI引擎,0:非AI引擎 注意:此字段可能返回 null,表示取不到有效值。 */ IsAIEngine?: number; /** * 引擎资源弹性伸缩策略 */ ScheduleElasticityConf?: ScheduleElasticityConf; /** * GPU 信息 */ GPUInfo?: GPUInfo; /** * GPU 使用量 */ EngineResourceUsedGPU?: number; /** * GPU 总规格 */ GPUTotalSize?: number; /** * GPU 机型 */ InstanceModel?: string; /** * 节点数量 */ NodeNum?: number; /** * 引擎规格,包含负载弹性或分时弹性 */ SizeWithElastic?: number; /** * 最大弹性值,包含负载弹性或分时弹性 */ MaxElasticSize?: number; } /** * DescribeSessionImageVersion返回参数结构体 */ export interface DescribeSessionImageVersionResponse { /** * 扩展镜像列表 注意:此字段可能返回 null,表示取不到有效值。 */ EngineSessionImages?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LockMetaData返回参数结构体 */ export interface LockMetaDataResponse { /** * 锁id */ LockId?: number; /** * 锁状态:ACQUIRED、WAITING、ABORT、NOT_ACQUIRED */ LockState?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetOptimizerPolicy返回参数结构体 */ export interface SetOptimizerPolicyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateUser请求参数结构体 */ export interface CreateUserRequest { /** * 需要授权的子用户uin,可以通过腾讯云控制台右上角 → “账号信息” → “账号ID进行查看”。 */ UserId: string; /** * 用户描述信息,方便区分不同用户 */ UserDescription?: string; /** * 绑定到用户的权限集合 */ PolicySet?: Array; /** * 用户类型。ADMIN:管理员 COMMON:一般用户。当用户类型为管理员的时候,不能设置权限集合和绑定的工作组集合,管理员默认拥有所有权限。该参数不填默认为COMMON */ UserType?: string; /** * 绑定到用户的工作组ID集合。 */ WorkGroupIds?: Array; /** * 用户别名,字符长度小50 */ UserAlias?: string; /** * 账号类型,UserAccount:用户账号 RoleAccount:角色账号,默认为用户账号 */ AccountType?: string; } /** * AlterDMSDatabase请求参数结构体 */ export interface AlterDMSDatabaseRequest { /** * 当前名称 */ CurrentName?: string; /** * schema名称 */ SchemaName?: string; /** * 路径 */ Location?: string; /** * 基础对象 */ Asset?: Asset; /** * 数据源连接名 */ DatasourceConnectionName?: string; } /** * DescribeOtherCHDFSBindingList返回参数结构体 */ export interface DescribeOtherCHDFSBindingListResponse { /** * 非DLC 产品绑定列表 */ OtherCHDFSBindingList?: Array; /** * 总记录数 */ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateRowFilter返回参数结构体 */ export interface UpdateRowFilterResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDataEngineEvents请求参数结构体 */ export interface DescribeDataEngineEventsRequest { /** * 虚拟集群名称 */ DataEngineName: string; /** * 返回数量,默认为10,最大为100 */ Limit?: number; /** * 偏移量,默认为0 */ Offset?: number; /** * 资源组id */ SessionId?: string; } /** * DescribeDataEnginePythonSparkImages返回参数结构体 */ export interface DescribeDataEnginePythonSparkImagesResponse { /** * PYSPARK镜像信息列表 */ PythonSparkImages?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeViews返回参数结构体 */ export interface DescribeViewsResponse { /** * 视图对象列表。 */ ViewList?: Array; /** * 实例总数。 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDataEngines返回参数结构体 */ export interface DescribeDataEnginesResponse { /** * 数据引擎列表 注意:此字段可能返回 null,表示取不到有效值。 */ DataEngines?: Array; /** * 总条数 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 标准引擎资源组,配置相关信息 */ export interface StandardEngineResourceGroupConfigInfo { /** * 引擎资源组 ID */ ResourceGroupId?: string; /** * 引擎ID */ DataEngineId?: string; /** * 资源组静态参数,需要重启资源组生效 */ StaticConfigPairs?: Array; /** * 资源组动态参数,下一个任务生效。 */ DynamicConfigPairs?: Array; /** * 创建时间 */ CreateTime?: number; /** * 更新时间 */ UpdateTime?: number; } /** * 数据源属性 */ export interface DatasourceConnectionConfig { /** * Mysql数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ Mysql?: MysqlInfo; /** * Hive数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ Hive?: HiveInfo; /** * Kafka数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ Kafka?: KafkaInfo; /** * 其他数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ OtherDatasourceConnection?: OtherDatasourceConnection; /** * PostgreSQL数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ PostgreSql?: DataSourceInfo; /** * SQLServer数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ SqlServer?: DataSourceInfo; /** * ClickHouse数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ ClickHouse?: DataSourceInfo; /** * Elasticsearch数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ Elasticsearch?: ElasticsearchInfo; /** * TDSQL-PostgreSQL数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ TDSQLPostgreSql?: DataSourceInfo; /** * Doris数据源连接的属性 注意:此字段可能返回 null,表示取不到有效值。 */ TCHouseD?: TCHouseD; /** * TccHive数据目录连接信息 */ TccHive?: TccHive; /** * MongoDB 数据源 */ MongoDB?: DataSourceInfo; } /** * UpdateRowFilter请求参数结构体 */ export interface UpdateRowFilterRequest { /** * 行过滤策略的id,此值可以通过DescribeUserInfo或者DescribeWorkGroupInfo接口获取 */ PolicyId: number; /** * 新的过滤策略。 */ Policy: Policy; } /** * 表字段描述信息 */ export interface TColumn { /** * 字段名称 */ Name: string; /** * 字段类型 */ Type: string; /** * 字段描述 */ Comment?: string; /** * 字段默认值 */ Default?: string; /** * 字段是否是非空 */ NotNull?: boolean; /** * 表示整个 numeric 的长度,取值1-38 */ Precision?: number; /** * 表示小数部分的长度 Scale小于Precision */ Scale?: number; /** * 字段位置,小的在前 */ Position?: number; /** * 是否为分区字段 */ IsPartition?: boolean; } /** * LakeFileSystem使用的临时token */ export interface LakeFileSystemToken { /** * Token使用的临时密钥的ID */ SecretId?: string; /** * Token使用的临时密钥 */ SecretKey?: string; /** * Token信息 */ Token?: string; /** * 过期时间 */ ExpiredTime?: number; /** * 颁布时间 */ IssueTime?: number; } /** * DeleteNativeSparkSession请求参数结构体 */ export interface DeleteNativeSparkSessionRequest { /** * 引擎id */ DataEngineId?: string; /** * 资源组id */ ResourceGroupId?: string; /** * spark session名称 */ EngineSessionName?: string; } /** * AlterDMSTable返回参数结构体 */ export interface AlterDMSTableResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateUserVpcConnection返回参数结构体 */ export interface CreateUserVpcConnectionResponse { /** * 终端节点IP */ UserVpcEndpointId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUpdatableDataEngines返回参数结构体 */ export interface DescribeUpdatableDataEnginesResponse { /** * 集群基础信息 */ DataEngineBasicInfos?: Array; /** * 集群个数 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteUser请求参数结构体 */ export interface DeleteUserRequest { /** * 需要删除的用户的Id */ UserIds: Array; /** * 用户来源类型TencentAccount(普通腾讯云用户) / EntraAccount(微软用户) */ AccountType?: string; } /** * 引擎规格详情 */ export interface DataEngineScaleInfoDetail { /** * 统计开始时间,格式为:yyyy-MM-dd HH:mm:ss */ StartTime?: string; /** * 统计结束时间,格式为:yyyy-MM-dd HH:mm:ss */ EndTime?: string; /** * 当前统计时间段,引擎规格 */ CU?: number; } /** * DeleteDataEngine返回参数结构体 */ export interface DeleteDataEngineResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * cos权限描述 */ export interface CosPermission { /** * cos路径 注意:此字段可能返回 null,表示取不到有效值。 */ CosPath?: string; /** * 权限【"read","write"】 注意:此字段可能返回 null,表示取不到有效值。 */ Permissions?: Array; } /** * ip端口对信息 */ export interface IpPortPair { /** * ip信息 注意:此字段可能返回 null,表示取不到有效值。 */ Ip?: string; /** * 端口信息 注意:此字段可能返回 null,表示取不到有效值。 */ Port?: number; } /** * Presto监控指标 */ export interface PrestoMonitorMetrics { /** * Alluxio本地缓存命中率 注意:此字段可能返回 null,表示取不到有效值。 */ LocalCacheHitRate?: number; /** * Fragment缓存命中率 注意:此字段可能返回 null,表示取不到有效值。 */ FragmentCacheHitRate?: number; } /** * DescribeTasksAnalysis返回参数结构体 */ export interface DescribeTasksAnalysisResponse { /** * 洞察结果分页列表 */ TaskList?: Array; /** * 洞察结果总数 */ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RestartDataEngine返回参数结构体 */ export interface RestartDataEngineResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNativeSparkSessions返回参数结构体 */ export interface DescribeNativeSparkSessionsResponse { /** * spark session列表 */ SparkSessionsList?: Array; /** * 资源组总规格 */ TotalSpec?: number; /** * 资源组当前可用规格 */ TotalAvailable?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SwitchDataEngineImage返回参数结构体 */ export interface SwitchDataEngineImageResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSparkAppTasks返回参数结构体 */ export interface DescribeSparkAppTasksResponse { /** * 任务结果(该字段已废弃) 注意:此字段可能返回 null,表示取不到有效值。 */ Tasks?: TaskResponseInfo; /** * 任务总数 */ TotalCount?: number; /** * 任务结果列表 注意:此字段可能返回 null,表示取不到有效值。 */ SparkAppTasks?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCHDFSBindingProduct请求参数结构体 */ export interface CreateCHDFSBindingProductRequest { /** * 需要绑定的元数据加速桶名 */ MountPoint: string; /** * 桶的类型,分为cos和lakefs */ BucketType: string; /** * 产品名称 */ ProductName: string; /** * 引擎名称,ProductName选择DLC产品时,必传此参数。其他产品可不传 */ EngineName?: string; /** * vpc信息,产品名称为other时必传此参数 */ VpcInfo?: Array; } /** * DescribeUserRegisterTime返回参数结构体 */ export interface DescribeUserRegisterTimeResponse { /** * 用户注册时间 */ RegisterTime?: number; /** * 是否时老用户 */ IsOldUser?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DropDMSTable返回参数结构体 */ export interface DropDMSTableResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DataEngine基本信息 */ export interface DataEngineBasicInfo { /** * DataEngine名称 */ DataEngineName?: string; /** * 数据引擎状态 -2已删除 -1失败 0初始化中 1挂起 2运行中 3准备删除 4删除中 */ State?: number; /** * 创建时间 */ CreateTime?: number; /** * 更新时间 */ UpdateTime?: number; /** * 返回信息 */ Message?: string; /** * 引擎id */ DataEngineId?: string; /** * 引擎类型,有效值:PrestoSQL/SparkSQL/SparkBatch */ DataEngineType?: string; /** * 用户ID */ AppId?: number; /** * 账号ID */ UserUin?: string; } /** * ModifySparkApp请求参数结构体 */ export interface ModifySparkAppRequest { /** * spark作业名 */ AppName: string; /** * spark作业类型,1代表spark jar作业,2代表spark streaming作业 */ AppType: number; /** * 执行spark作业的数据引擎名称 */ DataEngine: string; /** * spark作业程序包文件路径 */ AppFile: string; /** * 数据访问策略,CAM Role arn */ RoleArn: number; /** * 指定的Driver规格,当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu) */ AppDriverSize: string; /** * 指定的Executor规格,当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu) */ AppExecutorSize: string; /** * spark作业executor个数 */ AppExecutorNums: number; /** * spark作业Id */ SparkAppId: string; /** * 该字段已下线,请使用字段Datasource */ Eni?: string; /** * spark作业程序包是否本地上传,cos:存放与cos,lakefs:本地上传(控制台使用,该方式不支持直接接口调用) */ IsLocal?: string; /** * spark作业主类 */ MainClass?: string; /** * spark配置,以换行符分隔 */ AppConf?: string; /** * spark 作业依赖jar包是否本地上传,cos:存放与cos,lakefs:本地上传(控制台使用,该方式不支持直接接口调用) */ IsLocalJars?: string; /** * spark 作业依赖jar包(--jars),以逗号分隔 */ AppJars?: string; /** * spark作业依赖文件资源是否本地上传,cos:存放与cos,lakefs:本地上传(控制台使用,该方式不支持直接接口调用) */ IsLocalFiles?: string; /** * spark作业依赖文件资源(--files)(非jar、zip),以逗号分隔 */ AppFiles?: string; /** * pyspark:依赖上传方式,cos:存放与cos,lakefs:本地上传(控制台使用,该方式不支持直接接口调用) */ IsLocalPythonFiles?: string; /** * pyspark作业依赖python资源(--py-files),支持py/zip/egg等归档格式,多文件以逗号分隔 */ AppPythonFiles?: string; /** * spark作业程序入参 */ CmdArgs?: string; /** * 最大重试次数,只对spark流任务生效 */ MaxRetries?: number; /** * 数据源名 */ DataSource?: string; /** * spark作业依赖archives资源是否本地上传,cos:存放与cos,lakefs:本地上传(控制台使用,该方式不支持直接接口调用) */ IsLocalArchives?: string; /** * spark作业依赖archives资源(--archives),支持tar.gz/tgz/tar等归档格式,以逗号分隔 */ AppArchives?: string; /** * Spark Image 版本号 */ SparkImage?: string; /** * Spark Image 版本名称 */ SparkImageVersion?: string; /** * 指定的Executor数量(最大值),默认为1,当开启动态分配有效,若未开启,则该值等于AppExecutorNums */ AppExecutorMaxNumbers?: number; /** * 关联dlc查询脚本 */ SessionId?: string; /** * 任务资源配置是否继承集群配置模板:0(默认)不继承、1:继承 */ IsInherit?: number; /** * 是否使用session脚本的sql运行任务:false:否,true:是 */ IsSessionStarted?: boolean; /** * 标准引擎依赖包 */ DependencyPackages?: Array; } /** * 节点规格信息 */ export interface SpecInfo { /** * 规格名称 注意:此字段可能返回 null,表示取不到有效值。 */ Name?: string; /** * 当前规格的cu数 注意:此字段可能返回 null,表示取不到有效值。 */ Cu?: number; /** * 当前规格的cpu数 注意:此字段可能返回 null,表示取不到有效值。 */ Cpu?: number; /** * 当前规格的内存数,单位G 注意:此字段可能返回 null,表示取不到有效值。 */ Memory?: number; } /** * AssignMangedTableProperties请求参数结构体 */ export interface AssignMangedTablePropertiesRequest { /** * 表基本信息 */ TableBaseInfo: TableBaseInfo; /** * 表字段信息 */ Columns: Array; /** * 表分区信息 */ Partitions?: Array; /** * 表属性信息 */ Properties?: Array; /** * V2 upsert表 upsert键 */ UpsertKeys?: Array; } /** * 绑定到同一个工作组的用户Id的集合 */ export interface UserIdSetOfWorkGroupId { /** * 工作组Id */ WorkGroupId: number; /** * 用户Id集合,和CAM侧Uin匹配 */ UserIds: Array; } /** * AlterDMSPartition请求参数结构体 */ export interface AlterDMSPartitionRequest { /** * 当前名称,变更前db名称 */ CurrentDbName: string; /** * 当前名称,变更前table名称 */ CurrentTableName: string; /** * 当前名称,变更前Part名称 */ CurrentValues: string; /** * 分区 */ Partition?: DMSPartition; /** * 数据源连接名 */ DatasourceConnectionName?: string; } /** * ReportHeartbeatMetaData返回参数结构体 */ export interface ReportHeartbeatMetaDataResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QueryInternalTableWarehouse返回参数结构体 */ export interface QueryInternalTableWarehouseResponse { /** * warehouse路径 */ WarehousePath?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * script实例。 */ export interface Script { /** * 脚本Id,长度36字节。 */ ScriptId?: string; /** * 脚本名称,长度0-25。 */ ScriptName?: string; /** * 脚本描述,长度0-50。 注意:此字段可能返回 null,表示取不到有效值。 */ ScriptDesc?: string; /** * 默认关联数据库。 */ DatabaseName?: string; /** * SQL描述,长度0-10000。 注意:此字段可能返回 null,表示取不到有效值。 */ SQLStatement?: string; /** * 更新时间戳, 单位:ms。 */ UpdateTime?: number; } /** * DescribeUDFPolicy返回参数结构体 */ export interface DescribeUDFPolicyResponse { /** * UDF权限信息 */ UDFPolicyInfos?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CheckDataEngineImageCanBeUpgrade返回参数结构体 */ export interface CheckDataEngineImageCanBeUpgradeResponse { /** * 当前大版本下,可升级的集群镜像小版本id */ ChildImageVersionId?: string; /** * 是否能够升级 */ IsUpgrade?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateInternalTable请求参数结构体 */ export interface CreateInternalTableRequest { /** * 表基本信息 */ TableBaseInfo: TableBaseInfo; /** * 表字段信息 */ Columns: Array; /** * 表分区信息 */ Partitions?: Array; /** * 表属性信息 */ Properties?: Array; } /** * 批量顺序执行任务集合 */ export interface TasksInfo { /** * 任务类型,SQLTask:SQL查询任务。SparkSQLTask:Spark SQL查询任务 */ TaskType: string; /** * 容错策略。Proceed:前面任务出错/取消后继续执行后面的任务。Terminate:前面的任务出错/取消之后终止后面任务的执行,后面的任务全部标记为已取消。 */ FailureTolerance: string; /** * base64加密后的SQL语句,用";"号分隔每个SQL语句,一次最多提交50个任务。严格按照前后顺序执行 */ SQL: string; /** * 任务的配置信息,当前仅支持SparkSQLTask任务。 */ Config?: Array; /** * 任务的用户自定义参数信息 */ Params?: Array; } /** * AttachWorkGroupPolicy请求参数结构体 */ export interface AttachWorkGroupPolicyRequest { /** * 工作组Id */ WorkGroupId: number; /** * 要绑定的策略集合 */ PolicySet?: Array; } /** * notebook session statement输出信息。 */ export interface StatementOutput { /** * 执行总数 */ ExecutionCount?: number; /** * Statement数据 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: Array; /** * Statement状态:ok,error */ Status?: string; /** * 错误名称 */ ErrorName?: string; /** * 错误类型 注意:此字段可能返回 null,表示取不到有效值。 */ ErrorValue?: string; /** * 错误堆栈信息 注意:此字段可能返回 null,表示取不到有效值。 */ ErrorMessage?: Array; /** * SQL类型任务结果返回 */ SQLResult?: string; } /** * CreateUser返回参数结构体 */ export interface CreateUserResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNotebookSessionStatements请求参数结构体 */ export interface DescribeNotebookSessionStatementsRequest { /** * Session唯一标识 */ SessionId: string; /** * 批任务id */ BatchId: string; } /** * UpdateDataEngine返回参数结构体 */ export interface UpdateDataEngineResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTasksOverview请求参数结构体 */ export interface DescribeTasksOverviewRequest { /** * 开始时间 */ StartTime?: string; /** * 结束时间 */ EndTime?: string; /** * 筛选条件 */ Filters?: Array; /** * 引擎名 */ DataEngineName?: string; /** * DataEngine-dm8bjs29 */ HouseIds?: Array; } /** * 表分区字段信息 */ export interface TPartition { /** * 字段名称 */ Name: string; /** * 字段类型 */ Type?: string; /** * 字段描述 */ Comment?: string; /** * 分区类型(已废弃) */ PartitionType?: string; /** * 分区格式(已废弃) */ PartitionFormat?: string; /** * 分区分隔数(已废弃) */ PartitionDot?: number; /** * 分区转换策略 */ Transform?: string; /** * 策略参数 */ TransformArgs?: Array; } /** * DeleteUserVpcConnection请求参数结构体 */ export interface DeleteUserVpcConnectionRequest { /** * 引擎网络ID */ EngineNetworkId: string; /** * 终端节点ID */ UserVpcEndpointId: string; } /** * DescribeTaskMonitorInfos请求参数结构体 */ export interface DescribeTaskMonitorInfosRequest { /** * 任务ID列表,上限50个 */ TaskIdList?: Array; /** * 引擎名称 */ HouseName?: string; /** * 任务创建时间的起始时间 */ CreateTimeStart?: string; /** * 任务创建时间的结束时间 */ CreateTimeEnd?: string; /** * 每一页条数 */ Limit?: number; /** * 偏移量 */ Offset?: number; } /** * 描述DLC托管存储基本信息 */ export interface LakeFsInfo { /** * 托管存储名称 */ Name?: string; /** * 托管存储类型 */ Type?: string; /** * 存储用量 */ SpaceUsedSize?: number; /** * 创建时候的时间戳 */ CreateTimeStamp?: number; /** * 是否是用户默认桶,0:默认桶,1:非默认桶 */ DefaultBucket?: number; /** * 托管存储short name */ ShortName?: string; /** * 桶描述信息 */ Description?: string; /** * 托管桶状态,当前取值为:creating、bind、readOnly、isolate */ Status?: string; /** * 托管存储桶标签列表 */ TagList?: Array; } /** * QueryResult请求参数结构体 */ export interface QueryResultRequest { /** * 任务ID */ TaskId: string; /** * objectListMarker={marker}&lastReadFile={filename}&lastReadOffsetlastReadFile为上一次读取的文件,lastReadOffset为上一次读取到的位置 */ NextToken?: string; } /** * CheckDataEngineImageCanBeRollback请求参数结构体 */ export interface CheckDataEngineImageCanBeRollbackRequest { /** * 引擎唯一id */ DataEngineId: string; } /** * CreateTask请求参数结构体 */ export interface CreateTaskRequest { /** * 计算任务,该参数中包含任务类型及其相关配置信息 */ Task: Task; /** * 数据库名称。如果SQL语句中有数据库名称,优先使用SQL语句中的数据库,否则使用该参数指定的数据库(注:当提交建库sql时,该字段传空字符串)。 */ DatabaseName?: string; /** * 默认数据源名称。 */ DatasourceConnectionName?: string; /** * 数据引擎名称,不填提交到默认集群 */ DataEngineName?: string; /** * 标准spark执行任务resourceGroupName */ ResourceGroupName?: string; /** * 任务来源信息 */ SourceInfo?: Array; } /** * spark session详细信息 */ export interface SparkSessionInfo { /** * spark session id */ SparkSessionId?: string; /** * spark session名称 */ SparkSessionName?: string; /** * 资源组id */ ResourceGroupId?: string; /** * engine session id */ EngineSessionId?: string; /** * engine session name */ EngineSessionName?: string; /** * 自动销毁时间 */ IdleTimeoutMin?: number; /** * driver规格 */ DriverSpec?: string; /** * executor规格 */ ExecutorSpec?: string; /** * executor最小数量 */ ExecutorNumMin?: number; /** * executor最大数量 */ ExecutorNumMax?: number; /** * 总规格最小 */ TotalSpecMin?: number; /** * 总规格最大 */ TotalSpecMax?: number; /** * 状态,STARTING、RUNNING、TERMINATED */ State?: string; } /** * DescribeClusterMonitorInfos请求参数结构体 */ export interface DescribeClusterMonitorInfosRequest { /** * 引擎Id */ DataEngineId: string; /** * 任务创建时间的起始时间 */ TimeStart?: string; /** * 任务创建时间的结束时间 */ TimeEnd?: string; /** * 指标名称 */ MetricName?: string; } /** * CreateTable请求参数结构体 */ export interface CreateTableRequest { /** * 数据表配置信息 */ TableInfo: TableInfo; } /** * DescribeStandardEngineResourceGroups请求参数结构体 */ export interface DescribeStandardEngineResourceGroupsRequest { /** * 排序字段 */ SortBy?: string; /** * 升序,降序 */ Sorting?: string; /** * 过滤条件可选,app-id--用户appID,engine-resource-group-id--引擎资源组ID,data-engine-name--引擎名称,engine-resource-group-name---引擎资源组名称(模糊查询),engine-resource-group-state---引擎资源组状态engine-resource-group-name-unique --引擎资源组名称(完全匹配) */ Filters?: Array; /** * 数据条数,默认10 */ Limit?: number; /** * 偏移量,默认0 */ Offset?: number; } /** * 任务监控信息 */ export interface TaskMonitorInfo { /** * 任务id */ TaskId?: string; /** * 引擎名称 */ HouseName?: string; /** * sql语句 */ QuerySQL?: string; /** * 任务时间 */ CreateTime?: string; /** * 执行时间 */ UsedTime?: string; /** * 数据扫描量 */ DataAmount?: string; /** * 指标信息 */ QueryStats?: string; } /** * DescribeSparkSessionBatchSqlLog请求参数结构体 */ export interface DescribeSparkSessionBatchSqlLogRequest { /** * SparkSQL唯一标识 */ BatchId: string; /** * 用户自定义主键,若不为空,则按照该值进行查询 */ CustomKey?: string; } /** * 同一个用户绑定的工作组集合 */ export interface WorkGroupIdSetOfUserId { /** * 用户Id,和CAM侧Uin匹配 */ UserId: string; /** * 工作组Id集合 */ WorkGroupIds: Array; } /** * DescribeUpdatableDataEngines请求参数结构体 */ export interface DescribeUpdatableDataEnginesRequest { /** * 引擎配置操作命令,UpdateSparkSQLLakefsPath 更新托管表路径,UpdateSparkSQLResultPath 更新结果桶路径 */ DataEngineConfigCommand: string; /** * 是否使用托管存储作为结果存储 */ UseLakeFs?: boolean; /** * 用户自定义结果存储路径 */ CustomResultPath?: string; } /** * DeleteTable请求参数结构体 */ export interface DeleteTableRequest { /** * 表基本信息 */ TableBaseInfo: TableBaseInfo; } /** * DescribeStoreLocation请求参数结构体 */ export type DescribeStoreLocationRequest = null; /** * DescribeViews请求参数结构体 */ export interface DescribeViewsRequest { /** * 列出该数据库下所属数据表。 */ DatabaseName: string; /** * 返回数量,默认为10,最大值为100。 */ Limit?: number; /** * 数据偏移量,从0开始,默认为0。 */ Offset?: number; /** * 过滤条件,如下支持的过滤类型,传参Name应为其一 view-name - String - (过滤条件)数据表名称,形如:view-001。 view-id - String - (过滤条件)view id形如:12342。 */ Filters?: Array; /** * 数据库所属的数据源名称 */ DatasourceConnectionName?: string; /** * 排序字段 */ Sort?: string; /** * 排序规则,true:升序;false:降序 */ Asc?: boolean; /** * 按视图更新时间筛选,开始时间,如2021-11-11 00:00:00 */ StartTime?: string; /** * 按视图更新时间筛选,结束时间,如2021-11-12 00:00:00 */ EndTime?: string; /** * 查询类型:all:全部数据(默认)、permission:有权限的数据 注意:此字段需要开启白名单使用,如果需要使用,请提交工单联系我们。 */ DescribeType?: string; } /** * 用户标准引擎资源组信息 */ export interface StandardEngineResourceGroupInfo { /** * 标准引擎资源组ID */ EngineResourceGroupId?: string; /** * 标准引擎资源组名称,支持1-50个英文、汉字、数字、连接线-或下划线_ */ EngineResourceGroupName?: string; /** * 创建者 */ Creator?: string; /** * 资源组 状态,-1--删除、0--启动中、2--运行、3--暂停、4--暂停中、7--切换引擎中、8--配置修改中。9--资源组重启中,10--因为变配导致资源组启动、11--因为隔离导致资源组挂起、12- 资源配置下发中、 13-接入点隔离导致资源组挂起中 */ ResourceGroupState?: number; /** * 自动启动,(任务提交自动拉起资源组)0-自动启动,1-不自动启动 */ AutoLaunch?: number; /** * 自动挂起资源组。0-自动挂起,1-不自动挂起 */ AutoPause?: number; /** * 自动挂起时间,单位分钟,取值范围在1-999(在无任务AutoPauseTime后,资源组自动挂起) */ AutoPauseTime?: number; /** * driver的cu规格: 当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu),内存型cu为cpu:men=1:8,m.small(1cu内存型)、m.medium(2cu内存型)、m.large(4cu内存型)、m.xlarge(8cu内存型) */ DriverCuSpec?: string; /** * executor的cu规格: 当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu),内存型cu为cpu:men=1:8,m.small(1cu内存型)、m.medium(2cu内存型)、m.large(4cu内存型)、m.xlarge(8cu内存型) */ ExecutorCuSpec?: string; /** * 任务并发数 */ MaxConcurrency?: number; /** * executor最小数量, */ MinExecutorNums?: number; /** * executor最大数量, */ MaxExecutorNums?: number; /** * 创建时间戳 */ CreateTime?: number; /** * 更新时间戳 */ UpdateTime?: number; /** * 是否待重启,作为有资源参数,静态参数修改未重启生效的标识;0-- 不需要重启、1--因为资源参数待重启、2--因静态参数重启、3--因资源和静态参数而待重启、4--因网络配置而待重启、5--因网络配置和资源配置而待重启、6--因网络配置和静态参数而待重启、7--因网络配置,资源参数和静态参数而待重启、 */ NeedRestart?: number; /** * 绑定的引擎名称 */ DataEngineName?: string; /** * 绑定的引擎ID */ DataEngineId?: string; /** * 绑定的引擎状态 注意:此字段可能返回 null,表示取不到有效值。 */ DataEngineState?: number; /** * 接入点ID 注意:此字段可能返回 null,表示取不到有效值。 */ AccessPointId?: string; /** * 接入点名称 注意:此字段可能返回 null,表示取不到有效值。 */ AccessPointName?: string; /** * 接入点状态 注意:此字段可能返回 null,表示取不到有效值。 */ AccessPointState?: number; /** * 资源组类型,console/ default 注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupType?: string; /** * 引擎网络ID 注意:此字段可能返回 null,表示取不到有效值。 */ EngineNetworkId?: string; /** * 网络配置名称 注意:此字段可能返回 null,表示取不到有效值。 */ NetworkConfigNames?: Array; /** * AI类型资源组的框架类型 注意:此字段可能返回 null,表示取不到有效值。 */ FrameType?: string; /** * AI类型资源组的镜像类型,内置:bulit-in,自定义:custom 注意:此字段可能返回 null,表示取不到有效值。 */ ImageType?: string; /** * 镜像名称 注意:此字段可能返回 null,表示取不到有效值。 */ ImageName?: string; /** * 镜像id 注意:此字段可能返回 null,表示取不到有效值。 */ ImageVersion?: string; /** * AI资源组的可用资源上限 注意:此字段可能返回 null,表示取不到有效值。 */ Size?: number; /** * 是否是默认资源组 注意:此字段可能返回 null,表示取不到有效值。 */ IsDefault?: boolean; /** * 资源组场景 注意:此字段可能返回 null,表示取不到有效值。 */ ResourceGroupScene?: string; /** * python类型资源组python单机节点资源上限,该值要小于资源组的资源上限.small:1cu medium:2cu large:4cu xlarge:8cu 4xlarge:16cu 8xlarge:32cu 16xlarge:64cu,如果是高内存型资源,在类型前面加上m. 注意:此字段可能返回 null,表示取不到有效值。 */ PythonCuSpec?: string; /** * Spark类型资源组资源配置模式,fast:快速模式,custom:自定义模式 注意:此字段可能返回 null,表示取不到有效值。 */ SparkSpecMode?: string; /** * Spark类型资源组资源上限 注意:此字段可能返回 null,表示取不到有效值。 */ SparkSize?: number; /** * Spark类型资源组资源最小值 注意:此字段可能返回 null,表示取不到有效值。 */ SparkMinSize?: number; /** * 自定义镜像容器镜像服务domain 名称 */ PublicDomain?: string; /** * 自定义镜像容器镜像服务tcr实例id */ RegistryId?: string; /** * 容器镜像服务tcr所在地域 */ RegionName?: string; /** * 资源组启动耗时 */ LaunchTime?: string; } /** * CreateStandardEngineResourceGroup返回参数结构体 */ export interface CreateStandardEngineResourceGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDatasourceConnection请求参数结构体 */ export interface CreateDatasourceConnectionRequest { /** * 数据连接名称 */ DatasourceConnectionName: string; /** * 数据连接类型 */ DatasourceConnectionType: string; /** * 数据连接属性 */ DatasourceConnectionConfig: DatasourceConnectionConfig; /** * 数据连接所属服务 */ ServiceType: string; /** * 数据连接描述 */ DatasourceConnectionDesc?: string; /** * 数据引擎名称数组 */ DataEngineNames?: Array; /** * 网络连接名称 */ NetworkConnectionName?: string; /** * 网络连接描述 */ NetworkConnectionDesc?: string; /** * 网络连接类型 (2-夸源型,4-增强型) */ NetworkConnectionType?: number; /** * 自定义配置 */ CustomConfig?: Array; } /** * GrantDLCCatalogAccess请求参数结构体 */ export interface GrantDLCCatalogAccessRequest { /** * 授权VpcId */ VpcId: string; /** * 产品(EMR|DLC|Doris|Inlong|Wedata) */ Product: string; /** * 描述 */ Description?: string; /** * VPC所属账号UIN */ VpcUin?: string; /** * VPC所属账号AppId */ VpcAppId?: number; } /** * ReportHeartbeatMetaData请求参数结构体 */ export interface ReportHeartbeatMetaDataRequest { /** * 数据源名称 */ DatasourceConnectionName?: string; /** * 锁ID */ LockId?: number; /** * 事务ID */ TxnId?: number; } /** * DescribeEngineNetworks返回参数结构体 */ export interface DescribeEngineNetworksResponse { /** * 引擎网络信息 */ EngineNetworkInfos?: Array; /** * 总数 */ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNetworkConnections请求参数结构体 */ export interface DescribeNetworkConnectionsRequest { /** * 网络配置类型 */ NetworkConnectionType?: number; /** * 计算引擎名称 */ DataEngineName?: string; /** * 数据源vpcid */ DatasourceConnectionVpcId?: string; /** * 返回数量,默认为10,最大值为100。 */ Limit?: number; /** * 偏移量,默认为0。 */ Offset?: number; /** * 网络配置名称 */ NetworkConnectionName?: string; } /** * CreateTcIcebergTable请求参数结构体 */ export interface CreateTcIcebergTableRequest { /** * 表基本信息 */ TableBaseInfo: TableBaseInfo; /** * 表字段信息 */ Columns: Array; /** * 为true时只获取sql而不执行 */ DryRun: boolean; /** * 表分区信息 */ Partitions?: Array; /** * 表属性信息 */ Properties?: Array; } /** * AttachWorkGroupPolicy返回参数结构体 */ export interface AttachWorkGroupPolicyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddUsersToWorkGroup返回参数结构体 */ export interface AddUsersToWorkGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LaunchStandardEngineResourceGroups返回参数结构体 */ export interface LaunchStandardEngineResourceGroupsResponse { /** * 批量操作资源组时,操作失败的资源组相关信息 注意:此字段可能返回 null,表示取不到有效值。 */ OperateEngineResourceGroupFailMessages?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateNetworkConnection返回参数结构体 */ export interface UpdateNetworkConnectionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GenerateCreateMangedTableSql返回参数结构体 */ export interface GenerateCreateMangedTableSqlResponse { /** * 创建托管存储内表sql语句描述 */ Execution?: Execution; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据源信息 */ export interface DatasourceConnectionInfo { /** * 数据源数字Id */ Id: number; /** * 数据源字符串Id */ DatasourceConnectionId: string; /** * 数据源名称 */ DatasourceConnectionName: string; /** * 数据源描述 */ DatasourceConnectionDesc: string; /** * 数据源类型,支持DataLakeCatalog、IcebergCatalog、Result、Mysql、HiveCos、HiveHdfs */ DatasourceConnectionType: string; /** * 数据源属性 注意:此字段可能返回 null,表示取不到有效值。 */ DatasourceConnectionConfig: DatasourceConnectionConfig; /** * 数据源状态:0(初始化)、1(成功)、-1(已删除)、-2(失败)、-3(删除中) */ State: number; /** * 地域 */ Region: string; /** * 用户AppId */ AppId: string; /** * 数据源创建时间 */ CreateTime: string; /** * 数据源最近一次更新时间 */ UpdateTime: string; /** * 数据源同步失败原因 */ Message: string; /** * 数据源绑定的计算引擎信息 注意:此字段可能返回 null,表示取不到有效值。 */ DataEngines?: Array; /** * 创建人 */ UserAlias?: string; /** * 网络配置列表 注意:此字段可能返回 null,表示取不到有效值。 */ NetworkConnectionSet?: Array; /** * 连通性状态:0(未测试,默认)、1(正常)、2(失败) */ ConnectivityState?: number; /** * 连通性测试提示信息 */ ConnectivityTips?: string; /** * 自定义参数 */ CustomConfig?: Array; /** * 是否允许回退 */ AllowRollback?: boolean; } /** * DescribeDataEngineImageVersions请求参数结构体 */ export interface DescribeDataEngineImageVersionsRequest { /** * 引擎类型:SparkSQL、PrestoSQL、SparkBatch、StandardSpark、StandardPresto */ EngineType: string; /** * 排序字段: InsertTime(插入时间,默认),UpdateTime(更新时间) */ Sort?: string; /** * 排序方式:false(降序,默认),true(升序) */ Asc?: boolean; } /** * BindWorkGroupsToUser返回参数结构体 */ export interface BindWorkGroupsToUserResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateUDFPolicy返回参数结构体 */ export interface UpdateUDFPolicyResponse { /** * UDF权限信息 */ UDFPolicyInfos?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SparkSQL批任务运行日志 */ export interface SparkSessionBatchLog { /** * 日志步骤:BEG/CS/DS/DSS/DSF/FINF/RTO/CANCEL/CT/DT/DTS/DTF/FINT/EXCE */ Step?: string; /** * 时间 */ Time?: string; /** * 日志提示 */ Message?: string; /** * 日志操作 注意:此字段可能返回 null,表示取不到有效值。 */ Operate?: Array; } /** * DeleteScript请求参数结构体 */ export interface DeleteScriptRequest { /** * 脚本id,其可以通过DescribeScripts接口提取 */ ScriptIds: Array; } /** * AddDMSPartitions请求参数结构体 */ export interface AddDMSPartitionsRequest { /** * 分区 */ Partitions?: Array; } /** * DescribeUserRoles请求参数结构体 */ export interface DescribeUserRolesRequest { /** * 列举的数量限制 */ Limit: number; /** * 列举的偏移位置 */ Offset: number; /** * 按照arn模糊列举 */ Fuzzy?: string; /** * 返回结果按照该字段排序 */ SortBy?: string; /** * 正序或者倒序,例如:desc */ Sorting?: string; /** * 是否设置为常驻:1非常驻(默认)、2常驻(仅能设置一个常驻) */ IsDefault?: number; } /** * 数据优化资源信息结构 */ export interface ResourceInfo { /** * 归属类型 */ AttributionType?: string; /** * 资源类型 */ ResourceType?: string; /** * 引擎名称 */ Name?: string; /** * 如资源类型为spark-sql 取值为Name, 如为spark-batch 取值为session app_name */ Instance?: string; /** * 亲和性 注意:此字段可能返回 null,表示取不到有效值。 */ Favor?: Array; /** * 状态 */ Status?: number; /** * 标准引擎资源组信息 */ ResourceGroupName?: string; /** * 资源配置信息 */ ResourceConf?: ResourceConf; } /** * CreateImportTask返回参数结构体 */ export interface CreateImportTaskResponse { /** * 任务id */ TaskId: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUDFPolicy请求参数结构体 */ export interface DescribeUDFPolicyRequest { /** * udf名称 */ Name: string; /** * 数据库名(全局UDF:global-function) */ DatabaseName: string; /** * 数据目录名 */ CatalogName: string; } /** * SmartOptimizerIndexPolicy */ export interface SmartOptimizerIndexPolicy { /** * 开启索引 */ IndexEnable?: string; } /** * RenewDataEngine请求参数结构体 */ export interface RenewDataEngineRequest { /** * CU队列名称 */ DataEngineName: string; /** * 续费时长,单位月,最少续费1一个月 */ TimeSpan: number; /** * 付费类型,默认为1,预付费 */ PayMode?: number; /** * 单位,默认m,仅能填m */ TimeUnit?: string; /** * 自动续费标志,0,初始状态,默认不自动续费,若用户有预付费不停服特权,自动续费。1:自动续费。2:明确不自动续费。不传该参数默认为0 */ RenewFlag?: number; } /** * DescribeTasksAnalysis请求参数结构体 */ export interface DescribeTasksAnalysisRequest { /** * 数据引擎名称,用于筛选 */ DataEngineName?: string; /** * 返回数量,默认为10,最大值为100。 */ Limit?: number; /** * 偏移量,默认为0。 */ Offset?: number; /** * 过滤条件,如下支持的过滤类型,传参Name应为以下其中一个: task-id - String - (任务ID准确过滤)task-id 取值形如:e386471f-139a-4e59-877f-50ece8135b99。task-state - String - (任务状态过滤)取值范围 0(初始化), 1(运行中), 2(成功), -1(失败),rule-id - String - (洞察类型)取值范围 SPARK-StageScheduleDelay(资源抢占), SPARK-ShuffleFailure(Shuffle异常), SPARK-SlowTask(慢task), SPARK-DataSkew(数据倾斜), SPARK-InsufficientResource(磁盘或内存不足) */ Filters?: Array; /** * 排序字段,支持如下字段类型,instance-start-time (任务开始时间),job-time-sum (单位毫秒,引擎内执行耗时),task-time-sum (CU资源消耗,单位秒),input-bytes-sum(数据扫描总大小,单位bytes),shuffle-read-bytes-sum(数据shuffle总大小,单位bytes) */ SortBy?: string; /** * 排序方式,desc表示正序,asc表示反序, 默认为asc。 */ Sorting?: string; /** * 任务开始时间点,格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天],支持最近30天数据查询。默认为当前时刻 */ StartTime?: string; /** * 结束时间点,格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天],支持最近30天数据查询。默认为当前时刻 */ EndTime?: string; } /** * DescribeDataEngineSessionParameters返回参数结构体 */ export interface DescribeDataEngineSessionParametersResponse { /** * 集群Session配置列表 */ DataEngineParameters?: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeScripts返回参数结构体 */ export interface DescribeScriptsResponse { /** * Script列表 注意:此字段可能返回 null,表示取不到有效值。 */ Scripts?: Array