StopVisualService - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Stops the remote visualization service of Virtual Network Console (VNC) in a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:StopVisualService	WRITE	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-jeJki6****
CidrIp	string	Yes	The CIDR block or IP address that is allowed to access the VNC service. This parameter is used to assign a security group to the E-HPC cluster.	100.168..
Port	integer	Yes	The fixed port. Set the value to 12016.	12016

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The returned message.	Service stopped
RequestId	string	The request ID.	896D338C-E4F4-41EC-A154-D605E5DE6880

Examples

Sample success responses

JSONformat

{
  "Message": "Service stopped",
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE6880"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
400	NotEnabled	You have not enabled this service	You have not enabled this service
400	InDebt	Your account has overdue payments.	Your account has overdue payments.
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
403	ConflictOpt	A conflicting operation is running.	A conflicting operation is running. Please try again later.
403	AgentError	The agent service request failed.	-
403	ExecFail	Failed to execute the command: %s.	Failed to execute the command: %s.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
406	AliyunError	An Alibaba Cloud product error occurred.	An Alibaba Cloud product error occurred.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
409	PartFailure	Part of the batch operation failed.	Part of the batch operation failed.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.