All Products
Search
Document Center

BSS OpenAPI:RenewInstance

Last Updated:Mar 01, 2024

Renews a specified instance. You cannot call this operation to renew Elastic Compute Service (ECS) instances, ApsaraDB RDS instances, or ApsaraDB for Redis instances. To renew these types of instances, call the dedicated operation of the corresponding service.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bssapi:ModifyInstanceWRITE
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductCodestringYes

The code of the service to which the instance belongs.

rds
InstanceIdstringYes

The ID of the instance

rm-skjdhaskjdh
RenewPeriodintegerYes

The duration of the subscription renewal. Unit: months. Valid values:

  • 1 to 9
  • 12
  • 24
  • 36
6
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ASKJHKLASJHAFSLKJH
ProductTypestringNo

The type of the service.

rds

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Success
Messagestring

The error message returned.

Successful!
RequestIdstring

The ID of the request.

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

Indicates whether the request was successful.

true
Dataobject

The data returned.

OrderIdstring

The ID of the order.

202657601410661

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NotApplicableThis API is not applicable for caller.-
400NotAuthorizedThis API is not authorized for caller.-
400InvalidOwnerThe specified owner doesn't belong to caller.Invalid user identity.
400ResourceStatusErrorThe resource status error.-
400ResourceNotExistsThe specific resource is not exists.-
500InternalErrorThe request processing has failed due to some unknown error.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history