All Products
Search
Document Center

ApsaraDB for MyBase:DescribeHostWebShell

Last Updated:Aug 28, 2026

Queries the webshell URL for accessing a host in a dedicated cluster.

Operation description

ApsaraDB MyBase for MySQL and PostgreSQL dedicated clusters support webshell-based host access. Use a webshell to access a host.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

DedicatedHostId

string

Yes

The host ID. Call DescribeDedicatedHosts to query the host ID.

ch-bp10a5id3boqi****

RegionId

string

Yes

The region ID of the host. Call DescribeDedicatedHostAttribute to query the region ID.

cn-hangzhou

ZoneId

string

Yes

The zone ID of the host. Call DescribeDedicatedHostAttribute to query the zone ID.

cn-hangzhou-b

Response elements

Element

Type

Description

Example

object

LoginUrl

string

The URL of the webshell.

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

RequestId

string

The request ID.

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

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidUserId.NotSupport The user ID has no permission. You are not authorized to perform this operation.
403 InvalidInstance The instance does not support the operation. The specified instance does not support this operation.
404 HostInfo.NotFound The specified host info is not found. The specified host information is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.