DescribeInstances - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

1 つ以上の ApsaraDB for Redis（Tair 互換）インスタンスの情報を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeInstances

list

DBInstance

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

DBInstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	インスタンスのリージョン ID。説明この API を呼び出す際に Tag パラメーターを指定する場合、このパラメーターは必須です。	cn-hangzhou
InstanceIds	string	任意	クエリするインスタンスの ID。説明複数のインスタンス ID を指定するには、コンマ（,）で区切ります。1 回のリクエストで最大 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: 仮想プライベートクラウド（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	任意	VPC の ID。	vpc-bp1nme44gek34slfc****
VSwitchId	string	任意	vSwitch の ID。	vsw-bp1e7clcw529l773d****
PageNumber	integer	任意	インスタンスリストのページ番号。ページは 1 から始まります。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりの最大エントリ数。最大値: 50。デフォルト値: 30。	30
InstanceType	string	任意	インスタンスのカテゴリ。有効な値: Tair: Tair（Enhanced エディション） Redis: ApsaraDB for Redis Community エディション 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 API を呼び出すか、コンソールを使用してリソースグループ ID のリストを取得できます。詳細については、リソースグループの基本情報の表示を参照してください。	rg-acfmyiu4ekp****
GlobalInstance	boolean	任意	返されるインスタンスリストから分散インスタンスのサブインスタンスをフィルターするかどうかを指定します。有効な値: true: サブインスタンスの情報のみを返します。 false: サブインスタンスの情報を返しません。	true
EditionType	string	任意	インスタンスのエディション。有効な値: Community: ApsaraDB for Redis Community Edition。 Enterprise: Tair Enhanced Edition。	Enterprise
PrivateIp	string	任意	VPC のプライベート IP アドレス。	172.16.49.***
Tag	array<object>	任意	インスタンスのタグ。
	object	任意	オブジェクト。
Value	string	任意	タグの値。タグ値とキーで 1 つのキーと値のペアを構成します。	开发
Key	string	任意	タグのキー。タグキーと値で 1 つのキーと値のペアを構成します。説明一度に最大 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	1 ページあたりのエントリ数。	30
TotalCount	integer	インスタンスの総数。	1
Instances	object
KVStoreInstance	array<object>	インスタンスのコレクション。
	array<object>	オブジェクト。
