全部產品
Search
文件中心

Tair (Redis® OSS-Compatible):DescribeGlobalDistributeCache - 查詢分布式執行個體的詳細資料

更新時間:Mar 30, 2026

查詢分布式執行個體的詳細資料。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeGlobalDistributeCache

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

請求參數

名稱

類型

必填

描述

樣本值

GlobalInstanceId

string

分布式執行個體 ID。

gr-bp14rkqrhac****

PageNumber

string

頁碼,取值為大於 0 且不超過 整數資料類型的最大值,預設值為 1

1

PageSize

string

每頁記錄數。

20

SubInstanceId

string

子執行個體 ID。

gr-bp1zcjlobkyrq****

返回參數

名稱

類型

描述

樣本值

object

PageSize

integer

每頁可展示的記錄數。

20

RequestId

string

請求 ID。

F3F44BE3-5419-4B61-9BAC-E66E295A****

PageNumber

integer

頁碼。

1

TotalRecordCount

integer

總記錄數。

1

GlobalDistributeCaches

array<object>

分布式執行個體詳細資料列表。

array<object>

Status

string

分布式執行個體狀態,傳回值:

  • Normal:運行中。

  • Changing:修改中。

  • Creating:建立中。

Normal

GlobalInstanceId

string

分布式執行個體 ID。

gr-bp14rkqrhac****

SubInstances

array<object>

子執行個體詳細資料列表。

object

InstanceStatus

string

子執行個體狀態,傳回值:

  • Normal:正常。

  • Creating:建立中。

  • Changing:修改中。

  • Inactive:被禁用。

  • Flushing:清除中。

  • Released:已釋放。

  • Transforming:轉換中。

  • Unavailable:服務停止。

  • Error:建立失敗。

  • Migrating:遷移中。

  • BackupRecovering:備份恢複中。

  • MinorVersionUpgrading:小版本升級中。

  • NetworkModifying:網路變更中。

  • SSLModifying:SSL 變更中。

  • MajorVersionUpgrading:大版本升級中,可正常訪問。

說明

更多執行個體狀態及詳細資料,請參見執行個體狀態與影響

Normal

InstanceID

string

子執行個體 ID。

r-bp1zxszhcgatnx****

InstanceClass

string

子執行個體規格。更多資訊,請參見:

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

GlobalInstanceId

string

分布式執行個體 ID。

gr-bp14rkqrhac****

RegionId

string

地區 ID。

cn-hangzhou

樣本

正常返回樣本

JSON格式

{
  "PageSize": 20,
  "RequestId": "F3F44BE3-5419-4B61-9BAC-E66E295A****",
  "PageNumber": 1,
  "TotalRecordCount": 1,
  "GlobalDistributeCaches": [
    {
      "Status": "Normal",
      "GlobalInstanceId": "gr-bp14rkqrhac****",
      "SubInstances": [
        {
          "InstanceStatus": "Normal",
          "InstanceID": "r-bp1zxszhcgatnx****",
          "InstanceClass": "redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread",
          "GlobalInstanceId": "gr-bp14rkqrhac****",
          "RegionId": "cn-hangzhou"
        }
      ]
    }
  ]
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情