DescribeHostWebShell - 获取专属集群主机 Webshell 登录地址

更新时间:
复制 MD 格式

调用DescribeHostWebShell接口获取专属集群主机Webshell登录地址。

接口说明

专属集群 MySQL、PostgreSQL 类型的数据库引擎支持通过 Webshell 访问主机。具体详情请参见通过 Webshell 访问主机。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cddc:DescribeHostWebShell

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

DedicatedHostId

string

是

主机 ID。可调用 DescribeDedicatedHosts 获取。

ch-bp10a5id3boqi****

RegionId

string

是

主机所在地域 ID。可调用 DescribeDedicatedHostAttribute 获取。

cn-hangzhou

ZoneId

string

是

主机所在可用区 ID。可调用 DescribeDedicatedHostAttribute 获取。

cn-hangzhou-b

返回参数

名称

类型

描述

示例值

object

LoginUrl

string

Webshell 登录地址。

https://ecs-workbench-disposable.aliyun.com/account/disposable/login/sst/mybase.c7dfa64e9f/m44kih****

RequestId

string

请求 ID。

D6E068C3-25BC-455A-85FE-45F0B22ESTG2

示例

正常返回示例

JSON格式

{
  "LoginUrl": "https://ecs-workbench-disposable.aliyun.com/account/disposable/login/sst/mybase.c7dfa64e9f/m44kih****",
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ESTG2"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidUserId.NotSupport The user ID has no permission. 当前用户没有操作权限
403 InvalidInstance The instance does not support the operation. 该实例不支持该操作
404 HostInfo.NotFound The specified host info is not found. 找不到指定的主机信息

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。