すべてのプロダクト
Search

このプロダクト

    ApsaraDB RDS:DescribeHostWebShell

    ドキュメントセンター

    ApsaraDB RDS:DescribeHostWebShell

    最終更新日:Apr 18, 2026

    ApsaraDB RDS for SQL Server インスタンスのホストへの接続に使用されるウェブシェルの URL をクエリします。

    操作説明

    サポート対象のデータベースエンジン

    • SQL Server

    前提条件

    • インスタンスは、次の要件を満たしています。

      • インスタンスは、中国 (張家口) リージョン以外のリージョンにあります。

      • インスタンスは、RDS Basic Edition、RDS Cluster Edition、または RDS High-availability Edition を実行します。インスタンスが RDS High-availability Edition を実行している場合は、インスタンスが SQL Server 2012 以降を実行していることを確認してください。

      • インスタンスは、汎用または専用インスタンスファミリーに属します。共有インスタンスファミリーはサポートされていません。

      • インスタンスは VPC (Virtual Private Cloud) 内にあります。RDS インスタンスのネットワークタイプを変更する方法の詳細については、「ネットワークタイプの変更」をご参照ください。

      • インスタンスが RDS High-availability Edition または RDS Cluster Edition を実行している場合、インスタンスは 2021 年 1 月 1 日以降に作成されている必要があります。インスタンスが RDS Basic Edition を実行している場合、インスタンスは 2022 年 9 月 2 日以降に作成されている必要があります。インスタンスの [作成時間] パラメーターは、ApsaraDB RDS コンソールの [基本情報] ページの [ステータス] セクションで確認できます。

    • ログインには Alibaba Cloud アカウント (root ユーザー) を使用します。

    関連ドキュメント

    説明

    この操作を呼び出す前に、次のドキュメントをよくお読みください。この操作を呼び出すための前提条件と影響を十分に理解していることを確認してください。

    ホストアカウントを作成し、ホストアカウントを使用してログインする

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rds:DescribeHostWebShell

    get

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    rm-uf6wjk5****
    RegionID

    string

    必須

    インスタンスのリージョン ID。DescribeDBInstanceAttribute 操作を呼び出して、リージョン ID をクエリできます。

    cn-hangzhou
    HostName

    string

    必須

    インスタンスのホスト名。DescribeDBInstanceIpHostname 操作を呼び出して、ホスト名をクエリできます。

    testHost1
    AccountName

    string

    必須

    インスタンスのホストへのログインに使用されるアカウントのユーザー名。

    testOsAccount1
    AccountPassword

    string

    必須

    ホストアカウントのパスワード。

    ****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    LoginUrl

    string

    ウェブシェルの URL。

    ****
    RequestId

    string

    リクエスト ID。

    842B73C8-5776-4BD9-9872-69C8C46DD7D3

    例

    成功レスポンス

    JSONJSON

    {
  "LoginUrl": "****",
  "RequestId": "842B73C8-5776-4BD9-9872-69C8C46DD7D3"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 WebShellLoginFailed %s,%s.
    400 InvalidUserId.NotSupport The user ID has no permission.
    400 InvalidHostStatus.Format Specified host status is not valid.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found.
    400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
    400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase.
    400 CommodityServiceCalling.Exception Failed to call commodity service.
    400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again.
    400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
    400 Price.CommoditySys Commodity system call exception.
    400 Pay.InsufficientBalance Insufficient available balance.
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again.
    400 pay.noCreditCard Account not bound to credit card.
    400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method.
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation.
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details.
    400 Api.NotSupport Specified api is not supported.
    400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance.
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records.
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type
    400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
    400 KmsApiError User secret key invalid.
    400 System.SaleValidateFailed Sales expression validation system error.
    400 Abs.InvalidAccount.NotFound account is not found.
    400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s.
    400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled.
    400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled.
    400 IncorrectTargetClasscode The current instance type does not support this operation.
    400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS.
    400 RequiredParam.NotFound Required input param is not found.
    400 Parameters.Invalid Parameter error, please check the parameters.
    400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400 InvalideStatus.Format The instance status does not support this operation.
    400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid.
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation.
    400 Pay.NoCreditCard No credit cards.
    400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation.
    400 MirrorInsExists Specified DB instance mirror ins already existed.
    400 UnsupportedClassCode The specified DB instance class stops selling.
    400 InvalidBackupSet The specified database does not exist in the backup set.
    400 OrdTCommodityQueryError Failed to query for product.
    400 ProductInstanceReleased The instance has been released. Please check before placing the order.
    400 RegionEndTimeDissolvedIndia The region is no longer supported.
    500 ExternalFailure The request processing has failed due to external service failure.
    500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel.
    500 InvokeProxyFailure The request processing has failed due to service failure of rds api.
    403 ClusterTypeNotSupported The current Instance ClusterType does not support this operation.
    403 OrderStatus.UnPaid The specified db instance has unpaid order.
    403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount.
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
    403 InvalidUserOperatorPermission The user permission does not support this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid.
    403 IncorrectMinorVersion Current engine minor version does not support operations.
    403 OperationDenied.ZoneResource There is no available zone for inventory.
    403 NotInFlowController Sorry,no permission.
    403 InvalidKmsKey Kms key is disabled.
    403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation.
    404 HostInfo.NotFound The specified host info is not found.
    404 InvalidAccountName.NotFound Specified account name does not exist.
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service.
    404 Request.NotFound The requested resource is not available.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。