@cloudbase/manager-node 5.0.0 → 5.1.0

package/cloudbase-manager-node/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(TCB_BASE_URL=https://tcb.pre.tencentcloudapi.woa.com npm test -- --testPathPattern=cloudApp 2>&1)",
+      "Bash(TCB_BASE_URL=https://tcb.pre.tencentcloudapi.woa.com npm test 2>&1)",
+      "Bash(TCB_BASE_URL=https://tcb.pre.tencentcloudapi.woa.com npm test -- --testPathPattern=cloudApp --testNamePattern=\"获取版本列表\")"
+    ]
+  }
+}

package/cloudbase-manager-node/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/cloudbase-manager-node/.eslintignore

@@ -0,0 +1,3 @@
+lib/
+types/
+node_modules

package/cloudbase-manager-node/.eslintrc.js

@@ -0,0 +1,27 @@
+module.exports = {
+    extends: ['alloy', 'alloy/typescript'],
+    rules: {
+        indent: ['error', 4],
+        semi: ['error', 'never'],
+        complexity: ['error', { max: 40 }],
+        'no-useless-constructor': 'off',
+        '@typescript-eslint/explicit-member-accessibility': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/interface-name-prefix': 'off',
+        '@typescript-eslint/no-useless-constructor': 'off',
+        '@typescript-eslint/no-duplicate-imports': 'off'
+    },
+    env: {
+        es6: true,
+        node: true,
+        jest: true
+    },
+    overrides: [
+        {
+            files: ['*.js'],
+            rules: {
+                '@typescript-eslint/no-var-requires': 'off'
+            }
+        }
+    ]
+}

package/cloudbase-manager-node/.prettierrc.js

@@ -0,0 +1,31 @@
+module.exports = {
+    // 一行最多 100 字符
+    printWidth: 100,
+    // 使用 4 个空格缩进
+    tabWidth: 4,
+    // 不使用缩进符，而使用空格
+    useTabs: false,
+    // 行尾需要有分号
+    semi: false,
+    // 使用单引号
+    singleQuote: true,
+    // 对象的 key 仅在必要时用引号
+    quoteProps: 'as-needed',
+    // 末尾不需要逗号
+    trailingComma: 'none',
+    // 大括号内的首尾需要空格
+    bracketSpacing: true,
+    // 每个文件格式化的范围是文件的全部内容
+    rangeStart: 0,
+    rangeEnd: Infinity,
+    // 不需要写文件开头的 @prettier
+    requirePragma: false,
+    // 不需要自动在文件开头插入 @prettier
+    insertPragma: false,
+    // 使用默认的折行标准
+    proseWrap: 'preserve',
+    // 换行符使用 lf
+    endOfLine: 'lf',
+    // 箭头括号
+    arrowParens: 'avoid'
+}

package/cloudbase-manager-node/CHANGELOG.md

