DescribeDBInstances--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstances

最近更新时间：2024.08.22 10:38:36首次发布时间：2022.04.12 19:05:15

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

请求类型

异步请求。

请求参数

名称	类型	是否必选	示例值	描述
DBEngineVersion	String	否	MySQL_8_0	数据库引擎版本，取值固定为 `MySQL_8_0`。
PageSize	Integer	否	10	每页记录数。取值范围 1~1000，默认值为 10。
PageNumber	Integer	否	1	页码，取值大于等于 1，且不超过 Integer 的最大值，默认值为 1。
InstanceId	String	否	vedbm-d4mx2akm****	实例 ID。
InstanceName	String	否	test	实例名称，支持模糊查询。
InstanceStatus	String	否	Running	实例状态。说明关于实例状态的详细说明，请参见实例状态说明。
CreateTimeStart	String	否	2022-06-21T07:57:26Z	创建实例的开始时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
CreateTimeEnd	String	否	2022-06-21T07:57:26Z	创建实例的结束时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。说明同时传入 `CreateTimeStart` 和 `CreateTimeEnd` 参数时，创建实例的结束时间需晚于开始时间。
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 组标签键值对进行查询筛选。
ProjectName	String	否	default	指定实例所属的项目名称。

返回参数

名称	类型	示例值	描述
Total	Integer	1	符合查询条件的实例数量。
Instances	Array 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
    }
}

错误码

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