;
/**
* 引擎ID
*/
DataEngine?: string;
/**
* driver规格:small,medium,large,xlarge;内存型(引擎类型):m.small,m.medium,m.large,m.xlarge
*/
AppDriverSize?: string;
/**
* executor规格:small,medium,large,xlarge;内存型(引擎类型):m.small,m.medium,m.large,m.xlarge
*/
AppExecutorSize?: string;
/**
* 指定executor数量,最小值为1,最大值小于集群规格
*/
AppExecutorNums?: number;
/**
* 指定executor max数量(动态配置场景下),最小值为1,最大值小于集群规格(当ExecutorMaxNumbers小于ExecutorNums时,改值设定为ExecutorNums)
*/
AppExecutorMaxNumbers?: number;
/**
* 任务资源配置是否继承集群模板,0(默认)不继承,1:继承
*/
IsInherit?: number;
}
/**
* DescribeTable请求参数结构体
*/
export interface DescribeTableRequest {
/**
* 查询对象表名称
*/
TableName: string;
/**
* 查询表所在的数据库名称。
*/
DatabaseName: string;
/**
* 查询表所在的数据源名称
*/
DatasourceConnectionName?: string;
}
/**
* QueryDashboardOverview返回参数结构体
*/
export interface QueryDashboardOverviewResponse {
/**
* 时间范围内所有服务的总 QPS(每秒请求数)均值
单位:请求每秒
*/
TotalRequestsPerSecond?: number;
/**
* 时间范围内全局 P99 延迟均值(毫秒)
单位:毫秒
*/
AverageP99LatencyMs?: number;
/**
* 时间范围内全局错误率均值(0~1,如 0.02 表示 2%)
取值范围:[0, 1]
*/
ErrorRate?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
/**
* user和workgroup对应的确定性字符串PolicyId
*/
PolicyId?: string;
}
/**
* 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;
}
/**
* StopInferenceService请求参数结构体
*/
export interface StopInferenceServiceRequest {
/**
* 推理服务ID
*/
ServiceId: string;
}
/**
* UpdateJobSpec返回参数结构体
*/
export interface UpdateJobSpecResponse {
/**
* 配置ID
*/
Id?: string;
/**
* 配置名称
*/
Name?: string;
/**
* 配置描述
*/
Description?: string;
/**
* 入口命令
*/
Entrypoint?: string;
/**
* 镜像地址
*/
Image?: string;
/**
* 镜像拉取类型(Builtin: 内置, Custom: 自定义)
*/
ImagePullType?: string;
/**
* 镜像拉取策略
*/
ImagePullPolicy?: string;
/**
* 资源配置(JSON)
*/
ResourceConfig?: string;
/**
* 运行时环境配置(JSON)
*/
RuntimeEnv?: string;
/**
* 存储卷和挂载卷配置(JSON)
*/
Catalog?: string;
/**
* 弹性伸缩配置(JSON)
*/
AutoscalerOptions?: string;
/**
* 资源配置ID
*/
ResourceConfigId?: string;
/**
* 资源配置模板是否变更
*/
ResourceConfigChanged?: boolean;
/**
* 默认资源分区ID
*/
ResourcePartitionId?: string;
/**
* 默认资源分区名称
*/
ResourcePartitionName?: string;
/**
* 默认队列名称
*/
Queue?: string;
/**
* 所属队列别名
*/
QueueAlias?: string;
/**
* 作业包URL
*/
JobPackage?: string;
/**
* 作业包名称
*/
JobPackageName?: string;
/**
* 作业包来源类型(Local: 本地上传, Cos: 用户自有 COS 桶地址);缺省时按 Local 处理
*/
JobPackageSource?: string;
/**
* 应用ID
*/
AppId?: number;
/**
* 创建者UIN
*/
Uin?: string;
/**
* 子用户UIN
*/
SubAccountUin?: string;
/**
* 子用户名称(由聚合层通过 CAM 接口回填)
*/
SubAccountName?: string;
/**
* 创建时间
*/
CreateTime?: number;
/**
* 更新时间
*/
UpdateTime?: number;
/**
* 该配置产生的作业实例数量
*/
JobInstanceCount?: number;
/**
* 是否有运行中的作业实例
*/
HasRunningJobs?: boolean;
/**
* 高级参数json
*/
AdvancedOptions?: string;
/**
* 默认计算组名称(与 ClusterGroup 等价,新调用方使用 GroupId)
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupId?: string;
/**
* 默认集群 ID(与 GroupId 互斥)
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId?: string;
/**
* 作业优先级(1-9,数字越大优先级越高)
注意:此字段可能返回 null,表示取不到有效值。
*/
Priority?: number;
/**
* 标签列表(TagKey-TagValue),用于将资源与腾讯云标签系统中的标签绑定
*/
Tags?: Array;
/**
* 集群分派策略
枚举值:
*/
DispatchStrategy?: string;
/**
* 作业提交目标
枚举值:
*/
SubmissionTarget?: string;
/**
* 计算组名称
*/
GroupName?: string;
/**
* 集群名称
*/
ClusterName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateInferenceModel请求参数结构体
*/
export interface CreateInferenceModelRequest {
/**
* 模型名称(最长 256)
*/
Name: string;
/**
* 模型类型(如 LLM、Embedding、Reranker、ASR、TTS 等)
*/
ModelType: string;
/**
* 初始版本号(必填,如 v1、v1.5)
*/
InitialVersion: string;
/**
* 模型提供方
*/
Provider?: string;
/**
* 模型描述
*/
Description?: string;
/**
* 模型参数量(如 7B、1.5B)
*/
ParameterSize?: string;
/**
* 模型标签列表
*/
Tags?: Array;
/**
* 模型存储 URI(可选,如 cos://bucket-name/models/name/)
*/
StorageUri?: string;
/**
* 是否使用用户自带存储桶(默认 false 表示平台托管)
*/
UseCustomStorage?: boolean;
/**
* 任务类型列表(如 ["Text Generation", "Embedding"])
*/
Tasks?: Array;
/**
* 模型 UID(可选,前端预先生成的 UID,不传则后端自动生成)
*/
ModelUid?: string;
/**
* 系统标签列表(TagKey-TagValue)
*/
ResourceTags?: Array;
/**
* 模型文件来源于goosefs
*/
GooseFSConfig?: GooseFSConfig;
/**
* 模型上传来源类型
枚举值:
- Local: 本地上传
- COS: COS上传
- CFS: CFS上传
- CFSTurbo: CFSTurbo上传
- GooseFS: GooseFS上传
*/
StorageType?: string;
}
/**
* DescribeEngineNetworks请求参数结构体
*/
export interface DescribeEngineNetworksRequest {
/**
* 排序字段
*/
SortBy?: string;
/**
* 升序,降序
*/
Sorting?: string;
/**
* 过滤条件可选,engine-network-id--引擎网络ID,engine-network-state--引擎网络状态
*/
Filters?: Array;
/**
* 数据条数
*/
Limit?: number;
/**
* 偏移量
*/
Offset?: number;
}
/**
* GenerateCreateMangedTableSql请求参数结构体
*/
export interface GenerateCreateMangedTableSqlRequest {
/**
* 表基本信息
*/
TableBaseInfo: TableBaseInfo;
/**
* 表字段信息
*/
Columns: Array;
/**
* 表分区信息
*/
Partitions?: Array;
/**
* 表属性信息
*/
Properties?: Array;
/**
* V2 upsert表 upsert键
*/
UpsertKeys?: 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 ClusterGroup {
/**
* 集群组 ID(系统生成)
注意:此字段可能返回 null,表示取不到有效值。
*/
Id?: string;
/**
* 集群组名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* 集群组描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 配置
注意:此字段可能返回 null,表示取不到有效值。
*/
Config?: string;
/**
* 应用 ID(多租户)
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId?: number;
/**
* 创建者主账号 UIN
注意:此字段可能返回 null,表示取不到有效值。
*/
Uin?: string;
/**
* 创建者子账号 UIN
注意:此字段可能返回 null,表示取不到有效值。
*/
SubAccountUin?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: number;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: number;
/**
* 是否已软删除
注意:此字段可能返回 null,表示取不到有效值。
*/
Deleted?: boolean;
/**
* 删除时间(软删时写入,活跃记录为 null)
注意:此字段可能返回 null,表示取不到有效值。
*/
DeleteTime?: number;
}
/**
* 查询表信息对象
*/
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;
}
/**
* UpdateResourceConfig请求参数结构体
*/
export interface UpdateResourceConfigRequest {
/**
* 资源配置模板Id
*/
Id: string;
/**
* 模板名称
*/
Name?: string;
/**
* 描述
*/
Description?: string;
/**
* Head节点配置
*/
Head?: HeadSpecDTO;
/**
* Worker节点配置
*/
Worker?: Array;
/**
* 模板类型(不传默认Ray)
*/
Type?: 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;
}
/**
* CreateCHDFSBindingProduct请求参数结构体
*/
export interface CreateCHDFSBindingProductRequest {
/**
* 需要绑定的元数据加速桶名
*/
MountPoint: string;
/**
* 桶的类型,分为cos和lakefs
*/
BucketType: string;
/**
* 产品名称
*/
ProductName: string;
/**
* 引擎名称,ProductName选择DLC产品时,必传此参数。其他产品可不传
*/
EngineName?: string;
/**
* vpc信息,产品名称为other时必传此参数
*/
VpcInfo?: Array;
}
/**
* 引擎资源组参数 配置项
*/
export interface EngineResourceGroupConfigPair {
/**
* 配置项
注意:此字段可能返回 null,表示取不到有效值。
*/
ConfigItem: string;
/**
* 配置项的值
注意:此字段可能返回 null,表示取不到有效值。
*/
ConfigValue: string;
}
/**
* 流程简要信息
*/
export interface FlowInfo {
/**
* 流程ID
*/
FlowId?: number;
/**
* 流程编码
*/
WorkFlowCode?: string;
/**
* 流程状态
*/
Status?: number;
}
/**
* UnbindWorkGroupsFromUser请求参数结构体
*/
export interface UnbindWorkGroupsFromUserRequest {
/**
* 解绑的工作组Id和用户Id的关联关系
*/
AddInfo: WorkGroupIdSetOfUserId;
}
/**
* RenewDataEngine返回参数结构体
*/
export interface RenewDataEngineResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindApiKey请求参数结构体
*/
export interface BindApiKeyRequest {
/**
* apiKey的Id
*/
ApiKeyIds: Array;
/**
* 服务Id
*/
ServiceId: string;
}
/**
* 授权用户信息
*/
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;
}
/**
* CreateDatabase返回参数结构体
*/
export interface CreateDatabaseResponse {
/**
* 生成的建库执行语句对象。
*/
Execution?: Execution;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteJobSpec请求参数结构体
*/
export interface DeleteJobSpecRequest {
/**
* 配置ID
*/
SpecId: string;
}
/**
* GetLabPods请求参数结构体
*/
export interface GetLabPodsRequest {
/**
* 数据实验室ID
*/
Id: string;
/**
* 当前页码(从1开始)
*/
Page?: number;
/**
* 每页数量
*/
PageSize?: number;
/**
* 开始时间(毫秒时间戳)
*/
StartTime?: number;
/**
* 结束时间(毫秒时间戳)
*/
EndTime?: number;
/**
* 过滤条件
*/
Filters?: Array;
/**
* 排序字段列表
*/
SortFields?: Array;
}
/**
* 描述一个推理引擎的能力
*/
export interface EngineCapabilities {
/**
* GPU 是否可选
*/
GpuOptional?: boolean;
/**
* 是否支持并行配置
*/
SupportsParallelConfig?: boolean;
/**
* 是否支持远程代码
*/
SupportsRemoteCode?: boolean;
/**
* GPU 显存配置键名
*/
GpuMemoryKey?: string;
/**
* 并行配置键名列表
*/
ParallelKeys?: Array;
}
/**
* UpdateUserDataEngineConfig返回参数结构体
*/
export interface UpdateUserDataEngineConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Checkpoint 挂载摘要
*/
export interface CheckpointMountInfo {
/**
* 存储类型:COS / CFS / CFS_TURBO / GOOSEFS
*/
StorageType?: string;
/**
* 容器内挂载路径
*/
MountPath?: string;
/**
* COS key 前缀 或 CFS/GooseFS 子路径
*/
VolumeSubPath?: string;
/**
* 实际访问的 COS bucket
*/
Bucket?: string;
/**
* COS region
*/
Region?: string;
/**
* 是否平台托管桶(影响凭证选择)
*/
PlatformManaged?: boolean;
/**
* 快照在平台 COS 桶中的 key(仅 CFS/GooseFS 有值)
*/
SnapshotKey?: string;
}
/**
* GetRayJob请求参数结构体
*/
export interface GetRayJobRequest {
/**
* 任务ID
*/
Id: string;
}
/**
* 后训练资源规格配置
*/
export interface PostTrainingResources {
/**
* Head 节点资源规格
*/
Head?: HeadSpecDTO;
/**
* Worker 节点资源规格
*/
Worker?: Array;
}
/**
* DeleteDataMaskStrategy请求参数结构体
*/
export interface DeleteDataMaskStrategyRequest {
/**
* 数据脱敏策略Id
*/
StrategyId?: string;
}
/**
* ListExampleTags返回参数结构体
*/
export interface ListExampleTagsResponse {
/**
* 标签总数
*/
Total?: number;
/**
* 当前页码
*/
Page?: number;
/**
* 每页显示标签数量
*/
PageSize?: number;
/**
* 总页数
*/
TotalPages?: number;
/**
* 标签实体
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateWorkGroup请求参数结构体
*/
export interface CreateWorkGroupRequest {
/**
* 工作组名称
*/
WorkGroupName: string;
/**
* 工作组描述
*/
WorkGroupDescription?: string;
/**
* 工作组绑定的鉴权策略集合
*/
PolicySet?: Array;
/**
* 需要绑定到工作组的用户Id集合
*/
UserIds?: Array;
}
/**
* DescribeClusterGroupClusters请求参数结构体
*/
export interface DescribeClusterGroupClustersRequest {
/**
* 计算组 ID
*/
Id: string;
/**
* 返回样例 ClusterId 的最大数量(默认 5)
*/
SampleLimit?: number;
/**
* Cluster 状态列表
枚举值:
*/
Status?: Array;
}
/**
* 其他数据源
*/
export interface OtherDatasourceConnection {
/**
* 网络参数
*/
Location: DatasourceConnectionLocation;
}
/**
* 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;
}
/**
* ModifyTrainingJobSpec请求参数结构体
*/
export interface ModifyTrainingJobSpecRequest {
/**
* 配置 ID
*/
SpecId?: string;
/**
* 配置名称(不传则不更新)
*/
SpecName?: string;
/**
* 配置描述(不传则不更新)
*/
Description?: string;
/**
* 启动命令(不传则不更新)
*/
Entrypoint?: string;
/**
* 镜像地址(不传则不更新)
*/
Image?: string;
/**
* 镜像拉取类型(BuiltIn / Custom / CustomCcr,不传则不更新)
*/
ImagePullType?: string;
/**
* 镜像拉取策略(Always / IfNotPresent / Never,不传则不更新)
*/
ImagePullPolicy?: string;
/**
* 代码包 COS URL(不传则不更新)
*/
CodePackageUrl?: string;
/**
* 运行时环境配置 JSON(不传则不更新)
*/
RuntimeEnv?: string;
/**
* 资源配置模板 ID(可选)
*/
ResourceConfigId?: string;
/**
* 资源配置 JSON(不传则不更新)
*/
ResourceConfig?: string;
/**
* 资源分区 ID(不传则不更新)
*/
ResourcePartitionId?: string;
/**
* 队列名称(不传则不更新)
*/
Queue?: string;
/**
* 存储卷挂载配置 JSON(不传则不更新)
*/
Catalog?: string;
/**
* 作业优先级 1-9(不传则不更新)
*/
Priority?: number;
/**
* 高级参数 JSON(不传则不更新)
*/
AdvancedOptions?: string;
/**
* MlFlow 实验追踪配置(不传则不更新)
*/
MlFlowConfig?: MlFlowConfig;
/**
* 标签列表(TagKey-TagValue),null 不修改,空数组清空,非空全量替换
*/
Tags?: Array;
/**
* 基础模型ID(用于模型挂载)
*/
BaseModelUid?: string;
/**
* 输出模型名(用于产出模型自动注册)
*/
OutputModelName?: string;
/**
* 训练模式:sft / dpo / cpt / grpo(仅 POST_TRAINING 有值)
*/
Mode?: string;
/**
* 数据集挂载列表(整体替换,不传则不更新)
*/
Datasets?: Array;
/**
* Checkpoint 产出配置(整体替换,不传则不更新)
*/
Checkpoint?: CheckpointConfig;
/**
* 是否启用断点续训(创建时的意图声明;实际续训由实例级「断点续训」按钮触发,不传则不更新)
*/
ResumeTraining?: boolean;
/**
* 调优参数(整体替换,未填字段回模板默认值;不传则不更新;仅 POST_TRAINING)
*/
TuningParams?: TrainingTuningParams;
}
/**
* CheckDataEngineImageCanBeUpgrade请求参数结构体
*/
export interface CheckDataEngineImageCanBeUpgradeRequest {
/**
* 集群id
*/
DataEngineId: string;
}
/**
* DescribeModelEngines请求参数结构体
*/
export interface DescribeModelEnginesRequest {
/**
* 模型业务唯一标识
*/
ModelUid: 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;
}
/**
* GrantDLCCatalogAccess返回参数结构体
*/
export interface GrantDLCCatalogAccessResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PauseStandardEngineResourceGroups请求参数结构体
*/
export interface PauseStandardEngineResourceGroupsRequest {
/**
* 标准引擎资源组名称
*/
EngineResourceGroupNames: Array;
}
/**
* GenerateInternalTable请求参数结构体
*/
export interface GenerateInternalTableRequest {
/**
* 表基本信息
*/
TableBaseInfo: TableBaseInfo;
/**
* 字段信息
*/
Columns: Array;
/**
* 分区信息
*/
Partitions?: Array;
/**
* 属性
*/
Properties?: Array;
/**
* V2 upsert表 upsert键
*/
UpsertKeys?: Array;
}
/**
* UpdateStandardEngineResourceGroupConfigInfo请求参数结构体
*/
export interface UpdateStandardEngineResourceGroupConfigInfoRequest {
/**
* 引擎资源组名称
*/
EngineResourceGroupName: string;
/**
* 需要更新的配置
*/
UpdateConfContext: Array;
/**
* 是否立即重启资源组生效,0--立即生效,1--只保持不重启生效
*/
IsEffectiveNow: number;
}
/**
* GetRayClusterHistory返回参数结构体
*/
export interface GetRayClusterHistoryResponse {
/**
* 总记录数
*/
Total?: number;
/**
* 当前页码(从1开始)
*/
Page?: number;
/**
* 每页数量
*/
PageSize?: number;
/**
* 总页数
*/
TotalPages?: number;
/**
* 集群状态历史详情列表
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 关联的推理服务信息
*/
export interface LinkedServiceInfo {
/**
* 服务 UID
*/
ServiceId?: string;
/**
* 服务名称
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceName?: string;
}
/**
* UpdateUserDataEngineConfig请求参数结构体
*/
export interface UpdateUserDataEngineConfigRequest {
/**
* 引擎ID
*/
DataEngineId: string;
/**
* 用户自定义引擎配置项集合。该参数需要传用户需要添加的全部配置项,例如,已有配置项k1:v1,添加k2:v2,需要传[k1:v1,k2:v2]。
*/
DataEngineConfigPairs?: Array;
/**
* 作业引擎资源配置模板
*/
SessionResourceTemplate?: SessionResourceTemplate;
}
/**
* GetResourceConfig请求参数结构体
*/
export interface GetResourceConfigRequest {
/**
* 模板ID
*/
Id: string;
}
/**
* ListExampleCategories请求参数结构体
*/
export interface ListExampleCategoriesRequest {
/**
* 当前页码(从1开始)
*/
Page?: number;
/**
* 页数
*/
PageSize?: number;
}
/**
* DeleteModelVersion返回参数结构体
*/
export interface DeleteModelVersionResponse {
/**
* 是否整个模型已被删除(最后一个版本被删除时为 true)
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelDeleted?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTasksCostInfo返回参数结构体
*/
export interface DescribeTasksCostInfoResponse {
/**
* 下一页的标识
*/
SearchAfter?: string;
/**
* 返回的数据,字符串类型的二维数组,首行为列中文名称
*/
Data?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindApiKey返回参数结构体
*/
export interface BindApiKeyResponse {
/**
* ApiKey成功返回
*/
SuccessList?: Array;
/**
* 失败列表
*/
FailedList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterGroupClusters返回参数结构体
*/
export interface DescribeClusterGroupClustersResponse {
/**
* 活跃 cluster 总数
*/
Count?: number;
/**
* 前 N 个样例
*/
SampleClusters?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterPriority返回参数结构体
*/
export interface ModifyClusterPriorityResponse {
/**
* 集群ID
*/
Id?: string;
/**
* 资源类型:CLUSTER-普通集群;WORKSPACE-数据实验室(开发入口)
*/
Type?: string;
/**
* 集群名称
*/
Name?: string;
/**
* 所属资源分区ID
*/
ResourcePartitionId?: string;
/**
* 所属队列名称
*/
Queue?: string;
/**
* 应用ID
*/
AppId?: number;
/**
* 用户UIN
*/
Uin?: string;
/**
* 子账号UIN
*/
SubAccountUin?: string;
/**
* 集群状态
*/
Status?: string;
/**
* 创建时间
*/
CreateTime?: number;
/**
* 计算组 ID
*/
GroupId?: string;
/**
* 所属集群组名称
*/
GroupName?: string;
/**
* 资源配置(JSON)
*/
ResourceConfig?: string;
/**
* 资源配置ID
*/
ResourceConfigId?: string;
/**
* 镜像地址
*/
Image?: string;
/**
* 存储卷和挂载卷配置(JSON)
*/
Catalog?: string;
/**
* Dashboard URL / 历史记录链接
*/
HistoryUrl?: string;
/**
* 镜像拉取策略
*/
ImagePullPolicy?: string;
/**
* 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR)
*/
ImagePullType?: string;
/**
* 高级参数(规范化后的扁平 KV JSON)
*/
AdvancedOptions?: string;
/**
* 优先级(1-9,数字越大优先级越高)
*/
Priority?: number;
/**
* 启动时间(最近一次启动)
*/
StartTime?: number;
/**
* 标签列表(TagKey-TagValue)
*/
Tags?: Array;
/**
* 唯一请求 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;
}
/**
* CancelNotebookSessionStatement请求参数结构体
*/
export interface CancelNotebookSessionStatementRequest {
/**
* Session唯一标识
*/
SessionId: string;
/**
* Session Statement唯一标识
*/
StatementId: string;
}
/**
* 对指定参数的更新、增加、删除
*/
export interface Param {
/**
* 参数key,例如:
*/
ConfigItem?: string;
/**
* 参数值
*/
ConfigValue?: string;
/**
* 下发操作,支持:ADD、DELETE、MODIFY
*/
Operate?: string;
}
/**
* GPU 机型
*/
export interface GPUInfo {
/**
* 计费项
*/
BillingItem?: string;
/**
* 机型
*/
Model?: string;
/**
* cu
*/
CU?: number;
/**
* gpu 机型
*/
Type?: string;
/**
* 数量
*/
Num?: number;
/**
* 显存
*/
GPUMemory?: number;
/**
* 机型
*/
InstanceType?: string;
/**
* 售卖情况(1-缺货,2-低库存,3-充足)
*/
SaleStatus?: number;
}
/**
* GetRayClusterEvent请求参数结构体
*/
export interface GetRayClusterEventRequest {
/**
* Ray集群ID
*/
Id: string;
/**
* 当前页码(从1开始)
*/
Page?: number;
/**
* 每页数量
*/
PageSize?: number;
/**
* 开始时间(毫秒时间戳)
*/
StartTime?: number;
/**
* 结束时间(毫秒时间戳)
*/
EndTime?: number;
/**
* 排序字段列表
*/
SortFields?: Array;
/**
* 翻页上下文,首次查询不传,后续翻页传入上一次返回的 Context 值
*/
Context?: string;
}
/**
* UpdateStandardEngineResourceGroupBaseInfo请求参数结构体
*/
export interface UpdateStandardEngineResourceGroupBaseInfoRequest {
/**
* 引擎资源组名称
*/
EngineResourceGroupName: string;
/**
* 自动启动,(任务提交自动拉起资源组)0-自动启动,1-不自动启动
*/
AutoLaunch: number;
/**
* 自动挂起资源组。0-自动挂起,1-不自动挂起
*/
AutoPause: number;
/**
* 自动挂起时间,单位分钟,取值范围在1-999(在无任务AutoPauseTime后,资源组自动挂起)
*/
AutoPauseTime?: number;
/**
* 任务并发数
*/
MaxConcurrency?: number;
}
/**
* ListMlflowServerTrainingInstances返回参数结构体
*/
export interface ListMlflowServerTrainingInstancesResponse {
/**
* 返回训练实例列表
*/
Items?: Array;
/**
* 总数
*/
Total?: number;
/**
* 当前页
*/
Page?: number;
/**
* 每页大小
*/
PageSize?: number;
/**
* 总页数
*/
TotalPages?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTablePartitions请求参数结构体
*/
export interface DescribeTablePartitionsRequest {
/**
* 数据目录名称
*/
Catalog: string;
/**
* 数据库名称
*/
Database: string;
/**
* 数据表名称
*/
Table: string;
/**
* 查询偏移位置
*/
Offset: number;
/**
* 当次查询的数量限制
*/
Limit: number;
/**
* 模糊查询的分区名称
*/
FuzzyPartition?: string;
/**
* 排序信息
*/
Sorts?: Array;
/**
* 分页查询的游标信息
*/
Cursor?: string;
}
/**
* SubmitTrainingJob返回参数结构体
*/
export interface SubmitTrainingJobResponse {
/**
* 训练作业配置详情
*/
Spec?: TrainingJobSpec;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ResumeTrainingJobInstance返回参数结构体
*/
export interface ResumeTrainingJobInstanceResponse {
/**
* 训练实例详情
*/
Instance?: TrainingJobInstance;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 任务结果信息。
*/
export interface TaskResultInfo {
/**
* 任务唯一ID
*/
TaskId?: string;
/**
* 数据源名称,当前任务执行时候选中的默认数据源
*/
DatasourceConnectionName?: string;
/**
* 数据库名称,当前任务执行时候选中的默认数据库
*/
DatabaseName?: string;
/**
* 当前执行的SQL,一个任务包含一个SQL
*/
SQL?: string;
/**
* 执行任务的类型,现在分为DDL、DML、DQL
*/
SQLType?: string;
/**
* 任务当前的状态,0:初始化 1:任务运行中 2:任务执行成功 3:数据写入中 4:排队中 -1:任务执行失败 -3:用户手动终止 。只有任务执行成功的情况下,才会返回任务执行的结果
*/
State?: number;
/**
* 扫描的数据量,单位byte
*/
DataAmount?: number;
/**
* 计算耗时,单位: ms
*/
UsedTime?: number;
/**
* 任务结果输出的COS桶地址
*/
OutputPath?: string;
/**
* 任务创建时间,时间戳
*/
CreateTime?: string;
/**
* 任务执行信息,成功时返回success,失败时返回失败原因
*/
OutputMessage?: string;
/**
* 被影响的行数
*/
RowAffectInfo?: string;
/**
* 结果的schema信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ResultSchema?: Array;
/**
* 结果信息,反转义后,外层数组的每个元素为一行数据
*/
ResultSet?: string;
/**
* 分页信息,如果没有更多结果数据,nextToken为空
*/
NextToken?: string;
/**
* 任务执行进度num/100(%)
*/
Percentage?: number;
/**
* 任务进度明细
*/
ProgressDetail?: string;
/**
* 控制台展示格式。table:表格展示 text:文本展示
*/
DisplayFormat?: string;
/**
* 任务耗时,单位: ms
*/
TotalTime?: number;
/**
* 获取结果消耗的时间
*/
QueryResultTime?: number;
/**
* base64 编码结果集
*/
ResultSetEncode?: 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;
}
/**
* DeleteMlflowServer请求参数结构体
*/
export interface DeleteMlflowServerRequest {
/**
* MlFlow Server的ID
*/
ServerId?: 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;
}
/**
* UnbindWorkGroupsFromUser返回参数结构体
*/
export interface UnbindWorkGroupsFromUserResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTaskDetail请求参数结构体
*/
export interface DescribeTaskDetailRequest {
/**
* 任务id
*/
TaskInstanceId: 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;
}
/**
* CreatePartitionQueue返回参数结构体
*/
export interface CreatePartitionQueueResponse {
/**
* 新创建的资源队列ID
*/
Id?: number;
/**
* 最终生效的队列编码(含系统生成场景),与 DescribePartitionQueues 出参的 QueueName 语义一致
*/
QueueName?: string;
/**
* 队列别名(显示名)
*/
Alias?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 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;
}
/**
* DescribeStandardEngineResourceGroupConfigInfo请求参数结构体
*/
export interface DescribeStandardEngineResourceGroupConfigInfoRequest {
/**
* 排序字段
*/
SortBy?: string;
/**
* 升序,降序
*/
Sorting?: string;
/**
* 过滤条件可选,engine-resource-group-id--引擎资源组ID,engine-id---引擎ID
*/
Filters?: Array;
/**
* 数据条数,默认10
*/
Limit?: number;
/**
* 偏移量,默认0
*/
Offset?: number;
}
/**
* 表过期策略
*/
export interface TableExpirationPolicy {
/**
* 是否启用策略
*/
Enabled: boolean;
/**
* 表过期时间,单位:天
*/
Expiration: number;
}
/**
* CreateMetaDatabase请求参数结构体
*/
export interface CreateMetaDatabaseRequest {
/**
* 数据源名称,默认DataLakeCatalog
*/
DatasourceConnectionName?: string;
/**
* 元数据库基本信息
*/
MetaDatabaseInfo?: MetaDatabaseInfo;
/**
* 数据治理配置项
*/
GovernPolicy?: DataGovernPolicy;
/**
* 智能数据治理配置
*/
SmartPolicy?: SmartPolicy;
}
/**
* 自定义参数
*/
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;
/**
* Kernel id
*/
KernelId?: string;
/**
* spark app名称
*/
SparkAppName?: string;
}
/**
* SparkSQL批任务日志操作信息。
*/
export interface SparkSessionBatchLogOperate {
/**
* 操作提示
*/
Text?: string;
/**
* 操作类型:COPY、LOG、UI、RESULT、List、TAB
*/
Operate?: string;
/**
* 补充信息:如:taskid、sessionid、sparkui等
注意:此字段可能返回 null,表示取不到有效值。
*/
Supplement?: Array;
}
/**
* CreateNotebookSessionStatementSupportBatchSQL请求参数结构体
*/
export interface CreateNotebookSessionStatementSupportBatchSQLRequest {
/**
* Session唯一标识
*/
SessionId: string;
/**
* 执行的代码
*/
Code: string;
/**
* 类型,当前支持:sql
*/
Kind: string;
/**
* 是否保存运行结果
*/
SaveResult: boolean;
}
/**
* UpgradeDataEngineImage返回参数结构体
*/
export interface UpgradeDataEngineImageResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 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;
}
/**
* 服务监控指标
*/
export interface ServiceMetricsItem {
/**
* 服务 UID,服务唯一标识
*/
ServiceId?: string;
/**
* 服务显示名称
*/
ServiceName?: string;
/**
* 服务状态
*/
Status?: string;
/**
* 推理引擎
*/
Engine?: string;
/**
* 模型名称
*/
ModelName?: string;
/**
* OpenAI 兼容的模型标识符
*/
ModelIdentifier?: string;
/**
* 副本信息
*/
Replicas?: ReplicaInfo;
/**
* 监控指标数据
*/
Metrics?: MetricsData;
}
/**
* GetRayClusterPods请求参数结构体
*/
export interface GetRayClusterPodsRequest {
/**
* 集群ID
*/
Id: string;
/**
* 起始时间(毫秒时间戳)
*/
StartTime?: number;
/**
* 截止时间(毫秒时间戳)
*/
EndTime?: number;
/**
* 当前页码(从1开始)
*/
Page?: number;
/**
* 每页数量
*/
PageSize?: number;
/**
* 过滤条件列表
*/
Filters?: Array;
/**
* 排序字段列表
*/
SortFields?: Array;
}
/**
* SwitchDataEngine返回参数结构体
*/
export interface SwitchDataEngineResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteMlflowServer返回参数结构体
*/
export interface DeleteMlflowServerResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListExampleTags请求参数结构体
*/
export interface ListExampleTagsRequest {
/**
* 案例标签
*/
Category?: string;
}
/**
* DescribeLakeFsInfo请求参数结构体
*/
export type DescribeLakeFsInfoRequest = null;
/**
* DeleteDeployment请求参数结构体
*/
export interface DeleteDeploymentRequest {
/**
* DeploymentId
*/
DeploymentId: string;
}
/**
* UpdateStandardEngineResourceGroupConfigInfo返回参数结构体
*/
export interface UpdateStandardEngineResourceGroupConfigInfoResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 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;
/**
* TF 资源 ID
*/
PolicyId?: string;
}
/**
* CreateModelVersion返回参数结构体
*/
export interface CreateModelVersionResponse {
/**
* 版本ID
注意:此字段可能返回 null,表示取不到有效值。
*/
VersionId?: string;
/**
* 关联的模型ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelId?: string;
/**
* 该版本的存储 URI
注意:此字段可能返回 null,表示取不到有效值。
*/
StorageUri?: string;
/**
* 版本说明
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 创建时间(毫秒时间戳)
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: number;
/**
* 更新时间(毫秒时间戳)
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: number;
/**
* 关联的推理服务列表
注意:此字段可能返回 null,表示取不到有效值。
*/
LinkedServices?: Array;
/**
* 模型版本号
*/
Version?: string;
/**
* 是否使用用户自带存储桶(true=用户自带桶,false=平台托管)
*/
UseCustomStorage?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PauseStandardEngineResourceGroups返回参数结构体
*/
export interface PauseStandardEngineResourceGroupsResponse {
/**
* 批量操作资源组时,操作失败的资源组相关信息
注意:此字段可能返回 null,表示取不到有效值。
*/
OperateEngineResourceGroupFailMessages?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSaleRegions返回参数结构体
*/
export interface DescribeSaleRegionsResponse {
/**
* 可售卖地域列表
*/
RegionList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLabPriority返回参数结构体
*/
export interface ModifyLabPriorityResponse {
/**
* 案例模板ID(startMode=EXAMPLE 时使用)
*/
ExampleId?: string;
/**
* 代码包/工程归档地址
*/
CodeArchiveUrl?: string;
/**
* 数据实验室服务入口(服务类型 -> 访问地址)
*/
Services?: Array;
/**
* Lab 镜像地址(必填,用于开发工具如 Jupyter/VSCode/WebShell)。前端在"内置 / 自定义"两态中选择此值;当 Image 字段未显式传入时,后端会基于该字段按 R1(镜像表命中)/R2(同值 fallback)派生 Ray 集群镜像。
*/
LabImage?: string;
/**
* 集群ID
*/
Id?: string;
/**
* 资源类型:CLUSTER-普通集群;WORKSPACE-数据实验室(开发入口)
*/
Type?: string;
/**
* 集群名称
*/
Name?: string;
/**
* 集群描述
*/
Description?: string;
/**
* 所属资源分区ID
*/
ResourcePartitionId?: string;
/**
* 默认资源分区名称
*/
ResourcePartitionName?: string;
/**
* 所属队列名称
*/
Queue?: string;
/**
* 应用ID
*/
AppId?: number;
/**
* 用户UIN
*/
Uin?: string;
/**
* 子用户UIN
*/
SubAccountUin?: string;
/**
* 集群状态
*/
Status?: string;
/**
* 状态详情/错误信息
*/
StatusMessage?: string;
/**
* 创建时间
*/
CreateTime?: number;
/**
* 所属集群组名称
*/
GroupName?: string;
/**
* 计算组 ID
*/
GroupId?: string;
/**
* 资源配置(JSON)
*/
ResourceConfig?: string;
/**
* 资源配置ID
*/
ResourceConfigId?: string;
/**
* Ray 集群镜像地址(可选,OpenAPI/SDK 高级控制入口)。前端不再传递此字段;为空时后端按 R1(镜像表查询命中)→ R2(同值 fallback)顺序自动派生。非空时直接作为 Ray 集群镜像,跳过派生(EXPLICIT),且后端不校验其与 LabImage 的兼容性。
*/
Image?: string;
/**
* 存储卷和挂载卷配置(JSON)
*/
Catalog?: string;
/**
* Dashboard URL / 历史记录链接
*/
HistoryUrl?: string;
/**
* 镜像拉取策略
*/
ImagePullPolicy?: string;
/**
* 高级参数(扁平 Key-Value 的 JSON 字符串),Key 以 spec. 开头,按 RayCluster CRD 下钻;详见 ADVANCED_CLUSTER_OPTIONS_DESIGN.md
*/
AdvancedOptions?: string;
/**
* 优先级(1-9,数字越大优先级越高)
*/
Priority?: number;
/**
* 启动时间(最近一次启动)
*/
StartTime?: number;
/**
* 停止时间(最近一次停止/休眠)
*/
StopTime?: number;
/**
* 标签列表(TagKey-TagValue)
*/
Tags?: Array;
/**
* 持久化工作目录配置(可选)。启用后将 COS/CFS 指定路径挂载到容器内 /workspace 工作目录,与现有 Catalog 的卷配置互斥(不允许同时在 Catalog 中显式声明 MountPath=/workspace)。
*/
PersistentWorkDir?: PersistentWorkDir;
/**
* 是否开启token认证
*/
EnableToken?: boolean;
/**
* Lab sidecar 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR)
*/
LabImagePullType?: string;
/**
* 子用户名称(由聚合层通过 CAM 接口回填)
*/
SubAccountName?: string;
/**
* 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR)
*/
ImagePullType?: string;
/**
* 唯一请求 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;
}
/**
* 资源用量信息,描述某种资源类型的用量范围
*/
export interface ResourceUsage {
/**
* 资源规格
*/
ResourceSpec?: ResourceSpec;
/**
* 最小用量
*/
Min?: number;
/**
* 最大用量
*/
Max?: number;
}
/**
* DescribeUserType返回参数结构体
*/
export interface DescribeUserTypeResponse {
/**
* 用户类型。ADMIN:管理员 COMMON:普通用户
*/
UserType?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRecommendedParams返回参数结构体
*/
export interface DescribeRecommendedParamsResponse {
/**
* 推荐来源: builtin | matched | default
注意:此字段可能返回 null,表示取不到有效值。
*/
Source?: string;
/**
* 推荐的高级参数
注意:此字段可能返回 null,表示取不到有效值。
*/
AdvancedParams?: RecommendedAdvancedParams;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryResult返回参数结构体
*/
export interface QueryResultResponse {
/**
* 任务Id
*/
TaskId?: string;
/**
* 结果数据
*/
ResultSet?: string;
/**
* schema
*/
ResultSchema?: Array;
/**
* 分页信息
*/
NextToken?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SubmitTrainingJob请求参数结构体
*/
export interface SubmitTrainingJobRequest {
/**
* 训练作业配置名称(≤255 字符)
*/
SpecName?: string;
/**
* 描述(≤1024 字符)
*/
Description?: string;
/**
* 启动命令
*/
Entrypoint?: string;
/**
* 镜像地址
*/
Image?: string;
/**
* 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR)
*/
ImagePullType?: string;
/**
* 镜像拉取策略(Always / IfNotPresent / Never)
*/
ImagePullPolicy?: string;
/**
* 代码包 COS URL
*/
CodePackageUrl?: string;
/**
* Ray runtime_env 配置 JSON(含 pip 依赖、env_vars 等,结构参见 2.1)
*/
RuntimeEnv?: string;
/**
* 资源配置模板 ID(可选)
*/
ResourceConfigId?: string;
/**
* 资源配置 JSON
*/
ResourceConfig?: string;
/**
* 资源分区 ID
*/
ResourcePartitionId?: string;
/**
* 队列名称
*/
Queue?: string;
/**
* 存储卷挂载配置 JSON(含 Source 字段标记用途)
*/
Catalog?: string;
/**
* 高级参数 JSON(不传则不更新)
*/
AdvancedOptions?: string;
/**
* 基础模型Uid
*/
BaseModelUid?: string;
/**
* 算法模式:sft / dpo / cpt / grpo(仅 POST_TRAINING 必填,CUSTOM_CODE / LAB 禁止传入)
*/
Mode?: string;
/**
* 数据集挂载列表(元素含 DatasetId 或 Catalog 二选一 + DatasetName + Eval 属性)
*/
Datasets?: Array;
/**
* Checkpoint 产出配置(POST_TRAINING 必填;CUSTOM_CODE / LAB 可选)
*/
Checkpoint?: CheckpointConfig;
/**
* 是否启用断点续训
*/
ResumeTraining?: boolean;
/**
* 调优参数(高级参数,仅 POST_TRAINING 使用;CUSTOM_CODE / LAB 禁止传入)
*/
TuningParams?: TrainingTuningParams;
/**
* 作业优先级(1-9,数字越大优先级越高)
*/
Priority?: number;
/**
* 提交来源标签:LAB / CUSTOM_CODE(可选,用于溯源,不影响处理逻辑)
*/
Kind?: string;
/**
* MlFlow 实验追踪配置(可选,不传则不启用 MlFlow)
*/
MlFlowConfig?: MlFlowConfig;
/**
* 标签列表(TagKey-TagValue),用于将任务与腾讯云标签系统中的标签绑定
*/
Tags?: Array;
/**
* 产出模型名称(用于后续模型注册,当前仅保存)
*/
OutputModelName?: string;
}
/**
* RegisterThirdPartyAccessUser返回参数结构体
*/
export interface RegisterThirdPartyAccessUserResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 环境变量标签
*/
export interface Env {
/**
* 名称
*/
Name?: string;
/**
* 值
*/
Value?: string;
}
/**
* DeleteThirdPartyAccessUser请求参数结构体
*/
export type DeleteThirdPartyAccessUserRequest = null;
/**
* DescribeTrainingJobSpec请求参数结构体
*/
export interface DescribeTrainingJobSpecRequest {
/**
* 配置 ID
*/
SpecId?: string;
}
/**
* 流程详情
*/
export interface FlowDetail {
/**
* 流程ID(数据库主键)
*/
FlowId?: number;
/**
* Temporal Workflow ID
注意:此字段可能返回 null,表示取不到有效值。
*/
WorkFlowId?: string;
/**
* 流程编码
*/
WorkFlowCode?: string;
/**
* 流程进度,0~100
*/
Progress?: number;
/**
* 流程状态
*/
Status?: number;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 流程活动列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Activities?: Array;
}
/**
* DescribePartitions返回参数结构体
*/
export interface DescribePartitionsResponse {
/**
* 资源包列表
*/
Partitions?: Array;
/**
* 总记录数
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetRayClusterYaml请求参数结构体
*/
export interface GetRayClusterYamlRequest {
/**
* 集群ID
*/
Id: string;
}
/**
* 文本格式
*/
export interface TextFile {
/**
* 文本类型,本参数取值为TextFile。
*/
Format?: string;
/**
* 处理文本用的正则表达式。
*/
Regex?: string;
}
/**
* DescribeModelTaskOptions返回参数结构体
*/
export interface DescribeModelTaskOptionsResponse {
/**
* 各模型类型对应的可选任务列表
*/
TaskOptions?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteUser返回参数结构体
*/
export interface DeleteUserResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateUserRole请求参数结构体
*/
export interface CreateUserRoleRequest {
/**
* 角色Arn信息
*/
Arn: string;
/**
* 角色描述信息
*/
Desc: string;
/**
* 角色名称
*/
Name?: string;
/**
* cos授权路径列表
*/
CosPermissionList?: Array;
/**
* cam策略json
*/
PermissionJson?: string;
/**
* 是否设置为常驻:1非常驻(默认)、2常驻(仅能设置一个常驻)
*/
IsDefault?: number;
}
/**
* RestartInferenceService请求参数结构体
*/
export interface RestartInferenceServiceRequest {
/**
* 推理服务ID
*/
ServiceId: 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;
}
/**
* DescribeForbiddenTablePro请求参数结构体
*/
export type DescribeForbiddenTableProRequest = null;
/**
* CreateDataEngine返回参数结构体
*/
export interface CreateDataEngineResponse {
/**
* 虚拟引擎id
*/
DataEngineId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetRayJobPodYaml请求参数结构体
*/
export interface GetRayJobPodYamlRequest {
/**
* 任务ID
*/
Id?: string;
/**
* Pod名称
*/
PodName?: string;
}
/**
* AssociateDatasourceHouse返回参数结构体
*/
export interface AssociateDatasourceHouseResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDataEngine请求参数结构体
*/
export interface DescribeDataEngineRequest {
/**
* House名称
*/
DataEngineName: string;
}
/**
* CreateNotebookSession请求参数结构体
*/
export interface CreateNotebookSessionRequest {
/**
* Session名称
*/
Name: string;
/**
* 类型,当前支持:spark、pyspark、sparkr、sql
*/
Kind: string;
/**
* DLC Spark作业引擎名称
*/
DataEngineName: string;
/**
* session文件地址,当前支持:cosn://和lakefs://两种路径
*/
ProgramDependentFiles?: Array;
/**
* 依赖的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;
}
/**
* 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;
}
/**
* QueryDashboardServiceList返回参数结构体
*/
export interface QueryDashboardServiceListResponse {
/**
* 匹配过滤条件的服务总数
*/
Total?: number;
/**
* 当前页码
*/
Page?: number;
/**
* 每页数量
*/
PageSize?: number;
/**
* 总页数
*/
TotalPages?: number;
/**
* 服务监控指标列表
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNotebookSession请求参数结构体
*/
export interface DescribeNotebookSessionRequest {
/**
* Session唯一标识
*/
SessionId: string;
}
/**
* CreateTrainingJobInstance返回参数结构体
*/
export interface CreateTrainingJobInstanceResponse {
/**
* 训练实例详情配置
*/
Instance?: TrainingJobInstance;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 训练作业实例详情
*/
export interface TrainingJobInstance {
/**
* 实例 ID(即 RayJob UUID)
*/
InstanceId?: string;
/**
* 关联配置 ID
*/
SpecId?: string;
/**
* 配置名称
*/
SpecName?: string;
/**
* 作业优先级(1-9,数字越大优先级越高)
*/
Priority?: number;
/**
* 综合状态
*/
Status?: string;
/**
* 错误信息
*/
ErrorMessage?: string;
/**
* RayJob 实际启动时间(毫秒)
*/
JobCreateTime?: number;
/**
* RayJob 运行时长(毫秒)
*/
JobRunningTime?: number;
/**
* Ray Dashboard History 链接
*/
HistoryUrl?: string;
/**
* 创建人
*/
Creator?: string;
/**
* 创建时间(毫秒时间戳)
*/
CreateTime?: number;
/**
* 资源分区 ID
*/
ResourcePartitionId?: string;
/**
* 资源分区名称
*/
ResourcePartitionName?: string;
/**
* 队列名称
*/
Queue?: string;
/**
* 所属队列别名
*/
QueueAlias?: string;
/**
* 提交时 runtime_env JSON
*/
RuntimeEnv?: string;
/**
* 提交时 entrypoint
*/
Entrypoint?: string;
/**
* 提交时镜像
*/
Image?: string;
/**
* 提交时资源配置 JSON
*/
ResourceConfig?: string;
/**
* 提交时存储卷挂载配置 JSON
*/
Catalog?: string;
/**
* 提交时高级参数 JSON
*/
AdvancedOptions?: string;
/**
* 训练子类型快照(LAB / CUSTOM_CODE / POST_TRAINING)
*/
Kind?: string;
/**
* 提交时代码包 URL
*/
CodePackageUrl?: string;
/**
* 提交时 MLflow 配置 JSON
*/
MlFlowConfig?: string;
/**
* Checkpoint 挂载摘要(实例级)
*/
CheckpointMountInfo?: CheckpointMountInfo;
/**
* 训练方式(sft / dpo / cpt / grpo),仅 POST_TRAINING 有值
*/
Mode?: string;
/**
* 基础模型 modelUid(仅 POST_TRAINING 有值,用于关联推理模型仓库)
*/
BaseModelUid?: string;
/**
* 基础模型名称(仅 POST_TRAINING 有值)
*/
BaseModelName?: string;
/**
* 标签列表(TagKey-TagValue)
*/
Tags?: Array;
/**
* 创建实例时的数据集挂载列表快照(List<DatasetMount>,仅详情返回)
*/
Datasets?: Array;
/**
* 创建实例时的 Checkpoint 产出配置快照(仅详情返回)
*/
Checkpoint?: CheckpointConfig;
/**
* 创建实例时的调优参数快照(仅 POST_TRAINING,仅详情返回)
*/
TuningParams?: TrainingTuningParams;
/**
* 创建实例时的断点续训意图声明快照(仅详情返回)
*/
ResumeTraining?: boolean;
}
/**
* ListTkeCosBuckets返回参数结构体
*/
export interface ListTkeCosBucketsResponse {
/**
* cos 桶列表
*/
Buckets?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CSV类型数据格式
*/
export interface CSV {
/**
* 压缩格式,["Snappy", "Gzip", "None"选一]。
*/
CodeCompress?: string;
/**
* CSV序列化及反序列化数据结构。
*/
CSVSerde?: CSVSerde;
/**
* 标题行,默认为0。
*/
HeadLines?: number;
/**
* 格式,默认值为CSV
*/
Format?: string;
}
/**
* DescribeTrainingJobInstance请求参数结构体
*/
export interface DescribeTrainingJobInstanceRequest {
/**
* 训练实例ID
*/
InstanceId: string;
}
/**
* GetRayClusterPodYaml请求参数结构体
*/
export interface GetRayClusterPodYamlRequest {
/**
* 集群ID
*/
Id: string;
/**
* Pod名称
*/
PodName?: string;
}
/**
* DropDMSPartitions返回参数结构体
*/
export interface DropDMSPartitionsResponse {
/**
* 状态
*/
Status?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteBenchmarkTask请求参数结构体
*/
export interface DeleteBenchmarkTaskRequest {
/**
* 评测任务ID
*/
TaskId: 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;
}
/**
* TCHouseP 结构
*/
export interface TCHousePInfo {
/**
* 实例id
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: string;
/**
* 实例名称
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceName?: string;
/**
* JdbcUrl
注意:此字段可能返回 null,表示取不到有效值。
*/
JdbcUrl?: string;
/**
* 用户名
注意:此字段可能返回 null,表示取不到有效值。
*/
User?: string;
/**
* 密码
注意:此字段可能返回 null,表示取不到有效值。
*/
Password?: string;
/**
* 地址
注意:此字段可能返回 null,表示取不到有效值。
*/
Location?: DatasourceConnectionLocation;
/**
* 数据库名称
注意:此字段可能返回 null,表示取不到有效值。
*/
DbName?: string;
/**
* 地址信息
注意:此字段可能返回 null,表示取不到有效值。
*/
AccessInfo?: string;
}
/**
* UpdateDeployment请求参数结构体
*/
export interface UpdateDeploymentRequest {
/**
* DeploymentId
*/
DeploymentId: string;
/**
* 模型版本(如 v1, v2),未提供时保持当前版本
*/
ModelVersion?: string;
/**
* 推理引擎(vllm)
*/
Engine?: string;
/**
* 副本数
*/
Replicas?: number;
/**
* 是否启用弹性伸缩
*/
AutoscalingEnabled?: boolean;
}
/**
* 部署的资源规格
*/
export interface DeploymentResourceInfo {
/**
* 部署业务唯一标识(deploymentUid)
*/
DeploymentId?: string;
/**
* 部署名称
*/
DeploymentName?: string;
/**
* 部署状态
*/
Status?: string;
/**
* Worker 节点 BillingItem
*/
WorkerBillingItem?: string;
/**
* Worker 节点规格倍数
*/
WorkerSpec?: number;
/**
* Worker 节点资源类型,枚举: • GU — GPU 计费单位 • CU — CPU 计费单位
*/
WorkerResourceType?: string;
/**
* Head 节点 BillingItem
*/
HeadBillingItem?: string;
/**
* Head 节点规格倍数
*/
HeadSpec?: number;
/**
* Head 节点资源类型。当前实现恒为 CU
*/
HeadResourceType?: string;
/**
* GPU 型号。CPU 部署或型号未知时为空串 ""
*/
GpuType?: string;
/**
* 期望副本数
*/
Replicas?: number;
}
/**
* CreateExportTask返回参数结构体
*/
export interface CreateExportTaskResponse {
/**
* 任务id
*/
TaskId: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddUsersToWorkGroup请求参数结构体
*/
export interface AddUsersToWorkGroupRequest {
/**
* 要操作的工作组和用户信息
*/
AddInfo: UserIdSetOfWorkGroupId;
}
/**
* CreateDataMaskStrategy请求参数结构体
*/
export interface CreateDataMaskStrategyRequest {
/**
* 数据脱敏策略详情
*/
Strategy?: DataMaskStrategyInfo;
}
/**
* UpdateUDFPolicy返回参数结构体
*/
export interface UpdateUDFPolicyResponse {
/**
* UDF权限信息
*/
UDFPolicyInfos?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAdvancedStoreLocation请求参数结构体
*/
export interface ModifyAdvancedStoreLocationRequest {
/**
* 查询结果保存cos路径
*/
StoreLocation: string;
/**
* 是否启用高级设置:0-否,1-是
*/
Enable: number;
}
/**
* DescribeNotebookSessionLog请求参数结构体
*/
export interface DescribeNotebookSessionLogRequest {
/**
* Session唯一标识
*/
SessionId: string;
/**
* 分页参数,默认200
*/
Limit?: number;
/**
* 分页参数,默认0
*/
Offset?: number;
}
/**
* DeleteClusterGroup返回参数结构体
*/
export interface DeleteClusterGroupResponse {
/**
* 集群组 ID(系统生成)
*/
Id?: string;
/**
* 集群组名称(同一 AppId 下唯一)
*/
Name?: string;
/**
* 集群组描述
*/
Description?: string;
/**
* 集群组配置
注意:此字段可能返回 null,表示取不到有效值。
*/
Config?: string;
/**
* 应用 ID(多租户)
*/
AppId?: number;
/**
* 创建者主账号 UIN
*/
Uin?: string;
/**
* 创建者子账号 UIN
*/
SubAccountUin?: string;
/**
* 创建时间
*/
CreateTime?: number;
/**
* 更新时间
*/
UpdateTime?: number;
/**
* 是否已软删除(false=活跃, true=已删除)
注意:此字段可能返回 null,表示取不到有效值。
*/
Deleted?: boolean;
/**
* 删除时间(软删时写入,活跃记录为 null)
注意:此字段可能返回 null,表示取不到有效值。
*/
DeleteTime?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetOptimizerPolicy请求参数结构体
*/
export interface GetOptimizerPolicyRequest {
/**
* 策略描述
*/
SmartPolicy: SmartPolicy;
}
/**
* GetModelReadme请求参数结构体
*/
export interface GetModelReadmeRequest {
/**
* 模型UID
*/
ModelUid: string;
/**
* 模型版本
*/
ModelVersion?: string;
}
/**
* GetRayJobHistory返回参数结构体
*/
export interface GetRayJobHistoryResponse {
/**
* 总记录数
*/
Total?: number;
/**
* 当前页码(从1开始)
*/
Page?: number;
/**
* 页数
*/
PageSize?: number;
/**
* 总页数
*/
TotalPages?: number;
/**
* 作业状态历史列表
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 引擎配置
*/
export interface DataEngineConfigPair {
/**
* 配置项
*/
ConfigItem: string;
/**
* 配置值
*/
ConfigValue: string;
}
/**
* 合并策略sort类型的规则定义
*/
export interface SortOrder {
/**
* sort的数据表列名称
*/
Column?: string;
/**
* 按照升序或者降序进行排序
*/
SortDirection?: string;
/**
* null值放在开头或者末尾
*/
NullOrder?: string;
}
/**
* GetLabDetail返回参数结构体
*/
export interface GetLabDetailResponse {
/**
* 案例模板ID(startMode=EXAMPLE 时使用)
*/
ExampleId?: string;
/**
* 代码包/工程归档地址
*/
CodeArchiveUrl?: string;
/**
* 数据实验室服务入口(服务类型 -> 访问地址)
*/
Services?: Array;
/**
* 集群ID
*/
Id?: string;
/**
* 资源类型:CLUSTER-普通集群;WORKSPACE-数据实验室(开发入口)
*/
Type?: string;
/**
* 集群名称
*/
Name?: string;
/**
* 集群描述
*/
Description?: string;
/**
* 所属资源分区ID
*/
ResourcePartitionId?: string;
/**
* 默认资源分区名称
*/
ResourcePartitionName?: string;
/**
* 所属队列名称
*/
Queue?: string;
/**
* 所属队列别名
*/
QueueAlias?: string;
/**
* 应用ID
*/
AppId?: number;
/**
* 用户UIN
*/
Uin?: string;
/**
* 子用户UIN
*/
SubAccountUin?: string;
/**
* 集群状态
*/
Status?: string;
/**
* 状态详情/错误信息
*/
StatusMessage?: string;
/**
* 资源配置(JSON)
*/
ResourceConfig?: string;
/**
* 资源配置ID
*/
ResourceConfigId?: string;
/**
* Ray 集群镜像地址(可选,OpenAPI/SDK 高级控制入口)。前端不再传递此字段;为空时后端按 R1(镜像表查询命中)→ R2(同值 fallback)顺序自动派生。非空时直接作为 Ray 集群镜像,跳过派生(EXPLICIT),且后端不校验其与 LabImage 的兼容性。
*/
Image?: string;
/**
* 存储卷和挂载卷配置(JSON)
*/
Catalog?: string;
/**
* Dashboard URL / 历史记录链接
*/
HistoryUrl?: string;
/**
* 镜像拉取策略
*/
ImagePullPolicy?: string;
/**
* 高级参数(扁平 Key-Value 的 JSON 字符串),Key 以 spec. 开头,按 RayCluster CRD 下钻;详见 ADVANCED_CLUSTER_OPTIONS_DESIGN.md
*/
AdvancedOptions?: string;
/**
* 优先级(1-9,数字越大优先级越高)
*/
Priority?: number;
/**
* 启动时间(最近一次启动)
*/
StartTime?: number;
/**
* 停止时间(最近一次停止/休眠)
*/
StopTime?: number;
/**
* 删除时间
*/
DeleteTime?: number;
/**
* 标签列表(TagKey-TagValue)
*/
Tags?: Array;
/**
* 持久化工作目录配置(可选)。启用后将 COS/CFS 指定路径挂载到容器内 /workspace 工作目录,与现有 Catalog 的卷配置互斥(不允许同时在 Catalog 中显式声明 MountPath=/workspace)。
*/
PersistentWorkDir?: PersistentWorkDir;
/**
* 是否开启token认证
*/
EnableToken?: boolean;
/**
* Lab sidecar 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR)
*/
LabImagePullType?: string;
/**
* 子用户名称(由聚合层通过 CAM 接口回填)
*/
SubAccountName?: string;
/**
* 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR)
*/
ImagePullType?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数据实验室事件项
*/
export interface EventItem {
/**
* 事件时间(Unix 时间戳,毫秒)
*/
EventTime?: number;
/**
* 组件名称,来源于 event.involvedObject.kind
*/
Component?: string;
/**
* 事件级别,来源于 event.type 的原始值(如 Normal、Warning)
*/
Level?: string;
/**
* 事件内容,来源于 event.message
*/
Message?: string;
/**
* 关联的 K8s 对象名称,来源于 event.involvedObject.name
*/
InvolvedObjectName?: string;
/**
* 事件来源组件,来源于 event.source.component
*/
SourceComponent?: string;
/**
* 事件原因,来源于 event.reason
*/
Reason?: string;
}
/**
* SuspendResumeDataEngine返回参数结构体
*/
export interface SuspendResumeDataEngineResponse {
/**
* 虚拟集群详细信息
*/
DataEngineName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyUser请求参数结构体
*/
export interface ModifyUserRequest {
/**
* 用户Id,和CAM侧Uin匹配
*/
UserId: string;
/**
* 用户描述
*/
UserDescription: string;
/**
* 用户来源类型TencentAccount(普通腾讯云用户) / EntraAccount(微软用户)
*/
AccountType?: 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;
}
/**
* MlFlow Server Pod 信息
*/
export interface PodItem {
/**
* Pod 名称
*/
PodName?: string;
/**
* 命名空间
*/
Namespace?: string;
/**
* K8s Pod Phase
*/
Phase?: string;
/**
* 计算后的状态
*/
Status?: string;
/**
* Pod IP
*/
PodIp?: string;
/**
* 调度节点名
*/
NodeName?: string;
/**
* 容器镜像
*/
Image?: string;
/**
* CPU 请求
*/
CpuRequest?: string;
/**
* CPU 限制
*/
CpuLimit?: string;
/**
* 内存请求
*/
MemoryRequest?: string;
/**
* 内存限制
*/
MemoryLimit?: string;
/**
* 创建时间(epoch millis)
*/
CreateTime?: number;
/**
* 启动时间(epoch millis)
*/
StartTime?: number;
}
/**
* Smart Optimizer高级参数配置数据结构
*/
export interface WrittenAdvancePolicy {
/**
* 是否启用合并
*/
CompactEnable?: string;
/**
* 是否启用历史数据清理
*/
DeleteEnable?: string;
/**
* 合并最新文件数量
*/
MinInputFiles?: number;
/**
* 合并文件目录文件大小
*/
TargetFileSizeBytes?: number;
/**
* 保留过期时间的快照数量
*/
RetainLast?: number;
/**
* 快照过期时间
*/
BeforeDays?: number;
/**
* 快照过期执行周期
*/
ExpiredSnapshotsIntervalMin?: number;
/**
* 移除孤立文件执行周期
*/
RemoveOrphanIntervalMin?: number;
/**
* 是否开启COW表合并
*/
CowCompactEnable?: string;
/**
* 文件合并策略
*/
CompactStrategy?: string;
/**
* sort合并策略的规则定义
注意:此字段可能返回 null,表示取不到有效值。
*/
SortOrders?: Array;
}
/**
* DescribeTCLakeMetaInstance请求参数结构体
*/
export type DescribeTCLakeMetaInstanceRequest = null;
/**
* 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 SchedulableLimit {
/**
* 四层计费项,与 ResourceQuota[].ResourceSpec.BillingItem 同值
*/
BillingItem?: string;
/**
* 该计费项下单 worker/executor 可申请的最大可调度资源量,单位随计费项资源类型:CPU 计费项为 CU 数,GPU 计费项为 GU(卡)数
*/
MaxSchedulableUnits?: number;
}
/**
* EMR-TKE 集群资源用量
*/
export interface EmrResourceUsage {
/**
* CPU 用量,例如 2core
*/
Cpu?: string;
/**
* 内存用量,例如 4GB
*/
Mem?: string;
}
/**
* CreateNotebookSessionStatement返回参数结构体
*/
export interface CreateNotebookSessionStatementResponse {
/**
* Session Statement详情
*/
NotebookSessionStatement?: NotebookSessionStatementInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMlflowServerPods返回参数结构体
*/
export interface DescribeMlflowServerPodsResponse {
/**
* MlFlowServer的Pod列表,实际上只有1个POD
*/
Items?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GenerateInternalTable返回参数结构体
*/
export interface GenerateInternalTableResponse {
/**
* 返回sql
*/
Execution?: Execution;
/**
* 是否tciceberg
*/
IsTIcebergSql?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListTkeCosBuckets请求参数结构体
*/
export interface ListTkeCosBucketsRequest {
/**
* cos 桶名字
*/
BucketName?: string;
/**
* 分页 Limit
*/
Limit?: number;
/**
* 分页 Offset
*/
Offset?: number;
}
/**
* CheckApiKeyName请求参数结构体
*/
export interface CheckApiKeyNameRequest {
/**
* apiKey名称
*/
Name: string;
}
/**
* RestartDeployment返回参数结构体
*/
export interface RestartDeploymentResponse {
/**
* DeploymentId
注意:此字段可能返回 null,表示取不到有效值。
*/
DeploymentId?: string;
/**
* 部署名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* 关联的服务ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceId?: string;
/**
* 部署使用的模型版本号
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelVersion?: string;
/**
* 部署状态(Running/Stopped/Deploying/Failed)
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: string;
/**
* 推理引擎(vLLM/SGLang 等)
注意:此字段可能返回 null,表示取不到有效值。
*/
Engine?: string;
/**
* 期望副本数
注意:此字段可能返回 null,表示取不到有效值。
*/
Replicas?: number;
/**
* 可用副本数
注意:此字段可能返回 null,表示取不到有效值。
*/
AvailableReplicas?: number;
/**
* 资源配置(JSON 字符串)
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceConfig?: string;
/**
* 高级参数(JSON 字符串)
注意:此字段可能返回 null,表示取不到有效值。
*/
AdvancedParams?: string;
/**
* 是否开启自动伸缩
注意:此字段可能返回 null,表示取不到有效值。
*/
AutoscalingEnabled?: boolean;
/**
* 最小副本数(自动伸缩时使用)
注意:此字段可能返回 null,表示取不到有效值。
*/
MinReplicas?: number;
/**
* 最大副本数(自动伸缩时使用)
注意:此字段可能返回 null,表示取不到有效值。
*/
MaxReplicas?: number;
/**
* 模型存储配置(Catalog JSON,记录模型 COS 挂载信息)
注意:此字段可能返回 null,表示取不到有效值。
*/
ModelStorageConfig?: string;
/**
* AppId
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId?: number;
/**
* Uin
注意:此字段可能返回 null,表示取不到有效值。
*/
Uin?: string;
/**
* 创建时间(毫秒时间戳)
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: number;
/**
* 更新时间(毫秒时间戳)
注意:此字段可能返回 null,表示取不到有效值。
*/
UpdateTime?: number;
/**
* Neutrino Serve ID (RayService CR name)
注意:此字段可能返回 null,表示取不到有效值。
*/
NeutrinoServeId?: string;
/**
* 资源分区 ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourcePartitionId?: string;
/**
* 资源队列名称
注意:此字段可能返回 null,表示取不到有效值。
*/
Queue?: string;
/**
* SubAccountUin
*/
SubAccountUin?: string;
/**
* ray head 是否开启高可用
*/
HeadHighAvailabilityEnabled?: boolean;
/**
* 镜像名称
*/
Image?: string;
/**
* 资源分区名称
*/
ResourcePartitionName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMlflowServer返回参数结构体
*/
export interface DescribeMlflowServerResponse {
/**
* MlFlowServer的详情
*/
MlFlowServer?: MlFlowServerInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterMonitorInfos返回参数结构体
*/
export interface DescribeClusterMonitorInfosResponse {
/**
* 集群监控信息列表
*/
Info?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetRayJobPods返回参数结构体
*/
export interface GetRayJobPodsResponse {
/**
* 总记录数
*/
Total?: number;
/**
* 当前页码(从1开始)
*/
Page?: number;
/**
* 页数
*/
PageSize?: number;
/**
* 总页数
*/
TotalPages?: number;
/**
* 作业pod列表
*/
Items?: Array;
/**
* 唯一请求 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;
}
/**
* 运行中部署的 GPU 资源汇总
*/
export interface GpuSummaryItem {
/**
* GPU 型号
注意:此字段可能返回 null,表示取不到有效值。
*/
GpuType?: string;
/**
* GPU 总数(gpuNum × replicas)
注意:此字段可能返回 null,表示取不到有效值。
*/
GpuCount?: number;
/**
* 运行中的副本数
注意:此字段可能返回 null,表示取不到有效值。
*/
Replicas?: number;
}
/**
* worker组规格
*/
export interface WorkerSpecDTO {
/**
* worker名称
*/
Name?: string;
/**
* Pod CPU核数
*/
PodCpu?: number;
/**
* Pod 内存大小
*/
PodMem?: number;
/**
* GPU类型
*/
GpuType?: string;
/**
* GPU数量
*/
GpuNum?: number;
/**
* 环境变量列表
*/
Envs?: Array;
/**
* 标签列表
*/
Labels?: Array