密钥管理服务 KMS(Key Management Service)不提供修改实例配置的接口。您可以通过调用阿里云交易和账单管理API提供的ModifyInstance接口来修改KMS实例的配置。
背景信息
阿里云交易和账单管理API是一套通用的管理阿里云资源的接口,可以用于查询服务价格、管理实例、获取账单信息等。关于阿里云交易和账单管理API支持的所有接口,请参见API概览。
您可以调用阿里云交易和账单管理API提供的ModifyInstance - 实例变更服务接口,修改KMS实例的配置。关于该接口的调用方式,请参见请求结构。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
ProductCode | string | 是 | 产品代码。取值为kms。 | kms |
ProductType | string | 否 | 产品类型。
| kms_ddi_public_cn |
SubscriptionType | string | 是 | 付费类型。取值:
| Subscription |
ModifyType | string | 是 | 变配类型,取值:
| Upgrade |
InstanceId | String | 是 | kst-shh669f4f4ea2fzs5**** | 要变更配置的KMS实例ID。 |
ClientToken | string | 否 | 客户端幂等参数,服务端会查询是否有相同 ClientToken 的请求,如果有,直接返回上次调用结果。 | JASIOFKVNVIXXXXXX |
Parameter | object [] | 否 | 模块列表 | |
└Value | string | 是 | 第 n 个模块属性 value 配置,n 的取值范围为(1~100)。 | disk |
└Code | string | 是 | 第 n 个模块属性 code 配置,n 的取值范围为(1~100),如有多个模块属性参数,按照 n=1,2,3…n 的形式拼接多个参数。 | InstanceType |
Parameter参数设置
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Parameter.1.Code | String | 否 | Spec | 表示设置KMS实例的性能数据。 |
Parameter.1.Value | String | 否 | 1000 | 支持的取值,请参见密钥管理服务售卖页。 |
Parameter.2.Code | String | 否 | KeyNum | 表示设置KMS实例的密钥配额。 |
Parameter.2.Value | String | 否 | 1000 | 支持的取值,请参见密钥管理服务售卖页。 |
Parameter.3.Code | String | 否 | SecretNum | 表示设置KMS实例的凭据配额。 |
Parameter.3.Value | String | 否 | 1000 | 支持的取值,请参见密钥管理服务售卖页。 |
Parameter.4.Code | String | 否 | VpcNum | 表示设置KMS实例的访问管理数量配额。 |
Parameter.4.Value | String | 否 | 10 | 支持的取值,请参见密钥管理服务售卖页。 |
Parameter.5.Code | String | 否 | log | 表示设置KMS实例是否开启日志。 |
Parameter.5.Value | String | 否 | 1 | 取值:
|
Parameter.6.Code | String | 否 | logStore | 表示日志的容量。 |
Parameter.6.Value | String | 否 | 1000 | 支持的取值,请参见密钥管理服务售卖页。 |
返回参数
名称 | 类型 | 示例值 | 描述 |
Code | String | Success | 本次请求的状态码。 |
Data | Struct | 本次请求的返回信息。 | |
└HostId | String | testid | 主机ID。 |
└OrderId | String | 2026532523**** | 创建成功的订单ID。 |
Message | String | Successful! | 本次请求的错误信息。 |
RequestId | String | 65AE3CCE-D625-5CD5-A874-2DAB0CF80B37 | 本次请求的ID。 |
Success | Boolean | true | 本次请求是否成功。 |
示例
正常返回示例
XML
格式
<ModifyInstanceResponse>
<Message>Successful!</Message>
<RequestId>65AE3CCE-D625-5CD5-A874-2DAB0CF80B37</RequestId>
<Success>true</Success>
<Code>Success</Code>
<Data>
<OrderId>2026532523****</OrderId>
<HostId>testid</HostId>
</Data>
</ModifyInstanceResponse>
JSON
格式
{
"Message": "Successful!",
"RequestId": "65AE3CCE-D625-5CD5-A874-2DAB0CF80B37",
"Data": {
"OrderId": 23648989570****,
"HostId": "testid"
},
"Code": "Success",
"Success": true
}