Use the ReleaseDedicatedHost API to release a dedicated host - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

Before you release a pay-as-you-go dedicated host, make sure that no ECS instances exist on the host.

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:ReleaseDedicatedHost

delete

*DedicatedHost

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the dedicated host. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
DedicatedHostId	string	Yes	The ID of the dedicated host.	dh-bp199lyny9b3****
TerminateSubscription	boolean	No	Specifies whether to release an expired subscription dedicated host. true: Releases the host. false: Does not release the host. Default value: false.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A1B15AC8-E6F6-49A4-8985-8C07104B9199

Examples

Success response

JSON format

{
  "RequestId": "A1B15AC8-E6F6-49A4-8985-8C07104B9199"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ChargeTypeViolation	The operation is not permitted due to charge type of the dedicated host.	The billing method does not support this operation. Check whether the billing method of the instance conflicts with this operation.
400	IncorrectHostStatus.Initializing	The specified ddh status does not support this operation.	The current status of the dedicated host does not support this operation.
500	InternalError	The request processing has failed due to some unknown error.
403	InstanceExist	Instance exists on the dedicated host.	Instances are present on the dedicated host. You must remove the instances before you can release the dedicated host.
403	OperationDenied.DedicatedHostShared	The specified ddh is shared to other users. Remove it from the resource share before releasing.	The specified dedicated host has been shared with other users. Remove it from the resource share before releasing it.
404	InvalidDedicatedHostId.NotFound	The specified DedicatedHostId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.