ModifyInstanceVncPasswd-阿里云帮助中心

Operation description

The VNC password must be six characters in length and can contain uppercase letters, lowercase letters, and digits.
After you modify the VNC password of an ECS instance, take note of the following items:
- If the instance is I/O optimized, the new password takes effect immediately without the need to restart the instance.
- If the instance is not I/O optimized, you must restart the instance in the ECS console or by calling the RebootInstance operation for the new password to take effect.

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

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ECS instance.	i-bp67acfmxazb4ph****
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
VncPassword	string	Yes	The new VNC password of the ECS instance.	Ecs123

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error response

JSON format

{
    "RequestId": "E69EF3CC-94CD-42E7-8926-F133B86387C0",
    "HostId": "ecs.aliyuncs.com",
    "Code": "IncorrectInstanceStatus",
    "Message": "The current status of the resource does not support this operation."
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectVncPassword.Malformed	The specified parameter VncPassword is not valid.	The specified VNC password is invalid.
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.
403	InstanceNotReady	Temporarily unable to connect the specified instance,please try later.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instanceId is invalid.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region ID does not exist.
404	NoSuchResource	The specified resource is not found.	The specified resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.