@@ -0,0 +1,109 @@
+# 4.0.0
+- 升级 https-proxy-agent 3->5 修复 https://github.com/TencentCloud/tencentcloud-sdk-nodejs/issues/47
+
+
+# v3.9.2-beta
+-   扩展禁用用户接口为变更用户状态接口
+-   增加修改用户信息接口
+
+# v3.5.0
+
+-   新增获取云开发用户列表接口
+-   新增停用云开发用户接口
+-   新增批量删除云开发用户接口
+
+# v3.4.0
+
+-   增加云接入服务
+-   创建函数支持同时创建云接入
+-   优化请求错误栈
+
+# v3.3.2
+
+-   函数轮询状态时间修复 30s => 300s
+
+# v3.3.0
+
+-   静态托管支持配置重定向规则
+-   新增删除静态托管自定义域名接口
+-   新增获取静态网站配置接口
+-   新增获取域名配置接口
+-   新增域名配置接口
+
+# v3.2.0
+
+-   新增静态托管查询文件，配置文档，绑定自定义域名接口
+
+# v3.1.1
+
+-   优化文件夹删除接口
+-   增加批量上传文件接口
+-   修复静态网站上传单个文件没有回调的问题
+
+# v3.0.0
+
+-   [fix] common 方法改造
+-   [add] 支持数据库 CRUD
+
+# v2.4.1
+
+-   [fix] 修复并行调用 createFunction 接口报错的问题
+-   [add] 支持通过指定函数路径创建函数
+
+# v2.4.0
+
+-   [add] 新增安全来源 API
+-   [fix] 修复云函数环境下取环境变量 bug (入口函数外部调用，未取到报错)
+
+# v2.3.4
+
+-   [fix] 修复函数配置更新问题
+
+# v2.3.2
+
+-   [fix] 修复更新函数 VPC 配置导致无法访问公网的问题
+
+# v2.3.1
+
+-   [fix] 修复创建函数、更新函数代码，代码保护参数遗漏的问题
+
+# v2.3.0
+
+-   [add] 支持文件层
+-   [add] 支持查询修改存储安全规则异步任务状态
+-   [fix] 文档订正
+
+# v2.2.1
+
+-   [fix] 修复查询所有集合信息接口，集合为空时报错
+-   [fix] updateFunctionCode 支持自动安装依赖
+
+# v2.2.0
+
+-   [fix] 修复上传文件夹等接口 `onFileFinish` 参数 TS 定义错误
+-   [add] 创建云函数返回 RequestId 响应值
+-   [add] 支持 L5 选项
+
+# v2.1.0
+
+-   [add] 支持上传或更新函数时 等待依赖安装完成
+-   [add] 支持增量上传函数代码
+-   [add] 新增创建自定义登录私钥
+-   [add] 新增 HTTP Service API
+-   [add] 新增安全规则 API
+
+# v2.0.0
+
+-   [refactor] 重构 storage , function 接口(breaking change)
+-   [add] 支持闭环完成环境创建
+-   [add] 支持函数操作代码保护
+-   [fix] 修复 windows 下上传文件路径 bug
+
+# v1.3.0
+
+-   [add] 支持获取云函数代码下载链接
+
+# v1.2.0
+
+-   [deprecated] env 创建环境功能暂时停用
+-   [add] 支持创建云函数自动安装依赖

package/cloudbase-manager-node/LICENSE

@@ -0,0 +1,6 @@
+ISC License (ISC)
+Copyright <2019> <Tencent Cloud Base>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/cloudbase-manager-node/README.md

