调用StartVisualService启动指定集群的VNC远程可视化服务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ehpc:StartVisualService | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClusterId | string | 是 | 集群 ID。 您可以通过调用 ListClusters 获取集群 ID。 | ehpc-hz-jeJki6**** |
| CidrIp | string | 是 | 允许访问 VNC 服务的源地址范围，用于设置安全组。 | 190.100.XX.XX |
| Port | integer | 是 | 固定端口。固定为：12016 | 12016 |
返回参数
示例
正常返回示例
JSON格式
{
"Message": "Service started.",
"RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | 指定的参数 %s 无效。 |
| 400 | NotEnabled | You have not enabled this service | 您的账户还未开通此服务 |
| 400 | InDebt | Your account has overdue payments. | 您的账户已欠费 |
| 403 | InvalidClusterStatus | The operation failed due to invalid cluster status. | 集群状态不允许执行本次操作。 |
| 403 | ConflictOpt | A conflicting operation is running. | 有冲突的操作在执行中，请您稍后再试。 |
| 403 | AgentError | The agent service request failed. | 集群侧命令运行失败。%s |
| 403 | ExecFail | Failed to execute the command: %s. | 命令执行失败：%s |
| 404 | ClusterNotFound | The specified cluster does not exist. | 指定的集群不存在，请您检查该参数是否正确。 |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | 阿里云产品错误。%s |
| 407 | NotAuthorized | You are not authorized by RAM for this request. | 此请求未获得RAM授权 |
| 409 | PartFailure | Part of the batch operation failed. | 批量操作部分失败 |
| 500 | UnknownError | An unknown error occurred. | 未知错误 |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 请求失败，服务暂时不可用 |
访问错误中心查看更多错误码。