You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

ListDBInstances

最近更新时间：2023.05.23 18:46:14

首次发布时间：2021.11.12 19:19:31

我的收藏

调用 ListDBInstances 接口查询 MySQL 实例列表。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
OffsetInteger否0当前页查询偏移量。
LimitInteger否10每页记录数，取值应大于 0 且不超过 500，默认值为 10。
InstanceIdString否mysql-cf0c1a52****实例 ID。
InstanceNameString否ThisIsAnInstanceName实例名称。
InstanceTypeString否HA实例类型，取值：
HA：高可用版。
InstanceStatusString否Running实例状态，取值：
  • Running：运行中。
  • Creating：创建中。
  • Deleting：删除中。
  • Restarting：重启中。
  • Restoring：恢复中。
  • Updating：变更中。
  • Upgrading：升级中。
  • MasterChanging：主备切换中。
  • Error：错误。

    • CreateStartTime

    String

    否

    2020-12-20 00:00:00

    创建实例的开始时间，格式：yyyy-MM-dd HH:mm:ss（UTC 时间）。

    说明

    • 若设置了该参数，查询结束时间（即 EndTime）参数也必填。
    • 若该参数留空，默认返回当前实例下已存在的所有实例信息。

    CreateEndTime

    String

    否

    2020-12-20 12:00:10

    创建实例的结束时间，格式： yyyy-MM-dd HH:mm:ss（UTC 时间）。

    说明

    • 若设置了查询开始时间（即 StartTime），该参数必填。
    • 查询结束时间需晚于开始时间。

    Zone

    String

    否

    cn-beijing-a

    实例所属的可用区。

    说明

    您可以调用 DescribeDBInstance 接口查询实例所属的可用区。

    返回参数

    名称类型示例值描述
    TotalInteger1实例列表总数。
    DatasArray of InstanceInfo[
    {
    "InstanceId" : "rds-mysql-h441603c68aaa****",
    "InstanceName" : "rds-mysql-h441603c68aaa****",
    "InstanceStatus" : "Running",
    "CreateTime" : "2021-12-02 10:00:00",
    "InstanceType" : "HA",
    "DBEngine" : "MySQL",
    "DBEngineVersion : "MySQL_Community_5_7",
    "InstanceSpec" : {
    "CpuNum" : 2,
    "MemInGb" : 4,
    "SpecName" : "rds.mysql.2c4g"
    },
    "StorageSpaceGB" : 100,
    "Region" : "cn-beijing",
    "Zone" : "cn-beijing-a",
    "VpcID": "vpc-3teic1v7l64e8i4u****",
    "UpdateTime": "2021-10-10 10:10:10",
    "ChargeType": "PostPaid",
    "ChargeStatus": "Normal",
    "ReadOnlyInstanceIds": null,
    "TempModifyEndTime": "2023-05-23T08:49:10.000Z",
    "TempModifyStartTime": "2023-05-17T08:17:10.000Z"
    }
    ]    		实例列表详细信息。关于Instances的详细信息，请参见数据结构。

    请求示例

    POST /?Action=ListDBInstances&Version=2018-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "InstanceStatus" : "Running"
}

    返回示例

    正常返回示例

    {
    "ResponseMetadata" : {
        "RequestId": "d78bbf4e-63a5-4937-ac3c-3767e7eddfbe",
        "Action": "ListDBInstances",
        "Version": "2018-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
 
    "Result": {
        "Total" : 1,
        "Datas":[
            {
                "InstanceId" : "rds-mysql-h441603c68aaa****",
                "InstanceName" : "test",
                "InstanceStatus" : "Running",
                "CreateTime" : "2020-12-20 00:00:00",
                "InstanceType" : "HA",
                "DBEngine" : "MySQL",
                "DBEngineVersion" : "MySQL_Community_5_7",
                "InstanceSpec" : {
                    "CpuNum" : 2,
                    "MemInGb" : 4,
                    "SpecName" : "rds.mysql.2c4g"
                },
                "StorageSpaceGB" : 100,
                "Region" : "cn-beijing",
                "Zone" : "cn-beijing-a",
                "VpcID" : "vpc-3ajzohyfaru9s340jz1rp****",
                "UpdateTime": "2021-10-10 10:10:10",
                "ChargeType": "PostPaid",
                "ChargeStatus": "Normal",
                "ReadOnlyInstanceIds":  null,
                "TempModifyEndTime": "2023-05-16T13:48:58.000Z",
                "TempModifyStartTime": "2023-05-11T13:48:58.000Z"
            }
        ]
    }
}

    错误码

    更多详情，请参见错误码。