DescribeDBInstances--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstances

最近更新时间：2024.10.24 21:27:31首次发布时间：2021.11.15 16:07:16

调用 DescribeDBInstances 接口查询 Redis 实例的基本信息。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	否	cn-beijing	实例所属的地域 ID。说明若改参数留空，默认使用签名中设置的地域进行筛选。关于签名机制的更多信息，请参见签名机制。您可以调用 DescribeRegions 接口查询 Redis 实例支持的所有地域信息，包括地域 ID。
PageNumber	Integer	否	1	实例信息列表的页码。取值为不超过 Integer 数据类型的最大值，起始值与默认值均为 1。
PageSize	Integer	否	10	每页记录数。取值为 1~100 间的整数，默认值为 10。
ZoneId	String	否	cn-beijing-a	实例所属的可用区 ID，支持模糊查询。说明您可以调用 DescribeZones 接口查询 Redis 实例在指定地域下的可用区资源信息，包括可用区 ID。
InstanceId	String	否	redis-cn0212gzmh2xs****	实例 ID，精确查询。说明若该参数留空，表示不使用实例 ID 条件进行筛选。
InstanceName	String	否	api_test	实例名称，支持模糊查询。说明若该参数留空，表示不使用实例名称条件进行筛选。
ShardedCluster	Integer	否	1	实例是否启用分片集群。取值范围如下： `0`：不启用。 `1`：启用。说明若该参数留空，表示不使用实例是否启用分片集群条件进行筛选。
Status	String	否	Running	实例状态。关于实例状态的更多详情，请参见实例状态说明。说明若该参数留空，表示不使用实例状态条件进行筛选。
EngineVersion	String	否	5.0	实例的数据库版本号。取值范围如下： `5.0` `6.0` `7.0` 说明若该参数留空，表示不使用实例的数据库版本号条件进行筛选。
VpcId	String	否	vpc-rs5811nceqyov0x****	实例所属的私有网络（VPC）ID。支持模糊查询。说明若该参数留空，表示不使用实例的私有网络 ID 条件进行筛选。您可以调用 DescribeVpcs 接口查询当前账号下的所有私有网络列表信息，包括私有网络 ID。
ChargeType	String	否	PostPaid	实例的计费类型。取值范围如下： `PostPaid`：按量计费。 `PrePaid`：包年包月。说明若该参数留空，表示不使用实例的计费类型条件进行筛选。关于计费类型的更多信息，请参见计费类型。
TagFilters	Object[]	否		用于查询筛选的标签键值对数组。说明若该参数留空，表示不使用标签条件进行筛选。
ProjectName	String	否	default	实例所属的项目名称。说明若该参数留空，表示不使用实例的项目名称条件进行筛选。
ServiceType	String	否	Basic	实例的服务类型，取值范围如下： `Basic`（默认值）：社区版。 `Enterprise`：企业版。
DataLayout	String	否	RAM	实例的数据存储形态。说明该参数仅对企业版（即`ServiceType`为`Enterprise`）实例有意义；社区版（即`ServiceType`为`Basic`）实例不涉及数据存储形态，`DataLayout`取值固定为`RAM`。若该参数留空，表示不使用数据存储形态进行筛选。

返回参数

参数	类型	示例值	描述
TotalInstancesNum	Integer	1	符合查询条件的实例数量。
Instances	Object[]		实例基本信息列表。

示例

请求示例

查询社区版实例详情。

POST https://redis.volcengineapi.com/?Action=DescribeDBInstances&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
	"RegionId": "cn-beijing",
	"PageNumber": 1,
	"PageSize": 10,
	"ServiceType": "Basic"
}

返回示例

社区版实例返回详情。

{
    "ResponseMetadata": {
        "RequestId": "20220415154208010212042019****",
        "Action": "DescribeDBInstances",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Instances": [
            {
                "Capacity": {
                    "Total": 2048,
                    "Used": 57
                },
                "ChargeType": "PostPaid",
                "CreateTime": "2024-04-30T14:24:32Z",
                "DeletionProtection": "disabled",
                "EngineVersion": "5.0",
                "ExpiredTime": "",
                "InstanceClass": "PrimarySecondary",
                "InstanceId": "redis-cn0212gzmh2xs****",
                "InstanceName": "test",
                "NodeNumber": 2,
                "ProjectName": "default",
                "MultiAZ": "disabled",
                "RegionId": "cn-beijing",
                "ShardCapacity": 1,
                "ShardNumber": 2,
                "ShardedCluster": 1,
                "Status": "Running",
                "Tags": [
                    {
                        "Key": "owner",
                        "Value": "Alice"
                    },
                    {
                        "Key": "department",
                        "Value": "game"
                    }
                ],
                "VpcId": "vpc-rs5811nceqyov0x58x4****",
                "ZoneIds": [
                    "cn-beijing-a"
                ],
                "DataLayout": "RAM",
                "PrivateAddress": "redis-cn0212gzmh2xs****.redis.ivolces.com",
                "VIP": "192.168.\*\*\*.\*\*\*",
                "VIPv6": "2408:1000:abe5:ff40:a189:2f34:a82e:****"
            }
        ],
        "TotalInstancesNum": 1
    }
}

错误码

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