You need to enable JavaScript to run this app.
文档中心
云服务器

云服务器

复制全文
下载 pdf
实例
DescribeInstanceECSTerminalUrl - 查询ECS Terminal管理终端地址
复制全文
下载 pdf
DescribeInstanceECSTerminalUrl - 查询ECS Terminal管理终端地址
调用 DescribeInstanceECSTerminalUrl 查询一台云服务器的 ECS Terminal 管理终端地址。​
使用说明​
  • 您也可以调用DescribeInstanceVncUrl,获取云服务器的VNC管理终端地址,从而使用VNC登录实例。​
  • 相比VNC,ECS Terminal支持多操作系统用户远程连接同一台实例,并且支持复制粘贴文本和可视化查看系统文件资源,更加高效便捷,更多信息请参见 通过控制台登录Linux实例。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeInstanceECSTerminalUrl​
要执行的操作,取值:DescribeInstanceECSTerminalUrl。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
InstanceId string 必选 示例值:i-3tiefmkskq3vj0******​
实例ID。​
​
​
​
返回参数​
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。​
EcsTerminalUrl string 示例值:wss://cn-beijing-a01-vncproxy-ecs.volcengine.com:443/instance/login/18a948b9-00bd-4e56-b2a2-5de5f*******​
ECS Terminal管理终端Url。​
​
​
​
请求示例​
​
GET /?Action=DescribeInstanceECSTerminalUrl&Version=2020-04-01&InstanceId=i-3tiefmkskq3vj0****** HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202106111445100102252431000052****",​
"Action": "DescribeInstanceECSTerminalUrl",​
"Version": "2020-04-01",​
"Service": "ecs",​
"Region": "cn-beijing"​
},​
"Result": {​
"EcsTerminalUrl": "wss://cn-beijing-a01-vncproxy-ecs.volcengine.com:443/instance/login/18a948b9-00bd-4e56-b2a2-5de5f3******"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidInstanceStatus​
The status of the specified instance does not support this request.​
当前实例的状态不支持此操作。​
400​
MissingParameter.InstanceId​
The required parameter InstanceId is not supplied.​
参数实例ID不能为空。​
404​
InvalidInstance.NotFound​
The specified instance does not exist.​
指定的实例不存在。​
404​
InvalidPrimaryNetworkInterface.NotFound​
The specified PrimaryNetworkInterface does not exist.​
指定的主网卡不存在。​
500​
InternalError​
An internal error has occurred.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2025.09.04 16:59:39
这个页面对您有帮助吗?
有用
有用
无用
无用