DescribeInstances - 查詢執行個體的列表資訊 - Tair (Redis® OSS-Compatible)

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

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeInstances

list

DBInstance

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

DBInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	執行個體所屬的地區 ID。說明調用本介面時，如果傳入了 Tag 參數，則本參數必須傳入。	cn-hangzhou
InstanceIds	string	否	需要查詢的執行個體 ID。說明如需傳入多個執行個體 ID 時，使用英文逗號（,）分隔執行個體 ID，最多一個請求傳入 30 個執行個體 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
InstanceClass	string	否	執行個體規格，請參見執行個體規格表。	redis.master.small.default
VpcId	string	否	專用網路 ID。	vpc-bp1nme44gek34slfc****
VSwitchId	string	否	虛擬交換器 ID。	vsw-bp1e7clcw529l773d****
PageNumber	integer	否	執行個體列表的頁碼，起始值為 1，預設值為 1。	1
PageSize	integer	否	每頁最多可顯示的行數，最大值為 50，預設值為 30。	30
InstanceType	string	否	執行個體類型，取值： Tair：Tair（企業版） Redis：Redis 開源版 Memcache	Redis
SearchKey	string	否	支援模糊搜尋執行個體名稱或執行個體 ID。	apitest
ArchitectureType	string	否	架構類型，取值： cluster：叢集版。 standard：標準版。 rwsplit：讀寫分離版。	standard
Expired	string	否	執行個體的到期狀態，取值： true：已到期。 false：未到期。	false
ZoneId	string	否	可用性區域 ID。	cn-hongkong-b
ResourceGroupId	string	否	資源群組 ID。說明您可以通過調用 ListResourceGroups 介面或通過控制台擷取資源群組 ID 列表。相關操作，請參見查看資源群組基本資料。	rg-acfmyiu4ekp****
GlobalInstance	boolean	否	返回的執行個體列表中，是否過濾分布式執行個體中的子執行個體，取值： true：只返回子執行個體資訊。 false：不返回子執行個體資訊。	true
EditionType	string	否	執行個體類型，取值： Community：Redis 開源版。 Enterprise：Tair 企業版。	Enterprise
PrivateIp	string	否	專用網路 IP 位址。	172.16.49.***
Tag	array<object>	否	執行個體的標籤資訊。
	object	否	對象。
Value	string	否	標籤鍵的值，與 Tag Key 組成標籤的索引值對。	開發
Key	string	否	標籤的鍵，與 Tag Value 組成標籤的索引值對。說明單次最多支援傳入 5 組標籤的索引值對。	儲存類型
NodeType	string	否	節點類型，取值： MASTER_SLAVE：高可用（雙副本） STAND_ALONE：單副本 double：雙副本 single：單副本說明雲原生版執行個體請選擇MASTER_SLAVE或STAND_ALONE，經典版執行個體請選擇 double 或 single。	MASTER_SLAVE

返回參數

名稱	類型	描述	樣本值
	object	對象。
RequestId	string	請求 ID。	1E83311F-0EE4-4922-A3BF-730B312B****
PageNumber	integer	執行個體列表的頁碼。	1
PageSize	integer	輸入時設定的每頁行數。	30
TotalCount	integer	執行個體總個數。	1
Instances	object
KVStoreInstance	array<object>	由 Instance 組成的集合。
	array<object>	對象。
