密钥管理系统创建KMS实例

1. 接口描述

接口请求域名： kms.tencentcloudapi.com 。

购买开通KMS服务

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateKmsInstance。
Version	是	String	公共参数，本接口取值：2019-01-18。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceChargeType	是	String	实例付费类型(PREPAID) 示例值：PREPAID
ProductVersion	否	String	版本类型枚举值： professional：专业版示例值：professional
InstanceChargePrepaid	否	InstanceChargePrepaid	预付费实例信息
ClientToken	否	String	可重入客户端ID 示例值：9a4d46f4-c223-4652-af87-610d21a606aq
Tags.N	否	Array of Tag	实例标签

3. 输出参数

参数名称	类型	描述
InstanceId	String	实例ID 示例值：KMS-Pre***nkr28g
DealName	String	计费订单号示例值：20260921****0569371
BillId	String	计费冻结流水号示例值：20260921662023739465291
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建kms实例

输入示例

POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateKmsInstance
<公共请求参数>

{
    "InstanceChargeType": "PREPAID",
    "ProductVersion": "professional",
    "InstanceChargePrepaid": {
        "Period": 1,
        "RenewFlag": 1
    },
    "ClientToken": "9a4d46f4-c223-4652-af87-610d21a606aq",
    "Tags": [
        {
            "TagKey": "department",
            "TagValue": "development"
        }
    ]
}

输出示例

{
    "Response": {
        "BillId": "",
        "DealName": "20260921********0569371",
        "InstanceId": "KMS-Pre*******nkr28g",
        "RequestId": "54d52fdc-fa20-4efa-87e8-3092246a0a26"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.OrderCheckFailed	订单校验失败
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.ConflictParameter	后付费传了 ProductVersion/InstanceChargePrepaid
InvalidParameter.MissingProductVersion	ProductVersion参数缺失
InvalidParameterValue.InvalidInstanceChargeType	InstanceChargeType类型非法
InvalidParameterValue.InvalidPeriod	Period 越界(1~36)
InvalidParameterValue.InvalidProductVersion	ProductVersion不合法
LimitExceeded.InstanceQuotaExceeded	预付费实例达上限
ResourceInUse.OrderInProgress	存在进行中订单
ResourceInUse.PostpaidInstanceAlreadyExists	后付费实例已存在
UnauthorizedOperation	未授权操作。

创建KMS实例

本页目录：