tencentcloud-sdk-nodejs 4.1.315 → 4.1.316
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/es/common/sdk_version.js +1 -1
- package/es/services/aiart/v20221229/aiart_client.js +23 -38
- package/es/services/databuddy/v20260715/databuddy_client.js +53 -35
- package/es/services/dbbrain/v20210527/dbbrain_client.js +3 -0
- package/es/services/hai/v20230812/hai_client.js +3 -0
- package/es/services/teo/v20220901/teo_client.js +6 -0
- package/es/services/trocket/v20230308/trocket_client.js +25 -4
- package/package.json +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/aiart/v20221229/aiart_client.d.ts +59 -84
- package/tencentcloud/services/aiart/v20221229/aiart_client.js +73 -108
- package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +83 -376
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +6 -6
- package/tencentcloud/services/clb/v20180317/clb_client.d.ts +1 -1
- package/tencentcloud/services/clb/v20180317/clb_models.d.ts +159 -76
- package/tencentcloud/services/csip/v20221121/csip_models.d.ts +25 -13
- package/tencentcloud/services/databuddy/v20260715/databuddy_client.d.ts +102 -78
- package/tencentcloud/services/databuddy/v20260715/databuddy_client.js +132 -96
- package/tencentcloud/services/databuddy/v20260715/databuddy_models.d.ts +721 -318
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.d.ts +5 -1
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +6 -0
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +288 -18
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +50 -42
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +31 -45
- package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +1 -1
- package/tencentcloud/services/hai/v20230812/hai_client.d.ts +5 -1
- package/tencentcloud/services/hai/v20230812/hai_client.js +6 -0
- package/tencentcloud/services/hai/v20230812/hai_models.d.ts +58 -45
- package/tencentcloud/services/iss/v20230517/iss_models.d.ts +118 -79
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +21 -16
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +0 -8
- package/tencentcloud/services/teo/v20220901/teo_client.d.ts +13 -1
- package/tencentcloud/services/teo/v20220901/teo_client.js +16 -0
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +58 -8
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +42 -39
- package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +40 -12
- package/tencentcloud/services/trocket/v20230308/trocket_client.js +55 -13
- package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +629 -172
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +206 -143
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +9 -9
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { UpdateConsoleUsersResponse, DeleteWorkflowResponse, ListConsoleUsersResponse, RemoveConsoleUsersResponse, DeleteWorkflowRequest, ListWorkflowTaskRunsRequest, CreateWorkflowRequest, CreateFileResponse, UpdateWorkflowRequest, UnbindWorkflowBundleResponse, KillWorkflowRunResponse, ListWorkflowsRequest, ListWorkflowRunsRequest, GetWorkflowTaskRunResponse, GetFileRequest, RerunWorkflowRunResponse, GetFileResponse, RerunWorkflowRunRequest, ListWorkflowsResponse, AddConsoleUsersRequest, KillWorkflowRunRequest, ListWorkflowTaskRunsResponse, AddConsoleUsersResponse, RunWorkflowRequest, GetWorkflowResponse, GetWorkflowTaskRunRequest, DeleteFileResponse, UpdateWorkflowResponse, GetWorkflowRequest, CreateFileRequest, UpdateFileRequest, GetWorkflowRunRequest, RemoveConsoleUsersRequest, RunWorkflowResponse, ListConsoleUsersRequest, ListWorkflowRunsResponse, CreateWorkflowResponse, DeleteFileRequest, GetWorkflowRunResponse, UnbindWorkflowBundleRequest, UpdateFileResponse, UpdateConsoleUsersRequest } from "./databuddy_models";
|
|
3
|
+
import { ListConsoleGroupUsersRequest, ListConsoleGroupsRequest, UpdateConsoleUsersResponse, DeleteWorkflowResponse, ListConsoleUsersResponse, RemoveConsoleUsersResponse, DeleteWorkflowRequest, ListWorkflowTaskRunsRequest, CreateWorkflowRequest, CreateFileResponse, UpdateWorkflowRequest, UnbindWorkflowBundleResponse, KillWorkflowRunResponse, ListWorkflowsRequest, ListWorkflowRunsRequest, GetWorkflowTaskRunResponse, GetFileRequest, RerunWorkflowRunResponse, GetFileResponse, ListConsoleGroupUsersResponse, CreateConsoleGroupRequest, RerunWorkflowRunRequest, ListWorkflowsResponse, AddConsoleUsersRequest, KillWorkflowRunRequest, ListWorkflowTaskRunsResponse, AddConsoleUsersResponse, ListConsoleGroupsResponse, RunWorkflowRequest, UpdateConsoleGroupRequest, GetWorkflowResponse, GetWorkflowTaskRunRequest, DeleteFileResponse, CreateConsoleGroupResponse, DeleteConsoleGroupsRequest, UpdateWorkflowResponse, GetWorkflowRequest, CreateFileRequest, UpdateFileRequest, GetWorkflowRunRequest, RemoveConsoleUsersRequest, RunWorkflowResponse, ListConsoleUsersRequest, ListWorkflowRunsResponse, UpdateConsoleGroupResponse, DeleteConsoleGroupsResponse, CreateWorkflowResponse, ListConsoleRolesRequest, DeleteFileRequest, GetWorkflowRunResponse, UnbindWorkflowBundleRequest, ListConsoleRolesResponse, UpdateFileResponse, UpdateConsoleUsersRequest } from "./databuddy_models";
|
|
4
4
|
/**
|
|
5
5
|
* databuddy client
|
|
6
6
|
* @class
|
|
@@ -8,17 +8,9 @@ import { UpdateConsoleUsersResponse, DeleteWorkflowResponse, ListConsoleUsersRes
|
|
|
8
8
|
export declare class Client extends AbstractClient {
|
|
9
9
|
constructor(clientConfig: ClientConfig);
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
12
|
-
*/
|
|
13
|
-
RerunWorkflowRun(req: RerunWorkflowRunRequest, cb?: (error: string, rep: RerunWorkflowRunResponse) => void): Promise<RerunWorkflowRunResponse>;
|
|
14
|
-
/**
|
|
15
|
-
* <p>批量移除控制台用户(单次最多10个;前置校验任一不满足整体拒绝;执行阶段单个失败不中断后续删除,成败以 SuccessUins/FailItems 为准)</p>
|
|
16
|
-
*/
|
|
17
|
-
RemoveConsoleUsers(req: RemoveConsoleUsersRequest, cb?: (error: string, rep: RemoveConsoleUsersResponse) => void): Promise<RemoveConsoleUsersResponse>;
|
|
18
|
-
/**
|
|
19
|
-
* 创建工作流
|
|
11
|
+
* 更新工作流
|
|
20
12
|
*/
|
|
21
|
-
|
|
13
|
+
UpdateWorkflow(req: UpdateWorkflowRequest, cb?: (error: string, rep: UpdateWorkflowResponse) => void): Promise<UpdateWorkflowResponse>;
|
|
22
14
|
/**
|
|
23
15
|
* 添加控制台用户
|
|
24
16
|
*/
|
|
@@ -27,44 +19,6 @@ export declare class Client extends AbstractClient {
|
|
|
27
19
|
* 获取工作流详细信息
|
|
28
20
|
*/
|
|
29
21
|
GetWorkflow(req: GetWorkflowRequest, cb?: (error: string, rep: GetWorkflowResponse) => void): Promise<GetWorkflowResponse>;
|
|
30
|
-
/**
|
|
31
|
-
* 查询工作流运行详情
|
|
32
|
-
*/
|
|
33
|
-
GetWorkflowRun(req: GetWorkflowRunRequest, cb?: (error: string, rep: GetWorkflowRunResponse) => void): Promise<GetWorkflowRunResponse>;
|
|
34
|
-
/**
|
|
35
|
-
* 更新文件内容与运行配置(计算资源、默认 catalog/schema、参数等),返回更新后的文件元信息。
|
|
36
|
-
|
|
37
|
-
**前置条件**
|
|
38
|
-
1. FileId 对应文件必须存在且为活跃状态;
|
|
39
|
-
2. 调用方对该文件有写权限;
|
|
40
|
-
3. 仅更新配置时不传 Storage;仅更新内容时不传 FileConfig;
|
|
41
|
-
4. FileConfig.ResourceId 非空时会校验资源类型与文件类型的匹配性。
|
|
42
|
-
|
|
43
|
-
**错误码(Module 均为 `Studio`)**
|
|
44
|
-
|
|
45
|
-
| 错误码(Code) | InnerCode | 描述 | 处理建议 |
|
|
46
|
-
| --- | --- | --- | --- |
|
|
47
|
-
| `MissingParameter.WorkspaceId` | 1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId |
|
|
48
|
-
| `MissingParameter.FileId` | 1030003 | 缺少 FileId | 请传入 FileId |
|
|
49
|
-
| `InvalidParameterValue.FileType` | 1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE |
|
|
50
|
-
| `InvalidParameterValue.ResourceId` | 1030104 | 计算资源类型与文件类型不匹配 | Python/Notebook 选数据计算资源,SQL 选数据分析资源 |
|
|
51
|
-
| `ResourceNotFound.FileNotFound` | 1030203 | 文件不存在或已删除 | 请确认 FileId,或调用 GetFile 校验文件状态 |
|
|
52
|
-
| `UnauthorizedOperation.FileWriteDenied` | 1030302 | 对该文件无写权限 | 请联系文件负责人或空间管理员授权 |
|
|
53
|
-
| `FailedOperation.FileStorageUpdateFailed` | 1030401 | 文件内容写入存储失败 | 请稍后重试,持续失败请携带 RequestId 联系支持 |
|
|
54
|
-
| `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 |
|
|
55
|
-
*/
|
|
56
|
-
UpdateFile(req: UpdateFileRequest, cb?: (error: string, rep: UpdateFileResponse) => void): Promise<UpdateFileResponse>;
|
|
57
|
-
/**
|
|
58
|
-
* 在Studio(统一开发 IDE)的工作空间文件树中新建一个文件(Notebook/SQL/Python等),创建成功后返回文件的完整元信息。
|
|
59
|
-
|
|
60
|
-
**前置条件**
|
|
61
|
-
1. WorkspaceId 对应工作空间存在,且调用方为该工作空间成员;
|
|
62
|
-
2. ParentFolderPath 对应的父文件夹必须存在,且调用方对其有写权限(根目录传 `/`);
|
|
63
|
-
3. FileName 在同一父文件夹下不能重名(含后缀比较);
|
|
64
|
-
4. FileName 后缀必须与 FileType 匹配(`.ipynb`↔`NOTEBOOK_FILE`、`.sql`↔`SQL_FILE`);
|
|
65
|
-
5. 需带文件内容创建时通过 Storage 传入(大文件走 COS 中转,小文件放 Storage.Content)。
|
|
66
|
-
*/
|
|
67
|
-
CreateFile(req: CreateFileRequest, cb?: (error: string, rep: CreateFileResponse) => void): Promise<CreateFileResponse>;
|
|
68
22
|
/**
|
|
69
23
|
* 查询任务运行详情
|
|
70
24
|
*/
|
|
@@ -74,29 +28,9 @@ export declare class Client extends AbstractClient {
|
|
|
74
28
|
*/
|
|
75
29
|
ListWorkflowTaskRuns(req: ListWorkflowTaskRunsRequest, cb?: (error: string, rep: ListWorkflowTaskRunsResponse) => void): Promise<ListWorkflowTaskRunsResponse>;
|
|
76
30
|
/**
|
|
77
|
-
*
|
|
31
|
+
* 删除控制台用户组
|
|
78
32
|
*/
|
|
79
|
-
|
|
80
|
-
/**
|
|
81
|
-
* 修改控制台用户角色
|
|
82
|
-
*/
|
|
83
|
-
UpdateConsoleUsers(req: UpdateConsoleUsersRequest, cb?: (error: string, rep: UpdateConsoleUsersResponse) => void): Promise<UpdateConsoleUsersResponse>;
|
|
84
|
-
/**
|
|
85
|
-
* 运行工作流
|
|
86
|
-
*/
|
|
87
|
-
RunWorkflow(req: RunWorkflowRequest, cb?: (error: string, rep: RunWorkflowResponse) => void): Promise<RunWorkflowResponse>;
|
|
88
|
-
/**
|
|
89
|
-
* 工作流运行列表
|
|
90
|
-
*/
|
|
91
|
-
ListWorkflowRuns(req: ListWorkflowRunsRequest, cb?: (error: string, rep: ListWorkflowRunsResponse) => void): Promise<ListWorkflowRunsResponse>;
|
|
92
|
-
/**
|
|
93
|
-
* 终止工作流的运行
|
|
94
|
-
*/
|
|
95
|
-
KillWorkflowRun(req: KillWorkflowRunRequest, cb?: (error: string, rep: KillWorkflowRunResponse) => void): Promise<KillWorkflowRunResponse>;
|
|
96
|
-
/**
|
|
97
|
-
* 删除工作流
|
|
98
|
-
*/
|
|
99
|
-
DeleteWorkflow(req: DeleteWorkflowRequest, cb?: (error: string, rep: DeleteWorkflowResponse) => void): Promise<DeleteWorkflowResponse>;
|
|
33
|
+
DeleteConsoleGroups(req: DeleteConsoleGroupsRequest, cb?: (error: string, rep: DeleteConsoleGroupsResponse) => void): Promise<DeleteConsoleGroupsResponse>;
|
|
100
34
|
/**
|
|
101
35
|
* 获取文件的元信息,可选包含文件内容,支持按版本读取历史快照。
|
|
102
36
|
|
|
@@ -118,14 +52,19 @@ export declare class Client extends AbstractClient {
|
|
|
118
52
|
| `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 |
|
|
119
53
|
*/
|
|
120
54
|
GetFile(req: GetFileRequest, cb?: (error: string, rep: GetFileResponse) => void): Promise<GetFileResponse>;
|
|
121
|
-
/**
|
|
122
|
-
* 更新工作流
|
|
123
|
-
*/
|
|
124
|
-
UpdateWorkflow(req: UpdateWorkflowRequest, cb?: (error: string, rep: UpdateWorkflowResponse) => void): Promise<UpdateWorkflowResponse>;
|
|
125
55
|
/**
|
|
126
56
|
* 查询工作流列表
|
|
127
57
|
*/
|
|
128
58
|
ListWorkflows(req: ListWorkflowsRequest, cb?: (error: string, rep: ListWorkflowsResponse) => void): Promise<ListWorkflowsResponse>;
|
|
59
|
+
/**
|
|
60
|
+
* 解绑工作流Bundle信息
|
|
61
|
+
说明:本接口语义等同于规范动词清单中的 Detach,因兼容既有产品形态保留 Unbind 命名
|
|
62
|
+
*/
|
|
63
|
+
UnbindWorkflowBundle(req: UnbindWorkflowBundleRequest, cb?: (error: string, rep: UnbindWorkflowBundleResponse) => void): Promise<UnbindWorkflowBundleResponse>;
|
|
64
|
+
/**
|
|
65
|
+
* 删除工作流
|
|
66
|
+
*/
|
|
67
|
+
DeleteWorkflow(req: DeleteWorkflowRequest, cb?: (error: string, rep: DeleteWorkflowResponse) => void): Promise<DeleteWorkflowResponse>;
|
|
129
68
|
/**
|
|
130
69
|
* 将文件移入回收站(软删除),同时清理该文件的版本记录与执行结果快照。
|
|
131
70
|
|
|
@@ -148,8 +87,93 @@ export declare class Client extends AbstractClient {
|
|
|
148
87
|
*/
|
|
149
88
|
DeleteFile(req: DeleteFileRequest, cb?: (error: string, rep: DeleteFileResponse) => void): Promise<DeleteFileResponse>;
|
|
150
89
|
/**
|
|
151
|
-
*
|
|
152
|
-
说明:本接口语义等同于规范动词清单中的 Detach,因兼容既有产品形态保留 Unbind 命名
|
|
90
|
+
* 创建控制台用户组
|
|
153
91
|
*/
|
|
154
|
-
|
|
92
|
+
CreateConsoleGroup(req: CreateConsoleGroupRequest, cb?: (error: string, rep: CreateConsoleGroupResponse) => void): Promise<CreateConsoleGroupResponse>;
|
|
93
|
+
/**
|
|
94
|
+
* 终止工作流的运行
|
|
95
|
+
*/
|
|
96
|
+
KillWorkflowRun(req: KillWorkflowRunRequest, cb?: (error: string, rep: KillWorkflowRunResponse) => void): Promise<KillWorkflowRunResponse>;
|
|
97
|
+
/**
|
|
98
|
+
* 查询工作流运行详情
|
|
99
|
+
*/
|
|
100
|
+
GetWorkflowRun(req: GetWorkflowRunRequest, cb?: (error: string, rep: GetWorkflowRunResponse) => void): Promise<GetWorkflowRunResponse>;
|
|
101
|
+
/**
|
|
102
|
+
* 查询控制台用户列表
|
|
103
|
+
*/
|
|
104
|
+
ListConsoleUsers(req: ListConsoleUsersRequest, cb?: (error: string, rep: ListConsoleUsersResponse) => void): Promise<ListConsoleUsersResponse>;
|
|
105
|
+
/**
|
|
106
|
+
* <p>批量移除控制台用户(单次最多10个;前置校验任一不满足整体拒绝;执行阶段单个失败不中断后续删除,成败以 SuccessUins/FailItems 为准)</p>
|
|
107
|
+
*/
|
|
108
|
+
RemoveConsoleUsers(req: RemoveConsoleUsersRequest, cb?: (error: string, rep: RemoveConsoleUsersResponse) => void): Promise<RemoveConsoleUsersResponse>;
|
|
109
|
+
/**
|
|
110
|
+
* 运行工作流
|
|
111
|
+
*/
|
|
112
|
+
RunWorkflow(req: RunWorkflowRequest, cb?: (error: string, rep: RunWorkflowResponse) => void): Promise<RunWorkflowResponse>;
|
|
113
|
+
/**
|
|
114
|
+
* 查询控制台用户组列表
|
|
115
|
+
*/
|
|
116
|
+
ListConsoleGroups(req: ListConsoleGroupsRequest, cb?: (error: string, rep: ListConsoleGroupsResponse) => void): Promise<ListConsoleGroupsResponse>;
|
|
117
|
+
/**
|
|
118
|
+
* 查询控制台角色列表
|
|
119
|
+
*/
|
|
120
|
+
ListConsoleRoles(req: ListConsoleRolesRequest, cb?: (error: string, rep: ListConsoleRolesResponse) => void): Promise<ListConsoleRolesResponse>;
|
|
121
|
+
/**
|
|
122
|
+
* 重跑工作流
|
|
123
|
+
*/
|
|
124
|
+
RerunWorkflowRun(req: RerunWorkflowRunRequest, cb?: (error: string, rep: RerunWorkflowRunResponse) => void): Promise<RerunWorkflowRunResponse>;
|
|
125
|
+
/**
|
|
126
|
+
* 修改控制台用户组
|
|
127
|
+
*/
|
|
128
|
+
UpdateConsoleGroup(req: UpdateConsoleGroupRequest, cb?: (error: string, rep: UpdateConsoleGroupResponse) => void): Promise<UpdateConsoleGroupResponse>;
|
|
129
|
+
/**
|
|
130
|
+
* 创建工作流
|
|
131
|
+
*/
|
|
132
|
+
CreateWorkflow(req: CreateWorkflowRequest, cb?: (error: string, rep: CreateWorkflowResponse) => void): Promise<CreateWorkflowResponse>;
|
|
133
|
+
/**
|
|
134
|
+
* 更新文件内容与运行配置(计算资源、默认 catalog/schema、参数等),返回更新后的文件元信息。
|
|
135
|
+
|
|
136
|
+
**前置条件**
|
|
137
|
+
1. FileId 对应文件必须存在且为活跃状态;
|
|
138
|
+
2. 调用方对该文件有写权限;
|
|
139
|
+
3. 仅更新配置时不传 Storage;仅更新内容时不传 FileConfig;
|
|
140
|
+
4. FileConfig.ResourceId 非空时会校验资源类型与文件类型的匹配性。
|
|
141
|
+
|
|
142
|
+
**错误码(Module 均为 `Studio`)**
|
|
143
|
+
|
|
144
|
+
| 错误码(Code) | InnerCode | 描述 | 处理建议 |
|
|
145
|
+
| --- | --- | --- | --- |
|
|
146
|
+
| `MissingParameter.WorkspaceId` | 1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId |
|
|
147
|
+
| `MissingParameter.FileId` | 1030003 | 缺少 FileId | 请传入 FileId |
|
|
148
|
+
| `InvalidParameterValue.FileType` | 1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE |
|
|
149
|
+
| `InvalidParameterValue.ResourceId` | 1030104 | 计算资源类型与文件类型不匹配 | Python/Notebook 选数据计算资源,SQL 选数据分析资源 |
|
|
150
|
+
| `ResourceNotFound.FileNotFound` | 1030203 | 文件不存在或已删除 | 请确认 FileId,或调用 GetFile 校验文件状态 |
|
|
151
|
+
| `UnauthorizedOperation.FileWriteDenied` | 1030302 | 对该文件无写权限 | 请联系文件负责人或空间管理员授权 |
|
|
152
|
+
| `FailedOperation.FileStorageUpdateFailed` | 1030401 | 文件内容写入存储失败 | 请稍后重试,持续失败请携带 RequestId 联系支持 |
|
|
153
|
+
| `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 |
|
|
154
|
+
*/
|
|
155
|
+
UpdateFile(req: UpdateFileRequest, cb?: (error: string, rep: UpdateFileResponse) => void): Promise<UpdateFileResponse>;
|
|
156
|
+
/**
|
|
157
|
+
* 修改控制台用户角色
|
|
158
|
+
*/
|
|
159
|
+
UpdateConsoleUsers(req: UpdateConsoleUsersRequest, cb?: (error: string, rep: UpdateConsoleUsersResponse) => void): Promise<UpdateConsoleUsersResponse>;
|
|
160
|
+
/**
|
|
161
|
+
* 在Studio(统一开发 IDE)的工作空间文件树中新建一个文件(Notebook/SQL/Python等),创建成功后返回文件的完整元信息。
|
|
162
|
+
|
|
163
|
+
**前置条件**
|
|
164
|
+
1. WorkspaceId 对应工作空间存在,且调用方为该工作空间成员;
|
|
165
|
+
2. ParentFolderPath 对应的父文件夹必须存在,且调用方对其有写权限(根目录传 `/`);
|
|
166
|
+
3. FileName 在同一父文件夹下不能重名(含后缀比较);
|
|
167
|
+
4. FileName 后缀必须与 FileType 匹配(`.ipynb`↔`NOTEBOOK_FILE`、`.sql`↔`SQL_FILE`);
|
|
168
|
+
5. 需带文件内容创建时通过 Storage 传入(大文件走 COS 中转,小文件放 Storage.Content)。
|
|
169
|
+
*/
|
|
170
|
+
CreateFile(req: CreateFileRequest, cb?: (error: string, rep: CreateFileResponse) => void): Promise<CreateFileResponse>;
|
|
171
|
+
/**
|
|
172
|
+
* 查询控制台用户组成员列表
|
|
173
|
+
*/
|
|
174
|
+
ListConsoleGroupUsers(req: ListConsoleGroupUsersRequest, cb?: (error: string, rep: ListConsoleGroupUsersResponse) => void): Promise<ListConsoleGroupUsersResponse>;
|
|
175
|
+
/**
|
|
176
|
+
* 工作流运行列表
|
|
177
|
+
*/
|
|
178
|
+
ListWorkflowRuns(req: ListWorkflowRunsRequest, cb?: (error: string, rep: ListWorkflowRunsResponse) => void): Promise<ListWorkflowRunsResponse>;
|
|
155
179
|
}
|
|
@@ -28,22 +28,10 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
28
28
|
super("databuddy.tencentcloudapi.com", "2026-07-15", clientConfig);
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
32
|
-
*/
|
|
33
|
-
async RerunWorkflowRun(req, cb) {
|
|
34
|
-
return this.request("RerunWorkflowRun", req, cb);
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* <p>批量移除控制台用户(单次最多10个;前置校验任一不满足整体拒绝;执行阶段单个失败不中断后续删除,成败以 SuccessUins/FailItems 为准)</p>
|
|
38
|
-
*/
|
|
39
|
-
async RemoveConsoleUsers(req, cb) {
|
|
40
|
-
return this.request("RemoveConsoleUsers", req, cb);
|
|
41
|
-
}
|
|
42
|
-
/**
|
|
43
|
-
* 创建工作流
|
|
31
|
+
* 更新工作流
|
|
44
32
|
*/
|
|
45
|
-
async
|
|
46
|
-
return this.request("
|
|
33
|
+
async UpdateWorkflow(req, cb) {
|
|
34
|
+
return this.request("UpdateWorkflow", req, cb);
|
|
47
35
|
}
|
|
48
36
|
/**
|
|
49
37
|
* 添加控制台用户
|
|
@@ -58,60 +46,105 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
58
46
|
return this.request("GetWorkflow", req, cb);
|
|
59
47
|
}
|
|
60
48
|
/**
|
|
61
|
-
*
|
|
49
|
+
* 查询任务运行详情
|
|
62
50
|
*/
|
|
63
|
-
async
|
|
64
|
-
return this.request("
|
|
51
|
+
async GetWorkflowTaskRun(req, cb) {
|
|
52
|
+
return this.request("GetWorkflowTaskRun", req, cb);
|
|
65
53
|
}
|
|
66
54
|
/**
|
|
67
|
-
*
|
|
55
|
+
* 查询工作流任务历史运行列表
|
|
56
|
+
*/
|
|
57
|
+
async ListWorkflowTaskRuns(req, cb) {
|
|
58
|
+
return this.request("ListWorkflowTaskRuns", req, cb);
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* 删除控制台用户组
|
|
62
|
+
*/
|
|
63
|
+
async DeleteConsoleGroups(req, cb) {
|
|
64
|
+
return this.request("DeleteConsoleGroups", req, cb);
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* 获取文件的元信息,可选包含文件内容,支持按版本读取历史快照。
|
|
68
68
|
|
|
69
69
|
**前置条件**
|
|
70
|
-
1. FileId
|
|
71
|
-
2.
|
|
72
|
-
3.
|
|
73
|
-
4. FileConfig.ResourceId 非空时会校验资源类型与文件类型的匹配性。
|
|
70
|
+
1. FileId 与 FilePath 二选一,至少传一个;同时传时以 FileId 为准;
|
|
71
|
+
2. 对应文件必须存在,且调用方对该文件有读权限;
|
|
72
|
+
3. 传 VersionId 时该版本必须存在。
|
|
74
73
|
|
|
75
74
|
**错误码(Module 均为 `Studio`)**
|
|
76
75
|
|
|
77
76
|
| 错误码(Code) | InnerCode | 描述 | 处理建议 |
|
|
78
77
|
| --- | --- | --- | --- |
|
|
79
78
|
| `MissingParameter.WorkspaceId` | 1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId |
|
|
80
|
-
| `MissingParameter.FileId` | 1030003 |
|
|
79
|
+
| `MissingParameter.FileId` | 1030003 | FileId 与 FilePath 同时为空 | FileId 与 FilePath 二选一,至少传一个 |
|
|
81
80
|
| `InvalidParameterValue.FileType` | 1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE |
|
|
82
|
-
| `
|
|
83
|
-
| `ResourceNotFound.
|
|
84
|
-
| `UnauthorizedOperation.
|
|
85
|
-
| `FailedOperation.FileStorageUpdateFailed` | 1030401 | 文件内容写入存储失败 | 请稍后重试,持续失败请携带 RequestId 联系支持 |
|
|
81
|
+
| `ResourceNotFound.FileNotFound` | 1030203 | 文件不存在或已删除 | 请确认 FileId 或 FilePath |
|
|
82
|
+
| `ResourceNotFound.FileVersionNotFound` | 1030205 | 指定的文件版本不存在 | 请确认 VersionId,或调用 ListFileVersions 获取 |
|
|
83
|
+
| `UnauthorizedOperation.FileReadDenied` | 1030304 | 对该文件无读权限 | 请联系文件负责人或空间管理员授权 |
|
|
86
84
|
| `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 |
|
|
87
85
|
*/
|
|
88
|
-
async
|
|
89
|
-
return this.request("
|
|
86
|
+
async GetFile(req, cb) {
|
|
87
|
+
return this.request("GetFile", req, cb);
|
|
90
88
|
}
|
|
91
89
|
/**
|
|
92
|
-
*
|
|
90
|
+
* 查询工作流列表
|
|
91
|
+
*/
|
|
92
|
+
async ListWorkflows(req, cb) {
|
|
93
|
+
return this.request("ListWorkflows", req, cb);
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* 解绑工作流Bundle信息
|
|
97
|
+
说明:本接口语义等同于规范动词清单中的 Detach,因兼容既有产品形态保留 Unbind 命名
|
|
98
|
+
*/
|
|
99
|
+
async UnbindWorkflowBundle(req, cb) {
|
|
100
|
+
return this.request("UnbindWorkflowBundle", req, cb);
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* 删除工作流
|
|
104
|
+
*/
|
|
105
|
+
async DeleteWorkflow(req, cb) {
|
|
106
|
+
return this.request("DeleteWorkflow", req, cb);
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* 将文件移入回收站(软删除),同时清理该文件的版本记录与执行结果快照。
|
|
93
110
|
|
|
94
111
|
**前置条件**
|
|
95
|
-
1.
|
|
96
|
-
2.
|
|
97
|
-
3.
|
|
98
|
-
|
|
99
|
-
|
|
112
|
+
1. FileId 对应文件必须存在且为活跃状态;
|
|
113
|
+
2. 调用方对该文件有删除权限;
|
|
114
|
+
3. 文件未被工作流任务引用。
|
|
115
|
+
|
|
116
|
+
**错误码(Module 均为 `Studio`)**
|
|
117
|
+
|
|
118
|
+
| 错误码(Code) | InnerCode | 描述 | 处理建议 |
|
|
119
|
+
| --- | --- | --- | --- |
|
|
120
|
+
| `MissingParameter.WorkspaceId` | 1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId |
|
|
121
|
+
| `MissingParameter.FileId` | 1030003 | 缺少 FileId | 请传入 FileId |
|
|
122
|
+
| `InvalidParameterValue.FileType` | 1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE |
|
|
123
|
+
| `ResourceNotFound.FileNotFound` | 1030203 | 文件不存在或已删除 | 请确认 FileId |
|
|
124
|
+
| `ResourceInUse.FileReferencedByTask` | 1030204 | 文件被工作流任务引用,不允许删除 | 请先解除任务引用后再删除 |
|
|
125
|
+
| `UnauthorizedOperation.FileDeleteDenied` | 1030303 | 对该文件无删除权限 | 请联系文件负责人或空间管理员授权 |
|
|
126
|
+
| `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 |
|
|
100
127
|
*/
|
|
101
|
-
async
|
|
102
|
-
return this.request("
|
|
128
|
+
async DeleteFile(req, cb) {
|
|
129
|
+
return this.request("DeleteFile", req, cb);
|
|
103
130
|
}
|
|
104
131
|
/**
|
|
105
|
-
*
|
|
132
|
+
* 创建控制台用户组
|
|
106
133
|
*/
|
|
107
|
-
async
|
|
108
|
-
return this.request("
|
|
134
|
+
async CreateConsoleGroup(req, cb) {
|
|
135
|
+
return this.request("CreateConsoleGroup", req, cb);
|
|
109
136
|
}
|
|
110
137
|
/**
|
|
111
|
-
*
|
|
138
|
+
* 终止工作流的运行
|
|
112
139
|
*/
|
|
113
|
-
async
|
|
114
|
-
return this.request("
|
|
140
|
+
async KillWorkflowRun(req, cb) {
|
|
141
|
+
return this.request("KillWorkflowRun", req, cb);
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* 查询工作流运行详情
|
|
145
|
+
*/
|
|
146
|
+
async GetWorkflowRun(req, cb) {
|
|
147
|
+
return this.request("GetWorkflowRun", req, cb);
|
|
115
148
|
}
|
|
116
149
|
/**
|
|
117
150
|
* 查询控制台用户列表
|
|
@@ -120,10 +153,10 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
120
153
|
return this.request("ListConsoleUsers", req, cb);
|
|
121
154
|
}
|
|
122
155
|
/**
|
|
123
|
-
*
|
|
156
|
+
* <p>批量移除控制台用户(单次最多10个;前置校验任一不满足整体拒绝;执行阶段单个失败不中断后续删除,成败以 SuccessUins/FailItems 为准)</p>
|
|
124
157
|
*/
|
|
125
|
-
async
|
|
126
|
-
return this.request("
|
|
158
|
+
async RemoveConsoleUsers(req, cb) {
|
|
159
|
+
return this.request("RemoveConsoleUsers", req, cb);
|
|
127
160
|
}
|
|
128
161
|
/**
|
|
129
162
|
* 运行工作流
|
|
@@ -132,87 +165,90 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
132
165
|
return this.request("RunWorkflow", req, cb);
|
|
133
166
|
}
|
|
134
167
|
/**
|
|
135
|
-
*
|
|
168
|
+
* 查询控制台用户组列表
|
|
136
169
|
*/
|
|
137
|
-
async
|
|
138
|
-
return this.request("
|
|
170
|
+
async ListConsoleGroups(req, cb) {
|
|
171
|
+
return this.request("ListConsoleGroups", req, cb);
|
|
139
172
|
}
|
|
140
173
|
/**
|
|
141
|
-
*
|
|
174
|
+
* 查询控制台角色列表
|
|
142
175
|
*/
|
|
143
|
-
async
|
|
144
|
-
return this.request("
|
|
176
|
+
async ListConsoleRoles(req, cb) {
|
|
177
|
+
return this.request("ListConsoleRoles", req, cb);
|
|
145
178
|
}
|
|
146
179
|
/**
|
|
147
|
-
*
|
|
180
|
+
* 重跑工作流
|
|
148
181
|
*/
|
|
149
|
-
async
|
|
150
|
-
return this.request("
|
|
182
|
+
async RerunWorkflowRun(req, cb) {
|
|
183
|
+
return this.request("RerunWorkflowRun", req, cb);
|
|
151
184
|
}
|
|
152
185
|
/**
|
|
153
|
-
*
|
|
186
|
+
* 修改控制台用户组
|
|
187
|
+
*/
|
|
188
|
+
async UpdateConsoleGroup(req, cb) {
|
|
189
|
+
return this.request("UpdateConsoleGroup", req, cb);
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* 创建工作流
|
|
193
|
+
*/
|
|
194
|
+
async CreateWorkflow(req, cb) {
|
|
195
|
+
return this.request("CreateWorkflow", req, cb);
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* 更新文件内容与运行配置(计算资源、默认 catalog/schema、参数等),返回更新后的文件元信息。
|
|
154
199
|
|
|
155
200
|
**前置条件**
|
|
156
|
-
1. FileId
|
|
157
|
-
2.
|
|
158
|
-
3.
|
|
201
|
+
1. FileId 对应文件必须存在且为活跃状态;
|
|
202
|
+
2. 调用方对该文件有写权限;
|
|
203
|
+
3. 仅更新配置时不传 Storage;仅更新内容时不传 FileConfig;
|
|
204
|
+
4. FileConfig.ResourceId 非空时会校验资源类型与文件类型的匹配性。
|
|
159
205
|
|
|
160
206
|
**错误码(Module 均为 `Studio`)**
|
|
161
207
|
|
|
162
208
|
| 错误码(Code) | InnerCode | 描述 | 处理建议 |
|
|
163
209
|
| --- | --- | --- | --- |
|
|
164
210
|
| `MissingParameter.WorkspaceId` | 1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId |
|
|
165
|
-
| `MissingParameter.FileId` | 1030003 | FileId
|
|
211
|
+
| `MissingParameter.FileId` | 1030003 | 缺少 FileId | 请传入 FileId |
|
|
166
212
|
| `InvalidParameterValue.FileType` | 1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE |
|
|
167
|
-
| `
|
|
168
|
-
| `ResourceNotFound.
|
|
169
|
-
| `UnauthorizedOperation.
|
|
213
|
+
| `InvalidParameterValue.ResourceId` | 1030104 | 计算资源类型与文件类型不匹配 | Python/Notebook 选数据计算资源,SQL 选数据分析资源 |
|
|
214
|
+
| `ResourceNotFound.FileNotFound` | 1030203 | 文件不存在或已删除 | 请确认 FileId,或调用 GetFile 校验文件状态 |
|
|
215
|
+
| `UnauthorizedOperation.FileWriteDenied` | 1030302 | 对该文件无写权限 | 请联系文件负责人或空间管理员授权 |
|
|
216
|
+
| `FailedOperation.FileStorageUpdateFailed` | 1030401 | 文件内容写入存储失败 | 请稍后重试,持续失败请携带 RequestId 联系支持 |
|
|
170
217
|
| `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 |
|
|
171
218
|
*/
|
|
172
|
-
async
|
|
173
|
-
return this.request("
|
|
219
|
+
async UpdateFile(req, cb) {
|
|
220
|
+
return this.request("UpdateFile", req, cb);
|
|
174
221
|
}
|
|
175
222
|
/**
|
|
176
|
-
*
|
|
223
|
+
* 修改控制台用户角色
|
|
177
224
|
*/
|
|
178
|
-
async
|
|
179
|
-
return this.request("
|
|
225
|
+
async UpdateConsoleUsers(req, cb) {
|
|
226
|
+
return this.request("UpdateConsoleUsers", req, cb);
|
|
180
227
|
}
|
|
181
228
|
/**
|
|
182
|
-
*
|
|
229
|
+
* 在Studio(统一开发 IDE)的工作空间文件树中新建一个文件(Notebook/SQL/Python等),创建成功后返回文件的完整元信息。
|
|
230
|
+
|
|
231
|
+
**前置条件**
|
|
232
|
+
1. WorkspaceId 对应工作空间存在,且调用方为该工作空间成员;
|
|
233
|
+
2. ParentFolderPath 对应的父文件夹必须存在,且调用方对其有写权限(根目录传 `/`);
|
|
234
|
+
3. FileName 在同一父文件夹下不能重名(含后缀比较);
|
|
235
|
+
4. FileName 后缀必须与 FileType 匹配(`.ipynb`↔`NOTEBOOK_FILE`、`.sql`↔`SQL_FILE`);
|
|
236
|
+
5. 需带文件内容创建时通过 Storage 传入(大文件走 COS 中转,小文件放 Storage.Content)。
|
|
183
237
|
*/
|
|
184
|
-
async
|
|
185
|
-
return this.request("
|
|
238
|
+
async CreateFile(req, cb) {
|
|
239
|
+
return this.request("CreateFile", req, cb);
|
|
186
240
|
}
|
|
187
241
|
/**
|
|
188
|
-
*
|
|
189
|
-
|
|
190
|
-
**前置条件**
|
|
191
|
-
1. FileId 对应文件必须存在且为活跃状态;
|
|
192
|
-
2. 调用方对该文件有删除权限;
|
|
193
|
-
3. 文件未被工作流任务引用。
|
|
194
|
-
|
|
195
|
-
**错误码(Module 均为 `Studio`)**
|
|
196
|
-
|
|
197
|
-
| 错误码(Code) | InnerCode | 描述 | 处理建议 |
|
|
198
|
-
| --- | --- | --- | --- |
|
|
199
|
-
| `MissingParameter.WorkspaceId` | 1030001 | 缺少 WorkspaceId | 请传入 WorkspaceId |
|
|
200
|
-
| `MissingParameter.FileId` | 1030003 | 缺少 FileId | 请传入 FileId |
|
|
201
|
-
| `InvalidParameterValue.FileType` | 1030102 | FileType 取值不支持 | FileType 取 FILE/NOTEBOOK_FILE/SQL_FILE |
|
|
202
|
-
| `ResourceNotFound.FileNotFound` | 1030203 | 文件不存在或已删除 | 请确认 FileId |
|
|
203
|
-
| `ResourceInUse.FileReferencedByTask` | 1030204 | 文件被工作流任务引用,不允许删除 | 请先解除任务引用后再删除 |
|
|
204
|
-
| `UnauthorizedOperation.FileDeleteDenied` | 1030303 | 对该文件无删除权限 | 请联系文件负责人或空间管理员授权 |
|
|
205
|
-
| `InternalError` | 1030900 | 服务内部异常 | 请携带 RequestId 联系支持 |
|
|
242
|
+
* 查询控制台用户组成员列表
|
|
206
243
|
*/
|
|
207
|
-
async
|
|
208
|
-
return this.request("
|
|
244
|
+
async ListConsoleGroupUsers(req, cb) {
|
|
245
|
+
return this.request("ListConsoleGroupUsers", req, cb);
|
|
209
246
|
}
|
|
210
247
|
/**
|
|
211
|
-
*
|
|
212
|
-
说明:本接口语义等同于规范动词清单中的 Detach,因兼容既有产品形态保留 Unbind 命名
|
|
248
|
+
* 工作流运行列表
|
|
213
249
|
*/
|
|
214
|
-
async
|
|
215
|
-
return this.request("
|
|
250
|
+
async ListWorkflowRuns(req, cb) {
|
|
251
|
+
return this.request("ListWorkflowRuns", req, cb);
|
|
216
252
|
}
|
|
217
253
|
}
|
|
218
254
|
exports.Client = Client;
|