全部产品
Search
文档中心

云原生内存数据库Tair:DescribeAvailableResource - 查询某一可用区的资源列表

更新时间:Feb 20, 2024

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID,您可以调用 DescribeRegions 查询。

cn-hangzhou
ZoneIdstring

可用区 ID,您可以调用 DescribeZones 查询。

cn-hangzhou-h
InstanceChargeTypestring

付费类型,取值:

  • PrePaid:包年包月。
  • PostPaid:按量付费。
说明 默认值:PrePaid
PrePaid
OrderTypestring

订单类型,取值:

  • BUY(默认):新购。
  • UPGRADE:升级实例规格配置。
  • DOWNGRADE:降级实例规格配置。
BUY
Enginestring

引擎类型,取值:

  • Redis
  • Memcache
Redis
ResourceGroupIdstring

资源组 ID。您可以通过调用 ListResourceGroups 接口获取资源组 ID。

说明 您也可以通过控制台获取资源组 ID,相关操作,请参见查看资源组基本信息
rg-acfmyiu4e******
InstanceIdstring

实例 ID。

说明 OrderType 取值为 UPGRADEDOWNGRADE 时,本参数才可用且必须传入。
r-bp1zxszhcgatnx****
AcceptLanguagestring

返回值的语言,取值:

  • zh-CN:中文,默认值。
  • en-US:英文。
zh-CN
ProductTypestring

产品类型,取值:

  • Local:社区版实例(经典版)或内存型(经典版)。
  • Tair_rdb:内存型(云原生版)。
  • Tair_scm:持久内存型。
  • Tair_essd:云盘(ESSD)型。
  • OnECS:社区版实例(云原生版)。
Local
NodeIdstring

数据节点 ID,可调用 DescribeLogicInstanceTopology 获取。对于获取到的数据节点 ID,需要去除井号(#)及其后面的内容,例如仅保留 r-bp10noxlhcoim2****-db-0。

说明 传入本参数前,您还需要传入 InstanceId 参数,且要求实例为集群或读写分离架构。
r-bp1zxszhcgatnx****-db-0
InstanceScenestring

Redis 产品系列,取值如下:

  • professional:标准版,支持单副本、主备、读写分离、集群四种架构,扩展性强。
professional

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

493B7308-D9C2-55F6-B042-0313BD63****
AvailableZonesobject []

可用区详情。

ZoneIdstring

可用区 ID。

cn-hangzhou-h
ZoneNamestring

可用区名称。

杭州 可用区H
RegionIdstring

地域 ID。

cn-hangzhou
SupportedEnginesobject []

引擎类型。

Enginestring

实例的引擎类型。

Redis
SupportedEditionTypesobject []

实例类型。

EditionTypestring

实例类型,返回值:

  • Community:社区版。
  • Enterprise:企业版。
Enterprise
SupportedSeriesTypesobject []

实例的系列。

SeriesTypestring

系列,返回值:

  • enhanced_performance_type:内存型。
  • hybrid_storage:混合存储型。
enhanced_performance_type
SupportedEngineVersionsobject []

引擎版本(版本号)列表。

Versionstring

引擎版本。

5.0
SupportedArchitectureTypesobject []

架构类型。

Architecturestring

架构,返回值:

  • standard:标准架构。
  • cluster:集群架构。
  • rwsplit:读写分离架构。
cluster
SupportedShardNumbersobject []

可用分片数列表。

ShardNumberstring

分片数。

8
SupportedNodeTypesobject []

节点类型列表。

SupportedNodeTypestring

节点类型,返回值:

  • single:单副本。
  • double:双副本。
double
AvailableResourcesobject []

可用规格列表。

InstanceClassRemarkstring

实例规格描述。

16G集群版(8节点)(QPS:1920000 Connections:240000)
Capacitylong

实例的内存容量,单位为 MB。

16384
InstanceClassstring

规格编码。可在帮助中心的搜索框中搜索规格编码,查看其对应的规格信息。

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-25OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:InstanceScene