@cloudbase/manager-node 5.6.6 → 5.6.8

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/CHANGELOG.md CHANGED
@@ -1,3 +1,16 @@
1
+ ## @cloudbase/manager-node v5.6.7 版本发布 🚀(2026-08-05)
2
+
3
+ - 新增 describeServerManageTask 及版本详情/回滚/删除接口
4
+
5
+ ---
6
+
7
+ ## @cloudbase/manager-node v5.6.6 版本发布 🚀(2026-07-31)
8
+
9
+ - 新增 uploadCode 新增 onPhase 分步计时回调
10
+ - 优化 标记 HTTP Service (CloudBaseGW) 模块自 v5.0.0 起废弃,并添加迁移指引
11
+
12
+ ---
13
+
1
14
  ## @cloudbase/manager-node v5.6.5 版本发布 🚀(2026-07-28)
2
15
 
3
16
  - 新增 PostgreSQL 数据库迁移相关 API 与类型定义
@@ -88,6 +88,34 @@ class CloudRunService {
88
88
  throw new Error(`云托管代码下载地址为空(请求ID: ${cloudBaseBuildServiceRes.RequestId})`);
89
89
  }
90
90
  }
91
+ /**
92
+ * 查询服务管理任务信息
93
+ * @param {Object} params 查询参数
94
+ * @param {string} params.serverName 服务名
95
+ * @param {number} [params.taskId=0] 任务 ID,传 0 表示查询该服务当前最新的任务
96
+ * @param {string} [params.operatorRemark] 操作标识
97
+ * @returns {Promise<{ IsExist?: boolean; Task?: IServerManageTaskInfo; RequestId?: string }>} 任务是否存在及任务信息
98
+ */
99
+ async describeServerManageTask(params) {
100
+ var _a;
101
+ const envConfig = this.environment.lazyEnvironmentConfig;
102
+ return this.tcbrService.request('DescribeServerManageTask', Object.assign({ EnvId: envConfig.EnvId, ServerName: params.serverName, TaskId: (_a = params.taskId) !== null && _a !== void 0 ? _a : 0 }, (params.operatorRemark ? { OperatorRemark: params.operatorRemark } : {})));
103
+ }
104
+ /**
105
+ * 查询发布单信息(DescribeReleaseOrder)
106
+ * @param {IDescribeReleaseOrderParams} params 查询参数
107
+ * @returns {Promise<IDescribeReleaseOrderResponse>} 发布单详情
108
+ */
109
+ async describeReleaseOrder(params) {
110
+ var _a, _b;
111
+ const envConfig = this.environment.lazyEnvironmentConfig;
112
+ const serverName = (_a = params === null || params === void 0 ? void 0 : params.ServerName) === null || _a === void 0 ? void 0 : _a.trim();
113
+ const status = (_b = params === null || params === void 0 ? void 0 : params.Status) === null || _b === void 0 ? void 0 : _b.trim();
114
+ if (!serverName) {
115
+ throw new Error('Missing required parameters: ServerName');
116
+ }
117
+ return this.tcbrService.request('DescribeReleaseOrder', Object.assign({ EnvId: envConfig.EnvId, ServerName: serverName }, (status ? { Status: status } : {})));
118
+ }
91
119
  /**
92
120
  * 获取云托管服务列表
93
121
  * @param {Object} [params] 查询参数
@@ -197,6 +225,78 @@ class CloudRunService {
197
225
  OperateType: 'go_back',
198
226
  });
199
227
  }
228
+ /**
229
+ * 回滚版本(SubmitServerRollback)
230
+ * @param {ISubmitServerRollbackParams} params 回滚参数(服务名、当前版本名、目标回滚版本名)
231
+ * @returns {Promise<ISubmitServerRollbackResponse>} 返回任务 ID 和请求 ID
232
+ */
233
+ async submitServerRollback(params) {
234
+ var _a, _b, _c, _d;
235
+ const envConfig = this.environment.lazyEnvironmentConfig;
236
+ const serverName = (_a = params === null || params === void 0 ? void 0 : params.ServerName) === null || _a === void 0 ? void 0 : _a.trim();
237
+ const currentVersionName = (_b = params === null || params === void 0 ? void 0 : params.CurrentVersionName) === null || _b === void 0 ? void 0 : _b.trim();
238
+ const rollbackVersionName = (_c = params === null || params === void 0 ? void 0 : params.RollbackVersionName) === null || _c === void 0 ? void 0 : _c.trim();
239
+ const operatorRemark = (_d = params === null || params === void 0 ? void 0 : params.OperatorRemark) === null || _d === void 0 ? void 0 : _d.trim();
240
+ if (!serverName) {
241
+ throw new Error('Missing required parameters: ServerName');
242
+ }
243
+ if (!currentVersionName) {
244
+ throw new Error('Missing required parameters: CurrentVersionName');
245
+ }
246
+ if (!rollbackVersionName) {
247
+ throw new Error('Missing required parameters: RollbackVersionName');
248
+ }
249
+ return this.tcbrService.request('SubmitServerRollback', Object.assign({ EnvId: envConfig.EnvId, ServerName: serverName, CurrentVersionName: currentVersionName, RollbackVersionName: rollbackVersionName }, (operatorRemark ? { OperatorRemark: operatorRemark } : {})));
250
+ }
251
+ /**
252
+ * 批量删除版本
253
+ * @param {IDeleteCloudRunVersionsParams} params 删除参数
254
+ * @returns {Promise<IDeleteCloudRunVersionsResponse>} 删除结果
255
+ */
256
+ async deleteCloudRunVersions(params) {
257
+ var _a;
258
+ const envConfig = this.environment.lazyEnvironmentConfig;
259
+ const operatorRemark = (_a = params === null || params === void 0 ? void 0 : params.OperatorRemark) === null || _a === void 0 ? void 0 : _a.trim();
260
+ if (!Array.isArray(params === null || params === void 0 ? void 0 : params.SimpleVersions) || params.SimpleVersions.length === 0) {
261
+ throw new Error('Missing required parameters: SimpleVersions');
262
+ }
263
+ const simpleVersions = params.SimpleVersions.map((item, index) => {
264
+ var _a, _b, _c;
265
+ const serverName = (_a = item === null || item === void 0 ? void 0 : item.ServerName) === null || _a === void 0 ? void 0 : _a.trim();
266
+ const versionName = (_b = item === null || item === void 0 ? void 0 : item.VersionName) === null || _b === void 0 ? void 0 : _b.trim();
267
+ if (!serverName) {
268
+ throw new Error(`Invalid SimpleVersions[${index}].ServerName`);
269
+ }
270
+ if (!versionName) {
271
+ throw new Error(`Invalid SimpleVersions[${index}].VersionName`);
272
+ }
273
+ return {
274
+ EnvId: ((_c = item === null || item === void 0 ? void 0 : item.EnvId) === null || _c === void 0 ? void 0 : _c.trim()) || envConfig.EnvId,
275
+ ServerName: serverName,
276
+ VersionName: versionName
277
+ };
278
+ });
279
+ return this.tcbrService.request('DeleteCloudRunVersions', Object.assign({ EnvId: envConfig.EnvId, IsDeleteServer: params.IsDeleteServer, IsDeleteImage: params.IsDeleteImage, SimpleVersions: simpleVersions }, (operatorRemark ? { OperatorRemark: operatorRemark } : {})));
280
+ }
281
+ /**
282
+ * 查询版本详情
283
+ * @param {IDescribeVersionDetailParams} params 查询参数(服务名、版本名、可选渠道)
284
+ * @returns {Promise<IDescribeVersionDetailResponse>} 版本详情
285
+ */
286
+ async describeVersionDetail(params) {
287
+ var _a, _b, _c;
288
+ const envConfig = this.environment.lazyEnvironmentConfig;
289
+ const serverName = (_a = params === null || params === void 0 ? void 0 : params.ServerName) === null || _a === void 0 ? void 0 : _a.trim();
290
+ const versionName = (_b = params === null || params === void 0 ? void 0 : params.VersionName) === null || _b === void 0 ? void 0 : _b.trim();
291
+ const channel = (_c = params === null || params === void 0 ? void 0 : params.Channel) === null || _c === void 0 ? void 0 : _c.trim();
292
+ if (!serverName) {
293
+ throw new Error('Missing required parameters: ServerName');
294
+ }
295
+ if (!versionName) {
296
+ throw new Error('Missing required parameters: VersionName');
297
+ }
298
+ return this.tcbrService.request('DescribeVersionDetail', Object.assign({ EnvId: envConfig.EnvId, ServerName: serverName, VersionName: versionName }, (channel ? { Channel: channel } : {})));
299
+ }
200
300
  /**
201
301
  *查询云托管服务详情
202
302
  * @param {Object} params 查询参数
@@ -433,6 +533,12 @@ __decorate([
433
533
  __decorate([
434
534
  (0, utils_1.preLazy)()
435
535
  ], CloudRunService.prototype, "download", null);
536
+ __decorate([
537
+ (0, utils_1.preLazy)()
538
+ ], CloudRunService.prototype, "describeServerManageTask", null);
539
+ __decorate([
540
+ (0, utils_1.preLazy)()
541
+ ], CloudRunService.prototype, "describeReleaseOrder", null);
436
542
  __decorate([
437
543
  (0, utils_1.preLazy)()
438
544
  ], CloudRunService.prototype, "list", null);
@@ -445,6 +551,15 @@ __decorate([
445
551
  __decorate([
446
552
  (0, utils_1.preLazy)()
447
553
  ], CloudRunService.prototype, "rollback", null);
554
+ __decorate([
555
+ (0, utils_1.preLazy)()
556
+ ], CloudRunService.prototype, "submitServerRollback", null);
557
+ __decorate([
558
+ (0, utils_1.preLazy)()
559
+ ], CloudRunService.prototype, "deleteCloudRunVersions", null);
560
+ __decorate([
561
+ (0, utils_1.preLazy)()
562
+ ], CloudRunService.prototype, "describeVersionDetail", null);
448
563
  __decorate([
449
564
  (0, utils_1.preLazy)()
450
565
  ], CloudRunService.prototype, "detail", null);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cloudbase/manager-node",
3
- "version": "5.6.6",
3
+ "version": "5.6.8",
4
4
  "description": "The node manage service api for cloudbase.",
5
5
  "main": "lib/index.js",
6
6
  "scripts": {
@@ -1,6 +1,6 @@
1
1
  import { Environment } from '../environment';
2
2
  import { IResponseInfo } from '../interfaces';
3
- import { CloudrunServerType, ICloudrunDetailResponse, ICloudrunListResponse, ICloudrunServerBaseConfig, ICreateVpcInfo, IBuildLogResponse, IProcessLogResponse, IDiffConfigItem, ITemplate, ReleaseTypeEnum, IDescribeCloudRunDeployRecordResponse } from './type';
3
+ import { CloudrunServerType, ICloudrunDetailResponse, ICloudrunListResponse, ICloudrunServerBaseConfig, ICreateVpcInfo, IBuildLogResponse, IProcessLogResponse, IDiffConfigItem, ITemplate, ReleaseTypeEnum, IServerManageTaskInfo, IDescribeReleaseOrderParams, IDescribeReleaseOrderResponse, IDescribeCloudRunDeployRecordResponse, IDescribeVersionDetailParams, IDescribeVersionDetailResponse, ISubmitServerRollbackParams, ISubmitServerRollbackResponse, IDeleteCloudRunVersionsParams, IDeleteCloudRunVersionsResponse } from './type';
4
4
  /**
5
5
  * 云托管服务管理类
6
6
  * 提供云托管服务的初始化、下载、列表查询和删除等功能
@@ -41,6 +41,29 @@ export declare class CloudRunService {
41
41
  serverName: string;
42
42
  targetPath: string;
43
43
  }): Promise<void>;
44
+ /**
45
+ * 查询服务管理任务信息
46
+ * @param {Object} params 查询参数
47
+ * @param {string} params.serverName 服务名
48
+ * @param {number} [params.taskId=0] 任务 ID,传 0 表示查询该服务当前最新的任务
49
+ * @param {string} [params.operatorRemark] 操作标识
50
+ * @returns {Promise<{ IsExist?: boolean; Task?: IServerManageTaskInfo; RequestId?: string }>} 任务是否存在及任务信息
51
+ */
52
+ describeServerManageTask(params: {
53
+ serverName: string;
54
+ taskId?: number;
55
+ operatorRemark?: string;
56
+ }): Promise<{
57
+ IsExist?: boolean;
58
+ Task?: IServerManageTaskInfo;
59
+ RequestId?: string;
60
+ }>;
61
+ /**
62
+ * 查询发布单信息(DescribeReleaseOrder)
63
+ * @param {IDescribeReleaseOrderParams} params 查询参数
64
+ * @returns {Promise<IDescribeReleaseOrderResponse>} 发布单详情
65
+ */
66
+ describeReleaseOrder(params: IDescribeReleaseOrderParams): Promise<IDescribeReleaseOrderResponse>;
44
67
  /**
45
68
  * 获取云托管服务列表
46
69
  * @param {Object} [params] 查询参数
@@ -82,6 +105,24 @@ export declare class CloudRunService {
82
105
  rollback(serverName: string): Promise<{
83
106
  RequestId?: string;
84
107
  }>;
108
+ /**
109
+ * 回滚版本(SubmitServerRollback)
110
+ * @param {ISubmitServerRollbackParams} params 回滚参数(服务名、当前版本名、目标回滚版本名)
111
+ * @returns {Promise<ISubmitServerRollbackResponse>} 返回任务 ID 和请求 ID
112
+ */
113
+ submitServerRollback(params: ISubmitServerRollbackParams): Promise<ISubmitServerRollbackResponse>;
114
+ /**
115
+ * 批量删除版本
116
+ * @param {IDeleteCloudRunVersionsParams} params 删除参数
117
+ * @returns {Promise<IDeleteCloudRunVersionsResponse>} 删除结果
118
+ */
119
+ deleteCloudRunVersions(params: IDeleteCloudRunVersionsParams): Promise<IDeleteCloudRunVersionsResponse>;
120
+ /**
121
+ * 查询版本详情
122
+ * @param {IDescribeVersionDetailParams} params 查询参数(服务名、版本名、可选渠道)
123
+ * @returns {Promise<IDescribeVersionDetailResponse>} 版本详情
124
+ */
125
+ describeVersionDetail(params: IDescribeVersionDetailParams): Promise<IDescribeVersionDetailResponse>;
85
126
  /**
86
127
  *查询云托管服务详情
87
128
  * @param {Object} params 查询参数
@@ -426,6 +426,158 @@ export interface IReleaseOrderInfo {
426
426
  CreateTime?: string;
427
427
  IsReleasing?: boolean;
428
428
  }
429
+ /**
430
+ * DescribeReleaseOrder 请求参数
431
+ */
432
+ export interface IDescribeReleaseOrderParams {
433
+ /** 服务名 */
434
+ ServerName: string;
435
+ /** 发布单状态(可选) */
436
+ Status?: string;
437
+ }
438
+ /**
439
+ * DescribeReleaseOrder 响应
440
+ */
441
+ export interface IDescribeReleaseOrderResponse {
442
+ /** 是否存在发布单 */
443
+ IsExist?: boolean;
444
+ /** 发布单详情 */
445
+ ReleaseOrderInfo?: IReleaseOrderInfo;
446
+ /** 上一次成功发布时间 */
447
+ LastReleasedSuccessTime?: string;
448
+ /** 请求 ID */
449
+ RequestId: string;
450
+ }
451
+ /**
452
+ * DescribeVersionDetail 请求参数
453
+ */
454
+ export interface IDescribeVersionDetailParams {
455
+ /** 服务名 */
456
+ ServerName: string;
457
+ /** 版本名 */
458
+ VersionName: string;
459
+ /** 可选渠道 */
460
+ Channel?: string;
461
+ }
462
+ /**
463
+ * BuildPacksInfo(CreateCloudRunServer / DescribeVersionDetail / UpdateCloudRunServer)
464
+ */
465
+ export interface IBuildPacksInfo {
466
+ /** 基础镜像 */
467
+ BaseImage: string;
468
+ /** 启动命令 */
469
+ EntryPoint: string;
470
+ /** 语言 */
471
+ RepoLanguage: string;
472
+ /** 上传文件名 */
473
+ UploadFilename: string;
474
+ /** 语言版本 */
475
+ LanguageVersion?: string;
476
+ }
477
+ /**
478
+ * DescribeVersionDetail 响应
479
+ */
480
+ export interface IDescribeVersionDetailResponse {
481
+ Name: string;
482
+ Port: number;
483
+ Cpu: number;
484
+ Mem: number;
485
+ MinNum: number;
486
+ MaxNum: number;
487
+ PolicyDetails: ICloudrunHpaPolicy[];
488
+ Dockerfile: string;
489
+ BuildDir: string;
490
+ EnvParams: string;
491
+ Status: string;
492
+ CreatedTime: string;
493
+ UpdatedTime: string;
494
+ LogPath: string;
495
+ EntryPoint: string | null;
496
+ Cmd: string | null;
497
+ VpcConf: IVpcConf | null;
498
+ VolumesConf: IVolumeConf[] | null;
499
+ BuildPacks: IBuildPacksInfo | null;
500
+ RequestId: string;
501
+ }
502
+ /**
503
+ * SubmitServerRollback 请求参数
504
+ */
505
+ export interface ISubmitServerRollbackParams {
506
+ /** 服务名 */
507
+ ServerName: string;
508
+ /** 当前版本名 */
509
+ CurrentVersionName: string;
510
+ /** 目标回滚版本名 */
511
+ RollbackVersionName: string;
512
+ /** 操作标识 */
513
+ OperatorRemark?: string;
514
+ }
515
+ /**
516
+ * SubmitServerRollback 响应
517
+ */
518
+ export interface ISubmitServerRollbackResponse {
519
+ /** 任务 ID */
520
+ TaskId: number;
521
+ /** 请求 ID */
522
+ RequestId: string;
523
+ }
524
+ /**
525
+ * DeleteCloudRunVersions 版本信息
526
+ */
527
+ export interface ISimpleVersion {
528
+ /** 环境 ID(可选,不传时由 SDK 自动注入当前环境) */
529
+ EnvId?: string;
530
+ /** 服务名 */
531
+ ServerName: string;
532
+ /** 版本名 */
533
+ VersionName: string;
534
+ }
535
+ /**
536
+ * DeleteCloudRunVersions 请求参数
537
+ */
538
+ export interface IDeleteCloudRunVersionsParams {
539
+ /** 是否删除服务(仅最后一个版本时生效) */
540
+ IsDeleteServer: boolean;
541
+ /** 是否删除镜像(仅删除服务时生效) */
542
+ IsDeleteImage: boolean;
543
+ /** 待删除版本列表 */
544
+ SimpleVersions: ISimpleVersion[];
545
+ /** 操作标识 */
546
+ OperatorRemark?: string;
547
+ }
548
+ /**
549
+ * FailDeleteVersions(删除失败版本信息)
550
+ */
551
+ export interface IFailDeleteVersions {
552
+ /** 删除失败版本信息 */
553
+ Version: ISimpleVersion;
554
+ /** 删除失败错误码 */
555
+ ErrorCode: number;
556
+ /** 删除失败错误信息 */
557
+ ErrorMsg: string;
558
+ /** 删除操作 RequestId */
559
+ RequestId: string;
560
+ }
561
+ /**
562
+ * SuccessDeleteVersions(删除成功的版本信息)
563
+ */
564
+ export interface ISuccessDeleteVersions {
565
+ /** 版本简化信息 */
566
+ Version: ISimpleVersion;
567
+ /** 删除版本的 RequestId */
568
+ RequestId: string;
569
+ /** 删除版本结果 */
570
+ Result: string;
571
+ }
572
+ /**
573
+ * DeleteCloudRunVersions 响应
574
+ */
575
+ export interface IDeleteCloudRunVersionsResponse {
576
+ Result: 'succ' | 'fail' | 'partial' | string;
577
+ FailVersions: IFailDeleteVersions[];
578
+ SuccessVersions: ISuccessDeleteVersions[];
579
+ RequestId: string;
580
+ }
429
581
  /**
430
582
  * DescribeCloudRunDeployRecord 单条部署记录
431
583
  */