DescribeDatabaseInstances - 查看轻量数据库实例信息

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

指定的轻量数据库实例所属的地域 ID。

cn-hangzhou
DatabaseInstanceIdsstring

轻量数据库实例 ID。 取值可以由多个轻量数据库实例 ID 组成一个 JSON 数组,最多支持 100 个实例 ID,ID 之间用英文半角逗号(,)隔开。

["swasdb-xxx******","swasdb-yyy******"]
PageNumberinteger

轻量数据库实例列表的页码。

起始值:1

默认值:1

1
PageSizeinteger

分页查询时设置的每页行数。

最大值:100。

默认值:10。

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4****
DatabaseInstancesarray<object>

轻量数据库实例集合信息。

DatabaseInstanceobject

轻量数据库实例集合信息。

RegionIdstring

轻量数据库实例所属的地域 ID。

cn-hangzhou
DatabaseInstanceIdstring

轻量数据库实例 ID。

db-38263fa955774501a2ae1bdaed6f****
DatabaseInstanceNamestring

轻量数据库实例名称。

我的数据库
DatabaseInstanceEditionstring

轻量数据库实例套餐版本 ID。可能值:

  • swas.db.c1m1s25:35 元/月。

  • swas.db.c1m2s80:100 元/月。

  • swas.db.c2m4s120:200 元/月。

  • swas.db.c2m8s240:300 元/月。

swas.db.c1m1s25
DatabaseVersionstring

数据库版本。可能值:

  • 5.7:MySQL 5.7。
  • 8.0:MySQL 8.0。
5.7
Cpustring

vCPU 核数。

1
Memorystring

内存大小,单位为 GB。

1
Storageinteger

ESSD 云盘容量,单位为 GB。

25
PrivateConnectionstring

私网链接地址。

rm-bp1d39opj7906****.mysql.rds.aliyuncs.com
PublicConnectionstring

公网链接地址。

说明 只有申请开通公网访问地址才显示此参数。您可以调用 AllocatePublicConnection 申请外网地址。
db-38263fa955774501a2ae1bdaed6f****.mysql.rds.aliyuncs.com
DatabaseInstanceStatusstring

轻量数据库服务实例状态:可能值

  • Pending: 创建中。
  • Restarting:重启中。
  • Running:运行中。
  • Stopping:停止中。
  • Stopped:已停止。
  • UPGRADING:升级中。
  • DISABLED:已禁用。
Running
BusinessStatusstring

业务状态。可能值:

  • normal: 正常。
  • expired: 到期。
  • overdue: 欠费。
normal
CreationTimestring

实例创建时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2022-09-01T02:39:46Z
ExpiredTimestring

实例到期时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

说明 +8 小时后是控制台上显示的到期时间。
2022-10-01T16:00:00Z
ChargeTypestring

轻量数据库例的计费方式。目前只支持包年包月的计费方式,取值为 PrePaid。

默认值:PrePaid。

PrePaid
SuperAccountNamestring

轻量数据库实例超级账号名称。

administrator
PageSizeinteger

轻量数据库实例列表的当前页码。

1
PageNumberinteger

分页查询时设置的每页行数。

10
TotalCountinteger

总条数。

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
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史