2 Star 9 Fork 6

tencentcloud/tencentcloud-sdk-nodejs

加入 Gitee
与超过 1400万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
oceanus_client.ts 17.13 KB
一键复制 编辑 原始数据 按行查看 历史
tencentcloud 提交于 2026-03-30 19:48 +08:00 . release 4.1.202
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644
/* eslint-disable @typescript-eslint/no-unused-vars */
/*
* Copyright (c) 2018 Tencent. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { AbstractClient } from "../../../common/abstract_client"
import { ClientConfig } from "../../../common/interface"
import {
ParseConnectorRequest,
CopyJobResult,
CreateResourceRequest,
ModifyFolderRequest,
DescribeJobSubmissionLogResponse,
DeleteJobsRequest,
ModifyWorkSpaceRequest,
ModifyJobResponse,
CreateJobConfigResponse,
CreateResourceConfigResponse,
CreateJobConfigRequest,
ClusterVersion,
DescribeTreeJobsResponse,
CopyJobsRequest,
CopyJobsResponse,
CreateConnectorResponse,
TriggerJobSavepointRequest,
LogContent,
JobRuntimeInfo,
JobEventInfo,
ResourceLocParam,
NodeConfig,
WorkSpaceSetItem,
DescribeJobConfigsRequest,
ResultColumn,
Setats,
TreeJobSets,
ResourceItem,
RefJobStatusCountItem,
RunSqlGatewayStatementRequest,
DescribeFolderResponse,
ModifyConnectorRequest,
SetatsDisk,
ResourceLoc,
CCN,
DescribeWorkSpacesRequest,
ResourceRefJobInfo,
LogicalType,
DescribeTreeResourcesRequest,
DescribeResourceConfigsResponse,
DescribeClustersRequest,
CreateWorkSpaceResponse,
SlaveZone,
CreateJobResponse,
SqlGatewayItem,
DescribeVariablesRequest,
DescribeJobRuntimeInfoResponse,
StopJobDescription,
CreateFolderRequest,
DeleteJobConfigsResponse,
DeleteTableConfigRequest,
StatementResult,
DescribeTreeJobsRsp,
DeleteResourcesResponse,
DeleteTableConfigResponse,
SlotSharingGroupSpec,
Tag,
GetMetaTableResponse,
FetchSqlGatewayStatementResultResponse,
DescribeJobSavepointResponse,
JobGraphNode,
CreateWorkSpaceRequest,
DeleteResourceConfigsRequest,
DescribeVariablesResponse,
DeleteFoldersRequest,
DeleteWorkSpaceRequest,
DescribeJobRuntimeInfoRequest,
DescribeWorkSpacesResponse,
GatewayRefItem,
CreateResourceResponse,
ResourceRefLatest,
DescribeSystemResourcesRequest,
CreateFolderResponse,
DescribeResourcesResponse,
RunJobDescription,
DescribeResourceRelatedJobsResponse,
Connectors,
DescribeClustersResponse,
CheckConnectorNameResponse,
ResourceRef,
DescribeSystemResourcesResponse,
ClazzLevel,
SubEks,
WorkSpaceClusterItem,
CheckSavepointRequest,
DeleteJobConfigsRequest,
StopJobsRequest,
TraceModeConfiguration,
RunJobsRequest,
DeleteWorkSpaceResponse,
HadoopYarnItem,
TriggerJobSavepointResponse,
VariableItem,
DeleteJobsResponse,
Property,
JobGraphEdge,
Savepoint,
SystemResourceItem,
DescribeResourceRelatedJobsRequest,
ResourceConfigItem,
RoleAuth,
DescribeTreeResourcesRsp,
ResourceRefDetail,
SetatsCvmInfo,
TreeResourceItem,
ExpertModeConfiguration,
CreateVariableResponse,
Filter,
DeleteResourcesRequest,
RunJobsResponse,
ClusterGroupSetItem,
DescribeJobSavepointRequest,
ModifyJobRequest,
GetMetaTableRequest,
ResultData,
DeleteResourceConfigsResponse,
Cluster,
CreateVariableRequest,
JobGraph,
DescribeJobSubmissionLogRequest,
DescribeJobsRequest,
JobV1,
JobConfig,
DescribeResourceConfigsRequest,
ModifyFolderResponse,
SlotSharingGroup,
ModifyWorkSpaceResponse,
RunSqlGatewayStatementResponse,
CreateJobRequest,
JobInstanceForSubmissionLog,
DescribeFolderRequest,
Warehouse,
DeleteFoldersResponse,
SubFolderInfo,
ClusterSession,
ParseConnectorResponse,
CreateResourceConfigRequest,
ModifyConnectorResponse,
CheckConnectorNameRequest,
StopJobsResponse,
JobEvent,
DescribeResourcesRequest,
DescribeJobEventsRequest,
FlinkJdkVersion,
CheckSavepointResponse,
DescribeJobsResponse,
DescribeTreeResourcesResponse,
Order,
CreateConnectorRequest,
CopyJobItem,
DescribeTreeJobsRequest,
DescribeJobConfigsResponse,
FetchSqlGatewayStatementResultRequest,
SessionClusterRefItem,
DescribeJobEventsResponse,
} from "./oceanus_models"
/**
* oceanus client
* @class
*/
export class Client extends AbstractClient {
constructor(clientConfig: ClientConfig) {
super("oceanus.tencentcloudapi.com", "2019-04-22", clientConfig)
}
/**
* 生成树状作业显示结构
*/
async DescribeTreeJobs(
req: DescribeTreeJobsRequest,
cb?: (error: string, rep: DescribeTreeJobsResponse) => void
): Promise<DescribeTreeJobsResponse> {
return this.request("DescribeTreeJobs", req, cb)
}
/**
* 查询树状结构资源列表
*/
async DescribeTreeResources(
req: DescribeTreeResourcesRequest,
cb?: (error: string, rep: DescribeTreeResourcesResponse) => void
): Promise<DescribeTreeResourcesResponse> {
return this.request("DescribeTreeResources", req, cb)
}
/**
* 单条和批量复制作业
*/
async CopyJobs(
req: CopyJobsRequest,
cb?: (error: string, rep: CopyJobsResponse) => void
): Promise<CopyJobsResponse> {
return this.request("CopyJobs", req, cb)
}
/**
* 通过Sql gateway执行satement
*/
async RunSqlGatewayStatement(
req: RunSqlGatewayStatementRequest,
cb?: (error: string, rep: RunSqlGatewayStatementResponse) => void
): Promise<RunSqlGatewayStatementResponse> {
return this.request("RunSqlGatewayStatement", req, cb)
}
/**
* 删除资源版本
*/
async DeleteResourceConfigs(
req: DeleteResourceConfigsRequest,
cb?: (error: string, rep: DeleteResourceConfigsResponse) => void
): Promise<DeleteResourceConfigsResponse> {
return this.request("DeleteResourceConfigs", req, cb)
}
/**
* 创建工作空间
*/
async CreateWorkSpace(
req: CreateWorkSpaceRequest,
cb?: (error: string, rep: CreateWorkSpaceResponse) => void
): Promise<CreateWorkSpaceResponse> {
return this.request("CreateWorkSpace", req, cb)
}
/**
* 创建资源配置接口
*/
async CreateResourceConfig(
req: CreateResourceConfigRequest,
cb?: (error: string, rep: CreateResourceConfigResponse) => void
): Promise<CreateResourceConfigResponse> {
return this.request("CreateResourceConfig", req, cb)
}
/**
* 删除作业表配置
*/
async DeleteTableConfig(
req: DeleteTableConfigRequest,
cb?: (error: string, rep: DeleteTableConfigResponse) => void
): Promise<DeleteTableConfigResponse> {
return this.request("DeleteTableConfig", req, cb)
}
/**
* 查询指定文件夹及其相应的子文件夹信息
*/
async DescribeFolder(
req: DescribeFolderRequest,
cb?: (error: string, rep: DescribeFolderResponse) => void
): Promise<DescribeFolderResponse> {
return this.request("DescribeFolder", req, cb)
}
/**
* 删除工作空间
*/
async DeleteWorkSpace(
req: DeleteWorkSpaceRequest,
cb?: (error: string, rep: DeleteWorkSpaceResponse) => void
): Promise<DeleteWorkSpaceResponse> {
return this.request("DeleteWorkSpace", req, cb)
}
/**
* 创建Connector
*/
async CreateConnector(
req: CreateConnectorRequest,
cb?: (error: string, rep: CreateConnectorResponse) => void
): Promise<CreateConnectorResponse> {
return this.request("CreateConnector", req, cb)
}
/**
* 自定义树状结构页面拖拽文件夹
*/
async ModifyFolder(
req: ModifyFolderRequest,
cb?: (error: string, rep: ModifyFolderResponse) => void
): Promise<ModifyFolderResponse> {
return this.request("ModifyFolder", req, cb)
}
/**
* 查找Savepoint列表
*/
async DescribeJobSavepoint(
req: DescribeJobSavepointRequest,
cb?: (error: string, rep: DescribeJobSavepointResponse) => void
): Promise<DescribeJobSavepointResponse> {
return this.request("DescribeJobSavepoint", req, cb)
}
/**
* 查询作业实例启动日志
*/
async DescribeJobSubmissionLog(
req: DescribeJobSubmissionLogRequest,
cb?: (error: string, rep: DescribeJobSubmissionLogResponse) => void
): Promise<DescribeJobSubmissionLogResponse> {
return this.request("DescribeJobSubmissionLog", req, cb)
}
/**
* 描述资源接口
*/
async DescribeResources(
req: DescribeResourcesRequest,
cb?: (error: string, rep: DescribeResourcesResponse) => void
): Promise<DescribeResourcesResponse> {
return this.request("DescribeResources", req, cb)
}
/**
* 获取作业运行时的信息
*/
async DescribeJobRuntimeInfo(
req: DescribeJobRuntimeInfoRequest,
cb?: (error: string, rep: DescribeJobRuntimeInfoResponse) => void
): Promise<DescribeJobRuntimeInfoResponse> {
return this.request("DescribeJobRuntimeInfo", req, cb)
}
/**
* 查询Sql Gateway的Statement执行结果
*/
async FetchSqlGatewayStatementResult(
req: FetchSqlGatewayStatementResultRequest,
cb?: (error: string, rep: FetchSqlGatewayStatementResultResponse) => void
): Promise<FetchSqlGatewayStatementResultResponse> {
return this.request("FetchSqlGatewayStatementResult", req, cb)
}
/**
* 批量启动或者恢复作业,批量操作数量上限20
*/
async RunJobs(
req: RunJobsRequest,
cb?: (error: string, rep: RunJobsResponse) => void
): Promise<RunJobsResponse> {
return this.request("RunJobs", req, cb)
}
/**
* 请求参数不包含 "RunningOrderIds"时,接口获取指定作业的事件,包括作业启动停止、运行失败、快照失败、作业异常等各种事件类型;请求参数不包含 "RunningOrderIds"时,接口为查询作业实例ID接口,获取作业实例
*/
async DescribeJobEvents(
req: DescribeJobEventsRequest,
cb?: (error: string, rep: DescribeJobEventsResponse) => void
): Promise<DescribeJobEventsResponse> {
return this.request("DescribeJobEvents", req, cb)
}
/**
* 描述资源配置接口
*/
async DescribeResourceConfigs(
req: DescribeResourceConfigsRequest,
cb?: (error: string, rep: DescribeResourceConfigsResponse) => void
): Promise<DescribeResourceConfigsResponse> {
return this.request("DescribeResourceConfigs", req, cb)
}
/**
* 创建变量
*/
async CreateVariable(
req: CreateVariableRequest,
cb?: (error: string, rep: CreateVariableResponse) => void
): Promise<CreateVariableResponse> {
return this.request("CreateVariable", req, cb)
}
/**
* 作业列表删除文件夹
*/
async DeleteFolders(
req: DeleteFoldersRequest,
cb?: (error: string, rep: DeleteFoldersResponse) => void
): Promise<DeleteFoldersResponse> {
return this.request("DeleteFolders", req, cb)
}
/**
* 授权工作空间列表
*/
async DescribeWorkSpaces(
req: DescribeWorkSpacesRequest,
cb?: (error: string, rep: DescribeWorkSpacesResponse) => void
): Promise<DescribeWorkSpacesResponse> {
return this.request("DescribeWorkSpaces", req, cb)
}
/**
* 新建作业接口,一个 AppId 最多允许创建1000个作业
*/
async CreateJob(
req: CreateJobRequest,
cb?: (error: string, rep: CreateJobResponse) => void
): Promise<CreateJobResponse> {
return this.request("CreateJob", req, cb)
}
/**
* 触发Savepoint
*/
async TriggerJobSavepoint(
req: TriggerJobSavepointRequest,
cb?: (error: string, rep: TriggerJobSavepointResponse) => void
): Promise<TriggerJobSavepointResponse> {
return this.request("TriggerJobSavepoint", req, cb)
}
/**
* 解析用户上传connector
*/
async ParseConnector(
req: ParseConnectorRequest,
cb?: (error: string, rep: ParseConnectorResponse) => void
): Promise<ParseConnectorResponse> {
return this.request("ParseConnector", req, cb)
}
/**
* 查询资源名是否重复
*/
async CheckConnectorName(
req: CheckConnectorNameRequest,
cb?: (error: string, rep: CheckConnectorNameResponse) => void
): Promise<CheckConnectorNameResponse> {
return this.request("CheckConnectorName", req, cb)
}
/**
* 批量删除作业接口,批量操作数量上限20
*/
async DeleteJobs(
req: DeleteJobsRequest,
cb?: (error: string, rep: DeleteJobsResponse) => void
): Promise<DeleteJobsResponse> {
return this.request("DeleteJobs", req, cb)
}
/**
* 作业列表页面新建文件夹请求
*/
async CreateFolder(
req: CreateFolderRequest,
cb?: (error: string, rep: CreateFolderResponse) => void
): Promise<CreateFolderResponse> {
return this.request("CreateFolder", req, cb)
}
/**
* 检查快照是否可用
*/
async CheckSavepoint(
req: CheckSavepointRequest,
cb?: (error: string, rep: CheckSavepointResponse) => void
): Promise<CheckSavepointResponse> {
return this.request("CheckSavepoint", req, cb)
}
/**
* 创建作业配置,一个作业最多有100个配置版本
*/
async CreateJobConfig(
req: CreateJobConfigRequest,
cb?: (error: string, rep: CreateJobConfigResponse) => void
): Promise<CreateJobConfigResponse> {
return this.request("CreateJobConfig", req, cb)
}
/**
* 查询集群
*/
async DescribeClusters(
req: DescribeClustersRequest,
cb?: (error: string, rep: DescribeClustersResponse) => void
): Promise<DescribeClustersResponse> {
return this.request("DescribeClusters", req, cb)
}
/**
* 删除作业配置
*/
async DeleteJobConfigs(
req: DeleteJobConfigsRequest,
cb?: (error: string, rep: DeleteJobConfigsResponse) => void
): Promise<DeleteJobConfigsResponse> {
return this.request("DeleteJobConfigs", req, cb)
}
/**
* 批量停止作业,批量操作数量上限为20
*/
async StopJobs(
req: StopJobsRequest,
cb?: (error: string, rep: StopJobsResponse) => void
): Promise<StopJobsResponse> {
return this.request("StopJobs", req, cb)
}
/**
* 获取资源关联作业信息
*/
async DescribeResourceRelatedJobs(
req: DescribeResourceRelatedJobsRequest,
cb?: (error: string, rep: DescribeResourceRelatedJobsResponse) => void
): Promise<DescribeResourceRelatedJobsResponse> {
return this.request("DescribeResourceRelatedJobs", req, cb)
}
/**
* 修改工作空间
*/
async ModifyWorkSpace(
req: ModifyWorkSpaceRequest,
cb?: (error: string, rep: ModifyWorkSpaceResponse) => void
): Promise<ModifyWorkSpaceResponse> {
return this.request("ModifyWorkSpace", req, cb)
}
/**
* 删除资源接口
*/
async DeleteResources(
req: DeleteResourcesRequest,
cb?: (error: string, rep: DeleteResourcesResponse) => void
): Promise<DeleteResourcesResponse> {
return this.request("DeleteResources", req, cb)
}
/**
* 变量列表展示
*/
async DescribeVariables(
req: DescribeVariablesRequest,
cb?: (error: string, rep: DescribeVariablesResponse) => void
): Promise<DescribeVariablesResponse> {
return this.request("DescribeVariables", req, cb)
}
/**
* 查询作业
*/
async DescribeJobs(
req: DescribeJobsRequest,
cb?: (error: string, rep: DescribeJobsResponse) => void
): Promise<DescribeJobsResponse> {
return this.request("DescribeJobs", req, cb)
}
/**
* 更新作业属性,仅允许以下3种操作,不支持组合操作:
(1) 更新作业名称
(2) 更新作业备注
(3) 更新作业最大并行度
变更前提:WorkerCuNum<=MaxParallelism
如果MaxParallelism变小,不重启作业,待下一次重启生效
如果MaxParallelism变大,则要求入参RestartAllowed必须为True
假设作业运行状态,则先停止作业,再启动作业,中间状态丢失
假设作业暂停状态,则将作业更改为停止状态,中间状态丢失
*/
async ModifyJob(
req: ModifyJobRequest,
cb?: (error: string, rep: ModifyJobResponse) => void
): Promise<ModifyJobResponse> {
return this.request("ModifyJob", req, cb)
}
/**
* 修改Connector
*/
async ModifyConnector(
req: ModifyConnectorRequest,
cb?: (error: string, rep: ModifyConnectorResponse) => void
): Promise<ModifyConnectorResponse> {
return this.request("ModifyConnector", req, cb)
}
/**
* 创建资源接口
*/
async CreateResource(
req: CreateResourceRequest,
cb?: (error: string, rep: CreateResourceResponse) => void
): Promise<CreateResourceResponse> {
return this.request("CreateResource", req, cb)
}
/**
* 描述系统资源接口
*/
async DescribeSystemResources(
req: DescribeSystemResourcesRequest,
cb?: (error: string, rep: DescribeSystemResourcesResponse) => void
): Promise<DescribeSystemResourcesResponse> {
return this.request("DescribeSystemResources", req, cb)
}
/**
* 查询元数据表
*/
async GetMetaTable(
req: GetMetaTableRequest,
cb?: (error: string, rep: GetMetaTableResponse) => void
): Promise<GetMetaTableResponse> {
return this.request("GetMetaTable", req, cb)
}
/**
* 查询作业配置列表,一次最多查询100个
*/
async DescribeJobConfigs(
req: DescribeJobConfigsRequest,
cb?: (error: string, rep: DescribeJobConfigsResponse) => void
): Promise<DescribeJobConfigsResponse> {
return this.request("DescribeJobConfigs", req, cb)
}
}
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs.git
git@gitee.com:tencentcloud/tencentcloud-sdk-nodejs.git
tencentcloud
tencentcloud-sdk-nodejs
tencentcloud-sdk-nodejs
master

搜索帮助