全部产品
Search
文档中心

云服务器 ECS:DescribeInstanceAutoRenewAttribute - 查询实例自动续费状态

更新时间:May 14, 2024

调用DescribeInstanceAutoRenewAttribute查询一台或多台包年包月ECS实例的自动续费状态。

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeInstanceAutoRenewAttributeRead
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。支持最多 100 台包年包月实例批量查询,多个实例 ID 以半角逗号分隔。

说明 InstanceIdRenewalStatus参数至少需要填写一个。
i-bp18x3z4hc7bixhx****,i-bp1g6zv0ce8oghu7****
RegionIdstring

实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
RenewalStatusstring

实例的自动续费状态。取值范围:

  • AutoRenewal:设置为自动续费。

  • Normal:取消自动续费。

  • NotRenewal:不再续费,系统不再发送到期提醒,只在到期前第三天发送不续费提醒。不再续费的 ECS 实例可以通过 ModifyInstanceAutoRenewAttribute 更改成待续费(Normal)后,再自行续费或设置为自动续费。

AutoRenewal
PageSizestring

分页展示响应信息时设置的每页行数,单位:行。

最大值:100

默认值:10

10
PageNumberstring

查询接口返回资源信息列表的页码。

起始值:1

默认值:1

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

页码。

1
PageSizeinteger

每页行数。

10
TotalCountinteger

返回的实例总数。

6
InstanceRenewAttributesobject []

实例续费的属性 InstanceRenewAttribute 的集合。

PeriodUnitstring

自动续费时长的单位。

week
Durationinteger

自动续费时长。

1
RenewalStatusstring

实例的自动续费状态。可能值:

  • AutoRenewal:设置为自动续费。

  • Normal:取消自动续费。

  • NotRenewal:不再续费,系统不再发送到期提醒,只在到期前第三天发送不续费提醒。不再续费的 ECS 实例可以通过 ModifyInstanceAutoRenewAttribute 更改成待续费(Normal)后,再自行续费或设置为自动续费。

Normal
InstanceIdstring

实例 ID。

i-bp18x3z4hc7bixhx****
AutoRenewEnabledboolean

是否已设置自动续费。

false

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 6,
  "InstanceRenewAttributes": {
    "InstanceRenewAttribute": [
      {
        "PeriodUnit": "week",
        "Duration": 1,
        "RenewalStatus": "Normal",
        "InstanceId": "i-bp18x3z4hc7bixhx****",
        "AutoRenewEnabled": false
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2021-11-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    新增错误码:400