Help Center/ Elastic Cloud Server/ API Reference/ APIs/ Password Management/ Querying Whether One-Click Password Reset Is Supported
Updated on 2025-12-10 GMT+08:00
View PDF
Share

Querying Whether One-Click Password Reset Is Supported

Function

This API is used to query whether one-click 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 *

-

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

Specifies the project ID.

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

server_id

Yes

Specifies the ECS ID.

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 offline.

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

Example Response

{
	"resetpwd_flag": "False"
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Password Management