DescribeReservedInstanceAutoRenewAttribute
Queries the auto-renewal attributes of one or more reserved instances, including the auto-renewal duration and status.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:DescribeReservedInstanceAutoRenewAttribute |
get |
*ReservedInstance
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID of the reserved instance. You can call the DescribeRegions operation to query the most recent Alibaba Cloud regions. |
cn-hangzhou |
| ReservedInstanceId |
array |
No |
The IDs of the reserved instances. This parameter is required. If this parameter is not provided, the API returns MissingParamter.InstanceId. |
|
|
string |
No |
The ID of the reserved instance. You can call the DescribeReservedInstances operation to query the reserved instances that you have purchased. You can renew a maximum of 100 reserved instances at a time. |
ecsri-ajdfaj**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
04F0F334-1335-436C-A1D7-6C044FE7**** |
| ReservedInstanceRenewAttributes |
object |
||
| ReservedInstanceRenewAttribute |
array<object> |
The array of ReservedInstanceRenewAttribute objects, which contains the auto-renewal settings of the reserved instances. |
|
|
object |
|||
| PeriodUnit |
string |
The renewal unit. Valid values: Year and Month. |
Month |
| Duration |
integer |
The auto-renewal duration. |
1 |
| ReservedInstanceId |
string |
The ID of the reserved instance. |
ecsri-ajdfaj**** |
| RenewalStatus |
string |
The auto-renewal status of the reserved instance. Valid values:
|
AutoRenewal |
Examples
Success response
JSON format
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
"ReservedInstanceRenewAttributes": {
"ReservedInstanceRenewAttribute": [
{
"PeriodUnit": "Month",
"Duration": 1,
"ReservedInstanceId": "ecsri-ajdfaj****",
"RenewalStatus": "AutoRenewal"
}
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 403 | ChargeTypeViolation | Pay-As-You-Go dedicated host do not support this operation. | |
| 403 | MissingParamter.InstanceId | ReservedInstanceId should not be null. | The instance ID cannot be empty. |
| 403 | InvalidParameter.ToManyInstanceIds | ReservedInstanceId should be less than 100. | |
| 403 | InValidParameter | Parameter invalid.%s | |
| 403 | ResourceStatusViolation | The operation is not permitted due to resource status of the instance. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.