tencentcloud-sdk-nodejs-cdwch 4.0.490

package/src/services/cdwch/v20200915/cdwch_models.ts

@@ -0,0 +1,314 @@
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. 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.
+ */
+
+/**
+ * DescribeInstanceShards请求参数结构体
+ */
+export interface DescribeInstanceShardsRequest {
+  /**
+   * 集群实例ID
+   */
+  InstanceId: string
+}
+
+/**
+ * ModifyUserNewPrivilege请求参数结构体
+ */
+export type ModifyUserNewPrivilegeRequest = null
+
+/**
+ * CreateBackUpSchedule请求参数结构体
+ */
+export interface CreateBackUpScheduleRequest {
+  /**
+   * 编辑时需要传
+   */
+  ScheduleId?: number
+
+  /**
+   * 选择的星期 逗号分隔
+   */
+  WeekDays?: string
+
+  /**
+   * 执行小时
+   */
+  ExecuteHour?: number
+
+  /**
+   * 备份表列表
+   */
+  BackUpTables?: Array<BackupTableContent>
+}
+
+/**
+ * DescribeInstanceShards返回参数结构体
+ */
+export interface DescribeInstanceShardsResponse {
+  /**
+      * 实例shard信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  InstanceShardsList: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * OpenBackUp请求参数结构体
+ */
+export interface OpenBackUpRequest {
+  /**
+   * 集群id
+   */
+  InstanceId: string
+
+  /**
+   * OPEN 或者CLOSE
+   */
+  OperationType: string
+
+  /**
+   * 桶名字
+   */
+  CosBucketName: string
+}
+
+/**
+ * ModifyClusterConfigs返回参数结构体
+ */
+export interface ModifyClusterConfigsResponse {
+  /**
+   * 流程相关信息
+   */
+  FlowId: number
+
+  /**
+   * 错误信息
+   */
+  ErrorMsg: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 备份表信息
+ */
+export interface BackupTableContent {
+  /**
+   * 数据库
+   */
+  Database: string
+
+  /**
+   * 表
+   */
+  Table: string
+
+  /**
+   * 表总字节数
+   */
+  TotalBytes: number
+
+  /**
+   * 虚拟cluster
+   */
+  VCluster?: string
+
+  /**
+   * 表ip
+   */
+  Ips?: string
+}
+
+/**
+ * OpenBackUp返回参数结构体
+ */
+export interface OpenBackUpResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 配置文件修改信息
+ */
+export interface ConfigSubmitContext {
+  /**
+   * 配置文件名称
+   */
+  FileName: string
+
+  /**
+   * 配置文件旧内容，base64编码
+   */
+  OldConfValue: string
+
+  /**
+   * 配置文件新内容，base64编码
+   */
+  NewConfValue: string
+
+  /**
+   * 保存配置文件的路径
+   */
+  FilePath?: string
+}
+
+/**
+ * ActionAlterCkUser返回参数结构体
+ */
+export interface ActionAlterCkUserResponse {
+  /**
+      * 错误信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ErrMsg: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DescribeCkSqlApis请求参数结构体
+ */
+export interface DescribeCkSqlApisRequest {
+  /**
+   * 实例id
+   */
+  InstanceId: string
+
+  /**
+   * api接口名称
+   */
+  ApiType: string
+
+  /**
+   * 集群名称
+   */
+  Cluster?: string
+
+  /**
+   * 用户名称
+   */
+  UserName?: string
+}
+
+/**
+ * ActionAlterCkUser请求参数结构体
+ */
+export interface ActionAlterCkUserRequest {
+  /**
+   * 用户信息
+   */
+  UserInfo: CkUserAlterInfo
+
+  /**
+   * api接口类型
+   */
+  ApiType: string
+}
+
+/**
+ * 新增或是修改ck用户
+ */
+export interface CkUserAlterInfo {
+  /**
+   * 集群实例id
+   */
+  InstanceId: string
+
+  /**
+   * 用户名
+   */
+  UserName: string
+
+  /**
+   * 密码
+   */
+  PassWord: string
+
+  /**
+   * 描述
+   */
+  Describe?: string
+}
+
+/**
+ * CreateBackUpSchedule返回参数结构体
+ */
+export interface CreateBackUpScheduleResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * ModifyClusterConfigs请求参数结构体
+ */
+export interface ModifyClusterConfigsRequest {
+  /**
+   * 集群ID，例如cdwch-xxxx
+   */
+  InstanceId: string
+
+  /**
+   * 配置文件修改信息
+   */
+  ModifyConfContext: Array<ConfigSubmitContext>
+
+  /**
+   * 修改原因
+   */
+  Remark?: string
+}
+
+/**
+ * DescribeCkSqlApis返回参数结构体
+ */
+export interface DescribeCkSqlApisResponse {
+  /**
+      * 返回的查询数据，大部分情况是list，也可能是bool
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ReturnData: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * ModifyUserNewPrivilege返回参数结构体
+ */
+export interface ModifyUserNewPrivilegeResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}

package/src/services/cdwch/v20200915/index.ts

@@ -0,0 +1,6 @@
+import * as Models from "./cdwch_models"
+import { Client } from "./cdwch_client"
+export const v20200915 = {
+  Client: Client,
+  Models: Models,
+}

package/src/services/index.ts

@@ -0,0 +1 @@
+export { cdwch } from "./cdwch"

package/tencentcloud/index.d.ts

@@ -0,0 +1 @@
+export * from "./services";

package/tencentcloud/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./services"), exports);

package/tencentcloud/services/cdwch/index.d.ts

@@ -0,0 +1,6 @@
+export declare const cdwch: {
+    v20200915: {
+        Client: typeof import("./v20200915/cdwch_client").Client;
+        Models: typeof import("./v20200915/cdwch_models");
+    };
+};

package/tencentcloud/services/cdwch/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cdwch = void 0;
+const v20200915_1 = require("./v20200915");
+exports.cdwch = {
+    v20200915: v20200915_1.v20200915,
+};

package/tencentcloud/services/cdwch/v20200915/cdwch_client.d.ts

@@ -0,0 +1,37 @@
+import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
+import { DescribeInstanceShardsRequest, ModifyUserNewPrivilegeRequest, CreateBackUpScheduleRequest, DescribeInstanceShardsResponse, OpenBackUpRequest, ModifyClusterConfigsResponse, OpenBackUpResponse, ActionAlterCkUserResponse, DescribeCkSqlApisRequest, ActionAlterCkUserRequest, CreateBackUpScheduleResponse, ModifyClusterConfigsRequest, DescribeCkSqlApisResponse, ModifyUserNewPrivilegeResponse } from "./cdwch_models";
+/**
+ * cdwch client
+ * @class
+ */
+export declare class Client extends TencentCloudCommon.AbstractClient {
+    constructor(clientConfig: TencentCloudCommon.ClientConfig);
+    /**
+     * 创建或者修改备份策略
+     */
+    CreateBackUpSchedule(req: CreateBackUpScheduleRequest, cb?: (error: string, rep: CreateBackUpScheduleResponse) => void): Promise<CreateBackUpScheduleResponse>;
+    /**
+     * 针对驱动sql命令查询ck集群接口
+     */
+    DescribeCkSqlApis(req: DescribeCkSqlApisRequest, cb?: (error: string, rep: DescribeCkSqlApisResponse) => void): Promise<DescribeCkSqlApisResponse>;
+    /**
+     * 新增和修改用户接口
+     */
+    ActionAlterCkUser(req: ActionAlterCkUserRequest, cb?: (error: string, rep: ActionAlterCkUserResponse) => void): Promise<ActionAlterCkUserResponse>;
+    /**
+     * 开启或者关闭策略
+     */
+    OpenBackUp(req: OpenBackUpRequest, cb?: (error: string, rep: OpenBackUpResponse) => void): Promise<OpenBackUpResponse>;
+    /**
+     * 在集群配置页面修改集群配置文件接口，xml模式
+     */
+    ModifyClusterConfigs(req: ModifyClusterConfigsRequest, cb?: (error: string, rep: ModifyClusterConfigsResponse) => void): Promise<ModifyClusterConfigsResponse>;
+    /**
+     * 针对ck账号的权限做管控（新版）
+     */
+    ModifyUserNewPrivilege(req?: ModifyUserNewPrivilegeRequest, cb?: (error: string, rep: ModifyUserNewPrivilegeResponse) => void): Promise<ModifyUserNewPrivilegeResponse>;
+    /**
+     * 获取实例shard信息列表
+     */
+    DescribeInstanceShards(req: DescribeInstanceShardsRequest, cb?: (error: string, rep: DescribeInstanceShardsResponse) => void): Promise<DescribeInstanceShardsResponse>;
+}

package/tencentcloud/services/cdwch/v20200915/cdwch_client.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. 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.
+ */
+const TencentCloudCommon = require("tencentcloud-sdk-nodejs-common");
+/**
+ * cdwch client
+ * @class
+ */
+class Client extends TencentCloudCommon.AbstractClient {
+    constructor(clientConfig) {
+        super("cdwch.tencentcloudapi.com", "2020-09-15", clientConfig);
+    }
+    /**
+     * 创建或者修改备份策略
+     */
+    async CreateBackUpSchedule(req, cb) {
+        return this.request("CreateBackUpSchedule", req, cb);
+    }
+    /**
+     * 针对驱动sql命令查询ck集群接口
+     */
+    async DescribeCkSqlApis(req, cb) {
+        return this.request("DescribeCkSqlApis", req, cb);
+    }
+    /**
+     * 新增和修改用户接口
+     */
+    async ActionAlterCkUser(req, cb) {
+        return this.request("ActionAlterCkUser", req, cb);
+    }
+    /**
+     * 开启或者关闭策略
+     */
+    async OpenBackUp(req, cb) {
+        return this.request("OpenBackUp", req, cb);
+    }
+    /**
+     * 在集群配置页面修改集群配置文件接口，xml模式
+     */
+    async ModifyClusterConfigs(req, cb) {
+        return this.request("ModifyClusterConfigs", req, cb);
+    }
+    /**
+     * 针对ck账号的权限做管控（新版）
+     */
+    async ModifyUserNewPrivilege(req, cb) {
+        return this.request("ModifyUserNewPrivilege", req, cb);
+    }
+    /**
+     * 获取实例shard信息列表
+     */
+    async DescribeInstanceShards(req, cb) {
+        return this.request("DescribeInstanceShards", req, cb);
+    }
+}
+exports.Client = Client;

package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts

@@ -0,0 +1,255 @@
+/**
+ * DescribeInstanceShards请求参数结构体
+ */
+export interface DescribeInstanceShardsRequest {
+    /**
+     * 集群实例ID
+     */
+    InstanceId: string;
+}
+/**
+ * ModifyUserNewPrivilege请求参数结构体
+ */
+export declare type ModifyUserNewPrivilegeRequest = null;
+/**
+ * CreateBackUpSchedule请求参数结构体
+ */
+export interface CreateBackUpScheduleRequest {
+    /**
+     * 编辑时需要传
+     */
+    ScheduleId?: number;
+    /**
+     * 选择的星期 逗号分隔
+     */
+    WeekDays?: string;
+    /**
+     * 执行小时
+     */
+    ExecuteHour?: number;
+    /**
+     * 备份表列表
+     */
+    BackUpTables?: Array<BackupTableContent>;
+}
+/**
+ * DescribeInstanceShards返回参数结构体
+ */
+export interface DescribeInstanceShardsResponse {
+    /**
+        * 实例shard信息
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    InstanceShardsList: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * OpenBackUp请求参数结构体
+ */
+export interface OpenBackUpRequest {
+    /**
+     * 集群id
+     */
+    InstanceId: string;
+    /**
+     * OPEN 或者CLOSE
+     */
+    OperationType: string;
+    /**
+     * 桶名字
+     */
+    CosBucketName: string;
+}
+/**
+ * ModifyClusterConfigs返回参数结构体
+ */
+export interface ModifyClusterConfigsResponse {
+    /**
+     * 流程相关信息
+     */
+    FlowId: number;
+    /**
+     * 错误信息
+     */
+    ErrorMsg: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * 备份表信息
+ */
+export interface BackupTableContent {
+    /**
+     * 数据库
+     */
+    Database: string;
+    /**
+     * 表
+     */
+    Table: string;
+    /**
+     * 表总字节数
+     */
+    TotalBytes: number;
+    /**
+     * 虚拟cluster
+     */
+    VCluster?: string;
+    /**
+     * 表ip
+     */
+    Ips?: string;
+}
+/**
+ * OpenBackUp返回参数结构体
+ */
+export interface OpenBackUpResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * 配置文件修改信息
+ */
+export interface ConfigSubmitContext {
+    /**
+     * 配置文件名称
+     */
+    FileName: string;
+    /**
+     * 配置文件旧内容，base64编码
+     */
+    OldConfValue: string;
+    /**
+     * 配置文件新内容，base64编码
+     */
+    NewConfValue: string;
+    /**
+     * 保存配置文件的路径
+     */
+    FilePath?: string;
+}
+/**
+ * ActionAlterCkUser返回参数结构体
+ */
+export interface ActionAlterCkUserResponse {
+    /**
+        * 错误信息
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ErrMsg: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * DescribeCkSqlApis请求参数结构体
+ */
+export interface DescribeCkSqlApisRequest {
+    /**
+     * 实例id
+     */
+    InstanceId: string;
+    /**
+     * api接口名称
+     */
+    ApiType: string;
+    /**
+     * 集群名称
+     */
+    Cluster?: string;
+    /**
+     * 用户名称
+     */
+    UserName?: string;
+}
+/**
+ * ActionAlterCkUser请求参数结构体
+ */
+export interface ActionAlterCkUserRequest {
+    /**
+     * 用户信息
+     */
+    UserInfo: CkUserAlterInfo;
+    /**
+     * api接口类型
+     */
+    ApiType: string;
+}
+/**
+ * 新增或是修改ck用户
+ */
+export interface CkUserAlterInfo {
+    /**
+     * 集群实例id
+     */
+    InstanceId: string;
+    /**
+     * 用户名
+     */
+    UserName: string;
+    /**
+     * 密码
+     */
+    PassWord: string;
+    /**
+     * 描述
+     */
+    Describe?: string;
+}
+/**
+ * CreateBackUpSchedule返回参数结构体
+ */
+export interface CreateBackUpScheduleResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * ModifyClusterConfigs请求参数结构体
+ */
+export interface ModifyClusterConfigsRequest {
+    /**
+     * 集群ID，例如cdwch-xxxx
+     */
+    InstanceId: string;
+    /**
+     * 配置文件修改信息
+     */
+    ModifyConfContext: Array<ConfigSubmitContext>;
+    /**
+     * 修改原因
+     */
+    Remark?: string;
+}
+/**
+ * DescribeCkSqlApis返回参数结构体
+ */
+export interface DescribeCkSqlApisResponse {
+    /**
+        * 返回的查询数据，大部分情况是list，也可能是bool
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    ReturnData: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * ModifyUserNewPrivilege返回参数结构体
+ */
+export interface ModifyUserNewPrivilegeResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}