DescribeDedicatedHostAutoRenew-阿里云帮助中心

Queries the auto-renewal status of one or more subscription dedicated hosts.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeDedicatedHostAutoRenew

get

*DedicatedHost

acs:ecs:{#regionId}:{#accountId}:ddh/{#ddhId}

None

Request parameters

Parameter	Type	Required	Description	Example
DedicatedHostIds	string	Yes	The ID of the dedicated host. You can specify up to 100 subscription dedicated host IDs. Separate multiple IDs with commas (,).	dh-bp165p6xk2tlw61e**,dh-bp1f9vxmno**
RegionId	string	Yes	The ID of the region where the dedicated host resides.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
DedicatedHostRenewAttributes	object
DedicatedHostRenewAttribute	array<object>	The array that consists of dedicated host auto-renewal attributes.
	object
PeriodUnit	string	The unit of the auto-renewal duration. Valid values: Week Month	Month
Duration	integer	The auto-renewal period.	0
DedicatedHostId	string	The ID of the dedicated host.	dh-bp165p6xk2tlw61e****
RenewalStatus	string	Indicates whether the subscription dedicated host is automatically renewed. Valid values: AutoRenewal: The dedicated host is automatically renewed. Normal: The dedicated host is not automatically renewed, but renewal notifications are sent. NotRenewal: The dedicated host is not automatically renewed, and no expiration notification is sent. Alibaba Cloud sends only a non-renewal notice three days before the host expires. If the renewal status of a dedicated host is NotRenewal, you can change the value to Normal and then call RenewDedicatedHosts to manually renew the dedicated host, or directly change the value to AutoRenewal.	Normal
AutoRenewEnabled	boolean	Indicates whether auto-renewal is enabled. Valid values: true false	false
AutoRenewWithEcs	string	Indicates whether the dedicated host is automatically renewed if a subscription ECS instance it hosts, after being automatically renewed, has a new expiration time that is later than that of the dedicated host. Valid values: AutoRenewWithEcs: The dedicated host is automatically renewed along with the ECS instance. StopRenewWithEcs: The dedicated host is not automatically renewed along with the ECS instance.	StopRenewWithEcs

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
403	ChargeTypeViolation	Pay-As-You-Go dedicated host does not support this operation.
403	MissingParameter.DedicatedHostId	DedicatedHostId should not be null.	The DedicatedHostId parameter is required.
403	InvalidParameter.ToManyDedicatedHostIds	DedicatedHostId should be less than 100.	More than 100 dedicated host IDs are specified in the DedicatedHostIds value.
403	InvalidParameter.InvalidDedicatedHostId	%s	The specified DedicatedHostId parameter is invalid.
403	IncorrectDedicatedHostStatus	The current status of the resource does not support this operation.
403	MissingParamter.InstanceId	InstanceId should not be null.	The instance ID must be specified.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.