全部产品
Search
文档中心

云服务器 ECS:DescribeDedicatedHostAutoRenew - 查询专有宿主机自动续费状态

更新时间:May 14, 2024

调用DescribeDedicatedHostAutoRenew查询一台或多台包年包月专有宿主机自动续费状态。

调试

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

授权信息

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

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

请求参数

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

专有宿主机 ID。最多可以输入 100 个包年包月专有宿主机 ID,ID 之间用半角逗号(,)隔开。

dh-bp165p6xk2tlw61e****,dh-bp1f9vxmno****
RegionIdstring

专有宿主机所属的地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
DedicatedHostRenewAttributesobject []

专有宿主机自动续费属性组成的数组。

PeriodUnitstring

续费单位。可能值:

  • Week
  • Month
Month
Durationinteger

自动续费时长。

0
DedicatedHostIdstring

专有宿主机 ID。

dh-bp165p6xk2tlw61e****
RenewalStatusstring

是否自动续费包年包月专有宿主机。取值范围:

  • AutoRenewal:自动续费。
  • Normal:待续费。
  • NotRenewal:不续费,也不发送到期提醒。到期前第三天阿里云会发送不续费提醒。不续费的专有宿主机可以设置成待续费(Normal),再自行续费 RenewDedicatedHosts 或设置为自动续费(AutoRenewal)。
Normal
AutoRenewEnabledboolean

是否自动续费。可能值:

  • true:自动续费
  • false:不自动续费
false
AutoRenewWithEcsstring

包年包月专有宿主机内的包年包月 ECS 实例自动续费时,如果 ECS 实例续费后的到期时间比专有宿主机的到期时间晚,则该专有宿主机是否随 ECS 实例自动续费。可能值:

  • AutoRenewWithEcs:跟随 ECS 实例自动续费。
  • StopRenewWithEcs:不跟随 ECS 实例自动续费。
StopRenewWithEcs

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "DedicatedHostRenewAttributes": {
    "DedicatedHostRenewAttribute": [
      {
        "PeriodUnit": "Month",
        "Duration": 0,
        "DedicatedHostId": "dh-bp165p6xk2tlw61e****",
        "RenewalStatus": "Normal",
        "AutoRenewEnabled": false,
        "AutoRenewWithEcs": "StopRenewWithEcs"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403ChargeTypeViolationPay-As-You-Go dedicated host does not support this operation.按量付费的宿主机不支持当前操作。
403MissingParameter.DedicatedHostIdDedicatedHostId should not be null.参数 DedicatedHostId 不能为空。
403InvalidParameter.ToManyDedicatedHostIdsDedicatedHostId should be less than 100.参数 DedicatedHostIds 包含的专有宿主机 ID 应该少于 100 个。
403InvalidParameter.InvalidDedicatedHostId%s指定的参数 DedicatedHostId 无效。
403IncorrectDedicatedHostStatusThe current status of the resource does not support this operation.当前资源的状态不支持此操作。
403MissingParamter.InstanceIdInstanceId should not be null.实例id不能为空

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

变更历史

变更时间变更内容概要操作
2023-06-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更