密钥管理服务 KMS(Key Management Service)不提供为实例续费的接口。您可以通过调用阿里云交易和账单管理API提供的RenewInstance接口来为KMS实例续费。
背景信息
阿里云交易和账单管理API是一套通用的管理阿里云资源的接口,可以用于查询服务价格、管理实例、获取账单信息等。关于阿里云交易和账单管理API支持的所有接口,请参见API概览。
您可以调用阿里云交易和账单管理API提供的RenewInstance - 实例续费服务接口,为KMS实例续费。关于该接口的调用方式,请参见签名机制说明。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 描述 | 示例值 |
ProductCode | String | 是 | 产品代码。设置为kms,表示密钥管理服务。 | kms |
InstanceId | String | 是 | 要续费的密钥管理实例的ID。 | kst-hzz65f176a0ogplgq**** |
RenewPeriod | Integer | 是 | 预付费续费时长,单位:月。取值:
| 6 |
ProductType | String | 否 | 产品类型。
| kms_ddi_public_cn |
ClientToken | String | 否 | 客户端幂等参数,服务端会查询是否有相同ClientToken的请求,如果有,直接返回上次调用结果。用于保证请求的幂等性,防止请求重复提交。 | JASIOFKVNVI**** |
返回参数
名称 | 类型 | 示例值 | 描述 |
Code | String | Success | 本次请求的状态码。 |
Data | Struct | 本次请求的返回信息。 | |
└OrderId | String | 23629137930**** | 创建成功的订单ID。 |
Message | String | Successful! | Code对应的状态码信息。 |
RequestId | String | C60F3341-3E85-5FCA-8290-3437D290D9B9 | 本次请求的ID。 |
Success | Boolean | true | 本次请求是否成功。 |
示例
正常返回示例
XML
格式
<RenewInstanceResponse>
<Message>Successful!</Message>
<RequestId>C60F3341-3E85-5FCA-8290-3437D290D9B9</RequestId>
<Data>
<OrderId>23629137930****</OrderId>
</Data>
<Code>Success</Code>
<Success>true</Success>
</RenewInstanceResponse>
JSON
格式
{
"Message": "Successful!",
"RequestId": "C60F3341-3E85-5FCA-8290-3437D290D9B9",
"Data": {
"OrderId": 23629137930****
},
"Code": "Success",
"Success": true
}