该接口用于查询RDS SQL Server实例的主机WebShell登录信息。
接口说明
适用引擎
- RDS SQL Server
前提条件
- RDS 实例需满足如下条件:
- 实例所在地域:除华北 3(张家口)外的其他地域均支持使用该功能。
- 实例系列:基础系列、高可用系列(2012 及以上版本)、集群系列。
- 实例规格:通用型、独享型(不支持共享型)。
- 网络类型:专有网络。如需变更网络类型,请参见更改网络类型。
- 实例创建时间:高可用系列和集群系列实例的创建时间需在 2021 年 01 月 01 日或之后;基础系列实例的创建时间需在 2022 年 09 月 02 日或之后。实例创建时间可在基本信息页内的运行状态中查看。
- 登录账号必须为阿里云主账号。
相关功能文档
注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeHostWebShell | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例 ID。 | rm-uf6wjk5**** |
RegionID | string | 是 | 实例所在的地域 ID。可调用 DescribeDBInstanceAttribute 接口查询。 | cn-hangzhou |
HostName | string | 是 | 实例主机名。可调用 DescribeDBInstanceIpHostname 接口查询。 | testHost1 |
AccountName | string | 是 | 需要登录到 RDS 实例主机的账号名称。 | testOsAccount1 |
AccountPassword | string | 是 | 主机账号名的密码。 | **** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "842B73C8-5776-4BD9-9872-69C8C46DD7D3",
"LoginUrl": "****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 您的账户可用额度小于0,请先充值后再尝试购买。 |
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 | RegionEndTimeDissolvedIndia | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. | 客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。 |
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. | 客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30 |
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 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | 您的信息不完整,请在操作前填写您的信息。 |
400 | System.SaleValidateFailed | Sales expression validation system error. | 销售表达式校验系统错误。 |
403 | ClusterTypeNotSupported | The current Instance ClusterType does not support this operation. | 当前实例所在集群不支持此操作。 |
403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 实例当前存在未支付订单,请支付后重试。 |
404 | HostInfo.NotFound | The specified host info is not found. | 指定的主机信息不存在。 |
404 | InvalidAccountName.NotFound | Specified account name does not exist. | 当前账户名不存在,请确认或选择正确的账户名。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史