全部產品
Search
文件中心

Tair (Redis® OSS-Compatible):DescribeAvailableResource - 查詢某一可用性區域的資源清單

更新時間:Mar 30, 2026

查詢指定可用性區域內可建立的執行個體規格。

調試

您可以在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

OrderType

string

訂單類型,取值:

  • BUY(預設):新購。

  • UPGRADE:升級執行個體規格配置。

  • DOWNGRADE:降級執行個體規格配置。

BUY

Engine

string

引擎類型,取值:

  • Redis

  • Memcache

Redis

ResourceGroupId

string

資源群組 ID。您可以通過調用 ListResourceGroups 介面擷取資源群組 ID。

說明

您也可以通過控制台擷取資源群組 ID,相關操作,請參見查看資源群組基本資料

rg-acfmyiu4e******

InstanceId

string

執行個體 ID。

說明

OrderType 取值為 UPGRADEDOWNGRADE 時,本參數才可用且必須傳入。

r-bp1zxszhcgatnx****

AcceptLanguage

string

傳回值的語言,取值:

  • zh-CN:中文,預設值。

  • en-US:英文。

zh-CN

ProductType

string

產品類型,取值(預設值為 Local):

  • Local:Redis 開源版執行個體(經典版)或記憶體型(經典版)。

  • Tair_rdb:記憶體型(雲原生版)。

  • Tair_scm:持久記憶體型。

  • Tair_essd:磁碟型。

  • OnECS:Redis 開源版執行個體(雲原生版)。

說明

該參數預設值為 Local,如果需要查雲端硬碟資源,需要傳入所需雲端硬碟資源對應的產品類型。

Local

NodeId

string

資料節點 ID,可調用 DescribeLogicInstanceTopology 擷取。對於擷取到的資料節點 ID,需要去除井號(#)及其後面的內容,例如僅保留 r-bp10noxlhcoim2****-db-0。

說明

傳入本參數前,您還需要傳入 InstanceId 參數,且要求執行個體為叢集或讀寫分離架構。

r-bp1zxszhcgatnx****-db-0

InstanceScene

string

產品系列,取值如下:

  • professional:標準版,支援單副本、主備、讀寫分離、叢集四種架構,擴充性強。

professional

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

493B7308-D9C2-55F6-B042-0313BD63****

AvailableZones

object

AvailableZone

array<object>

可用性區域詳情。

array<object>

ZoneId

string

可用性區域 ID。

cn-hangzhou-h

ZoneName

string

可用性區域名稱。

杭州 可用性區域H

RegionId

string

地區 ID。

cn-hangzhou

SupportedEngines

object

SupportedEngine

array<object>

引擎類型。

array<object>

Engine

string

執行個體的引擎類型。

Redis

SupportedEditionTypes

object

SupportedEditionType

array<object>

執行個體類型。

array<object>

EditionType

string

執行個體類型,傳回值:

  • Community:Redis 開源版。

  • Enterprise:Tair(企業版)。

Enterprise

SupportedSeriesTypes

object

SupportedSeriesType

array<object>

執行個體的系列。

array<object>

SeriesType

string

已廢棄欄位,無需關注。根據返回的 InstanceClass 擷取可用性區域內支援的規格資訊即可。

enhanced_performance_type

SupportedEngineVersions

object

SupportedEngineVersion

array<object>

引擎版本(版本號碼)列表。

array<object>

Version

string

引擎版本。

5.0

SupportedArchitectureTypes

object

SupportedArchitectureType

array<object>

架構類型。

array<object>

Architecture

string

架構,傳回值:

  • standard:經典版標準架構。

  • non_cluster:雲原生版標準架構。

  • cluster:經典版叢集架構/雲原生版叢集架構/雲原生版讀寫分離架構。

  • rwsplit:經典版讀寫分離架構。

cluster

SupportedShardNumbers

object

SupportedShardNumber

array<object>

可用分區數列表。

array<object>

ShardNumber

string

分區數。僅本地碟(Local)支援返回本參數。

8

SupportedNodeTypes

object

SupportedNodeType

array<object>

節點類型列表。

array<object>

節點類型列表。

SupportedNodeType

string

節點類型,傳回值:

  • single:單副本。

  • double:雙副本。

double

AvailableResources

object

AvailableResource

array<object>

可用規格列表。

object

可用規格列表。

InstanceClassRemark

string

執行個體規格描述。

16G叢集版(8節點)(QPS:1920000 Connections:240000)

Capacity

integer

執行個體的記憶體容量,單位為 MB。

16384

InstanceClass

string

規格編碼。可在協助中心的搜尋方塊中搜尋規格編碼,查看其對應的規格資訊。

redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread

IsMainSale

boolean

內部參數。

true

樣本

正常返回樣本

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"
                                                      }
                                                    ]
                                                  }
                                                }
                                              ]
                                            }
                                          }
                                        ]
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        },
        "IsMainSale": true
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情