DescribeInstanceAutoRenewAttribute - 查詢執行個體自動續約屬性 - Elastic Compute Service

本介面用於查詢一台或多台訂用帳戶ECS執行個體的自動續約屬性，包括是否開啟自動續約、續約周期等資訊。

介面說明

僅支援訂用帳戶的執行個體，隨用隨付的執行個體調用該介面會報錯。
在設定自動續約或者手動續約前，查詢執行個體續約狀態可以協助您瞭解執行個體是否已為自動續約狀態。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeInstanceAutoRenewAttribute

list

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Instance

acs:ecs:{#regionId}:{#accountId}:instance/*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	否	執行個體 ID。支援最多 100 台訂用帳戶執行個體批量查詢，多個執行個體 ID 以半形逗號分隔。說明 `InstanceId`與`RenewalStatus`參數至少需要填寫一個。	i-bp18x3z4hc7bixhx**,i-bp1g6zv0ce8oghu7**
RegionId	string	是	執行個體所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
RenewalStatus	string	否	執行個體的自動續約狀態。取值範圍： AutoRenewal：設定為自動續約。 Normal：取消自動續約。 NotRenewal：不再續約，系統不再發送到期提醒，只在到期前第三天發送不續約提醒。不再續約的 ECS 執行個體可以通過 ModifyInstanceAutoRenewAttribute 更改成待續約（`Normal`）後，再自行續約或設定為自動續約。	AutoRenewal
PageSize	string	否	分頁展示響應資訊時設定的每頁行數，單位：行。最大值：100。預設值：10。	10
PageNumber	string	否	查詢介面返回資源資訊列表的頁碼。起始值：1。預設值：1。	1

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	頁碼。	1
PageSize	integer	每頁行數。	10
TotalCount	integer	返回的執行個體總數。	6
InstanceRenewAttributes	object
InstanceRenewAttribute	array<object>	執行個體續約的屬性 InstanceRenewAttribute 的集合。
	object
PeriodUnit	string	自動續約時間長度的單位。	week
Duration	integer	自動續約時間長度。	1
RenewalStatus	string	執行個體的自動續約狀態。可能值： AutoRenewal：設定為自動續約。 Normal：取消自動續約。 NotRenewal：不再續約，系統不再發送到期提醒，只在到期前第三天發送不續約提醒。不再續約的 ECS 執行個體可以通過 ModifyInstanceAutoRenewAttribute 更改成待續約（`Normal`）後，再自行續約或設定為自動續約。	Normal
InstanceId	string	執行個體 ID。	i-bp18x3z4hc7bixhx****
AutoRenewEnabled	boolean	是否已設定自動續約。	false
EnableExpectedRenewDay	boolean

樣本

正常返回樣本

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,
        "EnableExpectedRenewDay": true
      }
    ]
  }
}

異常返回樣本

JSON格式

{
    "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", 
    "HostId": "ecs.aliyuncs.com",
    "Code": "IncompleteSignature",
    "Message": "The request signature does not conform to Aliyun standards."
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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.
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 參數無效。請檢查該參數取值是否正確。
403	InvalidParameter.InvalidInstanceId	The specified InstanceId does not exist.	指定的InstanceId不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。