调用 DescribeDBInstances 接口查询 Redis 实例的基本信息。
同步请求。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
RegionId | String | 是 | cn-beijing | 实例所属的地域 ID。 说明 您可以调用 DescribeRegions 接口查询 Redis 实例支持的所有地域信息,包括地域 ID。 |
PageNumber | Integer | 是 | 1 | 实例信息列表的页码,取值为不超过 Integer 数据类型的最大值,起始值为 1。 |
PageSize | Integer | 是 | 10 | 每页记录数。取值为 1~100 间的整数。 |
ZoneId | String | 否 | cn-beijing-a | 实例所属的可用区 ID,支持模糊查询。 说明 您可以调用 DescribeZones 接口查询 Redis 实例在指定地域下的可用区资源信息,包括可用区 ID。 |
InstanceId | String | 否 | redis-cn0212gzmh2xs**** | 实例ID,支持模糊查询。 说明 若该参数留空,表示不使用实例 ID 条件进行筛选。 |
InstanceName | String | 否 | api_test | 实例名称,支持模糊查询。 说明 若该参数留空,表示不使用实例名称条件进行筛选。 |
ShardedCluster | Integer | 否 | 1 | 实例是否启用分片集群。取值范围如下:
说明 若该参数留空,表示不使用实例是否启用分片集群条件进行筛选。 |
Status | String | 否 | Running | 实例状态。关于实例状态的更多详情,请参见实例状态说明。 说明 若该参数留空,表示不使用实例状态条件进行筛选。 |
EngineVersion | String | 否 | 5.0 | 实例的数据库版本号。取值范围如下:
说明 若该参数留空,表示不使用实例的数据库版本号条件进行筛选。 |
VpcId | String | 否 | vpc-2743n1ihbxla87fap8tap**** | 实例所属的私有网络(VPC)ID。支持模糊查询。 说明
|
ChargeType | String | 否 | PostPaid | |
TagFilters | Object[] | 否 | 用于查询筛选的标签键值对数组。 说明 若该参数留空,表示不使用标签条件进行筛选, | |
ProjectName | String | 否 | default | 实例所属的项目名称。 说明 若该参数留空,表示不使用实例的项目名称条件进行筛选。 |
ServiceType | String | 否 | Basic | 实例的服务类型。当前仅支持 说明 若该参数留空,表示不使用实例的服务类型条件进行筛选。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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": "202204151542080102120420191760****", "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" ] } ], "TotalInstancesNum": 1 } }
查询企业版实例详情。
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":"Enterprise" }
企业版实例返回详情。
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "DescribeDBInstances", "Version": "2020-12-07", "Service": "Redis", "Region": "cn-north-1" }, "Result": { "TotalInstancesNum": 1, "Instances": [ { "InstanceId": "redis-cnlfexqnf6f48****", "ProjectName": "default", "ShardedCluster": 0, "NodeNumber": 2, "EngineVersion": "7.2", "Tags": [ { "Key": "department", "Value": "game" }, { "Key": "owner", "Value": "Alice" } ], "CreateTime": "2024-04-18T14:24:32Z", "RegionId": "cn-beijing", "ChargeType": "PrePaid", "Status": "Running", "ExpiredTime": "2024-05-18T00:00:00Z", "InstanceName": "test", "MultiAZ": "disabled", "ShardNumber": 2, "Capacity": { "Total": 36864, "Used":57 }, "DeletionProtection": "disabled", "ZoneIds": [ "cn-beijing-a" ], "ServiceType": "Enterprise", "ShardCapacity": 36, "VpcId": "vpc-rs5811nceqyov0x58x4****" } ] } }
更多详情,请参见错误码。