DescribeInstanceAutoRenewAttribute - 云服务器 ECS

接口说明

在设置自动续费或者手动续费前，查询实例续费状态能使您了解实例是否已为自动续费状态。
仅支持包年包月的实例，按量付费的实例调用该接口会报错。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeInstanceAutoRenewAttribute	系统规定参数。取值：DescribeInstanceAutoRenewAttribute。
InstanceId	String	否	i-bp18x3z4hc7bixhx**,i-bp1g6zv0ce8oghu7**	实例ID。支持最多100台包年包月实例批量查询，多个实例ID以半角逗号分隔。说明 `InstanceId`与`RenewalStatus`参数至少需要填写一个。
RegionId	String	是	cn-hangzhou	实例所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
RenewalStatus	String	否	AutoRenewal	实例的自动续费状态。取值范围： AutoRenewal：设置为自动续费。 Normal：取消自动续费。 NotRenewal：不再续费，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。不再续费的ECS实例可以通过ModifyInstanceAutoRenewAttribute更改成待续费（`Normal`）后，再自行续费或设置为自动续费。
PageSize	String	否	10	分页展示响应信息时设置的每页行数，单位：行。最大值：100。默认值：10。
PageNumber	String	否	1	查询接口返回资源信息列表的页码。起始值：1。默认值：1。

返回数据

名称	类型	示例值	描述
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	请求ID。
PageNumber	Integer	1	页码。
PageSize	Integer	10	每页行数。
TotalCount	Integer	6	返回的实例总数。
InstanceRenewAttributes	Array of InstanceRenewAttribute		实例续费的属性InstanceRenewAttribute的集合。
InstanceRenewAttribute
PeriodUnit	String	week	自动续费时长的单位。
Duration	Integer	1	自动续费时长。
RenewalStatus	String	Normal	实例的自动续费状态。可能值： AutoRenewal：设置为自动续费。 Normal：取消自动续费。 NotRenewal：不再续费，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。不再续费的ECS实例可以通过ModifyInstanceAutoRenewAttribute更改成待续费（`Normal`）后，再自行续费或设置为自动续费。
InstanceId	String	i-bp18x3z4hc7bixhx****	实例ID。
AutoRenewEnabled	Boolean	false	是否已设置自动续费。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeInstanceAutoRenewAttribute
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&RenewalStatus=AutoRenewal
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceAutoRenewAttributeResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <InstanceRenewAttributes>
        <InstanceRenewAttribute>
            <RenewalStatus>AutoRenewal</RenewalStatus>
            <Duration>1</Duration>
            <InstanceId>i-bp18x3z4hc7bixhx****</InstanceId>
            <AutoRenewEnabled>true</AutoRenewEnabled>
            <PeriodUnit>Week</PeriodUnit>
        </InstanceRenewAttribute>
    </InstanceRenewAttributes>
    <PageSize>1</PageSize>
    <RequestId>DAE023B4-A78F-4B39-8860-96F17B54F772</RequestId>
</DescribeInstanceAutoRenewAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNumber" : 1,
  "TotalCount" : 1,
  "InstanceRenewAttributes" : {
    "InstanceRenewAttribute" : [ {
      "RenewalStatus" : "AutoRenewal",
      "Duration" : 1,
      "InstanceId" : "i-bp18x3z4hc7bixhx****",
      "AutoRenewEnabled" : true,
      "PeriodUnit" : "Week"
    } ]
  },
  "PageSize" : 1,
  "RequestId" : "DAE023B4-A78F-4B39-8860-96F17B54F772"
}

错误码

HttpCode	错误码	错误信息	描述
400	Throttling	Request was denied due to request throttling.	请求被流控。
403	MissingParameter.InstanceId	InstanceId should not be null.	参数 InstanceId 不能为空。
403	InvalidParameter.ToManyInstanceIds	InstanceId should be less than 100.	实例数应小于100。
403	InvalidParameter.InvalidInstanceId	%s	指定的参数 InstanceId 无效。
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.	该资源目前的状态不支持此操作。
403	ChargeTypeViolation	Pay-As-You-Go instances do not support this operation.	按量付费实例不支持该操作，检查实例的付费类型是否与该操作冲突。
403	InvalidParameter.RenewalStatus	The specified parameter RenewalStatus is not valid.	指定的参数 RenewalStatus 无效。
403	InvalidParameter.RenewalStatusInstanceId	The parameter RenewalStatus and InstanceId can not be both empty.	参数 RenewalStatus 和 InstanceId 都不能为空。
403	InvalidParameter.PageSize	The specified parameter PageSize is not valid.	PageSize参数不合法
403	InvalidParameter.PageNumber	The specified parameter PageNumber is not valid.	指定的 PageNumber 参数无效。请检查该参数取值是否正确。

访问错误中心查看更多错误码。