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

ApsaraDB for Tair (Redis OSS-compatible) インスタンス 1 台以上に関する情報を照会します。

今すぐお試しください

この 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。説明 Tag パラメーターを指定して本操作を呼び出す場合、本パラメーターも必ず指定する必要があります。	cn-hangzhou
InstanceIds	string	任意	照会対象のインスタンス ID。説明複数のインスタンス ID を指定する場合は、カンマ (,) で区切ってください。1 回のリクエストで指定できる最大数は 30 個です。	r-bp1zxszhcgatnx****
InstanceStatus	string	任意	インスタンスの状態。有効な値は以下のとおりです。 Normal: 正常な状態です。 Creating: 作成中です。 Changing: 構成変更中です。 Inactive: 無効化されています。 Flushing: 解除中です。 Released: 解除済みです。 Transforming: 課金方法の変更中です。 Unavailable: 利用不可です。 Error: 作成に失敗しました。 Migrating: 移行中です。 BackupRecovering: バックアップからの復元中です。 MinorVersionUpgrading: マイナーバージョンの更新中です。 NetworkModifying: ネットワークタイプの変更中です。 SSLModifying: SSL 証明書の変更中です。 MajorVersionUpgrading: メジャーバージョンのアップグレード中です。アップグレード中もインスタンスへのアクセスは可能です。説明インスタンスの状態について詳しくは、「インスタンスの状態と影響」をご参照ください。	Normal
ChargeType	string	任意	インスタンスの課金方法。有効な値は以下のとおりです。 PrePaid: サブスクリプション PostPaid: 従量課金	PostPaid
NetworkType	string	任意	ネットワークタイプ。有効な値は以下のとおりです。 CLASSIC VPC	CLASSIC
EngineVersion	string	任意	インスタンスのデータベースエンジンバージョン。有効な値は 2.8、4.0、5.0、6.0、7.0 です。列挙値: 1.0 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 (Enterprise Edition) Redis: Redis Open-Source Edition 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。説明リソースグループ ID は、Tair (Redis OSS-compatible) コンソールまたは ListResourceGroups 操作を呼び出して照会できます。詳細については、「リソースグループの基本情報を表示する」をご参照ください。	rg-acfmyiu4ekp****
GlobalInstance	boolean	任意	分散型インスタンスのサブインスタンスを返すかどうかを指定します。有効な値は以下のとおりです。 true: サブインスタンスのみを返します。 false: サブインスタンスを返しません。	true
EditionType	string	任意	インスタンスのエディション。有効な値は以下のとおりです。 Community: Redis Open-Source Edition Enterprise: Tair (Enterprise Edition)	Enterprise
PrivateIp	string	任意	インスタンスのプライベート IP アドレス。	172.16.49.***
Tag	array<object>	任意	インスタンスのタグ。
	object	任意	オブジェクト。
Value	string	任意	タグ値。	开发
Key	string	任意	タグキー。タグはキーと値のペアです。説明一度に指定できるキーと値のペアの最大数は 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: Redis Open-Source Edition Enterprise: Tair (Enterprise Edition)	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	インスタンスのサービスポート。	6379
DestroyTime	string	インスタンスが削除された時刻。	2019-04-28T10:03:01Z
GlobalInstanceId	string	分散型インスタンスの ID。説明このパラメーターは、インスタンスが分散型インスタンスのサブインスタンスである場合にのみ返されます。	gr-bp14rkqrhac****
HasRenewChangeOrder	boolean	Alibaba Cloud アカウントに、更新および構成変更の保留中の注文があるかどうかを示します。有効な値は以下のとおりです。 true false	false
ShardCount	integer	クラスターインスタンスにおけるデータシャードの数。説明このパラメーターは、クラウドネイティブクラスターインスタンスまたは読み書き分離インスタンスの場合にのみ返されます。	3
ConnectionDomain	string	インスタンスの内部エンドポイント。	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
SlaveReplicaCount	integer	セカンダリゾーン内のレプリカノード数。	1
PrivateIp	string	プライベート IP アドレス。説明このパラメーターは、インスタンスがクラシックネットワークに展開されている場合、返されません。	172.16.49.***
Capacity	integer	インスタンスのストレージ容量です。単位は MB です。	4096
QPS	integer	1 秒あたりのクエリ数 (QPS)。	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	インスタンスの帯域幅。単位は Mbit/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	インスタンスのアーキテクチャ。デフォルト値は NULL です。有効な値は次のとおりです。 cluster：クラスタアーキテクチャ standard：スタンダードアーキテクチャ rwsplit：読み書き分離アーキテクチャ NULL：上記のすべてのアーキテクチャ	cluster
EngineVersion	string	インスタンスのデータベースエンジンバージョンです。	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	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 RDS によって管理されているかどうかを示します。有効な値は以下のとおりです。 true false	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: クラウドネイティブコンピューティングサービス Machine: 物理マシン	Ecs
NodeType	string	ノードタイプ。有効な値は以下のとおりです。 double: マスターノードとレプリカノードを含むインスタンス。 single: マスターノードのみを含むインスタンス。このノードタイプは非推奨です。	double
ConnectionMode	string	インスタンスの接続モード。有効な値は以下のとおりです。 Standard: 標準モード Safe: データベースプロキシモード	Standard
RegionId	string	リージョン ID。	cn-hangzhou

例

成功レスポンス

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"
      }
    ]
  }
}

エラーレスポンス

JSONJSON

{
   "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 ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

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

変更履歴

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