@@ -0,0 +1,46 @@
+# cloudbase-manager-node
+
+云开发 manager-node 支持开发者通过接口形式对云开发提供的云函数、数据库、文件存储等资源进行创建、管理、配置等操作。更多源码内容请参见 [cloudbase-manager-node](https://github.com/TencentCloudBase/cloudbase-manager-node)。
+
+## 安装
+
+npm
+
+```bash
+npm install @cloudbase/manager-node
+```
+
+yarn
+
+```bash
+yarn add @cloudbase/manager-node
+```
+
+## 使用
+
+要在你的代码内使用该模块：
+
+```js
+const CloudBase = require('@cloudbase/manager-node')
+```
+
+或
+
+```js
+import CloudBase from '@cloudbase/manager-node'
+```
+
+初始化
+
+```js
+const app = CloudBase.init({
+    secretId: 'Your SecretId',
+    secretKey: 'Your SecretKey',
+    token: 'Your SecretToken', // 使用临时凭证需要此字段
+    envId: 'Your envId' // 云环境 ID，可在腾讯云-云开发控制台获取
+})
+```
+
+## 文档
+
+请访问新的[文档站点](https://docs.cloudbase.net/api-reference/manager/node/introduction.html)查看详细的文档。

package/cloudbase-manager-node/jest.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+    roots: ['<rootDir>/test'],
+    globals: {
+        'ts-jest': {
+            tsConfig: 'tsconfig.test.json'
+        }
+    },
+    transform: {
+        '^.+\\.ts?$': 'ts-jest'
+    },
+    transformIgnorePatterns: ['node_modules'],
+    testEnvironment: 'node',
+    forceExit: true,
+    // https://github.com/facebook/jest/issues/5164
+    globalSetup: './test/global-setup-hook.ts',
+    // globalTeardown: './test/global-teardown-hook.js',
+    coverageReporters: ['json', 'lcov', 'clover', 'text-summary']
+}

package/cloudbase-manager-node/package.json

@@ -0,0 +1,70 @@
+{
+    "name": "@cloudbase/manager-node",
+    "version": "5.1.0",
+    "description": "The node manage service api for cloudbase.",
+    "main": "lib/index.js",
+    "scripts": {
+        "build": "rimraf lib types && npx tsc",
+        "test:coverage": "jest --runInBand --detectOpenHandles --coverage --testTimeout=100000",
+        "test": "jest --runInBand --detectOpenHandles --testTimeout=100000",
+        "lint": "eslint \"./**/*.ts\"",
+        "lint:fix": "eslint --fix \"./**/*.ts\"",
+        "prepublishOnly": "npm run build",
+        "watch": "rimraf lib types && tsc -w",
+        "link": "node scripts/link.js",
+        "unlink": "node scripts/link.js -d"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/TencentCloudBase/cloudbase-manager-node.git"
+    },
+    "author": "Tencent CloudBase Team",
+    "license": "ISC",
+    "typings": "types/index.d.ts",
+    "devDependencies": {
+        "@lerna/create-symlink": "^6.4.1",
+        "@types/fs-extra": "^11.0.4",
+        "@types/jest": "^24.0.18",
+        "@types/node": "^12.7.4",
+        "@types/node-fetch": "^2.5.0",
+        "@types/unzipper": "^0.10.11",
+        "@typescript-eslint/eslint-plugin": "^3.7.1",
+        "@typescript-eslint/parser": "^3.7.1",
+        "eslint": "^7.6.0",
+        "eslint-config-alloy": "^3.7.4",
+        "husky": "^3.0.5",
+        "jest": "^24.9.0",
+        "lint-staged": "^9.2.5",
+        "rimraf": "^3.0.0",
+        "ts-jest": "^24.1.0",
+        "typescript": "^5.8.3"
+    },
+    "dependencies": {
+        "@cloudbase/database": "^0.6.2",
+        "archiver": "^3.1.1",
+        "cos-nodejs-sdk-v5": "^2.14.0",
+        "del": "^5.1.0",
+        "fs-extra": "^11.3.0",
+        "https-proxy-agent": "^5.0.1",
+        "lodash": "^4.17.21",
+        "make-dir": "^3.0.0",
+        "micromatch": "^4.0.2",
+        "node-fetch": "^2.6.0",
+        "query-string": "^6.8.3",
+        "unzipper": "^0.12.3",
+        "uuid": "^9.0.0",
+        "walkdir": "^0.4.1"
+    },
+    "husky": {
+        "hooks": {
+            "pre-commit": "npm run build && git add . && lint-staged"
+        }
+    },
+    "lint-staged": {
+        "*.ts": [
+            "eslint --fix",
+            "git add"
+        ]
+    },
+    "packageManager": "yarn@1.22.22"
+}

package/cloudbase-manager-node/scripts/link.js

@@ -0,0 +1,98 @@
+/**
+ * Tencent is pleased to support the open source community by making CloudBaseFramework - 云原生一体化部署工具 available.
+ *
+ * Copyright (C) 2020 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * Please refer to license text included with this package for license details.
+ */
+
+const os = require('os')
+const fs = require('fs')
+const fse = require('fs-extra')
+const del = require('del')
+const path = require('path')
+const mkdirp = require('mkdirp')
+const { execSync } = require('child_process')
+const { createSymlink } = require('@lerna/create-symlink')
+
+const globalNpmPath = execSync('npm root -g', {
+    encoding: 'utf-8'
+}).trim()
+// 如果不支持workspace 可以用下面写死
+// const globalNpmPath = '/usr/local/lib/node_modules';
+
+async function main() {
+    const unlink = process.argv?.[2] === '-d'
+    await linkCore(unlink)
+}
+
+async function linkCore(unlink = false) {
+    const jsonString = await fs.readFileSync(path.join(__dirname, '../package.json'))
+    const { name } = JSON.parse(jsonString)
+    await link(path.join(process.cwd()), path.join(globalNpmPath, '@cloudbase/cli'), name, unlink)
+}
+
+function isSymlink(path) {
+    const stats = fs.lstatSync(path)
+    return stats.isSymbolicLink()
+}
+
+// 将 global tcb cli 工具中的 framework-core link 到 packages/framework-core
+async function link(src, dest, packageName, unlink = false) {
+    const prevCwd = process.cwd()
+    const destPlugin = path.join(dest, 'node_modules', '@cloudbase')
+    // 确保目录存在
+    mkdirp.sync(destPlugin)
+    // 切换 cwd
+    process.chdir(destPlugin)
+
+    const pathName = packageName.replace('@cloudbase/', '')
+    const backupPathName = `${pathName}_backup`
+
+    if (unlink) {
+        if (fs.existsSync(pathName) && !isSymlink(pathName)) {
+            console.log(`【失败】${pathName} 不是软链接`, process.cwd())
+            return
+        }
+
+        if (fs.existsSync(pathName) && fs.existsSync(backupPathName)) {
+            // 删除软链接
+            del.sync([pathName])
+
+            // 恢复备份
+            fse.moveSync(backupPathName, pathName)
+
+            // 删除软链接
+            console.log('【成功】删除软链接：', process.cwd())
+        } else {
+            console.info(
+                `不存在 ${pathName} 或 ${backupPathName}，请重装安装 npm i @cloudbase/cli -g`,
+                process.cwd()
+            )
+        }
+    } else {
+        // 创建软链接
+
+        if (fs.existsSync(pathName)) {
+            if (!fs.existsSync(backupPathName)) {
+                // 不存在备份则进行备份
+
+                if (!isSymlink(pathName)) {
+                    // 不是软链接才备份
+                    fse.moveSync(pathName, backupPathName)
+                }
+            } else {
+                // 存在备份则直接删除
+                del.sync([pathName])
+            }
+        }
+
+        await createSymlink(src, pathName, 'junction')
+        console.log('【成功】创建软链接：', process.cwd())
+    }
+
+    // 切回源目录
+    process.chdir(prevCwd)
+}
+
+main()

package/cloudbase-manager-node/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compileOnSave": true,
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "ES2017",
+        "moduleResolution": "node",
+        "outDir": "lib",
+        "removeComments": false,
+        "types": ["node"],
+        "esModuleInterop": true,
+        "declaration": true,
+        "declarationDir": "./types",
+        "experimentalDecorators": true,
+        "newLine": "LF",
+        "skipLibCheck": true
+    },
+    "include": ["src/**/*"],
+    "exclude": ["node_modules", "test"]
+}

