调用 DescribeDBInstances 接口查询实例列表。 ## 请求类型同步请求。 ## 调试 [去调试](https://api.volcengine.com/api-explorer/debug?action=DescribeDBInstances&serviceCode=vedbm&version=2022-01-01&groupName=) ## 请求参数 |参数 |类型 |是否必选 |示例值 |描述 | |---|---|---|---|---| |DBEngineVersion |String |否 |MySQL_8_0 |实例兼容版本。取值范围：

* `MySQL_8_0`：表示兼容社区 MySQL 8.0 版本。

* `MySQL_5_7`：表示兼容社区 MySQL 5.7 版本。 | |InstanceId |String |否 |vedbm\-d4mx2akm\*\*\*\* |实例 ID。 | |InstanceName |String |否 |test |实例名称，支持模糊查询。 | |InstanceStatus |String |否 |Running |实例状态。

说明

关于实例状态的详细说明，请参见实例状态说明。

说明

同时传入 CreateTimeStart 和 CreateTimeEnd 参数时，创建实例的结束时间需晚于开始时间。

说明

您可以调用 DescribeAvailabilityZones 接口查询实例支持的可用区信息。

说明

关于实例节点规格的详细信息，请参见产品规格。

说明

单次最多支持同时传入 10 组标签键值对进行查询筛选。

| |ProjectName |String |否 |default |指定实例所属的项目名称。 | |PageSize |Integer |否 |10 |每页记录数。取值范围 1~500，默认值为 10。 | |PageNumber |Integer |否 |1 |页码，取值大于等于 1，且不超过 Integer 的最大值，默认值为 1。 | ### TagFilterObject |参数 |类型 |是否必选 |示例值 |描述 | |---|---|---|---|---| |Key |String |否 |department |用于查询筛选的标签键。 | |Value |String |否 |game |用于查询筛选的标签值。

说明

若绑定标签时，设置了标签值，则筛选时该参数必填。

| ## 返回参数 |参数 |类型 |示例值 |描述 | |---|---|---|---| |Total |Integer |1 |符合查询条件的实例数量。 | |Instances |Array of [InstanceObject](https://www.volcengine.com/docs/6357/96188#instanceobject) |请参见返回示例。 |实例列表。 | ### InstanceObject |参数 |类型 |示例值 |描述 | |---|---|---|---| |InstanceId |String |vedbm\-d4mx2akm\*\*\*\* |实例 ID。 | |InstanceName |String |test |实例名称。 | |InstanceStatus |String |Running |实例状态。

说明

关于实例状态的详细说明，请参见实例状态说明。

说明

项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色管理这些资源的权限。更多详情，请参见资源管理。

| |ZoneIds |String |cn\-beijing\-a |实例所属的可用区。 | |VpcId |String |vpc\-3ajzohyfaru9s340jz1rp\*\*\*\* |私有网络（VPC）ID。 | |TimeZone |String |UTC +08:00 |实例的时区。国内所有地域默认时区为 `UTC +08:00`。 | |StorageChargeType |String |PostPaid |存储计费类型，取值：

* `PostPaid`：按量计费（后付费）。

