@cloudbase/manager-node 4.11.0-alpha.2 → 4.11.0-alpha.4

package/types/mysql/index.d.ts

@@ -0,0 +1,261 @@
+import { Environment } from '../environment';
+import { IResponseInfo } from '../interfaces';
+import { ICreateMySQLOptions, ICreateMySQLResult, IDescribeCreateMySQLResult, IMySQLClusterDetail, IDestroyMySQLResult, IMySQLTaskStatus, IRunSqlOptions, IRunSqlResult, ICreateAccountsOptions, IDeleteAccountsOptions, IDescribeAccountsOptions, IDescribeAccountsResult, IModifyAccountDescriptionOptions, IModifyAccountHostOptions, IModifyAccountParamsOptions, IModifyAccountPrivilegesOptions, IDescribeAccountPrivilegesOptions, IDescribeAccountPrivilegesResult, IDescribeAccountAllGrantPrivilegesResult, IResetAccountPasswordOptions, IInputAccount, IWanOptions, IWanResult, ICreateBackupOptions, ICreateBackupResult, IDeleteBackupOptions, IModifyBackupConfigOptions, IDescribeBackupListOptions, IDescribeBackupListResult, IDescribeBackupDownloadUrlOptions, IDescribeBackupDownloadUrlResult, IRollBackClusterOptions, IRollBackClusterResult, IDescribeTasksOptions, IDescribeTasksResult, IDescribeClusterDatabasesOptions, IDescribeClusterDatabasesResult, IDescribeClusterDatabaseTablesOptions, IDescribeClusterDatabaseTablesResult, IDescribeClusterInstanceGroupsResult, IDescribeInstancesOptions, IDescribeInstancesResult, IRestartInstanceOptions, IRestartInstanceResult, IDescribeInstanceDetailOptions, IDescribeInstanceDetailResult, IUpgradeInstanceOptions, IUpgradeInstanceResult, IDescribeInstanceSlowQueriesOptions, IDescribeInstanceSlowQueriesResult, IDescribeInstanceErrorLogsOptions, IDescribeInstanceErrorLogsResult } from './types/index';
+export * from './types/index';
+export declare class MysqlService {
+    static tcbServiceVersion: {
+        service: string;
+        version: string;
+    };
+    static cynosdbServiceVersion: {
+        service: string;
+        version: string;
+    };
+    private environment;
+    private envId;
+    private cynosdbService;
+    private tcbService;
+    private _clusterId;
+    private _instanceGroupId;
+    constructor(environment: Environment);
+    /**
+     * 获取集群 ID（如未手动设置，则自动通过 describeClusterDetail 获取并缓存）
+     */
+    get clusterId(): string;
+    /**
+     * 手动设置集群 ID（适用于已知 clusterId 的场景，避免额外 API 调用）
+     */
+    set clusterId(id: string);
+    /**
+     * 开通 MySQL
+     * 开通后可通过 describeCreateResult 查询开通结果
+     * @param options 开通参数
+     * @returns 返回包含 TaskId 的结果
+     */
+    createMySQL(options: ICreateMySQLOptions): Promise<{
+        Data: ICreateMySQLResult;
+    } & IResponseInfo>;
+    /**
+     * 开通 MySQL 结果查询
+     * @param taskId OpenMySQL 返回的任务 ID（可选）
+     * @returns 开通结果状态
+     */
+    describeCreateResult(taskId?: string): Promise<{
+        Data: IDescribeCreateMySQLResult;
+    } & IResponseInfo>;
+    /**
+     * 查询 MySQL 集群信息
+     * @returns MySQL 集群详情
+     */
+    describeClusterDetail(): Promise<{
+        Data: IMySQLClusterDetail;
+    } & IResponseInfo>;
+    /**
+     * 销毁 MySQL
+     * 销毁后可通过 describeTaskStatus 查询销毁结果
+     * @returns 销毁结果（包含 TaskId、TaskName）
+     */
+    destroyMySQL(): Promise<{
+        Data: IDestroyMySQLResult;
+    } & IResponseInfo>;
+    /**
+     * 查询 MySQL 任务状态（销毁等异步任务的结果查询）
+     * @param options 查询参数
+     * @param options.taskId 任务 ID
+     * @param options.taskName 任务名称
+     * @returns 任务状态
+     */
+    describeTaskStatus(options?: {
+        taskId?: string;
+        taskName?: string;
+    }): Promise<{
+        Data: IMySQLTaskStatus;
+    } & IResponseInfo>;
+    /**
+     * 执行 SQL 语句
+     * @param options SQL 执行参数
+     * @returns 查询结果（Items、Infos、RowsAffected）
+     */
+    runSql(options: IRunSqlOptions): Promise<IRunSqlResult>;
+    /**
+     * 查询集群实例组信息
+     * 通过 CynosDB 原生接口获取真实的 InstanceGroupId 等信息
+     * @returns 实例组列表
+     */
+    describeClusterInstanceGroups(): Promise<IDescribeClusterInstanceGroupsResult & IResponseInfo>;
+    /**
+     * 关闭外网访问
+     * @param options 实例 ID 或实例组 ID（二选一）；均不传时自动获取实例组 ID
+     * @returns 任务流 ID
+     */
+    closeWan(options?: IWanOptions): Promise<IWanResult & IResponseInfo>;
+    /**
+     * 开启外网访问
+     * @param options 实例 ID 或实例组 ID（二选一）；均不传时自动获取实例组 ID
+     * @returns 任务流 ID
+     */
+    openWan(options?: IWanOptions): Promise<IWanResult & IResponseInfo>;
+    /**
+     * 查询任务列表
+     * @param options 查询参数
+     * @returns 任务列表
+     */
+    describeTasks(options?: IDescribeTasksOptions): Promise<IDescribeTasksResult & IResponseInfo>;
+    /**
+     * 查询实例列表
+     * @param options 查询参数（分页、排序、过滤条件等）
+     * @returns 实例列表和总数
+     */
+    describeInstances(options?: IDescribeInstancesOptions): Promise<IDescribeInstancesResult & IResponseInfo>;
+    /**
+     * 查询实例详情
+     * @param options 包含实例 ID
+     * @returns 实例详细信息
+     */
+    describeInstanceDetail(options: IDescribeInstanceDetailOptions): Promise<IDescribeInstanceDetailResult & IResponseInfo>;
+    /**
+     * 重启实例
+     * @param options 包含实例 ID
+     * @returns 异步任务 FlowId
+     */
+    restartInstance(options: IRestartInstanceOptions): Promise<IRestartInstanceResult & IResponseInfo>;
+    /**
+     * 实例变配（升级/降级实例规格）
+     * @param options 变配参数（实例 ID、CPU、内存、升级类型等）
+     * @returns 订单号和冻结流水 ID
+     */
+    upgradeInstance(options: IUpgradeInstanceOptions): Promise<IUpgradeInstanceResult & IResponseInfo>;
+    /**
+     * 查询实例慢查询日志
+     * @param options 查询参数（实例 ID、时间范围、分页、排序等）
+     * @returns 慢查询日志列表和总数
+     */
+    describeInstanceSlowQueries(options: IDescribeInstanceSlowQueriesOptions): Promise<IDescribeInstanceSlowQueriesResult & IResponseInfo>;
+    /**
+     * 查询实例错误日志
+     * @param options 查询参数（实例 ID、时间范围、分页、排序、日志等级等）
+     * @returns 错误日志列表和总数
+     */
+    describeInstanceErrorLogs(options: IDescribeInstanceErrorLogsOptions): Promise<IDescribeInstanceErrorLogsResult & IResponseInfo>;
+    /**
+     * 查询集群数据库列表
+     * @param options 分页参数
+     * @returns 数据库名称列表
+     */
+    describeClusterDatabases(options?: IDescribeClusterDatabasesOptions): Promise<IDescribeClusterDatabasesResult & IResponseInfo>;
+    /**
+     * 查询集群数据库表列表
+     * @param options 查询参数（包含数据库名）
+     * @returns 数据库表列表
+     */
+    describeClusterDatabaseTables(options: IDescribeClusterDatabaseTablesOptions): Promise<IDescribeClusterDatabaseTablesResult & IResponseInfo>;
+    /**
+     * 创建用户账号
+     * @param options 账号信息
+     * @returns RequestId
+     */
+    createAccounts(options: ICreateAccountsOptions): Promise<IResponseInfo>;
+    /**
+     * 删除用户账号
+     * @param options 要删除的账号列表
+     * @returns RequestId
+     */
+    deleteAccounts(options: IDeleteAccountsOptions): Promise<IResponseInfo>;
+    /**
+     * 查询账号所有可授予权限
+     * @param account 账号信息
+     * @returns 全局权限、数据库权限、表权限等
+     */
+    describeAccountAllGrantPrivileges(account: IInputAccount): Promise<IDescribeAccountAllGrantPrivilegesResult & IResponseInfo>;
+    /**
+     * 查询数据库账号列表
+     * @param options 查询参数
+     * @returns 账号列表和总数
+     */
+    describeAccounts(options?: IDescribeAccountsOptions): Promise<IDescribeAccountsResult & IResponseInfo>;
+    /**
+     * 查询账号已有权限
+     * @param options 查询参数
+     * @returns 权限列表
+     */
+    describeAccountPrivileges(options: IDescribeAccountPrivilegesOptions): Promise<IDescribeAccountPrivilegesResult & IResponseInfo>;
+    /**
+     * 修改数据库账号描述信息
+     * @param options 修改参数
+     * @returns RequestId
+     */
+    modifyAccountDescription(options: IModifyAccountDescriptionOptions): Promise<IResponseInfo>;
+    /**
+     * 修改账号主机
+     * @param options 修改参数
+     * @returns RequestId
+     */
+    modifyAccountHost(options: IModifyAccountHostOptions): Promise<IResponseInfo>;
+    /**
+     * 修改账号配置
+     * @param options 修改参数
+     * @returns RequestId
+     */
+    modifyAccountParams(options: IModifyAccountParamsOptions): Promise<IResponseInfo>;
+    /**
+     * 修改账号库表权限
+     * @param options 修改参数
+     * @returns RequestId
+     */
+    modifyAccountPrivileges(options: IModifyAccountPrivilegesOptions): Promise<IResponseInfo>;
+    /**
+     * 重置数据库账号密码
+     * @param options 重置参数
+     * @returns RequestId
+     */
+    resetAccountPassword(options: IResetAccountPasswordOptions): Promise<IResponseInfo>;
+    /**
+     * 创建手动备份
+     * @param options 备份参数
+     * @returns 异步任务流 ID
+     */
+    createBackup(options?: ICreateBackupOptions): Promise<ICreateBackupResult & IResponseInfo>;
+    /**
+     * 删除手动备份（无法删除自动备份）
+     * @param options 要删除的备份 ID
+     * @returns RequestId
+     */
+    deleteBackup(options: IDeleteBackupOptions): Promise<IResponseInfo>;
+    /**
+     * 修改备份配置
+     * @param options 备份配置参数
+     * @returns RequestId
+     */
+    modifyBackupConfig(options: IModifyBackupConfigOptions): Promise<IResponseInfo>;
+    /**
+     * 查询备份文件列表
+     * @param options 查询参数
+     * @returns 备份文件列表
+     */
+    describeBackupList(options?: IDescribeBackupListOptions): Promise<IDescribeBackupListResult & IResponseInfo>;
+    /**
+     * 查询备份下载地址
+     * @param options 备份 ID
+     * @returns 备份下载地址
+     */
+    describeBackupDownloadUrl(options: IDescribeBackupDownloadUrlOptions): Promise<IDescribeBackupDownloadUrlResult & IResponseInfo>;
+    /**
+     * 集群回档
+     * @param options 回档参数
+     * @returns 任务流 ID
+     */
+    rollBackCluster(options: IRollBackClusterOptions): Promise<IRollBackClusterResult & IResponseInfo>;
+    /**
+     * 确保 clusterId 已获取（内部使用，自动从集群信息中获取并缓存）
+     */
+    private ensureClusterId;
+    /**
+     * 确保 instanceGroupId 已获取（内部使用，通过 CynosDB 原生接口获取真实值并缓存）
+     */
+    private ensureInstanceGroupId;
+    /**
+     * 解析 Wan 操作的请求参数
+     * 若用户未显式传入 InstanceId / InstanceGroupId，则自动获取实例组 ID
+     */
+    private resolveWanParams;
+}