Connections	integer	執行個體的串連數限制。	20000
EndTime	string	訂用帳戶執行個體到期時間。	2019-06-13T16:00:00Z
ResourceGroupId	string	執行個體所屬的資源群組 ID。	rg-acfmyiu4ekp****
EditionType	string	執行個體類型，取值： Community：社區版。 Enterprise：企業版。	Enterprise
Config	string	執行個體的參數設定情況，詳情請參見參數設定。	{\"maxmemory-policy\":\"volatile-lfu\",\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64,\"#no_loose_disabled-commands\":\"flushall,flushdb\",\"lazyfree-lazy-eviction\":\"yes\"}
Port	integer	執行個體的服務連接埠。重要在執行個體做過修改網路連接地址的連接埠之後該欄位無法提供執行個體實際網路狀態資訊，請使用 DescribeDBInstanceNetInfo API 查詢執行個體即時的對外網路連接資訊。	6379
DestroyTime	string	銷毀執行個體的時間。	2019-04-28T10:03:01Z
GlobalInstanceId	string	分布式執行個體 ID。說明當執行個體為分布式執行個體中的子執行個體時，才會返回該參數。	gr-bp14rkqrhac****
HasRenewChangeOrder	boolean	是否有未生效的續約變更配置訂單，傳回值： true：是。 false：否。	false
ShardCount	integer	叢集的資料節點數。說明雲原生版叢集或讀寫分離架構執行個體才會返回本參數。	3
ConnectionDomain	string	執行個體的內網串連地址。重要在執行個體做過修改、申請新的網路連接地址的之後該欄位無法提供執行個體實際網路狀態資訊，請使用 DescribeDBInstanceNetInfo API 查詢執行個體即時的對外網路連接資訊。	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
SlaveReplicaCount	integer	備可用性區域的備節點數（個）。	1
PrivateIp	string	專用網路 IP 位址。說明執行個體的網路類型為傳統網路時，不會返回本參數。	172.16.49.***
Capacity	integer	執行個體容量，單位：MB。	4096
QPS	integer	每秒請求數（Queries per Second）。	100000
NetworkType	string	網路類型，傳回值： CLASSIC：傳統網路。 VPC：專用網路。	CLASSIC
InstanceStatus	string	執行個體狀態，傳回值： Normal：正常。 Creating：建立中。 Changing：修改中。 Inactive：被禁用。 Flushing：清除中。 Released：已釋放。 Transforming：轉換中。 Unavailable：服務停止。 Error：建立失敗。 Migrating：遷移中。 BackupRecovering：備份恢複中。 MinorVersionUpgrading：小版本升級中。 NetworkModifying：網路變更中。 SSLModifying：SSL 變更中。 MajorVersionUpgrading：大版本升級中，可正常訪問。	Normal
PackageType	string	套餐類型，傳回值： standard：標準套餐。 customized：定製套餐。	standard
Bandwidth	integer	執行個體頻寬，單位：MB/s。	96
InstanceType	string	執行個體類型，傳回值： Tair。 Redis。 Memcache。	Redis
Tags	object
Tag	array<object>	標籤資訊。
	object	對象。
Value	string	Tag 的 Value。	value1
Key	string	Tag 的 Key。	key1
ReplacateId	string	多活執行個體的邏輯 ID。	grr-bp11381ebc16****
ArchitectureType	string	架構類型，傳回值： cluster：叢集版。 standard：標準版。 rwsplit：讀寫分離版。 NULL：所有類型，預設值。	cluster
EngineVersion	string	執行個體相容 Redis 的版本。	4.0
UserName	string	串連使用的使用者名稱，預設包含有一個以執行個體 ID 命名的使用者名稱。	r-bp1zxszhcgatnx****
ZoneId	string	可用性區域 ID。	cn-hangzhou-b
CloudType	string	僅雲盒執行個體顯示該參數。	cloudbox
InstanceId	string	執行個體的 ID。	r-bp1zxszhcgatnx****
ShardClass	string	資料分區節點規格，規格詳情請參見規格查詢導航。說明叢集架構執行個體的整體效能為：分區節點規格（ShardClass） * 分區數（ShardCount）。	redis.shard.small.ce
CreateTime	string	執行個體的建立時間。	2018-11-07T08:49:00Z
VSwitchId	string	虛擬交換器的 ID。	vsw-bp1e7clcw529l773d****
ReplicaCount	integer	主可用性區域的備節點數（個）。說明 ReplicaCount 與 SlaveReplicaCount 參數僅適用於雲原生版執行個體。如果執行個體為叢集架構，則上述參數分別表示單分區的（主、備可用性區域）備節點數。	1
ReadOnlyCount	string	主可用性區域的唯讀節點數（個）。說明 ReadOnlyCount 與 SlaveReadOnlyCount 參數僅適用於雲原生版、開啟讀寫分離的執行個體。如果執行個體為叢集架構，則上述參數分別表示單分區的（主、備可用性區域）唯讀節點數量。	1
InstanceClass	string	執行個體的規格。	redis.logic.sharding.2g.2db.0rodb.4proxy.default
IsRds	boolean	是否屬 RDS 管控，傳回值： true：是。 false：否。	true
SecondaryZoneId	string	備可用性區域 ID。說明若 ZoneId 參數已返回多可用性區域，例如"cn-hangzhou-MAZ10(h,i)"，本參數將不返回備可用性區域 ID。	cn-hangzhou-h
InstanceName	string	執行個體的名稱。	apitest
SlaveReadOnlyCount	integer	備可用性區域的唯讀節點數（個）。	1
VpcId	string	Virtual Private Cloud的 ID。	vpc-bp1nme44gek34slfc****
ChargeType	string	付費類型，傳回值： PrePaid：預付費。 PostPaid：後付費。	PostPaid
ComputingType	string	執行個體計算類型，傳回值: Ecs: 雲原生 Machine: 物理機	Ecs
NodeType	string	節點類型，傳回值： double：雙副本。 single：單副本（已下線）。 MASTER_SLAVE：高可用（雙副本）。 STAND_ALONE：單副本。	double
ConnectionMode	string	執行個體的訪問模式，傳回值： Standard：標準訪問模式。 Safe：資料庫代理模式。已廢棄，請使用 Describedbinstancenetinfo 代替查詢	Standard
RegionId	string	地區 ID。	cn-hangzhou
WorkspaceId	string

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Instances": {
    "KVStoreInstance": [
      {
        "Connections": 20000,
        "EndTime": "2019-06-13T16:00:00Z",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "EditionType": "Enterprise",
        "Config": "{\\\"maxmemory-policy\\\":\\\"volatile-lfu\\\",\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64,\\\"#no_loose_disabled-commands\\\":\\\"flushall,flushdb\\\",\\\"lazyfree-lazy-eviction\\\":\\\"yes\\\"}",
        "Port": 6379,
        "DestroyTime": "2019-04-28T10:03:01Z",
        "GlobalInstanceId": "gr-bp14rkqrhac****",
        "HasRenewChangeOrder": false,
        "ShardCount": 3,
        "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
        "SlaveReplicaCount": 1,
        "PrivateIp": "172.16.49.***",
        "Capacity": 4096,
        "QPS": 100000,
        "NetworkType": "CLASSIC",
        "InstanceStatus": "Normal",
        "PackageType": "standard",
        "Bandwidth": 96,
        "InstanceType": "Redis",
        "Tags": {
          "Tag": [
            {
              "Value": "value1",
              "Key": "key1"
            }
          ]
        },
        "ReplacateId": "grr-bp11381ebc16****",
        "ArchitectureType": "cluster",
        "EngineVersion": "4.0",
        "UserName": "r-bp1zxszhcgatnx****",
        "ZoneId": "cn-hangzhou-b",
        "CloudType": "cloudbox",
        "InstanceId": "r-bp1zxszhcgatnx****",
        "ShardClass": "redis.shard.small.ce",
        "CreateTime": "2018-11-07T08:49:00Z",
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "ReplicaCount": 1,
        "ReadOnlyCount": "1",
        "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
        "IsRds": true,
        "SecondaryZoneId": "cn-hangzhou-h",
        "InstanceName": "apitest",
        "SlaveReadOnlyCount": 1,
        "VpcId": "vpc-bp1nme44gek34slfc****",
        "ChargeType": "PostPaid",
        "ComputingType": "Ecs",
        "NodeType": "double",
        "ConnectionMode": "Standard",
        "RegionId": "cn-hangzhou",
        "WorkspaceId": ""
      }
    ]
  }
}

