# @ibm-cloud/secrets-manager-instance-management 中文文档 规范地址：https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/ 版本：2\.0\.5 npm 元数据更新时间：2026-11-01T07:29:25.909Z 中文译文更新时间：2026-11-01T10:16:16.931Z 软件包许可：Apache-2\.0 本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40ibm-cloud/secrets-manager-instance-management 原文对照：https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/?lang=original 项目主页：https://github.com/IBM/secrets-manager-management-node-sdk#readme 源码仓库：https://github.com/IBM/secrets-manager-management-node-sdk ## 关键信息（来自 npm 元数据） - 包体积（解压后）：83.2 kB，11 个文件 - TypeScript 类型：未声明 - Node.js 要求：\>=22\.0\.0 - 运行依赖：2 个 - 首次发布：2026-07-20T16:33:51.381Z - 最新版本发布：2026-11-01T07:29:25.561Z - 已发布版本数：6（近 12 个月 6 个） ## 中文简介 用于IBM Cloud Secrets Manager实例管理的客户端库 ## 安装 ```sh npm install @ibm-cloud/secrets-manager-instance-management ``` 也可以使用：`pnpm add @ibm-cloud/secrets-manager-instance-management`、`yarn add @ibm-cloud/secrets-manager-instance-management`、`bun add @ibm-cloud/secrets-manager-instance-management` ## README # IBM Cloud Secrets Manager Management Node SDK 与IBM Cloud®Secrets Manager实例管理api交互的Node.js客户端库。 > **重要:** 该SDK用于IBM Cloud Secrets Manager的实例 **仅限Vault企业计划**。它与其他秘密管理器计划不兼容。 目录表 - [概述](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/#readme-overview) - [先决条件](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/#readme-prerequisites) - [安装](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/#readme-installation) - [身份验证](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/#readme-authentication) - [使用SDK](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/#readme-using-the-sdk) - [问题](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/#readme-issues) - [贡献](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/#readme-contributing) - [许可证](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/#readme-license) ## 概述 IBM Cloud Secrets Manager Management Node.js SDK允许开发人员以编程方式与以下IBM Cloud进行交互 服务: | 服务名称 | 导入路径 | | --- | --- | | 秘密管理器管理 | @ibm-cloud / secrets-manager-instance-management / secrets-manager-instance-management / v2 | ## 先决条件 - 一个 [IBM云账户](https://cloud.ibm.com/registration). - 一、 [秘密管理器服务实例](https://cloud.ibm.com/catalog/services/secrets-manager) 与 **Vault企业计划**. - 一个 [IBM云API密钥](https://cloud.ibm.com/iam/apikeys) 允许SDK访问您的帐户。 - Node.js版本16或以上。 此SDK在Node版本14及更高版本上进行了测试。SDK可以在以前的版本上工作，但不支持这个 正式。 ## 安装 ```sh npm install @ibm-cloud/secrets-manager-instance-management ``` ## 身份验证 秘密管理器使用基于令牌的身份和访问管理（IAM）身份验证。 通过IAM身份验证，您可以提供用于生成访问令牌的API密钥。则访问令牌为 包含在对秘密管理器的每个API请求中。访问令牌在有限的时间内有效，并且必须有效 再生。 此SDK的身份验证是通过使用 [我的身份验证器](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md#authentication)。进口 身份验证器从 `@ibm-cloud/secrets-manager-instance-management/auth`. ### 示例 #### 程序化的凭证 ```js import { IamAuthenticator } from '@ibm-cloud/secrets-manager-instance-management/auth'; const authenticator = new IamAuthenticator({ apikey: '{apikey}', }); ``` #### 外部配置 ```js import { getAuthenticatorFromEnvironment } from '@ibm-cloud/secrets-manager-instance-management/auth'; // env vars // SECRETS_MANAGER_INSTANCE_MANAGEMENT_API_APIKEY= const iamAuthenticator = getAuthenticatorFromEnvironment('SECRETS_MANAGER_INSTANCE_MANAGEMENT_API'); ``` 要了解更多关于IAM身份验证器以及如何在Node.js应用程序中使用它们的信息，请参见 这个 [IBM Node.js SDK核心文档](https://github.com/IBM/node-sdk-core/blob/master/Authentication.md). ## 使用SDK ### 基本用法 - 所有方法都返回一个Promise，该Promise要么使用服务的响应进行解析，要么使用错误进行拒绝。这个 响应包含正文、报头、状态码和状态文本。如果使用async/await，则使用try/catch for 处理错误。 - 使用 `serviceUrl` 参数来设置特定于Secrets Manager服务实例的端点URL。要查找端点URL，可以将其从 **端点** 的部分 **概述** 页面中的秘密管理器UI。 #### 示例 构造一个服务客户机并使用它来生成一个管理令牌并获取实例详细信息。 ```js const SecretsManagerInstanceManagement = require('@ibm-cloud/secrets-manager-instance-management/secrets-manager-instance-management/v2'); const { IamAuthenticator } = require('@ibm-cloud/secrets-manager-instance-management/auth'); async function secretsManagerInstanceManagementExample() { // Authenticate with IAM using your IBM Cloud API key const authenticator = new IamAuthenticator({ apikey: process.env.SECRETS_MANAGER_INSTANCE_MANAGEMENT_API_APIKEY, }); // Create an instance of the SDK by providing an authentication mechanism and the service endpoint URL const secretsManagerInstanceManagement = new SecretsManagerInstanceManagement({ authenticator, serviceUrl: '', }); // Generate admin token let res = await secretsManagerInstanceManagement.adminTokenGenerate({ instanceCrn: '', }); console.log('Admin token generated!'); // Get instance details res = await secretsManagerInstanceManagement.instanceDetails({ instanceCrn: '', }); console.log('Instance details:\n' + JSON.stringify(res.result, null, 2)); } secretsManagerInstanceManagementExample(); ``` 取代 `apikey`， `SERVICE_URL`, `INSTANCE_CRN` 值。然后运行应用程序。 有关Node.js的更多信息和IBM Cloud SDK使用示例，请参见 这个 [IBM Cloud SDK通用文档](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md) ## 问题 如果您在项目中遇到问题，欢迎您提交 一个 [错误报告](https://github.com/IBM/secrets-manager-management-node-sdk/issues) 帮助我们进步。 ## 贡献 有关一般贡献指南，请参阅 [贡献](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/CONTRIBUTING.md). ## 许可证 该SDK项目在Apache 2.0许可下发布。许可证的全文可以在 [许可证](https://npmcn.com/package/%40ibm-cloud/secrets-manager-instance-management/LICENSE). ## 常见问题 ### @ibm-cloud/secrets-manager-instance-management 是什么？ 用于IBM Cloud Secrets Manager实例管理的客户端库 ### 如何安装 @ibm-cloud/secrets-manager-instance-management？ 在项目目录运行 npm install @ibm-cloud/secrets-manager-instance-management，或使用 pnpm add / yarn add / bun add。 ### @ibm-cloud/secrets-manager-instance-management 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/ibm-cloud\_\_secrets-manager-instance-management 是否存在。 ### @ibm-cloud/secrets-manager-instance-management 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @ibm-cloud/secrets-manager-instance-management 可以商用吗？ @ibm-cloud/secrets-manager-instance-management 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @ibm-cloud/secrets-manager-instance-management 还在维护吗？ 最新版本 2\.0\.5 发布于 2026/11/01（2 天前）；至今共发布 6 个版本，其中过去 12 个月发布了 6 个；首次发布于 2026/07/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。