阿里云RDS数据库DescribeDBInstances – 查询实例列表-云淘科技

接口说明

适用引擎

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

调试

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

调试调试

授权信息

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

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

请求参数

本接口支持如下两种方式查看返回数据：

• 方式一：通过传入MaxResults参数设置每页的记录数，再通过NextToken参数设置翻页凭证来展示下一页的内容。NextToken取值为上一次调用DescribeDBInstances接口返回的NextToken参数值。

说明
首次调用接口进行分页查询时，您只需设置MaxResults参数，接口会返回第一页的数据和NextToken参数值。

• 方式二：通过PageSize参数设置每页的记录数，通过PageNumber参数进行翻页。

说明
上述两种方式只能任选其一。当返回的记录数较多时，推荐使用方式一，可以获得更快的查询速度。

返回参数

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": 1,
  "PageRecordCount": 10,
  "TotalRecordCount": 100,
  "Items": {
    "DBInstance": [
      {
        "VpcId": "vpc-uf6f7l4fg90****",
        "DedicatedHostIdForLog": "dh-bp****",
        "CreateTime": "2018-11-05T11:26:02Z",
        "PayType": "Postpaid",
        "DedicatedHostNameForLog": "testlog",
        "MutriORsignle": true,
        "DedicatedHostGroupName": "testhostgroup",
        "EngineVersion": "5.7",
        "DedicatedHostGroupId": "dhg-7a9****",
        "VpcName": "test-huadong",
        "DedicatedHostZoneIdForMaster": "cn-hangzhou-c",
        "ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
        "InstanceNetworkType": "Classic",
        "MasterInstanceId": "rm-uf6wjk5****",
        "ExpireTime": "2019-02-27T16:00:00Z",
        "DestroyTime": "2018-11-05T11:26:02Z",
        "GuardDBInstanceId": "rm-uf64zsu****",
        "DedicatedHostNameForMaster": "testmaster",
        "ZoneId": "cn-hangzhou-a",
        "TipsLevel": 1,
        "DBInstanceId": "rm-uf6wjk5****",
        "DedicatedHostIdForMaster": "dh-bp****",
        "TempDBInstanceId": "rm-uf64zsu****",
        "DBInstanceStorageType": "ModuleList.4.ModuleCode",
        "ConnectionMode": "Standard",
        "LockMode": "Unlock",
        "GeneralGroupName": "TestGroup",
        "VpcCloudInstanceId": "rm-uf6wjk5****",
        "DedicatedHostZoneIdForSlave": "cn-hangzhou-d",
        "Tips": "normal",
        "DedicatedHostZoneIdForLog": "cn-hangzhou-b",
        "DedicatedHostNameForSlave": "testslave",
        "DBInstanceDescription": "testdb",
        "DBInstanceNetType": "Internet",
        "DBInstanceType": "Primary",
        "LockReason": "instance_expired",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-uf6adz52c2p****",
        "DedicatedHostIdForSlave": "dh-bp****",
        "ResourceGroupId": "rg-acfmy****",
        "Category": "Basic",
        "Engine": "MySQL",
        "DBInstanceClass": "rds.mys2.small",
        "SwitchWeight": 100,
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            {
              "DBInstanceId": "rr-uf6wjk5****"
            }
          ]
        },
        "DeletionProtection": false,
        "BurstingEnabled": false,
        "BpeEnabled": "0"
      }
    ]
  },
  "NextToken": "o7PORW5o2TJg****"
}

错误码

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

变更历史