All Products
Search
Document Center

Elastic Compute Service:DescribeReservedInstanceAutoRenewAttribute

Last Updated:Apr 25, 2025

Queries the auto-renewal attributes of one or more reserved instances, including the auto-renewal duration and auto-renewal status.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
ecs:DescribeReservedInstanceAutoRenewAttributeget
*ReservedInstance
acs:ecs:{#regionId}:{#accountId}:reservedinstance/{#ReservedInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the reserved instance.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ReservedInstanceIdarrayNo

The IDs of reserved instances.

stringNo

The ID of the reserved instance. You can call the DescribeReservedInstances operation to query the IDs of reserved instances that you purchased.

You can specify the IDs of up to 100 reserved instances in a single request.

ecsri-ajdfaj****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE7****
ReservedInstanceRenewAttributesarray<object>

Details about the auto-renewal settings of the reserved instances.

ReservedInstanceRenewAttributeobject
PeriodUnitstring

The unit of the auto-renewal duration.

Valid values: Year and Month.

Month
Durationinteger

The auto-renewal duration.

1
ReservedInstanceIdstring

The ID of the reserved instance.

ecsri-ajdfaj****
RenewalStatusstring

The auto-renewal status of the reserved instance. Valid values:

  • AutoRenewal: automatically renews the reserved instance.
  • Normal: manually renews the reserved instances.
AutoRenewal

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "ReservedInstanceRenewAttributes": {
    "ReservedInstanceRenewAttribute": [
      {
        "PeriodUnit": "Month",
        "Duration": 1,
        "ReservedInstanceId": "ecsri-ajdfaj****",
        "RenewalStatus": "AutoRenewal"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
403ChargeTypeViolationPay-As-You-Go dedicated host do not support this operation.
403MissingParamter.InstanceIdReservedInstanceId should not be null.
403InvalidParameter.ToManyInstanceIdsReservedInstanceId should be less than 100.
403InValidParameterParameter invalid.%s

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

Change history

Change timeSummary of changesOperation
2024-12-26API Description Update. The Error code has changedView Change Details