package/cloudbase-manager-node/tsconfig.test.json

@@ -0,0 +1,14 @@
+{
+    "compileOnSave": true,
+    "compilerOptions": {
+        "experimentalDecorators": true,
+        "module": "commonjs",
+        "target": "ES2017",
+        "moduleResolution": "node",
+        "outDir": "lib",
+        "types": ["node", "jest"],
+        "esModuleInterop": true
+    },
+    "include": ["src/**/*", "test/**/*"],
+    "exclude": ["node_modules"]
+}

package/lib/env/index.js

@@ -23,6 +23,7 @@ class EnvService {
         this.envId = environment.getEnvId();
         this.envType = environment.getEnvType();
         this.cloudService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
+        this.tcbService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
         this.commonService = environment.getCommonService('lowcode', '2021-01-08');
         this.billingService = new billing_1.BillingService(environment.cloudBaseContext);
     }
@@ -168,7 +169,7 @@ class EnvService {
     }
     /**
      * 拉取登录配置列表
-     * @deprecated 请使用 getLoginConfigListV2 代替
+     * @deprecated 请使用 getLoginConfig 代替
      * @returns {Promise<IEnvLoginConfigRes>}
      */
     async getLoginConfigList() {
@@ -178,6 +179,7 @@ class EnvService {
     }
     /**
      * 拉取登录配置列表
+     * @deprecated 该方法已废弃，请使用 getLoginConfig 代替
      */
     async getLoginConfigListV2() {
         return this.commonService.call({
@@ -187,8 +189,21 @@ class EnvService {
             }
         });
     }
+    /**
+     * 获取登录策略配置
+     * 查询指定云开发环境的登录策略配置，包括手机号短信登录、邮箱登录、
+     * 用户名密码登录和匿名登录方式的开启状态，同时包含短信验证码发送通道、
+     * MFA 多因子认证和密码的更新策略。
+     * @returns {Promise<IDescribeLoginConfigRes>}
+     */
+    async getLoginConfig() {
+        return this.tcbService.request('DescribeLoginConfig', {
+            EnvId: this.envId
+        });
+    }
     /**
      * 创建登录方式
+     * @deprecated 该方法已废弃
      * 'WECHAT-OPEN'：微信开放平台
      * 'WECHAT-PUBLIC'：微信公众平台
      * @param {('WECHAT-OPEN' | 'WECHAT-PUBLIC')} platform 'WECHAT-OPEN' | 'WECHAT-PUBLIC'
@@ -212,6 +227,7 @@ class EnvService {
     }
     /**
      * 更新登录方式配置
+     * @deprecated 该方法已废弃，请使用 modifyLoginConfig 代替
      * @param {string} configId 配置 Id，从配置列表中获取
      * @param {string} [status='ENABLE'] 是否启用 'ENABLE', 'DISABLE' ，可选
      * @param {string} [appId=''] 微信 appId，可选
@@ -240,6 +256,7 @@ class EnvService {
     }
     /**
      * 更新登录方式配置
+     * @deprecated 该方法已废弃，请使用 modifyLoginConfig 代替
      * @param {IModifyLoginStrategy} options
      * @returns {Promise<boolean>}
      */
@@ -249,6 +266,123 @@ class EnvService {
             Param: options
         });
     }
