调用DescribeDatabaseInstances查看轻量数据库实例信息_轻量应用服务器(SAS)-阿里云帮助中心

查看轻量数据库实例信息。

接口说明

通过此接口可查看指定地域下一个或多个轻量数据库实例的详细信息，包括轻量数据库实例 ID、名称、套餐、数据库版本、公网访问地址、内网访问地址、创建时间、到期时间等信息。

QPS 限制

本接口的单用户 QPS 限制为 10 次/分钟。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	指定的轻量数据库实例所属的地域 ID。	cn-hangzhou
DatabaseInstanceIds	string	否	轻量数据库实例 ID。取值可以由多个轻量数据库实例 ID 组成一个 JSON 数组，最多支持 100 个实例 ID，ID 之间用英文半角逗号（,）隔开。	["swasdb-xxx****","swasdb-yyy****"]
PageNumber	integer	否	轻量数据库实例列表的页码。起始值：1 默认值：1	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：100。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	20758A-585D-4A41-A9B2-28DA8F4****
DatabaseInstances	object []	轻量数据库实例集合信息。
RegionId	string	轻量数据库实例所属的地域 ID。	cn-hangzhou
DatabaseInstanceId	string	轻量数据库实例 ID。	db-38263fa955774501a2ae1bdaed6f****
DatabaseInstanceName	string	轻量数据库实例名称。	我的数据库
DatabaseInstanceEdition	string	轻量数据库实例套餐版本 ID。可能值： swas.db.c1m1s25：35 元/月。 swas.db.c1m2s80：100 元/月。 swas.db.c2m4s120：200 元/月。 swas.db.c2m8s240：300 元/月。	swas.db.c1m1s25
DatabaseVersion	string	数据库版本。可能值： 5.7：MySQL 5.7。 8.0：MySQL 8.0。	5.7
Cpu	string	vCPU 核数。	1
Memory	string	内存大小，单位为 GB。	1
Storage	integer	ESSD 云盘容量，单位为 GB。	25
PrivateConnection	string	私网链接地址。	rm-bp1d39opj7906****.mysql.rds.aliyuncs.com
PublicConnection	string	公网链接地址。说明只有申请开通公网访问地址才显示此参数。您可以调用 AllocatePublicConnection 申请外网地址。	db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com
DatabaseInstanceStatus	string	轻量数据库服务实例状态：可能值 Pending: 创建中。 Restarting：重启中。 Running：运行中。 Stopping：停止中。 Stopped：已停止。 UPGRADING：升级中。 DISABLED：已禁用。	Running
BusinessStatus	string	业务状态。可能值： normal: 正常。 expired: 到期。 overdue: 欠费。	normal
CreationTime	string	实例创建时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2022-09-01T02:39:46Z
ExpiredTime	string	实例到期时间。按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。说明 +8 小时后是控制台上显示的到期时间。	2022-10-01T16:00:00Z
ChargeType	string	轻量数据库例的计费方式。目前只支持包年包月的计费方式，取值为 PrePaid。默认值：PrePaid。	PrePaid
SuperAccountName	string	轻量数据库实例超级账号名称。	administrator
PageSize	integer	轻量数据库实例列表的当前页码。	1
PageNumber	integer	分页查询时设置的每页行数。	10
TotalCount	integer	总条数。	5

示例

正常返回示例

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4****",
  "DatabaseInstances": [
    {
      "RegionId": "cn-hangzhou",
      "DatabaseInstanceId": "db-38263fa955774501a2ae1bdaed6f****",
      "DatabaseInstanceName": "我的数据库",
      "DatabaseInstanceEdition": "swas.db.c1m1s25",
      "DatabaseVersion": "5.7",
      "Cpu": "1",
      "Memory": "1",
      "Storage": 25,
      "PrivateConnection": "rm-bp1d39opj7906****.mysql.rds.aliyuncs.com",
      "PublicConnection": "db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com",
      "DatabaseInstanceStatus": "Running",
      "BusinessStatus": "normal",
      "CreationTime": "2022-09-01T02:39:46Z",
      "ExpiredTime": "2022-10-01T16:00:00Z",
      "ChargeType": "PrePaid",
      "SuperAccountName": "administrator"
    }
  ],
  "PageSize": 1,
  "PageNumber": 10,
  "TotalCount": 5
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史