* `PrePaid`：包年包月（预付费）。 | |PrePaidStorageInGB |Integer |50 |预付费的存储总容量大小，单位 GiB。 | |StorageUsedGiB |Double |0.44 |已使用存储空间大小，单位 GiB。 | |ChargeDetail |Object of [ChargeDetailObject](https://www.volcengine.com/docs/6357/96188#chargedetailobject) |请参见返回示例。 |计费信息。 | |RegionId |String |cn\-beijing |地域 ID。 | |SubnetId |String |subnet\-1g15j13jtzgu88ibuxwqp\*\*\*\* |子网 ID。子网必须属于所选的可用区。 | |Nodes |Array of [NodeObject](https://www.volcengine.com/docs/6357/96188#nodeobject) |请参见返回示例。 |实例节点的详细信息。 | |Tags |Array of [TagObject](https://www.volcengine.com/docs/6357/96188#tagobject) |请参见返回示例。 |实例绑定的标签键和标签值数组对象。 | |DeletionProtection |String |enabled |实例是否开启了删除保护功能。取值范围：

* `enabled`：开启。

* `disabled`：关闭。 | |DBRevisionVersion |String |3.0.2.1 |实例的内核版本。关于实例内核版本的详细信息，请参见[版本号管理](https://www.volcengine.com/docs/6357/1330616)。 | |SpecFamily |String |Exclusive |实例规格类型，取值：

* `General`：通用型。

* `Exclusive`：独享型。 | |LowerCaseTableNames |String |1 |表名是否区分大小写。取值范围：

* `0`：表名称大小写敏感，后端根据实际表名存储。

* `1`：表名称不区分大小写，后端存储时将表名称统一为小写字母。 | |StorageType |String |IOOptimizedStorage |存储类型。取值范围：

* `IOOptimizedStorage`：IO 性能型。

* `SmartCompressedStorage`：智能压缩型。 | ### ChargeDetailObject |参数 |类型 |示例值 |描述 | |---|---|---|---| |ChargeType |String |PostPaid |计算计费类型，取值：

* `PostPaid`：按量计费（后付费）。

* `PrePaid`：包年包月（预付费）。 | |ChargeStatus |String |Normal |付费状态：

* `Normal`：正常。

* `Overdue`：欠费。

* `Shutdown`：关停。 | |OverdueReclaimTime |String |2022\-09\-27T06:09:20Z |欠费关停时预计释放时间，格式：yyyy\-MM\-ddTHH:mm:ssZ（UTC 时间）。 | |OverdueTime |String |2022\-10\-04T07:50:22Z |欠费关停时间，格式：yyyy\-MM\-ddTHH:mm:ssZ（UTC 时间）。 | |AutoRenew |Boolean |true |预付费场景下是否自动续费。取值：

* `true`：自动续费。

* `false`：不自动续费。 | |ChargeStartTime |String |2023\-09\-22T08:08:35Z |计费开始的时间，格式：yyyy\-MM\-ddTHH:mm:ssZ（UTC 时间）。 | |ChargeEndTime |String |2023\-09\-22T08:08:35Z |预付费场景下计费到期的时间，格式：yyyy\-MM\-ddTHH:mm:ssZ（UTC 时间）。 | ### NodeObject |参数 |类型 |示例值 |描述 | |---|---|---|---| |NodeId |String |vedbm\-h441603c68aaa\*\*\*\*\-\*\* |节点 ID。 | |ZoneId |String |cn\-beijing\-a |可用区 ID。 | |NodeType |String |Primary |节点类型。取值：

* `Primary`：主节点。

* `ReadOnly`：只读节点。 | |vCPU |Integer |8 |CPU 大小，例如当取值为 1 时表示 CPU 大小为 1U。 | |Memory |Integer |32 |内存大小，单位为 GiB。 | |NodeSpec |String |vedb.mysql.x4.xlarge |实例的节点规格。

说明

关于实例节点规格的详细信息，请参见产品规格。

| |FailoverPriority |Integer |5 |节点切主的优先级，取值范围为 0~15。数值越大，优先级越高。 | ### TagObject |参数 |类型 |示例值 |描述 | |---|---|---|---| |Key |String |department |实例绑定的标签键。 | |Value |String |game |实例绑定的标签值。 | ## 示例 ### 请求示例 ```json POST /?Action=DescribeDBInstances&Version=2022-01-01 HTTP/1.1 Content-Type: application/json Host:vedbm.cn-beijing.volcengineapi.com X-Date: 20220101T101010Z Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645**** { "PageSize": 10, "PageNumber": 1, "ChargeType": "PostPaid", "InstanceStatus": "Running", "CreateTimeEnd": "2023-07-24T06:09:36Z", "TagFilters": [ { "Key": "project", "Value": "default" } ] } ``` ### 返回示例 ```json { "ResponseMetadata": { "RequestId": "20230801111540C54F0E53A01BAA61D62A", "Action": "DescribeDBInstances", "Version": "2022-01-01", "Service": "vedbm", "Region": "cn-beijing" }, "Result": { "Instances": [ { "ChargeDetail": { "ChargeStatus": "Normal", "ChargeType": "PostPaid", "OverdueReclaimTime": "", "OverdueTime": "" }, "CreateTime": "2023-07-24T06:09:36Z", "DBEngineVersion": "MySQL_8_0", "DBRevisionVersion": "3.0.2.1", "DeletionProtection": "disabled", "InstanceId": "vedbm-d6rjf5ln****", "InstanceName": "vedb_test", "InstanceStatus": "Running", "LowerCaseTableNames": "0", "Nodes": [ { "Memory": 32, "NodeId": "vedbm-d6rjf5ln****-0", "NodeSpec": "vedb.mysql.x4.xlarge", "NodeType": "ReadOnly", "ZoneId": "cn-beijing-b", "vCPU": 8 }, { "Memory": 32, "NodeId": "vedbm-d6rjf5ln****-1", "NodeSpec": "vedb.mysql.x4.xlarge", "NodeType": "Primary", "ZoneId": "cn-beijing-b", "vCPU": 8 } ], "PrePaidStorageInGB": 50, "ProjectName": "default", "RegionId": "cn-beijing", "SpecFamily": "Exclusive", "StorageChargeType": "PostPaid", "StorageType": "IOOptimizedStorage", "StorageUsedGiB": 235.16, "SubnetId": "subnet-3jh4l05leg6ww3pncmeyb****", "Tags": [ { "Key": "hhhh", "Value": "" }, { "Key": "project", "Value": "default" } ], "TimeZone": "UTC +08:00", "VpcId": "vpc-30uw0duznqt4w7r2qr0un****", "ZoneIds": "cn-beijing-b" } ], "Total": 1 } } ``` ## 错误码更多详情，请参见[错误码](https://www.volcengine.com/docs/6357/96181)。