UnlockUsers - - Alibaba Cloud Documentation Center

Description

The locked convenience users must be unlocked before they can log on to cloud desktops.

Note You can call the DescribeUsers operation to query the information about convenience users. If the return value of Status is 0, the user is unlocked. If the return value of Status is 9, the user is locked.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	UnlockUsers	The operation that you want to perform. Set the value to UnlockUsers.
Users.N	RepeatList	Yes	test1	The usernames of convenience users to be unlocked. You can specify multiple usernames in the list.

Response parameters


Parameter	Type	Example	Description
RequestId	String	023F4EC4-3602-4A3E-A514-4970847D59DB	The ID of the request.
UnlockUsersResult	Struct		The result of the operation.
FailedUsers	Array of FailedUsers		The information about the convenience users that failed to be unlocked.
EndUserId	String	test123	The convenience user that failed to be unlocked.
ErrorCode	String	InvalidUsername	The error code.
ErrorMessage	String	test123 is invalid username	The error message.
UnlockedUsers	List	test1	The convenience users that were unlocked.

Examples

Sample requests

https://eds-user.cn-shanghai.aliyuncs.com/?Action=UnlockUsers
&Users.1=test1
&<Common request parameters>

Sample success responses

XML format

<UnlockUsersResponse>
      <RequestId>023F4EC4-3602-4A3E-A514-4970847D59DB</RequestId>
      <UnlockUsersResult>
            <UnlockedUsers>test1</UnlockedUsers>
      </UnlockUsersResult>
</UnlockUsersResponse>

JSON format

{
    "RequestId": "023F4EC4-3602-4A3E-A514-4970847D59DB",
    "UnlockUsersResult": {
        "FailedUsers": [],
        "UnlockedUsers": [
            "test1"
        ]
    }
}