调用DescribeAvailableResource查询某可用区的资源列表-阿里云帮助中心

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
kvstore:DescribeAvailableResource	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
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：磁盘型。 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	array<object>	可用区详情。
AvailableZone	object
ZoneId	string	可用区 ID。	cn-hangzhou-h
ZoneName	string	可用区名称。	杭州可用区H
RegionId	string	地域 ID。	cn-hangzhou
SupportedEngines	array<object>	引擎类型。
SupportedEngine	object
Engine	string	实例的引擎类型。	Redis
SupportedEditionTypes	array<object>	实例类型。
SupportedEditionType	object
EditionType	string	实例类型，返回值： Community：社区版。 Enterprise：企业版。	Enterprise
SupportedSeriesTypes	array<object>	实例的系列。
SupportedSeriesType	object
SeriesType	string	系列，返回值： enhanced_performance_type：内存型。 hybrid_storage：混合存储型。	enhanced_performance_type
SupportedEngineVersions	array<object>	引擎版本（版本号）列表。
SupportedEngineVersion	object
Version	string	引擎版本。	5.0
SupportedArchitectureTypes	array<object>	架构类型。
SupportedArchitectureType	object
Architecture	string	架构，返回值： standard：标准架构。 cluster：集群架构。 rwsplit：读写分离架构。	cluster
SupportedShardNumbers	array<object>	可用分片数列表。
SupportedShardNumber	object
ShardNumber	string	分片数。	8
SupportedNodeTypes	array<object>	节点类型列表。
SupportedNodeType	object
SupportedNodeType	string	节点类型，返回值： single：单副本。 double：双副本。	double
AvailableResources	array<object>	可用规格列表。
AvailableResource	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 入参发生变更	查看变更详情