调用DescribeAvailableResource查询某可用区的资源列表_云原生内存数据库Tair-阿里云帮助中心

查询指定可用区内可创建的实例规格。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

返回参数

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-07-25

OpenAPI 入参发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更
	新增入参：InstanceScene