+    /**
+     * 修改登录策略配置
+     * 修改指定云开发环境的登录策略配置。支持开启或关闭手机号短信登录、邮箱登录、
+     * 用户名密码登录和匿名登录，同时可配置短信验证码发送通道、MFA 多因子认证和密码更新策略。
+     * 修改后立即生效，影响该环境下所有终端用户的登录行为。
+     * @param {IModifyLoginConfigParams} options 修改参数
+     * @returns {Promise<IModifyLoginConfigRes>}
+     */
+    async modifyLoginConfig(options) {
+        return this.tcbService.request('ModifyLoginConfig', Object.assign({ EnvId: this.envId }, options));
+    }
+    /**
+     * 查询应用客户端详情
+     * 获取指定云开发环境下某个客户端的配置信息，包括 OAuth 凭证、Token 有效期、会话控制策略等。
+     * 当客户端 ID 等于环境 ID 时，返回该环境的默认客户端配置。
+     * @param {string} Id 客户端唯一标识符（Client ID），一般使用环境 ID
+     * @returns {Promise<IDescribeClientRes>}
+     */
+    async describeClient(Id) {
+        return this.tcbService.request('DescribeClient', {
+            EnvId: this.envId,
+            Id
+        });
+    }
+    /**
+     * 修改应用客户端配置
+     * 采用增量更新策略，仅更新请求中传入的非空字段，未传入的字段保持原值不变。
+     * 支持修改 Token 有效期、会话控制策略等配置。
+     * 当客户端 ID 等于环境 ID 且客户端尚未创建时，将自动创建默认客户端配置。
+     * @param {IModifyClientParams} options 修改参数
+     * @returns {Promise<IModifyClientRes>}
+     */
+    async modifyClient(options) {
+        return this.tcbService.request('ModifyClient', Object.assign({ EnvId: this.envId }, options));
+    }
+    /**
+     * 获取三方认证源列表
+     * 查询指定云开发环境下的身份认证源列表，包括第三方登录（OAuth、OIDC、SAML）、
+     * 微信小程序登录、自定义登录和邮箱登录等。
+     * 若自定义登录或邮箱登录的身份源尚未创建，接口会自动追加一个默认关闭状态的记录。
+     * @returns {Promise<IGetProvidersRes>}
+     */
+    async getProviders() {
+        return this.tcbService.request('GetProviders', {
+            EnvId: this.envId
+        });
+    }
+    /**
+     * 修改身份认证源
+     * 更新已有身份认证源的配置信息，支持修改基本信息、协议连接配置、登录行为控制及启用状态。
+     * 采用增量更新策略，仅更新传入的字段，未传入的字段保持原值。
+     * OIDC 类型修改 Issuer 后将自动通过 Discovery 重新获取端点配置。
+     * 若 CUSTOM 或 EMAIL 身份源尚不存在，调用时将自动创建。
+     * @param {IModifyProviderParams} options 修改参数
+     * @returns {Promise<IModifyProviderRes>}
+     */
+    async modifyProvider(options) {
+        return this.tcbService.request('ModifyProvider', Object.assign({ EnvId: this.envId }, options));
+    }
+    /**
+     * 删除第三方认证源
+     * @param {string} Id 认证源 ID，2~32 位小写英文字母或数字，如 'github'
+     * @returns {Promise<IDeleteProviderRes>}
+     */
+    async deleteProvider(Id) {
+        return this.tcbService.request('DeleteProvider', {
+            EnvId: this.envId,
+            Id
+        });
+    }
+    /**
+     * 添加身份认证源
+     * 在指定云开发环境下创建新的身份认证源，支持 OAuth 2.0、OIDC、SAML 2.0 等标准协议，
+     * 以及自定义登录和邮箱登录等多种认证方式。若身份源 ID 已存在将返回错误。
+     * 限制：一个环境最大可允许加入 20 个认证源。
+     * @param {IAddProviderParams} options 添加参数
+     * @returns {Promise<IAddProviderRes>}
+     */
+    async addProvider(options) {
+        return this.tcbService.request('AddProvider', Object.assign({ EnvId: this.envId }, options));
+    }
+    /**
+     * 创建 API Key
+     * 在指定云开发环境下创建 API Key 访问凭证。支持两种类型：
+     * - api_key：服务端管理员访问凭证，可设置有效期
+     * - publish_key：前端匿名访问凭证，固定有效期
+     * 创建成功后返回 API Key 明文 Token，该值仅在创建时返回一次，请妥善保存。
+     * @param {ICreateApiKeyParams} options 创建参数
+     * @returns {Promise<ICreateApiKeyRes>}
+     */
+    async createApiKey(options) {
+        return this.tcbService.request('CreateApiKey', Object.assign({ EnvId: this.envId }, options));
+    }
+    /**
+     * 删除 API Key
+     * 删除指定云开发环境下的某个 API Key 服务端访问凭证。
+     * 删除后该 Key 对应的 Token 将被吊销，已使用该 Key 发起的请求将失败。
+     * 该操作具有幂等性，若指定的 API Key 不存在则直接返回成功。
+     * @param {string} KeyId 密钥唯一标识符，可通过查询密钥列表接口获取
+     * @returns {Promise<IDeleteApiKeyRes>}
+     */
+    async deleteApiKey(KeyId) {
+        return this.tcbService.request('DeleteApiKey', {
+            EnvId: this.envId,
+            KeyId
+        });
+    }
+    /**
+     * 查询 API Key 列表
+     * 分页查询指定云开发环境下的 API Key 访问凭证列表，支持按类型过滤。
+     * api_key 类型的令牌值脱敏处理，publish_key 类型返回完整明文。
+     * @param {IDescribeApiKeyListParams} options 查询参数
+     * @returns {Promise<IDescribeApiKeyListRes>}
+     */
+    async describeApiKeyList(options) {
+        return this.tcbService.request('DescribeApiKeyList', Object.assign({ EnvId: this.envId }, options));
+    }
     // 创建自定义登录私钥
     async createCustomLoginKeys() {
         return this.cloudService.request('CreateCustomLoginKeys', {