package/types/mysql/types/account.d.ts

@@ -0,0 +1,160 @@
+/** 账号输入信息（用于删除、查询权限等操作） */
+export interface IInputAccount {
+    /** 账号名称 */
+    AccountName: string;
+    /** 主机，默认 '%' */
+    Host?: string;
+}
+/** 新建账号信息 */
+export interface INewAccount {
+    /** 账号名称 */
+    AccountName: string;
+    /** 账号密码（8-64个字符，包含大小写英文字母、数字和符号） */
+    AccountPassword: string;
+    /** 允许访问的主机，可以是 IP 或 '%' */
+    Host: string;
+    /** 账号描述 */
+    Description?: string;
+    /** 用户最大连接数限制 */
+    MaxUserConnections?: number;
+}
+/** 创建账号请求参数 */
+export interface ICreateAccountsOptions {
+    /** 新账户列表 */
+    Accounts: INewAccount[];
+}
+/** 删除账号请求参数 */
+export interface IDeleteAccountsOptions {
+    /** 账号数组 */
+    Accounts?: IInputAccount[];
+}
+/** 查询账号列表请求参数 */
+export interface IDescribeAccountsOptions {
+    /** 需要过滤的账户列表 */
+    AccountNames?: string[];
+    /** 需要过滤的主机列表 */
+    Hosts?: string[];
+    /** 限制量 */
+    Limit?: number;
+    /** 偏移量 */
+    Offset?: number;
+    /** 模糊匹配关键字（同时匹配 AccountName 和 Host，支持正则） */
+    AccountRegular?: string;
+}
+/** 账号信息 */
+export interface IAccountInfo {
+    /** 账号名称 */
+    AccountName: string;
+    /** 账号描述 */
+    Description: string;
+    /** 创建时间 */
+    CreateTime: string;
+    /** 更新时间 */
+    UpdateTime: string;
+    /** 主机 */
+    Host: string;
+    /** 最大用户连接数 */
+    MaxUserConnections: number;
+}
+/** 查询账号列表返回结果 */
+export interface IDescribeAccountsResult {
+    /** 账号列表 */
+    AccountSet: IAccountInfo[];
+    /** 账号总数 */
+    TotalCount: number;
+}
+/** 修改账号描述请求参数 */
+export interface IModifyAccountDescriptionOptions {
+    /** 账号名称 */
+    AccountName: string;
+    /** 新的描述信息 */
+    Description: string;
+    /** 主机，默认 '%' */
+    Host?: string;
+}
+/** 修改账号主机请求参数 */
+export interface IModifyAccountHostOptions {
+    /** 账号信息 */
+    Account: IInputAccount;
+    /** 新主机 */
+    NewHost: string;
+}
+/** 账号参数项 */
+export interface IAccountParamItem {
+    /** 参数名称 */
+    ParamName: string;
+    /** 参数值 */
+    ParamValue: string;
+}
+/** 修改账号配置请求参数 */
+export interface IModifyAccountParamsOptions {
+    /** 账号信息 */
+    Account: IInputAccount;
+    /** 账号参数列表 */
+    AccountParams: IAccountParamItem[];
+}
+/** 数据库权限 */
+export interface IDatabasePrivilege {
+    /** 数据库名 */
+    Db: string;
+    /** 权限列表 */
+    Privileges: string[];
+}
+/** 表权限 */
+export interface ITablePrivilege {
+    /** 数据库名 */
+    Db: string;
+    /** 表名 */
+    TableName: string;
+    /** 权限列表 */
+    Privileges: string[];
+}
+/** 修改账号权限请求参数 */
+export interface IModifyAccountPrivilegesOptions {
+    /** 账号信息 */
+    Account: IInputAccount;
+    /** 全局权限 */
+    GlobalPrivileges?: string[];
+    /** 数据库权限 */
+    DatabasePrivileges?: IDatabasePrivilege[];
+    /** 表权限 */
+    TablePrivileges?: ITablePrivilege[];
+}
+/** 查询账号已有权限请求参数 */
+export interface IDescribeAccountPrivilegesOptions {
+    /** 账号名 */
+    AccountName: string;
+    /** 主机 */
+    Host: string;
+    /** 数据库名，为 '*' 时忽略 Type/TableName，表示修改用户全局权限 */
+    Db: string;
+    /** 指定数据库下的对象类型，可选 'table' 或 '*' */
+    Type: string;
+    /** 当 Type='table' 时，用来指定表名 */
+    TableName?: string;
+}
+/** 查询账号已有权限返回结果 */
+export interface IDescribeAccountPrivilegesResult {
+    /** 权限列表 */
+    Privileges: string[];
+}
+/** 查询账号所有可授予权限返回结果 */
+export interface IDescribeAccountAllGrantPrivilegesResult {
+    /** 权限语句 */
+    PrivilegeStatements: string[];
+    /** 全局权限 */
+    GlobalPrivileges: string[];
+    /** 数据库权限 */
+    DatabasePrivileges: IDatabasePrivilege[];
+    /** 表权限 */
+    TablePrivileges: ITablePrivilege[];
+}
+/** 重置账号密码请求参数 */
+export interface IResetAccountPasswordOptions {
+    /** 账号名称 */
+    AccountName: string;
+    /** 新密码 */
+    AccountPassword: string;
+    /** 主机，默认 '%' */
+    Host?: string;
+}

