SetRenewal

Updated at:

Configure renewal settings for one or more instances.

Debugging

Call this operation directly in OpenAPI Explorer to automatically generate SDK sample code without calculating a signature.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

SetRenewal

The action to perform. Set the value to SetRenewal.

InstanceIDs

String

Yes

dbaudit-cn-****

The IDs of one or more subscription instances. You can specify up to 100 instance IDs, separated by commas (,).

RenewalStatus

String

Yes

AutoRenewal

The renewal status. Valid values:

  • AutoRenewal: Enable auto-renewal.

  • ManualRenewal: Enable manual renewal.

  • NotRenewal: Do not renew.

RenewalPeriod

Integer

No

1

The auto-renewal period. Valid values:

  • 1

  • 2

  • 3

  • 6

  • 12

Note
  • This parameter is required when RenewalStatus is set to AutoRenewalRenewalPeriod.

  • The unit for this parameter is month if RenewalPeriodUnit is set to M, and year if RenewalPeriodUnit is set to Y.

ProductCode

String

No

dbaudit

The product code.

For Database Audit, the product code is dbaudit.

ProductType

String

No

dbaudit

The product type.

For Database Audit, the product type is dbaudit.

SubscriptionType

String

No

Subscription

The billing method.

Set this to Subscription, which specifies the prepaid billing method for Database Audit.

RenewalPeriodUnit

String

No

M

The auto-renewal period unit. Valid values:

  • M: month.

  • Y: year.

Note

RenewalStatusAutoRenewalRenewalPeriodUnitThis parameter is required when is set to .

Response parameters

Parameter

Type

Example

Description

Code

String

Success

The status code of the request.

Message

String

Successful

The message that corresponds to the Code.

RequestId

String

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

The request ID.

Success

Boolean

true

Indicates whether the request was successful.

Examples

Sample request

http(s)://[Endpoint]/?Action=SetRenewal
&InstanceIDs=dbaudit-cn-****
&RenewalStatus=AutoRenewal
&RenewalPeriod=1
&RenewalPeriodUnit=M
&<common request parameters>

Sample response

XML format

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

JSON format

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

Error codes

For a list of error codes, see the Error Center.