调用 DescribeInstanceECSTerminalUrl 查询一台云服务器的 ECS Terminal 管理终端地址。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
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: open.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 | MissingParameter.InstanceId | The required parameter InstanceId is not supplied. | 参数实例ID不能为空。 |
400 | InvalidInstanceStatus | The status of the specified instance does not support this request. | 当前实例的状态不支持此操作。 |
404 | InvalidPrimaryNetworkInterface.NotFound | The specified PrimaryNetworkInterface does not exist. | 指定的主网卡不存在。 |
404 | InvalidInstance.NotFound | The specified instance does not exist. | 指定的实例不存在。 |
500 | InternalError | An internal error has occurred. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |