Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Querying Hibernation Type

Updated on 2026-02-10 GMT+08:00

View PDF

Querying Hibernation Type

Queries the hibernation type.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

GET /v2/{project_id}/hibernate-type

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

None

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
tenant_id	String	Tenant ID.
hibernate_type	String	ECS hibernation type. SUSPEND: out-of-band cold hibernation PAUSE: out-of-band hot hibernation
shutdown_days	Integer	Hibernation duration (days).

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: default

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

None

Status code: 200

Returned when the request succeeded.

{
  "tenant_id" : "902b906e372241fe9b4e2e7280d64613",
  "hibernate_type" : "PAUSE",
  "shutdown_days" : 15
}

Status Code	Description
200	Returned when the request succeeded.
400	The request cannot be understood by the server due to malformed syntax.
404	No resources found.
500	An internal service error occurred. For details about the error code, see the error code description.
default	Default response to a failure.