tencentcloud-sdk-nodejs
Version:
2,588 lines (2,587 loc) • 354 kB
TypeScript
/**
* CheckDataEngineConfigPairsValidity返回参数结构体
*/
export interface CheckDataEngineConfigPairsValidityResponse {
/**
* 参数有效性:ture:有效,false:至少存在一个无效参数;
*/
IsAvailable?: boolean;
/**
* 无效参数集合
*/
UnavailableConfig?: Array<string>;
/**
* 唯一请求 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<string>;
}
/**
* 引擎网络信息
*/
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<GatewayInfo>;
}
/**
* 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<KVPair>;
/**
* 附加属性
*/
Params?: Array<KVPair>;
/**
* 附加业务属性
*/
BizParams?: Array<KVPair>;
/**
* 数据版本
*/
DataVersion?: number;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 修改时间
*/
ModifiedTime?: string;
/**
* 数据源主键
*/
DatasourceId?: number;
}
/**
* DescribeDataMaskStrategies返回参数结构体
*/
export interface DescribeDataMaskStrategiesResponse {
/**
* 总数据脱敏策略数
*/
TotalCount?: number;
/**
* 数据脱敏策略列表
*/
Strategies?: Array<DataMaskStrategy>;
/**
* 唯一请求 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;
}
/**
* 数据格式其它类型。
*/
export interface Other {
/**
* 枚举类型,默认值为Json,可选值为[Json, Parquet, ORC, AVRD]之一。
*/
Format?: string;
}
/**
* DLC分区信息查询返回数据结构
*/
export interface MixedTablePartitions {
/**
* 数据表格式
*/
TableFormat?: string;
/**
* 分区总数
*/
TotalSize?: number;
/**
* 分页查询的游标信息,在获取下一页信息时需要回传到服务端
*/
NextCursor?: string;
/**
* iceberg表分区信息
*/
IcebergPartitions?: Array<IcebergTablePartition>;
/**
* hive表分区信息
*/
HivePartitions?: Array<HiveTablePartition>;
}
/**
* 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<string>;
/**
* 排序字段(默认按创建时间)
*/
SortFields?: Array<string>;
/**
* 排序字段:true:升序、false:降序(默认)
*/
Asc?: boolean;
/**
* 分页参数,默认10
*/
Limit?: number;
/**
* 分页参数,默认0
*/
Offset?: number;
/**
* 过滤类型,支持如下的过滤类型,传参Name应为以下其中一个, engine-generation - String(引擎时代: supersql:supersql引擎,native:标准引擎):notebook-keyword - String(数据引擎名称或sessionid或sessionname的模糊搜索)
*/
Filters?: Array<Filter>;
}
/**
* 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 {
/**
* <p>任务对象列表。</p>
*/
TaskList?: Array<TaskFullRespInfo>;
/**
* <p>实例总数。</p>
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 策略集合
*/
export interface Policys {
/**
* 策略集合
注意:此字段可能返回 null,表示取不到有效值。
*/
PolicySet?: Array<Policy>;
/**
* 策略总数
*/
TotalCount?: number;
}
/**
* DropDMSDatabase请求参数结构体
*/
export interface DropDMSDatabaseRequest {
/**
* 数据库名称
*/
Name: string;
/**
* 是否删除数据
*/
DeleteData?: boolean;
/**
* 是否级联删除
*/
Cascade?: boolean;
/**
* 数据源连接名
*/
DatasourceConnectionName?: string;
}
/**
* 按批提交Statement运行SQL任务。
*/
export interface NotebookSessionStatementBatchInformation {
/**
* 任务详情列表
注意:此字段可能返回 null,表示取不到有效值。
*/
NotebookSessionStatementBatch?: Array<NotebookSessionStatementInfo>;
/**
* 当前批任务是否运行完成
*/
IsAvailable?: boolean;
/**
* Session唯一标识
*/
SessionId?: string;
/**
* Batch唯一标识
注意:此字段可能返回 null,表示取不到有效值。
*/
BatchId?: string;
}
/**
* DescribeTables返回参数结构体
*/
export interface DescribeTablesResponse {
/**
* 数据表对象列表。
*/
TableList?: Array<TableResponseInfo>;
/**
* 实例总数。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDataEngineEvents返回参数结构体
*/
export interface DescribeDataEngineEventsResponse {
/**
* <p>事件详细信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Events?: Array<HouseEventsInfo>;
/**
* <p>分页号</p>
*/
Page?: number;
/**
* <p>分页大小</p>
*/
Size?: number;
/**
* <p>总页数</p>
*/
TotalPages?: number;
/**
* <p>总条数</p>
*/
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<DataEngineConfigPair>;
}
/**
* DeleteNativeSparkSession返回参数结构体
*/
export interface DeleteNativeSparkSessionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AlterTableComment返回参数结构体
*/
export interface AlterTableCommentResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDMSPartitions请求参数结构体
*/
export interface DescribeDMSPartitionsRequest {
/**
* 数据库名
*/
DatabaseName: string;
/**
* 表名称
*/
TableName: string;
/**
* schema名称
*/
SchemaName?: string;
/**
* 名称
*/
Name?: string;
/**
* 单个分区名称,精准匹配
*/
Values?: Array<string>;
/**
* 多个分区名称,精准匹配
*/
PartitionNames?: Array<string>;
/**
* 多个分区字段的匹配,模糊匹配
*/
PartValues?: Array<string>;
/**
* 过滤SQL
*/
Filter?: string;
/**
* 最大分区数量
*/
MaxParts?: number;
/**
* 翻页跳过数量
*/
Offset?: number;
/**
* 页面数量
*/
Limit?: number;
/**
* 表达式
*/
Expression?: string;
/**
* 数据源连接名
*/
DatasourceConnectionName?: string;
}
/**
* DescribeDMSTable返回参数结构体
*/
export interface DescribeDMSTableResponse {
/**
* 基础对象
*/
Asset?: Asset;
/**
* 视图文本
*/
ViewOriginalText?: string;
/**
* 视图文本
*/
ViewExpandedText?: string;
/**
* hive维护版本
*/
Retention?: number;
/**
* 存储对象
*/
Sds?: DMSSds;
/**
* 分区列
注意:此字段可能返回 null,表示取不到有效值。
*/
PartitionKeys?: Array<DMSColumn>;
/**
* 分区
注意:此字段可能返回 null,表示取不到有效值。
*/
Partitions?: Array<DMSPartition>;
/**
* 表类型
*/
Type?: string;
/**
* 数据库名称
*/
DbName?: string;
/**
* Schame名称
*/
SchemaName?: string;
/**
* 存储大小
*/
StorageSize?: number;
/**
* 记录数量
*/
RecordCount?: number;
/**
* 生命周期
*/
LifeTime?: number;
/**
* 最后访问时间
*/
LastAccessTime?: string;
/**
* 数据更新时间
*/
DataUpdateTime?: string;
/**
* 结构更新时间
*/
StructUpdateTime?: string;
/**
* 列
注意:此字段可能返回 null,表示取不到有效值。
*/
Columns?: Array<DMSColumn>;
/**
* 表名称
*/
Name?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AlterTableComment请求参数结构体
*/
export interface AlterTableCommentRequest {
/**
* 修改表的基本信息
*/
TableBaseInfo: TableBaseInfo;
}
/**
* CreateTasksInOrder请求参数结构体
*/
export interface CreateTasksInOrderRequest {
/**
* 数据库名称。如果SQL语句中有数据库名称,优先使用SQL语句中的数据库,否则使用该参数指定的数据库。
*/
DatabaseName: string;
/**
* SQL任务信息
*/
Tasks: TasksInfo;
/**
* 数据源名称,默认为COSDataCatalog
*/
DatasourceConnectionName?: string;
}
/**
* DescribeUpdatableDataEngines返回参数结构体
*/
export interface DescribeUpdatableDataEnginesResponse {
/**
* 集群基础信息
*/
DataEngineBasicInfos?: Array<DataEngineBasicInfo>;
/**
* 集群个数
*/
TotalCount?: number;
/**
* 唯一请求 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<DMSTableInfo>;
/**
* 统计值
*/
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<GroupInfo>;
/**
* 用户子账号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<string>;
/**
* 实例总数。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAdvancedStoreLocation请求参数结构体
*/
export type DescribeAdvancedStoreLocationRequest = null;
/**
* DeleteMetaDatabase请求参数结构体
*/
export interface DeleteMetaDatabaseRequest {
/**
* 数据库名称
*/
DatabaseName: string;
/**
* 数据源名称,默认DataLakeCatalog
*/
DatasourceConnectionName?: string;
}
/**
* 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;
}
/**
* ModifySparkAppForTDLC返回参数结构体
*/
export interface ModifySparkAppForTDLCResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据脱敏用户组信息
*/
export interface GroupInfo {
/**
* 用户组ID
*/
WorkGroupId?: number;
/**
* 策略类型
*/
StrategyType?: string;
}
/**
* 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;
}
/**
* DescribeDatabase返回参数结构体
*/
export interface DescribeDatabaseResponse {
/**
* 数据库信息
*/
DatabaseInfo?: DatabaseResponseInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSparkAppJobs请求参数结构体
*/
export interface DescribeSparkAppJobsRequest {
/**
* 返回结果按照该字段排序
*/
SortBy?: string;
/**
* 正序或者倒序,例如:desc
*/
Sorting?: string;
/**
* 过滤条件,如下支持的过滤类型,传参Name应为其一:spark-job-name(作业名称),spark-job-id(作业id),spark-app-type(作业类型,1:批任务,2:流任务,4:SQL作业),user-name(创建人),key-word(作业名称或ID关键词模糊搜索)
*/
Filters?: Array<Filter>;
/**
* 更新时间起始点,支持格式:yyyy-MM-dd HH:mm:ss
*/
StartTime?: string;
/**
* 更新时间截止点,支持格式:yyyy-MM-dd HH:mm:ss
*/
EndTime?: string;
/**
* 查询列表偏移量, 默认值0
*/
Offset?: number;
/**
* 查询列表限制数量, 默认值100
*/
Limit?: number;
}
/**
* DeleteNotebookSession请求参数结构体
*/
export interface DeleteNotebookSessionRequest {
/**
* Session唯一标识
*/
SessionId: string;
}
/**
* CreateDMSTable返回参数结构体
*/
export interface CreateDMSTableResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 查询视图信息对象
*/
export interface ViewResponseInfo {
/**
* 视图基本信息。
*/
ViewBaseInfo?: ViewBaseInfo;
/**
* 视图列信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Columns?: Array<Column>;
/**
* 视图属性信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Properties?: Array<Property>;
/**
* 视图创建时间。
*/
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<string>;
}
/**
* SmartOptimizerPolicy
*/
export interface SmartOptimizerPolicy {
/**
* 是否继承
*/
Inherit?: string;
/**
* 数据治理资源
注意:此字段可能返回 null,表示取不到有效值。
*/
Resources?: Array<ResourceInfo>;
/**
* 数据重写策略
注意:此字段可能返回 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 {
/**
* <p>用户详细信息</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
UserInfo?: UserDetailInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTaskList请求参数结构体
*/
export interface DescribeTaskListRequest {
/**
* <p>返回数量,默认为10,最大值为100。</p>
*/
Limit?: number;
/**
* <p>偏移量,默认为0。</p>
*/
Offset?: number;
/**
* <p>过滤条件,如下支持的过滤类型,传参Name应为以下其中一个,其中task-id支持最大50个过滤个数,其他过滤参数支持的总数不超过5个。<br>task-id - String - (任务ID准确过滤)task-id取值形如:e386471f-139a-4e59-877f-50ece8135b99。<br>task-state - String - (任务状态过滤)取值范围 0(初始化), 1(运行中), 2(成功), -1(失败)。<br>task-sql-keyword - String - (SQL语句关键字模糊过滤)取值形如:DROP TABLE。<br>task-operator- string (子uin过滤)<br>task-kind - string (任务类型过滤)</p>
*/
Filters?: Array<Filter>;
/**
* <p>排序字段,支持如下字段类型,create-time(创建时间,默认)、update-time(更新时间)</p>
*/
SortBy?: string;
/**
* <p>排序方式,desc表示正序,asc表示反序, 默认为asc。</p>
*/
Sorting?: string;
/**
* <p>起始时间点,格式为yyyy-mm-dd HH:MM:SS。默认为45天前的当前时刻</p>
*/
StartTime?: string;
/**
* <p>结束时间点,格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天],支持最近45天数据查询。默认为当前时刻</p>
*/
EndTime?: string;
/**
* <p>数据引擎名称,用于筛选</p>
*/
DataEngineName?: string;
/**
* <p>spark引擎资源组名称</p>
*/
ResourceGroupName?: string;
/**
* <p>引擎id列表</p>
*/
HouseIds?: Array<string>;
}
/**
* 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<KVPair>;
/**
* 输出配置
*/
OutputConf: Array<KVPair>;
/**
* 目标数据源的类型,目前支持导入到托管存储,即lakefsStorage
*/
OutputType?: string;
}
/**
* DescribeDataMaskStrategies请求参数结构体
*/
export interface DescribeDataMaskStrategiesRequest {
/**
* 分页参数,单页返回数据量,默认10
*/
Limit?: number;
/**
* 分页参数,数据便偏移量,默认0
*/
Offset?: number;
/**
* 过滤字段,strategy-name: 按策略名称搜索
*/
Filters?: Array<Filter>;
}
/**
* 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<DLCCatalogAccess>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteTable返回参数结构体
*/
export interface DeleteTableResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUserRoles返回参数结构体
*/
export interface DescribeUserRolesResponse {
/**
* 符合列举条件的总数量
*/
Total?: number;
/**
* 用户角色信息
*/
UserRoles?: Array<UserRole>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateExportTask请求参数结构体
*/
export interface CreateExportTaskRequest {
/**
* 数据来源,lakefsStorage、taskResult
*/
InputType: string;
/**
* 导出任务输入配置
*/
InputConf: Array<KVPair>;
/**
* 导出任务输出配置
*/
OutputConf: Array<KVPair>;
/**
* 目标数据源的类型,目前支持导出到cos
*/
OutputType?: string;
}
/**
* CreateDMSTable请求参数结构体
*/
export interface CreateDMSTableRequest {
/**
* 基础对象
*/
Asset?: Asset;
/**
* 表类型: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<DMSColumn>;
/**
* 分区键值
*/
PartitionKeys?: Array<DMSColumn>;
/**
* 视图文本
*/
ViewOriginalText?: string;
/**
* 视图文本
*/
ViewExpandedText?: string;
/**
* 分区
*/
Partitions?: Array<DMSPartition>;
/**
* 表名称
*/
Name?: string;
/**
* 数据源连接名
*/
DatasourceConnectionName?: string;
}
/**
* ModifySparkApp返回参数结构体
*/
export interface ModifySparkAppResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DMSTable基本信息
*/
export interface DMSTable {
/**
* 视图文本
注意:此字段可能返回 null,表示取不到有效值。
*/
ViewOriginalText?: string;
/**
* 视图文本
注意:此字段可能返回 null,表示取不到有效值。
*/
ViewExpandedText?: string;
/**
* hive维护版本
注意:此字段可能返回 null,表示取不到有效值。
*/
Retention?: number;
/**
* 存储对象
注意:此字段可能返回 null,表示取不到有效值。
*/
Sds?: DMSSds;
/**
* 分区列
注意:此字段可能返回 null,表示取不到有效值。
*/
PartitionKeys?: Array<DMSColumn>;
/**
* 分区
注意:此字段可能返回 null,表示取不到有效值。
*/
Partitions?: Array<DMSPartition>;
/**
* 表类型
注意:此字段可能返回 null,表示取不到有效值。
*/
Type?: string;
/**
* 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
*/
DbName?: string;
/**
* Schema名称
注意:此字段可能返回 null,表示取不到有效值。
*/
SchemaName?: string;
/**
* 存储大小
注意:此字段可能返回 null,表示取不到有效值。
*/
StorageSize?: number;
/**
* 记录数量
注意:此字段可能返回 null,表示取不到有效值。
*/
RecordCount?: number;
/**
* 生命周期
注意:此字段可能返回 null,表示取不到有效值。
*/
LifeTime?: number;
/**
* 最后访问时间
注意:此字段可能返回 null,表示取不到有效值。
*/
LastAccessTime?: string;
/**
* 数据更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
DataUpdateTime?: string;
/**
* 结构更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
StructUpdateTime?: string;
/**
* 列
注意:此字段可能返回 null,表示取不到有效值。
*/
Columns?: Array<DMSColumn>;
/**
* 表名
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
}
/**
* 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<DataMaskStrategyPolicy>;
}
/**
* 元数据存储描述属性
*/
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<string>;
/**
* 序列化参数
注意:此字段可能返回 null,表示取不到有效值。
*/
SerdeParams?: Array<KVPair>;
/**
* 附加参数
注意:此字段可能返回 null,表示取不到有效值。
*/
Params?: Array<KVPair>;
/**
* 列排序(Expired)
注意:此字段可能返回 null,表示取不到有效值。
*/
SortCols?: DMSColumnOrder;
/**
* 列
注意:此字段可能返回 null,表示取不到有效值。
*/
Cols?: Array<DMSColumn>;
/**
* 列排序字段
注意:此字段可能返回 null,表示取不到有效值。
*/
SortColumns?: Array<DMSColumnOrder>;
}
/**
* 开通了第三方访问的用户信息
*/
export interface OpendThirdAccessUserInfo {
/**
* id信息
*/
Id?: number;
/**
* 用户主UIN
*/
Uin?: string;
/**
* 用户AppId
*/
AppId?: string;
/**
* 开通时间
*/
CreateTime?: string;
}
/**
* DescribeDataEnginesScaleDetail返回参数结构体
*/
export interface DescribeDataEnginesScaleDetailResponse {
/**
* 引擎规格统计详细信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Scales?: Array<DataEngineScaleInfo>;
/**
* 唯一请求 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<EngineResourceGroupConfigPair>;
/**
* 资源组动态参数,下一个任务生效。
*/
DynamicConfigPairs?: Array<EngineResourceGroupConfigPair>;
/**
* 任务并发数,默人是5个
*/
MaxConcurrency?: number;
/**
* 网络配置名称
*/
NetworkConfigNames?: Array<string>;
/**
* 自定义镜像域名
*/
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<KVPair>;
/**
* 任务来源信息
*/
SourceInfo?: Array<KVPair>;
/**
* 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<DataEngineConfigPair>;
/**
* 作业引擎资源配置模板
*/
SessionResourceTemplate?: SessionResourceTemplate;
}
/**
* DeleteMetaDatabase返回参数结构体
*/
export interface DeleteMetaDatabaseResponse {
/**
* 本批次提交的任务的批次Id
*/
BatchId?: string;
/**
* 任务Id集合,按照执行顺序排列
*/
TaskIdSet?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUsers返回参数结构体
*/
export interface DescribeUsersResponse {
/**
* 查询到的用户总数
*/
TotalCount?: number;
/**
* 查询到的授权用户信息集合
*/
UserSet?: Array<UserInfo>;
/**
* 唯一请求 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 {
/**
* <p>工作组详细信息</p>
注意:此字段可能返回 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<Filter>;
/**
* 指定查询的数据源名称,默认为DataLakeCatalog
*/
DatasourceConnectionName?: string;
/**
* 起始时间:用于对更新时间的筛选,格式为yyyy-mm-dd HH:MM:SS
*/
StartTime?: string;
/**
* 终止时间:用于对更新时间的筛选,格式为yyyy-mm-dd HH:MM:SS
*/
EndTime?: string;
/**
* 排序字段,支持:CreateTime(创建时间)、UpdateTime(更新时间)、StorageSize(存储空间)、RecordCount(行数)、Name(表名称)(不传则默认按name升序)
*/
Sort?: string;
/**
* 排序字段,false:降序(默认);true:升序
*/
Asc?: boolean;
/**
* table type,表类型查询,可用值:EXTERNAL_TABLE,INDEX_TABLE,MANAGED_TABLE,MATERIALIZED_VIEW,TABLE,VIEW,VIRTUAL_VIEW
*/
TableType?: string;
/**
* 筛选字段-表格式:不传(默认)为查全部;LAKEFS:托管表;ICEBERG:非托管iceberg表;HIVE:非托管hive表;OTHER:非托管其它;
*/
TableFormat?: string;
/**
* 查询类型:all:全部数据(默认)、permission:有权限的数据
注意:此字段需要开启白名单使用,如果需要使用,请提交工单联系我们。
*/
DescribeType?: string;
}
/**
* CreateStoreLocation请求参数结构体
*/
export interface CreateStoreLocationRequest {
/**
* 计算结果存储cos路径,如:cosn://bucketname/
*/
StoreLocation: string;
}
/**
* DescribeLakeFsInfo返回参数结构体
*/
export interface DescribeLakeFsInfoResponse {
/**
* 托管存储信息
注意:此字段可能返回 null,表示取不到有效值。
*/
LakeFsInfos?: Array<LakeFsInfo>;
/**
* 唯一请求 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;
}
/**
* ModifyWorkGroup返回参数结构体
*/
export interface ModifyWorkGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDMSPartitions返回参数结构体
*/
export interface DescribeDMSPartitionsResponse {
/**
* 分区信息
*/
Partitions?: Array<DMSPartition>;
/**
* 总数
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeStandardEngineResourceGroupConfigInfo返回参数结构体
*/
export interface DescribeStandardEngineResourceGroupConfigInfoResponse {
/**
* 总数
*/
Total?: number;
/**
* 标准引擎资源组,配置相关信息
*/
StandardEngineResourceGroupConfigInfos?: Array<StandardEngineResourceGroupConfigInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTable请求参数结构体
*/
export interface DescribeTableRequest {
/**
* 查询对象表名称
*/
TableName: string;
/**
* 查询表所在的数据库名称。
*/
DatabaseName: string;
/**
* 查询表所在的数据源名称
*/
DatasourceConnectionName?: string;
}
/**
* 权限对象
*/
export interface Policy {
/**
* <p>需要授权的数据库名,填 * 代表当前Catalog下所有数据库。当授权类型为管理员级别时,只允许填 “*”,当授权类型为数据连接级别时只允许填空,其他类型下可以任意指定数据库。</p>
*/
Database: string;
/**
* <p>需要授权的数据源名称,管理员级别下只支持填 * (代表该级别全部资源);数据源级别和数据库级别鉴权的情况下,只支持填COSDataCatalog或者*;在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意:如果是对用户自定义数据源进行鉴权,DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。</p>
*/
Catalog: string;
/**
* <p>需要授权的表名,填 * 代表当前Database下所有表。当授权类型为管理员级别时,只允许填“*”,当授权类型为数据连接级别、数据库级别时只允许填空,其他类型下可以任意指定数据表。</p>
*/
Table: string;
/**
* <p>授权的权限操作,对于不同级别的鉴权提供不同操作。管理员权限:ALL,不填默认为ALL;数据连接级鉴权:CREATE;数据库级别鉴权:ALL、CREATE、ALTER、DROP;数据表权限:ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意:在数据表权限下,指定的数据源不为COSDataCatalog的时候,只支持SELECT操作。</p>
*/
Operation: string;
/**
* <p>授权类型,现在支持八种授权类型:ADMIN:管理员级别鉴权 DATASOURCE:数据连接级别鉴权 DATABASE:数据库级别鉴权 TABLE:表级别鉴权 VIEW:视图级别鉴权 FUNCTION:函数级别鉴权 COLUMN:列级别鉴权 ENGINE:数据引擎鉴权。不填默认为管理员级别鉴权。</p>
*/
PolicyType?: string;
/**
* <p>需要授权的函数名,填 * 代表当前Catalog下所有函数。当授权类型为管理员级别时,只允许填“*”,当授权类型为数据连接级别时只允许填空,其他类型下可以任意指定函数。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Function?: string;
/**
* <p>需要授权的视图,填 * 代表当前Database下所有视图。当授权类型为管理员级别时,只允许填“*”,当授权类型为数据连接级别、数据库级别时只允许填空,其他类型下可以任意指定视图。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
View?: string;
/**
* <p>需要授权的列,填 * 代表当前所有列。当授权类型为管理员级别时,只允许填“*”</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Column?: string;
/**
* <p>需要授权的数据引擎,填 * 代表当前所有引擎。当授权类型为管理员级别时,只允许填“*”</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
DataEngine?: string;
/**
* <p>用户是否可以进行二次授权。当为true的时候,被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
ReAuth?: boolean;
/**
* <p>权限来源,入参不填。USER:权限来自用户本身;WORKGROUP:权限来自绑定的工作组</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Source?: string;
/**
* <p>授权模式,入参不填。COMMON:普通模式;SENIOR:高级模式。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Mode?: string;
/**
* <p>操作者,入参不填。</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Operator?: string;
/**
* <p>权限创建的时间,入参不填</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;