異常返回樣本

JSON格式

{
   "PageNumber":1,
   "TotalCount":38,
   "PageSize":10,
   "RequestId":"9099BAE9-BE8A-4B25-8E96-3C22289C70A6",
   "Instances":{
       "KVStoreInstance":[
           {
               "Config":"{"EvictionPolicy":"volatile-lru","list-max-ziplist-entries":512,"zset-max-ziplist-entries":128,"hash-max-ziplist-entries":512,"hash-max-ziplist-value":64,"list-max-ziplist-value":64,"set-max-intset-entries":512,"zset-max-ziplist-value":64}",
               "HasRenewChangeOrder":false,
               "InstanceId":"r-xxxxxxxxxxxxxxx",
               "UserName":"r-xxxxxxxxxxxxxxx",
               "ZoneId":"cn-hangzhou-g",
               "ArchitectureType":"standard",
               "NetworkType":"Classic",
               "QPS":100000,
               "PackageType":"standard",
               "IsRds":true,
               "ConnectionDomain":"r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com",
               "EngineVersion":"2.8",
               "InstanceName":"zhai_test",
               "ReplacateId":"bls-xxxxxxxxxxxxxxx",
               "Bandwidth":16,
               "ChargeType":"PostPaid",
               "InstanceType":"Redis",
               "InstanceStatus":"Normal",
               "Port":6379,
               "InstanceClass":"redis.master.mid.default",
               "RegionId":"cn-hangzhou",
               "CreateTime":"2018-10-10T04:19:01Z",
               "NodeType":"double",
               "Capacity":2048,
               "Connections":10000
           }
       ]
   }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

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

變更歷史

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