Queries the URL of a webshell that is used to access a specified host in a dedicated cluster.

You can use a webshell to access a host in an ApsaraDB MyBase for MySQL or ApsaraDB MyBase for PostgreSQL dedicated cluster. For more information, see Use a webshell to access a host.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeHostWebShell

The operation that you want to perform. Set the value to DescribeHostWebShell.

DedicatedHostId String Yes ch-bp10a5id3boqi****

The ID of the host. You can call the DescribeDedicatedHosts operation to query the host ID.

RegionId String Yes cn-hangzhou

The region ID of the host. You can call the DescribeDedicatedHostAttribute operation to query the region ID.

ZoneId String Yes cn-hangzhou-b

The zone ID of the host. You can call the DescribeDedicatedHostAttribute operation to query the zone ID.

Response parameters

Parameter Type Example Description
LoginUrl String https://ecs-workbench-disposable.aliyun.com/account/disposable/login/sst/mybase.c7dfa64e9f/m44kih****

The URL of the webshell.

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

The ID of the request.

Examples

Sample requests

http(s)://cddc.aliyuncs.com/?Action=DescribeHostWebShell
&DedicatedHostId=ch-bp10a5id3boqi****
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-b
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

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

Error codes

HttpCode Error code Error message Description
400 InvalidUserId.NotSupport The user ID has no permission. The error message returned because you are not authorized to perform this operation.
403 InvalidInstance The instance does not support the operation. The error message returned because the specified instance does not support the operation.
404 HostInfo.NotFound The specified host info is not found. The error message returned because the specified host information is not found.

For a list of error codes, visit the API Error Center.