Help Center/ Elastic Cloud Server/ API Reference/ APIs/ Password Management/ Querying Whether One-Click Password Reset Is Supported
Updated on 2026-08-14 GMT+08:00

Querying Whether One-Click Password Reset Is Supported

Function

This API is used to query whether an ECS supports one-click password reset.

An ECS supports the following password reset methods:
  • Offline password reset: This method depends on the one-click password reset plug-in. The new password will not be applied unless the ECS is restarted or started.
  • Online password reset: This method depends on Cloud Operations Center (COC) and UniAgents provided by Application Operations Management (AOM). The new password is applied immediately without restarting the ECS.

For more information, see Overview of Password Reset.

This API is used to query whether password reset offline is supported.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permissions listed below are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ecs:cloudServers:showResetPasswordFlag

read

instance *

  • g:ResourceTag/<tag-key>
  • g:EnterpriseProjectId

ecs:cloudServers:get

-

URI

GET /v1/{project_id}/cloudservers/{server_id}/os-resetpwd-flag

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Definition

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

server_id

Yes

Definition

Specifies the ECS ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request

None

Response

Table 2 describes the response parameters.
Table 2 Response parameters

Parameter

Type

Description

resetpwd_flag

String

Definition

Specifies whether one-click password reset offline is supported.

Range

  • True: Password reset offline is supported.
  • False: Password reset offline is not supported.

Example Request

Query whether a specified ECS supports one-click password reset.

GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-resetpwd-flag

Example Response

{
	"resetpwd_flag": "False"
}

Error Codes

See Error Codes.