調用ModifyDedicatedHostAutoRenewAttribute為一臺或多臺包年包月專有宿主機設置自動續費,也可以取消已設定的自動續費。
接口說明
- 當您的包年包月專有宿主機開啟自動續費功能后,到期前九天將自動續費,扣費在 08:00:00(UTC +8)時間點自動執行。如果前一日扣費失敗,次日繼續定時執行??圪M成功或者九天之后專有宿主機到期被鎖定后停止自動扣費。期間,您需要保證自己的支付方式使用額度充足即可。
- 包年包月的專有宿主機支持跟隨宿主機內的包年包月 ECS 實例自動續費。詳細信息,請參見 AutoRenewWithEcs 參數說明。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:ModifyDedicatedHostAutoRenewAttribute | update | *DedicatedHost acs:ecs:{#regionId}:{#accountId}:ddh/{#ddhId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DedicatedHostIds | string | 是 | 專有宿主機 ID。最多可以輸入 100 個包年包月專有宿主機 ID,ID 之間用半角逗號(,)隔開。 | dh-bp165p6xk2tlw61e**** |
RegionId | string | 是 | 專有宿主機所屬的地域 ID。 | cn-hangzhou |
Duration | integer | 否 | 續費周期。取值范圍:
| 1 |
PeriodUnit | string | 否 | 續費時長單位。取值范圍:
默認值:Month。 | Month |
AutoRenew | boolean | 否 | 是否自動續費包年包月專有宿主機。取值范圍:
默認值:false | false |
RenewalStatus | string | 否 | 是否自動續費包年包月專有宿主機,參數
| Normal |
AutoRenewWithEcs | string | 否 | 設置是否跟隨專有宿主機內的包年包月 ECS 實例自動續費。 如果您的專有宿主機(簡稱 DDH)為包年包月計費方式,且該 DDH 內包年包月 ECS 實例開啟了自動續費。您可以通過該參數設置 DDH 跟隨 ECS 實例自動續費。當 DDH 內 ECS 實例自動續費時,如果 DDH 的到期時間比該 ECS 實例續費后的到期時間短,則 DDH 也會自動續費。DDH 跟隨 ECS 實例自動續費的原則說明: DDH 會自動判斷對應 ECS 實例續費后的到期時間,然后在自動續費 DDH 時長時,選擇大于 ECS 實例到期時間,且滿足 DDH 續費周期的最小續費時長進行續費。DDH 支持的續費周期詳情,請參見 例如:包年包月 DDH 在當年 01 月 15 日到期,DDH 內的包年包月 ECS 實例在自動續費后,將時長延長至當年 11 月 15 日到期,則 DDH 生命周期比 ECS 實例的生命周期少 10 個月。此時,DDH 在自動續費時,會選擇大于 10 個月,且符合 DDH 續費周期的最小續費時長 12 個月(即 取值范圍:
說明
如果您設置該參數為 AutoRenewWithEcs,需要確保專有宿主機已開啟自動續費(即 AutoRenew=true )。否則,該參數只是改變了參數值,實際的跟隨 ECS 實例自動續費功能并不生效。
默認值:NoOperation | StopRenewWithEcs |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "2A4EA075-CB5B-41B7-B0EB-70D339F6****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
403 | MissingParameter.DedicatedHostId | DedicatedHostId should not be null. | 參數 DedicatedHostId 不能為空。 |
403 | InvalidParameter.ToManyDedicatedHostIds | DedicatedHostId should be less than 100. | 參數 DedicatedHostIds 包含的專有宿主機 ID 應該少于 100 個。 |
403 | InvalidParameter.InvalidDedicatedHostId | %s | 指定的參數 DedicatedHostId 無效。 |
403 | IncorrectHostStatus | The current status of the resource does not support this operation. | 當前資源的狀態不支持此操作。 |
403 | ChargeTypeViolation | Pay-As-You-Go dedicated host do not support this operation. | - |
403 | InvalidParameter.Duration | %s | 參數 Duration 無效。 |
403 | InvalidParameter.RenewalStatus | %s | 指定的參數 RenewalStatus 無效。 |
403 | InvalidPeriodUnit.ValueNotSupported | The specified parameter PeriodUnit is not valid. | 參數 PeriodUnit 無效。 |
403 | InvalidParameter.AutoRenewWithEcs | The value of parameter AutoRenewWithEcs is invalid. | 參數是否隨ECS自動續費無效 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-11-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |