AI 助理
备案控制台
文档
输入文档关键字查找
首页 密钥管理服务 密钥管理服务KMS 开发参考 API参考 OpenAPI 购买密钥管理实例 CreateInstance

CreateInstance

更新时间：
产品详情
我的收藏

密钥管理服务 KMS（Key Management Service）不提供创建实例的接口。您可以通过调用阿里云交易和账单管理API提供的CreateInstance接口来创建KMS实例。

背景信息

阿里云交易和账单管理API是一套通用的管理阿里云资源的接口，可以用于查询服务价格、管理实例、获取账单信息等。关于阿里云交易和账单管理API支持的所有接口，请参见API概览。

您可以调用阿里云交易和账单管理API提供的CreateInstance - 实例创建服务接口，创建KMS实例。关于该接口的调用方式，请参见签名机制说明。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

必填

描述

示例值

ProductCode

string

是

产品代码。设置为kms，表示密钥管理服务。

kms

ProductType

string

否

产品类型。

  • kms_ddi_public_cn：中国站

  • kms_ddi_public_intl：国际站

kms_ddi_public_cn

SubscriptionType

string

是

付费类型。

  • Subscription：预付费。

  • PayAsYouGo：后付费。

Subscription

Period

integer

否

预付费周期。单位为月，按年付费产品请输入12的整数倍。

说明

当创建预付费实例时，必须设置。

12

RenewalStatus

string

否

自动续费状态，取值：

  • AutoRenewal：自动续费。

  • ManualRenewal（默认值）：手动续费。

ManualRenewal

RenewPeriod

integer

否

自动续费周期， 单位为月。

说明

当设置RenewalStatus为AutoRenewal时，必须设置。

12

ClientToken

string

否

客户端幂等参数，服务端会查询是否有相同 ClientToken 的请求，如果有，直接返回上次调用结果。

JASIOFKVNVIXXXXXX

Parameter

object []

否

模块列表

└Value

string

是

第 n 个模块属性 value 配置，n 的取值范围为（1~100）。

Region

└Code

string

是

第 n 个模块属性 code 配置，n 的取值范围为（1~100），如有多个模块属性参数，按照 n=1,2,3…n 的形式拼接多个参数。

cn-shanghai

Parameter参数设置

名称

类型

是否必选

示例值

描述

Parameter.1.Code

String

是

ProductVersion

表示KMS实例的类型。

Parameter.1.Value

String

是

3

取值如下：

  • 1：硬件密钥管理实例

  • 3：软件密钥管理实例

Parameter.2.Code

String

是

Region

表示设置KMS实例的地域。

Parameter.2.Value

String

是

cn-shanghai

可通过DescribeRegions接口获取。

Parameter.3.Code

String

是

Spec

表示设置KMS实例的性能数据。

Parameter.3.Value

String

是

1000

支持的取值，请参见密钥管理服务售卖页。

Parameter.4.Code

String

是

KeyNum

表示设置KMS实例的密钥配额。

Parameter.4.Value

String

是

1000

支持的取值，请参见密钥管理服务售卖页。

Parameter.5.Code

String

是

SecretNum

表示设置KMS实例的凭据配额。

Parameter.5.Value

String

是

1000

支持的取值，请参见密钥管理服务售卖页。

Parameter.6.Code

String

是

VpcNum

表示设置KMS实例的访问管理数量配额。

Parameter.6.Value

String

是

10

支持的取值，请参见密钥管理服务售卖页。

Parameter.7.Code

String

是

log

表示设置KMS实例是否开启日志。

Parameter.7.Value

String

是

1

取值：

  • 0：不开启

  • 1：开启

Parameter.8.Code

String

否

logStore

表示日志的容量。单位为GB。

说明

当您开启日志时，本参数必须设置。

Parameter.8.Value

String

否

1000

支持的取值，请参见密钥管理服务售卖页。

返回参数

名称

类型

示例值

描述

Code

String

Success

本次请求的状态码。

Data

Struct

本次请求的返回信息。

└HostId

String

testId

主机ID。

└OrderId

String

23646261542****

创建成功的订单ID。

Message

String

Successful！

Code对应的状态码信息。

RequestId

String

24CC6FF3-7A78-5CF9-A3FF-74A630EBFAD9

本次请求的ID。

Success

Boolean

true

本次请求是否成功。取值：

  • true：请求成功。

  • false：请求失败。

示例

正常返回示例

XML 格式

<CreateInstanceResponse>
      <Message>Successful!</Message>
      <RequestId>24CC6FF3-7A78-5CF9-A3FF-74A630EBFAD9</RequestId>
      <Success>true</Success>
      <Code>Success</Code>
      <Data>
            <HostId>testId</HostId>
            <OrderId>23646261542****</OrderId>
      </Data>
</CreateInstanceResponse>

JSON 格式

{
  "Message": "Successful!",
  "RequestId": "24CC6FF3-7A78-5CF9-A3FF-74A630EBFAD9",
  "Data": {
    "HostId": "testId",
    "OrderId": 23646261542****
  },
  "Code": "Success",
  "Success": true
}

上一篇：购买密钥管理实例下一篇：ModifyInstance
文档推荐