package/types/mysql/types/backup.d.ts

@@ -0,0 +1,161 @@
+/** 数据库表信息（用于备份） */
+export interface IDatabaseTables {
+    /** 数据库名 */
+    Database?: string;
+    /** 表名称列表 */
+    Tables?: string[];
+}
+/** 创建备份请求参数 */
+export interface ICreateBackupOptions {
+    /** 备份类型：logic（逻辑备份）、snapshot（物理备份） */
+    BackupType?: string;
+    /** 备份的库，只在 BackupType 为 logic 时有效 */
+    BackupDatabases?: string[];
+    /** 备份的表，只在 BackupType 为 logic 时有效 */
+    BackupTables?: IDatabaseTables[];
+    /** 备注名 */
+    BackupName?: string;
+}
+/** 创建备份返回结果 */
+export interface ICreateBackupResult {
+    /** 异步任务流 ID */
+    FlowId: number;
+}
+/** 删除备份请求参数 */
+export interface IDeleteBackupOptions {
+    /** 备份文件 ID（推荐使用） */
+    BackupIds?: number[];
+    /** 备份文件 ID（旧版本，不推荐） */
+    SnapshotIdList?: number[];
+}
+/** 修改备份配置请求参数 */
+export interface IModifyBackupConfigOptions {
+    /** 全备开始时间，范围 [0-24*3600]，如 0:00=0, 1:00=3600, 2:00=7200 */
+    BackupTimeBeg?: number;
+    /** 全备结束时间，范围 [0-24*3600] */
+    BackupTimeEnd?: number;
+    /** 保留备份时长（秒），超过该时间将被清理，如七天=604800 */
+    ReserveDuration?: number;
+    /** 备份频率，长度为7的数组，对应周一到周日，full-全量，increment-增量 */
+    BackupFreq?: string[];
+    /** 备份类型 */
+    BackupType?: string;
+}
+/** 查询备份列表请求参数 */
+export interface IDescribeBackupListOptions {
+    /** 返回数量，取值范围 (0,100] */
+    Limit?: number;
+    /** 记录偏移量 */
+    Offset?: number;
+    /** 数据库类型，取值 MYSQL */
+    DbType?: string;
+    /** 备份 ID 列表 */
+    BackupIds?: number[];
+    /** 备份类型：snapshot（快照备份）、logic（逻辑备份） */
+    BackupType?: string;
+    /** 备份方式：auto（自动备份）、manual（手动备份） */
+    BackupMethod?: string;
+    /** 快照类型：full（全量）、increment（增量） */
+    SnapShotType?: string;
+    /** 备份开始时间 */
+    StartTime?: string;
+    /** 备份结束时间 */
+    EndTime?: string;
+    /** 备份文件名，支持模糊查询 */
+    FileNames?: string[];
+    /** 备份备注名，支持模糊查询 */
+    BackupNames?: string[];
+    /** 快照备份 ID 列表 */
+    SnapshotIdList?: number[];
+    /** 备份地域 */
+    BackupRegion?: string;
+    /** 是否跨地域备份 */
+    IsCrossRegionsBackup?: string;
+}
+/** 备份文件信息 */
+export interface IBackupFileInfo {
+    /** 快照文件ID（已废弃，请使用 BackupId） */
+    SnapshotId: number;
+    /** 备份文件名 */
+    FileName: string;
+    /** 备份文件大小 */
+    FileSize: number;
+    /** 备份开始时间 */
+    StartTime: string;
+    /** 备份完成时间 */
+    FinishTime: string;
+    /** 备份类型：snapshot / logic */
+    BackupType: string;
+    /** 备份方式：auto / manual */
+    BackupMethod: string;
+    /** 备份文件状态：success / fail / creating / deleting */
+    BackupStatus: string;
+    /** 备份文件时间 */
+    SnapshotTime: string;
+    /** 备份ID */
+    BackupId: number;
+    /** 快照类型：full / increment */
+    SnapShotType: string;
+    /** 备份文件备注 */
+    BackupName: string;
+}
+/** 查询备份列表返回结果 */
+export interface IDescribeBackupListResult {
+    /** 总共备份文件个数 */
+    TotalCount: number;
+    /** 备份文件列表 */
+    BackupList: IBackupFileInfo[];
+}
+/** 查询备份下载地址请求参数 */
+export interface IDescribeBackupDownloadUrlOptions {
+    /** 备份 ID */
+    BackupId: number;
+}
+/** 查询备份下载地址返回结果 */
+export interface IDescribeBackupDownloadUrlResult {
+    /** 备份下载地址 */
+    DownloadUrl: string;
+}
+/** 回档数据库信息 */
+export interface IRollbackDatabase {
+    /** 旧数据库名称 */
+    OldDatabase: string;
+    /** 新数据库名称 */
+    NewDatabase: string;
+}
+/** 回档表信息 */
+export interface IRollbackTableInfo {
+    /** 旧表名称 */
+    OldTable: string;
+    /** 新表名称 */
+    NewTable: string;
+}
+/** 回档数据库及表 */
+export interface IRollbackTable {
+    /** 数据库名称 */
+    Database: string;
+    /** 数据库表 */
+    Tables: IRollbackTableInfo[];
+}
+/** 集群回档请求参数 */
+export interface IRollBackClusterOptions {
+    /** 回档策略：timeRollback（按时间点）、snapRollback（按备份文件） */
+    RollbackStrategy: string;
+    /** 备份文件ID，snapRollback 时必填 */
+    RollbackId?: number;
+    /** 期望回档时间，timeRollback 时必填 */
+    ExpectTime?: string;
+    /** 期望阈值（已废弃） */
+    ExpectTimeThresh?: number;
+    /** 回档数据库列表 */
+    RollbackDatabases?: IRollbackDatabase[];
+    /** 回档数据库表列表 */
+    RollbackTables?: IRollbackTable[];
+    /** 按时间点回档模式：full（普通，默认）、db（快速）、table（极速） */
+    RollbackMode?: string;
+}
+/** 回档返回结果 */
+export interface IRollBackClusterResult {
+    /** 任务流 ID */
+    FlowId: number;
+}