調用DescribeInstanceAutoRenewAttribute查詢一臺或多臺包年包月ECS實例的自動續費狀態。
接口說明
- 在設置自動續費或者手動續費前，查詢實例續費狀態能使您了解實例是否已為自動續費狀態。
- 只支持包年包月的實例，按量付費的實例調用該接口會報錯。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 否 | 實例 ID。支持最多 100 臺包年包月實例批量查詢，多個實例 ID 以半角逗號分隔。 說明
InstanceId與RenewalStatus參數至少需要填寫一個。
| i-bp18x3z4hc7bixhx****,i-bp1g6zv0ce8oghu7**** |
| RegionId | string | 是 | 實例所屬的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| RenewalStatus | string | 否 | 實例的自動續費狀態。取值范圍：
| AutoRenewal |
| PageSize | string | 否 | 分頁展示響應信息時設置的每頁行數，單位：行。 最大值：100 默認值：10 | 10 |
| PageNumber | string | 否 | 查詢接口返回資源信息列表的頁碼。 起始值：1 默認值：1 | 1 |
返回參數
示例
正常返回示例
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 | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 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 參數無效。請檢查該參數取值是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2021-11-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |