查询可用区资源 - 云数据库 Redis

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeAvailableResource	系统规定参数。取值：DescribeAvailableResource。
RegionId	String	是	cn-hangzhou	地域ID，您可以调用DescribeRegions查询。
ZoneId	String	否	cn-hangzhou-h	可用区ID，您可以调用DescribeZones查询。
InstanceChargeType	String	否	PrePaid	付费类型，取值： PrePaid：包年包月。 PostPaid：按量付费。说明默认值：PrePaid。
OrderType	String	否	BUY	订单类型，取值： BUY（默认）：新购。 UPGRADE：升级实例规格配置。 DOWNGRADE：降级实例规格配置。
Engine	String	否	Redis	引擎类型，取值： Redis。 Memcache。
ResourceGroupId	String	否	rg-acfmyiu4e******	资源组ID。您可以通过调用ListResourceGroups接口获取资源组ID。说明您也可以通过控制台获取资源组ID，相关操作，请参见查看资源组基本信息。
InstanceId	String	否	r-bp1zxszhcgatnx****	实例ID。说明当OrderType取值为UPGRADE或DOWNGRADE时，本参数才可用且必须传入。
AcceptLanguage	String	否	zh-CN	返回值的语言，取值： zh-CN：中文，默认值。 en-US：英文。
ProductType	String	否	Local	产品类型，取值： Local：社区版实例（本地盘版）或内存型（本地盘版）。 Tair_rdb：内存型（云盘版）。 Tair_scm：持久内存型。 Tair_essd：云盘（ESSD）型。 OnECS：社区版实例（云盘版）。
NodeId	String	否	r-bp1zxszhcgatnx****-db-0	数据节点ID，可调用DescribeLogicInstanceTopology获取。对于获取到的数据节点ID，需要去除井号（`#`）及其后面的内容，例如仅保留r-bp10noxlhcoim2-db-0。说明传入本参数前，您还需要传入InstanceId参数，且要求实例为集群或读写分离架构。

返回数据


名称	类型	示例值	描述
RequestId	String	493B7308-D9C2-55F6-B042-0313BD63****	请求ID。
AvailableZones	Array of AvailableZone		可用区详情。
AvailableZone
ZoneId	String	cn-hangzhou-h	可用区ID。
ZoneName	String	杭州可用区H	可用区名称。
RegionId	String	cn-hangzhou	地域ID。
SupportedEngines	Array of SupportedEngine		引擎类型。
SupportedEngine
Engine	String	Redis	实例的引擎类型。
SupportedEditionTypes	Array of SupportedEditionType		实例类型。
SupportedEditionType
EditionType	String	Enterprise	实例类型，返回值： Community：社区版。 Enterprise：企业版。
SupportedSeriesTypes	Array of SupportedSeriesType		实例的系列。
SupportedSeriesType
SeriesType	String	enhanced_performance_type	系列，返回值： enhanced_performance_type：内存型。 hybrid_storage：混合存储型。
SupportedEngineVersions	Array of SupportedEngineVersion		引擎版本（版本号）列表。
SupportedEngineVersion
Version	String	5.0	引擎版本。
SupportedArchitectureTypes	Array of SupportedArchitectureType		架构类型。
SupportedArchitectureType
Architecture	String	cluster	架构，返回值： standard：标准架构。 cluster：集群架构。 rwsplit：读写分离架构。
SupportedShardNumbers	Array of SupportedShardNumber		可用分片数列表。
SupportedShardNumber
ShardNumber	String	8	分片数。
SupportedNodeTypes	Array of SupportedNodeType		节点类型列表。
SupportedNodeType
SupportedNodeType	String	double	节点类型，返回值： single：单副本。 double：双副本。
AvailableResources	Array of AvailableResource		可用规格列表。
AvailableResource
InstanceClassRemark	String	16G集群版（8节点）（QPS:1920000 Connections:240000）	实例规格描述。
Capacity	Long	16384	实例的内存容量，单位为MB。
InstanceClass	String	redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread	规格编码。可在帮助中心的搜索框中搜索规格编码，查看其对应的规格信息。

示例

请求示例

https://r-kvstore.aliyuncs.com?Action=DescribeAvailableResource
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-h
&OrderType=UPGRADE
&InstanceId=r-bp1zxszhcg******
&ProductType=Local
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAvailableResourceResponse>
    <RequestId>493B7308-D9C2-55F6-B042-0313BD63****</RequestId>
    <AvailableZones>
        <AvailableZone>
            <ZoneName>杭州 可用区H</ZoneName>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <SupportedEngines>
                <SupportedEngine>
                    <SupportedEditionTypes>
                        <SupportedEditionType>
                            <SupportedSeriesTypes>
                                <SupportedSeriesType>
                                    <SeriesType>enhanced_performance_type</SeriesType>
                                    <SupportedEngineVersions>
                                        <SupportedEngineVersion>
                                            <SupportedArchitectureTypes>
                                                <SupportedArchitectureType>
                                                    <Architecture>cluster</Architecture>
                                                    <SupportedShardNumbers>
                                                        <SupportedShardNumber>
                                                            <SupportedNodeTypes>
                                                                <SupportedNodeType>
                                                                    <SupportedNodeType>double</SupportedNodeType>
                                                                    <AvailableResources>
                                                                        <AvailableResource>
                                                                            <Capacity>16384</Capacity>
                                                                            <InstanceClassRemark>16G集群版（8节点）（QPS:1920000 Connections:240000）</InstanceClassRemark>
                                                                            <InstanceClass>redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread</InstanceClass>
                                                                        </AvailableResource>
                                                                        <AvailableResource>
                                                                            <Capacity>32768</Capacity>
                                                                            <InstanceClassRemark>32G集群版（8节点）（QPS:1920000 Connections:240000）</InstanceClassRemark>
                                                                            <InstanceClass>redis.amber.logic.sharding.4g.8db.0rodb.24proxy.multithread</InstanceClass>
                                                                        </AvailableResource>
                                                                        <AvailableResource>
                                                                            <Capacity>65536</Capacity>
                                                                            <InstanceClassRemark>64G集群版（8节点）（QPS:1920000 Connections:240000）</InstanceClassRemark>
                                                                            <InstanceClass>redis.amber.logic.sharding.8g.8db.0rodb.24proxy.multithread</InstanceClass>
                                                                        </AvailableResource>
                                                                    </AvailableResources>
                                                                </SupportedNodeType>
                                                            </SupportedNodeTypes>
                                                            <ShardNumber>8</ShardNumber>
                                                        </SupportedShardNumber>
                                                    </SupportedShardNumbers>
                                                </SupportedArchitectureType>
                                            </SupportedArchitectureTypes>
                                            <Version>5.0</Version>
                                        </SupportedEngineVersion>
                                    </SupportedEngineVersions>
                                </SupportedSeriesType>
                            </SupportedSeriesTypes>
                            <EditionType>Enterprise</EditionType>
                        </SupportedEditionType>
                    </SupportedEditionTypes>
                    <Engine>redis</Engine>
                </SupportedEngine>
            </SupportedEngines>
        </AvailableZone>
    </AvailableZones>
</DescribeAvailableResourceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "493B7308-D9C2-55F6-B042-0313BD63****",
  "AvailableZones" : {
    "AvailableZone" : [ {
      "ZoneName" : "杭州 可用区H",
      "ZoneId" : "cn-hangzhou-h",
      "SupportedEngines" : {
        "SupportedEngine" : [ {
          "SupportedEditionTypes" : {
            "SupportedEditionType" : [ {
              "SupportedSeriesTypes" : {
                "SupportedSeriesType" : [ {
                  "SeriesType" : "enhanced_performance_type",
                  "SupportedEngineVersions" : {
                    "SupportedEngineVersion" : [ {
                      "SupportedArchitectureTypes" : {
                        "SupportedArchitectureType" : [ {
                          "Architecture" : "cluster",
                          "SupportedShardNumbers" : {
                            "SupportedShardNumber" : [ {
                              "SupportedNodeTypes" : {
                                "SupportedNodeType" : [ {
                                  "SupportedNodeType" : "double",
                                  "AvailableResources" : {
                                    "AvailableResource" : [ {
                                      "Capacity" : 16384,
                                      "InstanceClassRemark" : "16G集群版（8节点）（QPS:1920000 Connections:240000）",
                                      "InstanceClass" : "redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread"
                                    }, {
                                      "Capacity" : 32768,
                                      "InstanceClassRemark" : "32G集群版（8节点）（QPS:1920000 Connections:240000）",
                                      "InstanceClass" : "redis.amber.logic.sharding.4g.8db.0rodb.24proxy.multithread"
                                    }, {
                                      "Capacity" : 65536,
                                      "InstanceClassRemark" : "64G集群版（8节点）（QPS:1920000 Connections:240000）",
                                      "InstanceClass" : "redis.amber.logic.sharding.8g.8db.0rodb.24proxy.multithread"
                                    } ]
                                  }
                                } ]
                              },
                              "ShardNumber" : "8"
                            } ]
                          }
                        } ]
                      },
                      "Version" : "5.0"
                    } ]
                  }
                } ]
              },
              "EditionType" : "Enterprise"
            } ]
          },
          "Engine" : "redis"
        } ]
      }
    } ]
  }
}

错误码

访问错误中心查看更多错误码。