Connections	integer	インスタンスへの最大接続数です。	20000
EndTime	string	サブスクリプションインスタンスの有効期限です。	2019-06-13T16:00:00Z
ResourceGroupId	string	インスタンスが属するリソースグループの ID です。	rg-acfmyiu4ekp****
EditionType	string	インスタンスのエディションです。有効値： Community：Community Edition。 Enterprise：Enterprise Edition (Tair)。	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 操作を呼び出してください。	6379
DestroyTime	string	インスタンスがリリースされた時刻です。	2019-04-28T10:03:01Z
GlobalInstanceId	string	分散インスタンスの ID です。説明このパラメーターは、インスタンスが分散インスタンスの子インスタンスである場合にのみ返されます。	gr-bp14rkqrhac****
HasRenewChangeOrder	boolean	インスタンスに更新または設定変更の保留中の注文があるかどうかを示します。有効値： true：保留中の注文があります。 false：保留中の注文はありません。	false
ShardCount	integer	クラスターインスタンスのデータシャード数です。説明このパラメーターは、クラウドネイティブのクラスターインスタンス、または読み書き分離アーキテクチャを使用するインスタンスに対してのみ返されます。	3
ConnectionDomain	string	インスタンスの内部エンドポイントです。重要インスタンスのエンドポイントを変更した後、このパラメーターの値が遅延する場合があります。リアルタイムのエンドポイントを照会するには、DescribeDBInstanceNetInfo 操作を呼び出してください。	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
SlaveReplicaCount	integer	セカンダリアベイラビリティゾーンのレプリカノード数です。	1
PrivateIp	string	インスタンスのプライベート IP アドレスです。説明インスタンスのネットワークタイプがクラシックネットワークの場合、このパラメーターは返されません。	172.16.49.***
Capacity	integer	インスタンスのメモリ容量です。単位：MB。	4096
QPS	integer	秒間クエリ数 (QPS) です。	100000
NetworkType	string	インスタンスのネットワークタイプです。有効値： CLASSIC：クラシックネットワーク。 VPC：Virtual Private Cloud (VPC)。	CLASSIC
InstanceStatus	string	インスタンスの状態です。有効値： Normal：インスタンスは実行中です。 Creating：インスタンスは作成中です。 Changing：インスタンスの設定は変更中です。 Inactive：インスタンスは無効化されています。 Flushing：インスタンスはフラッシュ中です。 Released：インスタンスはリリース済みです。 Transforming：インスタンスの課金方法は変更中です。 Unavailable：インスタンスは利用できません。 Error：インスタンスの作成に失敗しました。 BackupRecovering：インスタンスはバックアップから復元中です。 MinorVersionUpgrading：インスタンスのマイナーバージョンはアップグレード中です。 NetworkModifying：インスタンスのネットワーク設定は変更中です。 SSLModifying：SSL 証明書は変更中です。 MajorVersionUpgrading：インスタンスのメジャーバージョンはアップグレード中です。インスタンスには引き続きアクセスできます。 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	タグの値です。	value1
Key	string	タグのキーです。	key1
ReplacateId	string	マルチアクティブインスタンスの論理 ID です。	grr-bp11381ebc16****
ArchitectureType	string	インスタンスのアーキテクチャです。有効値： cluster：クラスターアーキテクチャ。 standard：標準アーキテクチャ。 rwsplit：読み書き分離アーキテクチャ。 NULL：この値はインスタンスのアーキテクチャには返されません。リクエストのフィルタリングにのみ使用されます。	cluster
EngineVersion	string	インスタンスのデータベースエンジンバージョンです。	4.0
UserName	string	接続ユーザー名です。デフォルトでは、インスタンス ID と同じです。	r-bp1zxszhcgatnx****
ZoneId	string	アベイラビリティゾーンの ID です。	cn-hangzhou-b
CloudType	string	このパラメーターは、Alibaba Cloud Box のインスタンスに対してのみ返されます。	cloudbox
InstanceId	string	インスタンスの ID です。	r-bp1zxszhcgatnx****
ShardClass	string	各データシャードのインスタンスタイプです。詳細については、「インスタンスタイプ」をご参照ください。説明クラスターインスタンスの全体的なパフォーマンスは、次の数式を使用して計算されます：データシャードのパフォーマンス (ShardClass) × データシャードの数 (ShardCount)。	redis.shard.small.ce
CreateTime	string	インスタンスが作成された時刻です。	2018-11-07T08:49:00Z
VSwitchId	string	vSwitch の 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	インスタンスが ApsaraDB によって管理されているかどうかを示します。有効値： true：インスタンスは ApsaraDB によって管理されています。 false：インスタンスは ApsaraDB によって管理されていません。	true
SecondaryZoneId	string	セカンダリアベイラビリティゾーンの ID です。説明 ZoneId パラメーターが `cn-hangzhou-MAZ10(h,i)` のようなマルチゾーン配置を示す値を返す場合、このパラメーターは返されません。	cn-hangzhou-h
InstanceName	string	インスタンスの名前です。	apitest
SlaveReadOnlyCount	integer	セカンダリアベイラビリティゾーンの読み取り専用ノード数です。	1
VpcId	string	VPC の ID です。	vpc-bp1nme44gek34slfc****
ChargeType	string	インスタンスの課金方法です。有効値： PrePaid：サブスクリプション。 PostPaid：従量課金。	PostPaid
ComputingType	string	コンピューティングリソースのタイプです。有効値： Ecs：インスタンスは 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
UsedCount	integer
QuotaCount	integer

例

成功レスポンス

JSONJSON

{
  "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": "",
        "UsedCount": 0,
        "QuotaCount": 0
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。