全部產品
Search

搜尋本產品

    Tair (Redis® OSS-Compatible)：DescribeInstancesOverview

    文件中心

    Tair (Redis® OSS-Compatible)：DescribeInstancesOverview

    更新時間：Jul 10, 2026

    查詢一個或多個雲端資料庫 Tair（相容 Redis）執行個體的資訊概覽。

    介面說明

    若您未指定請求參數，將返回所有執行個體的資訊概覽。

    說明

    該介面返回結果均無分頁。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    kvstore:DescribeInstancesOverview

    get

    *全部資源。

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    執行個體所屬的地域 ID，可呼叫 DescribeRegions 介面獲取。

    cn-hangzhou
    InstanceIds

    string

    否

    需要查詢的執行個體 ID。

    說明

    預設查詢該帳號下所有執行個體。如需傳入多個執行個體 ID 時，使用英文逗號（,）分隔執行個體 ID。

    r-bp1zxszhcgatnx****
    InstanceStatus

    string

    否

    執行個體狀態，取值：

    • Normal：執行中。

    • Creating：建立中。

    • Changing：修改中。

    • Inactive：被停用。

    • Flushing：清除中。

    • Released：已釋放。

    • Transforming：轉換中。

    • Migrating：遷移中。

    • BackupRecovering：備份還原中。

    • MinorVersionUpgrading：小版本升級中。

    • NetworkModifying：網路變更中。

    • SSLModifying：SSL 變更中。

    • MajorVersionUpgrading：大版本升級中，可正常存取。

    說明

    更多執行個體狀態及詳細資訊，請參見執行個體狀態與影響。

    Normal
    ChargeType

    string

    否

    付費類型，取值：

    • PrePaid：預付費，即包年包月。

    • PostPaid：後付費，即按量付費。

    PostPaid
    NetworkType

    string

    否

    網路類型，取值：

    • CLASSIC：傳統網路。

    • VPC：專有網路。

    CLASSIC
    EngineVersion

    string

    否

    執行個體相容 Redis 的版本，返回值：2.8、4.0、5.0、6.0 或 7.0。

    枚舉值：

    • 4.0 :

      4.0

    • 5.0 :

      5.0

    • 6.0 :

      6.0

    • 7.0 :

      7.0

    • 2.8 :

      2.8

    6.0
    InstanceClass

    string

    否

    執行個體規格，請參見執行個體規格表。

    redis.master.small.default
    VpcId

    string

    否

    專有網路 ID。

    vpc-bp1nme44gek34slfc****
    VSwitchId

    string

    否

    虛擬交換器 ID。

    vsw-bp1e7clcw529l773d****
    InstanceType

    string

    否

    執行個體類型，取值：

    • Tair。

    • Redis。

    • Memcache。

    Redis
    SearchKey

    string

    否

    基於執行個體 ID 或者執行個體備註模糊搜尋時使用的關鍵字。

    apitest
    ArchitectureType

    string

    否

    架構類型，取值：

    • cluster：叢集版。

    • standard：標準版。

    • rwsplit：讀寫分離版。

    standard
    ZoneId

    string

    否

    可用區 ID。

    cn-hangzhou-b
    ResourceGroupId

    string

    否

    資源群組 ID。

    說明

    您可以透過呼叫 ListResourceGroups 介面或透過主控台獲取資源群組 ID 清單。相關操作，請參見檢視資源群組基本資訊。

    rg-acfmyiu4ekp****
    EditionType

    string

    否

    執行個體類型，取值：

    • Community：開源版。

    • Enterprise：企業版。

    Enterprise
    PrivateIp

    string

    否

    專有網路 IP 地址。

    172.16.49.***

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    物件。

    RequestId

    string

    請求 ID。

    1E83311F-0EE4-4922-A3BF-730B312B****
    TotalCount

    integer

    執行個體總個數。

    1
    Instances

    array<object>

    由 Instance（執行個體）組成的陣列。

    object

    物件。

    VpcId

    string

    專有網路 ID。

    vpc-bp1nme44gek34slfc****
    PrivateIp

    string

    專有網路 IP 地址，IP 地址可能會發生變化，請透過 ConnectionDomain（內網連線地址）進行連線。

    說明

    • 執行個體的網路類型為傳統網路時，不會返回本參數。

    • 雲原生版執行個體不會返回該參數。

    172.16.49.***
    Capacity

    integer

    執行個體容量，單位：MB。

    4096
    CreateTime

    string

    執行個體的建立時間。

    2018-11-07T08:49:00Z
    ConnectionDomain

    string

    執行個體的內網連線地址。

    r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
    ChargeType

    string

    付費類型，取值：

    • PrePaid：預付費，即包年包月。

    • PostPaid：後付費，即按量付費。

    PrePaid
    ArchitectureType

    string

    架構類型，取值：

    • cluster：叢集版。

    • standard：標準版。

    • rwsplit：讀寫分離版。

    cluster
    NetworkType

    string

    網路類型，取值：

    • CLASSIC：傳統網路。

    • VPC：專有網路。

    CLASSIC
    EngineVersion

    string

    執行個體相容的 Redis 版本，返回值：2.8、4.0、5.0、6.0 或 7.0。

    6.0
    InstanceName

    string

    執行個體的名稱。

    apitest
    GlobalInstanceId

    string

    分散式執行個體 ID。

    說明

    當執行個體為分散式執行個體中的子執行個體時，才會返回該參數。

    gr-bp14rkqrhac****
    InstanceClass

    string

    執行個體的規格。

    redis.logic.sharding.2g.2db.0rodb.4proxy.default
    InstanceId

    string

    執行個體 ID。

    r-bp1zxszhcgatnx****
    InstanceType

    string

    執行個體類型，取值：

    • Tair：Tair（企業版）

    • Redis：Redis 開源版

    • Memcache

    Redis
    NodeType

    string

    RegionId

    string

    地域 ID。

    cn-hangzhou
    EndTime

    string

    包年包月執行個體到期時間。

    2022-06-13T16:00:00Z
    VSwitchId

    string

    虛擬交換器的 ID。

    vsw-bp1e7clcw529l773d****
    ResourceGroupId

    string

    執行個體所屬的資源群組 ID。

    rg-acfmyiu4ekp****
    ZoneId

    string

    可用區 ID。

    cn-hangzhou-b
    InstanceStatus

    string

    執行個體狀態，取值：

    • Normal：執行中。

    • Creating：建立中。

    • Changing：修改中。

    • Inactive：被停用。

    • Flushing：清除中。

    • Released：已釋放。

    • Transforming：轉換中。

    • Unavailable：服務停止。

    • Error：建立失敗。

    • Migrating：遷移中。

    • BackupRecovering：備份還原中。

    • MinorVersionUpgrading：小版本升級中。

    • NetworkModifying：網路變更中。

    • SSLModifying：SSL 變更中。

    • MajorVersionUpgrading：大版本升級中，可正常存取。

    Normal
    SecondaryZoneId

    string

    備用可用區 ID。

    說明

    當執行個體存在備用可用區 ID 時，才會返回該參數。

    cn-hangzhou-g

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "TotalCount": 1,
  "Instances": [
    {
      "VpcId": "vpc-bp1nme44gek34slfc****",
      "PrivateIp": "172.16.49.***",
      "Capacity": 4096,
      "CreateTime": "2018-11-07T08:49:00Z",
      "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
      "ChargeType": "PrePaid",
      "ArchitectureType": "cluster",
      "NetworkType": "CLASSIC",
      "EngineVersion": "6.0",
      "InstanceName": "apitest",
      "GlobalInstanceId": "gr-bp14rkqrhac****",
      "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceType": "Redis",
      "NodeType": "",
      "RegionId": "cn-hangzhou",
      "EndTime": "2022-06-13T16:00:00Z",
      "VSwitchId": "vsw-bp1e7clcw529l773d****",
      "ResourceGroupId": "rg-acfmyiu4ekp****",
      "ZoneId": "cn-hangzhou-b",
      "InstanceStatus": "Normal",
      "SecondaryZoneId": "cn-hangzhou-g"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidInstanceIds.Malformed The Specified parameter InstanceIds is not valid.

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

    變更歷史

    更多資訊，參考變更詳情。