文档

DescribeAvailableClasses - 查询实例可变更规格

更新时间:

该接口用于查询RDS实例的可变更规格及存储空间等信息。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeAvailableClassesRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
RegionIdstring

当前实例的地域 ID。可以通过接口 DescribeDBInstanceAttribute 查看所属地域 ID。

cn-hangzhou
ZoneIdstring

当前实例的可用区 ID。可以通过接口 DescribeDBInstanceAttribute 查看所属可用区 ID。

说明 若 DescribeDBInstanceAttribute 返回多可用区(例如cn-hangzhou-MAZ9(g,h)),请以单可用区形式传入。例如:cn-hangzhou-gcn-hangzhou-j
cn-hangzhou-j
InstanceChargeTypestring

当前付费类型,取值:

  • Prepaid:包年包月
  • Postpaid:按量付费
  • Serverless:Serverless
说明 MariaDB 不支持创建 Serverless 实例。
Prepaid
Enginestring

当前数据库类型。取值:

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
MySQL
EngineVersionstring

当前数据库版本。取值:

  • 常规实例
    • MySQL:5.5、5.6、5.7、8.0
    • SQL Server:2008r2、08r2_ent_ha、2012、2012_ent_ha、2012_std_ha、2012_web、2014_std_ha、2016_ent_ha、2016_std_ha、2016_web、2017_std_ha、2017_ent、2019_std_ha、2019_ent
    • PostgreSQL:10.0、11.0、12.0、13.0、14.0、15.0
    • MariaDB:10.3
  • Serverless 实例
    • MySQL:5.78.0

    • SQL Server:2016_std_sl2017_std_sl2019_std_sl

    • PostgreSQL:14.0

    说明 MariaDB 不支持创建 Serverless 实例。
8.0
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
OrderTypestring

订单类型。当前仅唯一取值:BUY

BUY
DBInstanceStorageTypestring

当前实例存储类型。取值:

  • local_ssd:本地 SSD 盘(推荐)
  • cloud_ssd:SSD 云盘
  • cloud_essd:ESSD PL1 云盘
  • cloud_essd2:ESSD PL2 云盘
  • cloud_essd3:ESSD PL3 云盘
说明 Serverless 实例仅支持 ESSD PL1 云盘,必须传入cloud_essd
local_ssd
Categorystring

当前实例系列。取值:

  • 常规实例
    • Basic:基础系列
    • HighAvailability:高可用系列
    • cluster:MySQL 集群系列
    • AlwaysOn:SQL Server 集群系列
    • Finance:三节点企业系列
  • Serverless 实例
    • serverless_basic:Serverless 基础系列(仅适用 MySQL 和 PostgreSQL)

    • serverless_standard:MySQL Serverless 高可用系列

    • serverless_ha:SQL Server Serverless 高可用系列

    说明 若创建 Serverless 实例,该字段必传。
HighAvailability
CommodityCodestring

当前实例的商品码。取值:

  • bards:主实例按量付费(中国站)
  • rds:主实例包年包月(中国站)
  • rords:只读实例按量付费(中国站)
  • rds_rordspre_public_cn:只读实例包年包月(中国站)
  • bards_intl:主实例按量付费(国际站)
  • rds_intl:主实例包年包月(国际站)
  • rords_intl:只读实例按量付费(国际站)
  • rds_rordspre_public_intl:只读实例包年包月(国际站)
  • rds_serverless_public_cn:serverless(中国站)
  • rds_serverless_public_intl:serverless(国际站)
说明 查询只读实例时必须传入本参数。
bards

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC
DBInstanceClassesobject []

当前实例可用规格列表。

DBInstanceClassstring

实例规格。

rds.mysql.c1.large
DBInstanceStorageRangeobject

实例存储空间范围。

Stepinteger

调整存储空间的最小粒度。当前为固定 5 GB 递增。

5
MinValueinteger

最小存储空间,单位:GB。

5
MaxValueinteger

最大存储空间,单位:GB。

2000

示例

正常返回示例

JSON格式

{
  "RequestId": "7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC",
  "DBInstanceClasses": [
    {
      "DBInstanceClass": "rds.mysql.c1.large",
      "DBInstanceStorageRange": {
        "Step": 5,
        "MinValue": 5,
        "MaxValue": 2000
      }
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ArticleNotFoundArticle not found没有找到相关约束
400InvalidDBInstanceNameThe specified parameter DBInstanceName is null or the instance cannot be found, please check parameter DBInstanceName.指定的参数DBInstanceName值为null,或者没有找到对应的实例,请检查参数DBInstanceName。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou 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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear 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.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud 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。
400RegionEndTimeDissolvedAustraliaCloud 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
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
404InvalidDBInstanceName.NotFoundDBInstanceName not found-
404InvalidCondition.NotFoundNo class found操作失败,可用类的条件无效。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2024-03-14OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
  • 本页导读 (1)