DescribeInstanceAttribute - 查詢執行個體的詳細資料 - Tair (Redis® OSS-Compatible)

查詢雲資料庫 Tair（相容 Redis）執行個體的詳細資料。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeInstanceAttribute

get

*DBInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	r-bp1zxszhcgatnx****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	CA40C261-EB72-4EDA-AC57-958722162595
Instances	object
DBInstanceAttribute	array<object>	執行個體詳細資料列表。
	array<object>
VpcId	string	Virtual Private Cloud的 ID。	vpc-bp1nme44gek34slfc****
PrivateIp	string	專用網路 IP 位址。說明執行個體的網路類型為傳統網路時，不會返回本參數。	172.16.49.***
Capacity	integer	儲存容量，單位：MB。	1024
CreateTime	string	執行個體建立時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2019-03-06T10:42:03Z
ConnectionDomain	string	執行個體的內網串連地址。	r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com
IsRds	boolean	是否屬 RDS 管控，傳回值： true：是。 false：否。	true
ChargeType	string	付費類型，傳回值： PrePaid：預付費，即訂用帳戶。 PostPaid：後付費，即隨用隨付。	PostPaid
StorageType	string	儲存類型。	essd_pl1
VpcAuthMode	string	VPC 認證模式，傳回值： Open：要求輸入密碼認證。 Close：關閉密碼認證，即開啟了 VPC 免密功能。	Open
ArchitectureType	string	執行個體的架構，傳回值： cluster：叢集版。 standard：標準版。 rwsplit：讀寫分離版。	standard
AvailabilityValue	string	當月的可用性指標。	100%
NetworkType	string	網路類型，傳回值： CLASSIC：傳統網路。 VPC：專用網路。	CLASSIC
Port	integer	執行個體的服務連接埠。	6379
SecondaryZoneId	string	備可用性區域 ID。說明執行個體沒有備可用性區域 ID 時，不返回本參數。	cn-hongkong-h
PackageType	string	套餐類型，傳回值： standard：標準套餐。 customized：定製套餐，已下線。	standard
EngineVersion	string	執行個體相容 Redis 的版本，傳回值：2.8、4.0、5.0、6.0或7.0。	4.0
Config	string	執行個體的參數配置資訊，格式為 JSON，詳情請參見參數說明，查看審計日誌配置可使用 DescribeAuditLogConfig 介面。	{\"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}
VpcCloudInstanceId	string	VPC 執行個體 ID。	r-bp1d72gwl41z7f****
Bandwidth	integer	頻寬，單位：MB/s。	10
InstanceName	string	執行個體名稱。	apitest
SecurityIPList	string	IP 白名單。	127.0.0.1
ShardCount	integer	分區數，本參數僅適用於中國站。	2
ReplicaCount	integer	主可用性區域的備節點數（個）。說明 ReplicaCount 與 SlaveReplicaCount 參數僅適用於雲原生版執行個體。如果執行個體為叢集架構，則上述參數分別表示單分區的（主、備可用性區域）備節點數。	1
SlaveReplicaCount	integer	備可用性區域的備節點數（個）。	1
ReadOnlyCount	integer	主可用性區域的唯讀節點數（個）。說明 ReadOnlyCount 與 SlaveReadOnlyCount 參數僅適用於雲原生版、開啟讀寫分離的執行個體。如果執行個體為叢集架構，則上述參數分別表示單分區的（主、備可用性區域）唯讀節點數量。	5
SlaveReadOnlyCount	integer	備可用性區域的唯讀節點數，該參數僅在多可用性區域中開啟讀寫分離後才會返回。	2
GlobalInstanceId	string	所屬的分布式執行個體 ID。說明當 Redis 執行個體為分布式執行個體中的子執行個體時，才會返回本參數。	gr-bp14rkqrhac****
QPS	integer	理論最大 QPS 值。	100000
AuditLogRetention	string	審計日誌中設定的日誌保留時間，單位為天。0 代表未開通審計日誌，開通方式請參見開通審計日誌。	15
ZoneType	string	可用性區域類型，傳回值： singlezone：同城單可用性區域。 doublezone：同城雙可用性區域。	singlezone
MaintainStartTime	string	可營運開始時間，格式為HH:mmZ（UTC 時間）。	18:00Z
MaintainEndTime	string	可營運結束時間，格式為HH:mmZ（UTC 時間）。	22:00Z
InstanceClass	string	執行個體規格，請參見執行個體規格表。	redis.master.small.default
RealInstanceClass	string	當執行個體為雲原生版叢集執行個體時，本參數為雲原生版叢集執行個體的實際分區規格，InstanceClass 參數為虛擬規格。說明如需查詢該規格的執行個體費用，可在 DescribePrice 介面中指定本參數返回的執行個體規格進行查詢。	tair.rdb.with.proxy.1g
InstanceId	string	執行個體 ID。	r-bp1d72gwl41z7f****
InstanceType	string	執行個體類型，傳回值： Tair Redis 其中經典版 Tair 記憶體型也會返回 Redis 執行個體類型。 Memcache	Redis
HasRenewChangeOrder	string	是否有未生效的續約變更配置訂單，傳回值： true：是。 false：否。	false
InstanceReleaseProtection	boolean	是否開啟了執行個體釋放保護，傳回值： true：已開啟。 false：未開啟。	false
ReplicationMode	string	副本架構，傳回值： master-slave：標準版的主備架構。 cluster：叢集架構，包含讀寫分離版或叢集版。 db：雲原生分區叢集架構。	master-slave
RegionId	string	地區 ID。	cn-hangzhou
EndTime	string	預付費執行個體到期時間，格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2019-04-06T10:42:03Z
VSwitchId	string	虛擬交換器 ID。	vsw-bp1e7clcw529l773d****
ReplicaId	string	複本識別碼。	bls-awxxxxxxxxxxxxx
NodeType	string	節點類型，傳回值： double：雙副本。 single：單副本。 readone：經典架構讀寫分離執行個體，一個唯讀節點。 readthree：經典架構讀寫分離執行個體，三個唯讀節點。	double
Connections	integer	執行個體串連數限制。	10000
BackupLogStartTime	string	允許閃回的最早時間點，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明當 Redis 執行個體開啟了資料閃回功能，才會返回本參數。調用 RestoreInstance 介面執行資料閃回時，可通過本參數的傳回值確認允許閃回的最早時間點（即 RestoreTime 可傳入的最早時間點）。	2021-07-06T05:49:55Z
ResourceGroupId	string	執行個體所屬的資源群組 ID。	rg-acfmyiu4ekp****
ZoneId	string	可用性區域 ID。	cn-hongkong-b
InstanceStatus	string	執行個體狀態，傳回值： Normal：正常。 Creating：建立中。 Changing：修改中。 Inactive：被禁用。 Flushing：清除中。 Released：已釋放。 Transforming：轉換中。 Migrating：遷移中。 BackupRecovering：備份恢複中。 MinorVersionUpgrading：小版本升級中。 NetworkModifying：網路變更中。 SSLModifying：SSL 變更中。 MajorVersionUpgrading：大版本升級中，可正常訪問。說明更多執行個體狀態及詳細資料，請參見執行個體狀態與影響。	Normal
Engine	string	資料庫類型，傳回值固定為 Redis。	Redis
Storage	string	Tair ESSD 磁碟型的儲存空間。	50
CloudType	string	僅雲盒執行個體顯示該參數。	cloudbox
IsOrderCompleted	boolean	執行個體訂單是否完成，用於判斷變更配置訂單是否到達終態，傳回值： true：變更配置已完成，或進行未變更配置。 false：變更配置中。	true
IsSupportTDE	boolean	執行個體是否支援開啟透明資料加密 TDE（Transparent Data Encryption）功能，傳回值： true：支援，僅經典版記憶體型執行個體支援。 false：不支援。	true
Tags	object
Tag	array<object>	標籤資訊。
	object	標籤資訊。
Key	string	標籤 key。	tagkey
Value	string	標籤 value。	tagvalue
AutoSecondaryZone	boolean	自動分配 Secondary 可用性區域。 true：自動分配 false：非自動分配	true
ComputingType	string

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CA40C261-EB72-4EDA-AC57-958722162595",
  "Instances": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-bp1nme44gek34slfc****",
        "PrivateIp": "172.16.49.***",
        "Capacity": 1024,
        "CreateTime": "2019-03-06T10:42:03Z",
        "ConnectionDomain": "r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com",
        "IsRds": true,
        "ChargeType": "PostPaid",
        "StorageType": "essd_pl1",
        "VpcAuthMode": "Open",
        "ArchitectureType": "standard",
        "AvailabilityValue": "100%",
        "NetworkType": "CLASSIC",
        "Port": 6379,
        "SecondaryZoneId": "cn-hongkong-h",
        "PackageType": "standard",
        "EngineVersion": "4.0",
        "Config": "{\\\"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}",
        "VpcCloudInstanceId": "r-bp1d72gwl41z7f****",
        "Bandwidth": 10,
        "InstanceName": "apitest",
        "SecurityIPList": "127.0.0.1",
        "ShardCount": 2,
        "ReplicaCount": 1,
        "SlaveReplicaCount": 1,
        "ReadOnlyCount": 5,
        "SlaveReadOnlyCount": 2,
        "GlobalInstanceId": "gr-bp14rkqrhac****",
        "QPS": 100000,
        "AuditLogRetention": "15",
        "ZoneType": "singlezone",
        "MaintainStartTime": "18:00Z",
        "MaintainEndTime": "22:00Z",
        "InstanceClass": "redis.master.small.default",
        "RealInstanceClass": "tair.rdb.with.proxy.1g",
        "InstanceId": "r-bp1d72gwl41z7f****",
        "InstanceType": "Redis",
        "HasRenewChangeOrder": "false",
        "InstanceReleaseProtection": false,
        "ReplicationMode": "master-slave",
        "RegionId": "cn-hangzhou",
        "EndTime": "2019-04-06T10:42:03Z",
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "ReplicaId": "bls-awxxxxxxxxxxxxx",
        "NodeType": "double",
        "Connections": 10000,
        "BackupLogStartTime": "2021-07-06T05:49:55Z",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hongkong-b",
        "InstanceStatus": "Normal",
        "Engine": "Redis",
        "Storage": "50",
        "CloudType": "cloudbox",
        "IsOrderCompleted": true,
        "IsSupportTDE": true,
        "Tags": {
          "Tag": [
            {
              "Key": "tagkey",
              "Value": "tagvalue"
            }
          ]
        },
        "AutoSecondaryZone": true,
        "ComputingType": ""
      }
    ]
  }
}

錯誤碼

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

變更歷史

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