文档

SetRenewal

更新时间:

密钥管理服务 KMS(Key Management Service)不提供为实例设置自动续费的接口。您可以通过调用阿里云交易和账单管理API提供的SetRenewal接口为KMS实例设置自动续费。

背景信息

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

您可以调用阿里云交易和账单管理API提供的SetRenewal - 设置实例自动续费服务接口,为KMS实例设置自动续费。关于该接口的调用方式,请参见签名机制说明

调试

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

请求参数

名称

类型

是否必选

描述

示例值

InstanceIDs

String

要设置的实例ID。多个ID用半角逗号(,)分隔,仅支持预付费实例,最大不超过100个。

kst-hzz65f176a0ogplgq****

RenewalStatus

String

续费状态,取值:

  • AutoRenewal:自动续费。

  • ManualRenewal:手动续费。

  • NotRenewal:不续费。

AutoRenewal

RenewalPeriod

Integer

设置实例自动续费时长。单位:月。取值:

  • 1

  • 2

  • 3

  • 6

  • 12

说明

RenewalStatus取值为AutoRenewal时,RenewalPeriod为必填参数。

1

RenewalPeriodUnit

String

自动续费周期单位,取值:

  • M:月。

  • Y:年。

说明

RenewalStatus取值为AutoRenewal时,RenewalPeriodUnit为必填参数。

M

ProductCode

String

产品代码。

密钥管理服务代码为kms

kms

ProductType

String

产品类型。

  • kms_ddi_public_cn:中国站

  • kms_ddi_public_intl:国际站

kms_ddi_public_cn

SubscriptionType

String

付费类型。取值为Subscription,表示预付费。

Subscription

返回参数

名称

类型

示例值

描述

Code

String

Success

本次请求的状态码。

Message

String

Successful!

Code对应的状态码信息。

RequestId

String

6000EE23-274B-4E07-A697-FF2E999520A4

本次请求的ID。

Success

Boolean

true

本次请求是否成功。

示例

正常返回示例

XML 格式

<SetRenewalResponse>
      <Message>Successful!</Message>
      <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>
      <Success>true</Success>
      <Code>Success</Code>
</SetRenewalResponse>

JSON 格式

{
    "Message": "Successful!",
    "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
    "Success": true,
    "Code": "Success"
}