You need to enable JavaScript to run this app.
导航
DescribeDBInstances
最近更新时间:2024.06.13 14:27:24首次发布时间:2022.04.12 19:05:15

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

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述
DBEngineVersionStringMySQL_8_0数据库引擎版本,取值固定为 MySQL_8_0
PageSizeInteger10每页记录数。取值范围 1~1000,默认值为 10。
PageNumberInteger1页码,取值大于等于 1,且不超过 Integer 的最大值,默认值为 1。
InstanceIdStringvedbm-d4mx2akm****实例 ID。
InstanceNameStringtest实例名称,支持模糊查询。

InstanceStatus

String

Running

实例状态,取值:

  • WaitingPaid:等待支付。
  • Running:运行中。
  • Creating:创建中。
  • Scaling:变更配置中。
  • Restarting:重启中。
  • Restoring:恢复中。
  • Upgrading:升级版本中。
  • PrimaryChanging:主备切换中。
  • Unavailable:不可用。
  • Deleting:删除中。
  • Deleted:已释放。
  • CreateFailed:创建失败。
  • Closing:关停中。
  • Expired:到期。
  • Owing:欠费中。
  • Resuming:恢复中。
  • AllowListMaintaining:白名单维护中。
  • Error:错误。
CreateTimeStartString2022-06-21T07:57:26Z创建实例的开始时间,格式:YYYY-MM-DDTHH:MM:SSZ(UTC 时间)。

CreateTimeEnd

String

2022-06-21T07:57:26Z

创建实例的结束时间,格式:YYYY-MM-DDTHH:MM:SSZ(UTC 时间)。

说明

同时传入 CreateTimeStartCreateTimeEnd 参数时,创建实例的结束时间需晚于开始时间。

ZoneId

String

cn-beijing-a

实例所在可用区的 ID。

说明

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

ChargeType

String

PostPaid

计费类型,取值:

  • PostPaid:按量计费(后付费)。
  • PrePaid:包年包月(预付费)。

NodeSpec

String

vedb.mysql.x4.xlarge

实例的节点规格。

说明

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

TagFilters

Array of TagFilterObject

请参见请求示例

用于查询筛选的标签键值对数组。关于 Tags 的更多说明,请参见 TagFilterObject

说明

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

ProjectNameStringdefault指定实例所属的项目名称。

返回参数

名称类型示例值描述
TotalInteger1符合查询条件的实例数量。
InstancesArray of InstanceObject请参见返回示例实例列表。详细信息,请参见 InstanceObject

请求示例

POST /?Action=DescribeDBInstances&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220101T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****

{
    "PageSize": 10,
    "PageNumber": 1,
    "ChargeType": "PostPaid",
    "InstanceStatus": "Running",
    "CreateTimeEnd": "2023-07-24T06:09:36Z",
    "TagFilters": [
        {
            "Key": "project",
            "Value": "default"
        }
    ]
}

返回示例

正常返回示例

{
    "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",
                "InstanceId": "vedbm-d6rjf5ln****",
                "InstanceName": "vedb_test",
                "InstanceStatus": "Running",
                "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",
                "StorageChargeType": "PostPaid",
                "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
    }
}

错误码

更多详情,请参见错误码