Queries the auto renewal status of an instance.

Description

  • Queries the auto renewal status of your instance to view if your instance is set to auto renewal.

  • Supports Subscription ECS instances only. If you use this API on a Pay-As-You-Go instance, an error is returned.

Request parameters

Name Type Required Description
Action String Yes The name of this interface. Value: DescribeInstanceAutoRenewAttribute.
RegionId String Yes Region ID of an instance. For more information, call DescribeRegions to obtain the latest region list.
InstanceId String Yes Instance ID set. A maximum of 100 Subscription instances are supported, in the format of ["instanceId1", "instanceId2", "instanceId3"…].

Response parameters

Name Type Description
InstanceId String ID of the instance, which is generated by the system and is globally unique. The unique identity to accesses an instance.
Duration Integer Auto renewal duration.
AutoRenewEnabled Boolean Auto renewal or not.
  • true: Auto renewal is enabled.
  • false: Auto renewal is disabled.
RenewalStatus String Returns whether to renew an ECS instance automatically or not.
  • AutoRenewal: Auto renewal is enabled.
  • Normal: Auto renewal is disabled. However, you can renew your ECS instance manually.
  • NotRenewal: No renewal any longer. If this value is returned, Alibaba Cloud ceases to send notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry. In this case, if you want to renew your instance, you can change the renewal status of your instance to RenewalStatus=Normal (Noramal) before a manual renewal or setting it to auto renewal.

Example

Request example
https://ecs.aliyuncs.com/?Action=DescribeInstanceAutoRenewAttribute
&RegionId=cn-hangzhou
&InstanceId=i-instance1,i-instance2
&<Common Request Parameters>
Response example

XML format

<DescribeInstanceAutoRenewAttributeResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <InstanceRenewAttributes>
        <InstanceRenewAttribute>
          <Instance>
            <InstanceId>i-instance1</InstanceId>
            <Duration>0</Duration>
            <AutoRenewEnalbed>false</AutoRenewEnalbed>
            <RenewalStatus>Normal</RenewalStatus>
          </Instance>
          <Instance>
            <InstanceId>i-instance2</InstanceId>
            <Duration>1</Duration>
            <AutoRenewEnalbed>true</AutoRenewEnalbed>
            <RenewalStatus>AutoRenewal</RenewalStatus>
          </Instance>
        </InstanceRenewAttribute>
    </InstanceRenewAttributes>
</DescribeInstanceAutoRenewAttributeResponse>
JSON format
{
    "InstanceRenewAttributes": {
        "InstanceRenewAttribute": [
            {
                "Duration": 0,
                "InstanceId": "i-instance1",
                "AutoRenewEnabled": false
                "RenewalStatus": "Normal"
            },
            {
                "Duration": 1,
                "InstanceId": "i-instance2",
                "AutoRenewEnabled": true
                "RenewalStatus": "AutoRenewal"
            }
        ]
    },
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

Error codes specific to this interface are as follows. For more information, see API Error Center.

Error code Error message HTTP status code Meaning
Abs.MissingParamter.InstanceId InstanceId should not be null. 403 InstanceId is required.
ChargeTypeViolation Pay-As-You-Go instances do not support this operation. 403 Pay-As-You-Go instances do not support this operation.
IncorrectInstanceStatus The current status of the resource does not support this  operation. 403 This operation is not supported because the instance has expired.
InvalidParameter.InvalidInstanceId The specified instanceId is not valid. 403 The specified InstanceId is invalid.
InvalidParameter.ToManyInstanceIds No more than 100 InstanceIds can be specified. 403  The number of the specified InstanceId cannot exceed 100.