All Products
Search
Document Center

Elastic Compute Service:DescribeReservedInstanceAutoRenewAttribute

Last Updated:Sep 29, 2024

Queries the auto-renewal status of one or more subscription reserved instances.

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
ecs:DescribeReservedInstanceAutoRenewAttributeget
  • ReservedInstance
    acs:ecs:{#regionId}:{#accountId}:reservedinstance/{#ReservedInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the reserved instances. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ReservedInstanceIdarrayNo

The IDs of the 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 query only the auto-renewal status of reserved instances that have taken effect. A reserved instance that has taken effect is in the Active state.

You can specify up to 100 reserved instance IDs 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: The reserved instance is automatically renewed.
  • Normal: You must manually renew the reserved instance.
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 messageDescription
403ChargeTypeViolationPay-As-You-Go dedicated host do not support this operation.-
403MissingParamter.InstanceIdReservedInstanceId should not be null.-
403InvalidParameter.ToManyInstanceIdsReservedInstanceId should be less than 100.-
403InvalidParameter%sThe specified parameter is invalid.

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

Change history

Change timeSummary of changesOperation
No change history