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

DescribeDBInstances

最近更新时间：2024.03.14 22:52:08

首次发布时间：2023.02.02 17:41:21

我的收藏

调用 DescribeDBInstances 接口查看实例列表。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString否mysql-1d797b6f****实例 ID。
InstanceNameString否TestDB实例名称。

InstanceStatus

String

否

Running

实例状态，取值：

  • Creating：创建中。
  • Running：运行中。
  • Deleting：删除中。
  • Restarting：重启中。
  • Updating：变更中。
  • Restoring：恢复中。
  • Error：错误。
  • Upgrading：升级中。
  • Recycled：已回收。
  • MasterChanging：主节点切换中。
  • TDEUpdating：TDE 修改中。
  • Closed：关停。
  • Maintaining：维护中。
  • CreateFailed：创建失败。
  • Closing：关停中。
  • SSLUpdating：SSL 变更中。
  • AllowListMaintaining：白名单变更中。
  • Unknown：未知。
  • ProxyCreating：代理开启中。
  • ProxyDeleting：代理关闭中。

DBEngineVersion

String

否

MySQL_8_0

兼容版本。取值：

  • MySQL_5_7：MySQL 5.7 版本。
  • MySQL_8_0：MySQL 8.0 版本。
CreateTimeStartString否2022-01-01T10:10:10Z查询创建实例创建时间范围。
CreateTimeEndString否2022-01-01T10:10:10Z查询创建实例创建时间范围。
ZoneIdString否cn-beijing-a实例所属可用区。

ChargeType

String

否

PostPaid

付费类型。取值：

  • PostPaid：按量付费。
  • PrePaid：包年包月（默认）。
ProjectNameString否testProject项目名称。
PageNumberInteger否1当前页页码。取值最小为 1。默认值为 1。
PageSizeInteger否10每页记录数。最小值为 1，最大值不超过 100。默认值为 10。

返回参数

名称类型示例值描述
TotalInteger1实例总数。
InstancesArray of InstanceObject无实例列表。更多关于 Instances 的信息，请参见数据结构。

请求示例

POST /?Action=DescribeDBInstances&Version=2022-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":"20230110194301C23B8A99043A27D617A2",
        "Action":"DescribeDBInstances",
        "Version":"2022-01-01",
        "Service":"rds_mysql",
        "Region":"cn-beijing"
    },
    "Result":{
        "Instances":[
            {
                "AddressObject":[
                    {
                        "DNSVisibility": false,
                        "Domain": "mysql-1d797b6f****-public.rds.volces.com",
                        "EipId": "eip-13flx63066io03n6nu51u****",
                        "IPAddress": "180.***.***.***",
                        "InternetProtocol": "IPv4",
                        "NetworkType": "Public",
                        "SubnetId": "subnet-rs4brkc5pnuov0x576g****"
                    },
                    {
                        "DNSVisibility": false,
                        "Domain": "mysql-1d797b6f****.rds.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.***.***.***",
                        "InternetProtocol": "IPv4",
                        "NetworkType": "Private",
                        "SubnetId": "subnet-rs4brkc5pnuov0x576g****"
                    }
                ],
                "AllowListVersion":"v2",
                "ChargeDetail":{
                    "AutoRenew":FALSE,
                    "ChargeEndTime":"",
                    "ChargeStartTime":"2023-01-10T11:13:34.000Z",
                    "ChargeStatus":"Normal",
                    "ChargeType":"PostPaid",
                    "Number":0,
                    "OverdueReclaimTime":"2200-01-15T16:00:00.000Z",
                    "OverdueTime":"",
                    "Period":0,
                    "PeriodUnit":"Month"
                },
                "CreateTime":"2023-01-10T11:13:30.000Z",
                "DBEngineVersion":"MySQL_5_7",
                "InstanceId":"mysql-1d797b6f****",
                "InstanceName":"测试实例 1",
                "InstanceStatus":"Running",
                "InstanceType": "DoubleNode",
                "LowerCaseTableNames":"1",
                "NodeNumber":3,
                "NodeSpec":"rds.mysql.1c2g",
                "ProjectName":"",
                "RegionId":"cn-beijing",
                "StorageSpace":20,
                "StorageType":"LocalSSD",
                "SubnetId":"subnet-2bzr8zdx5o8ao2dx0efq4****",
                "TimeZone":"UTC +08:00",
                "VpcId":"vpc-3rebt5uf5fr405zsk2if9****",
                "ZoneId":"cn-beijing-c"
            }
        ],
        "Total": 1
    }
}

错误码

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