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

Tair (Redis 互換) インスタンスの詳細を取得します。

今すぐお試しください

この 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: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	VPC の ID。	vpc-bp1nme44gek34slfc****
PrivateIp	string	インスタンスのプライベート IP アドレス。説明インスタンスのネットワークタイプがクラシックネットワークの場合、このパラメーターは返されません。	172.16.49.***
Capacity	integer	インスタンスのメモリ容量。単位：MB。	1024
CreateTime	string	インスタンスが作成された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は協定世界時 (UTC) で表示されます。	2019-03-06T10:42:03Z
ConnectionDomain	string	インスタンスの内部エンドポイント。	r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com
IsRds	boolean	インスタンスが RDS によって管理されているかどうかを示します。有効な値： true：インスタンスは RDS によって管理されています。 false：インスタンスは RDS によって管理されていません。	true
ChargeType	string	インスタンスの課金方法。有効な値： PrePaid：サブスクリプション PostPaid：従量課金	PostPaid
StorageType	string	ストレージタイプ。	essd_pl1
VpcAuthMode	string	VPC にデプロイされているインスタンスの認証モード。有効な値： Open：パスワード認証が有効になっています。 Close：パスワードなしのアクセスが有効になっています。	Open
ArchitectureType	string	インスタンスのアーキテクチャ。有効な値： cluster：インスタンスはクラスターインスタンスです。 standard：インスタンスはスタンダードインスタンスです。 rwsplit：インスタンスは読み書き分離インスタンスです。	standard
AvailabilityValue	string	当月のインスタンスの可用性メトリック。	100%
NetworkType	string	インスタンスのネットワークタイプ。有効な値： CLASSIC：クラシックネットワーク VPC：VPC	CLASSIC
Port	integer	インスタンスのサービスポート。	6379
SecondaryZoneId	string	セカンダリゾーンの ID。説明インスタンスがセカンダリゾーンにデプロイされていない場合、このパラメーターは返されません。	cn-hongkong-h
PackageType	string	インスタンスのエディション。有効な値： standard：スタンダードエディション customized：カスタマイズエディションは廃止されました。	standard
EngineVersion	string	インスタンスのデータベースエンジンバージョン。有効な値：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	インスタンスの帯域幅。単位：Mbit/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。説明このパラメーターは、分散インスタンスの子インスタンスに対してのみ返されます。	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：ApsaraDB for Redis Community Edition インスタンスと、従来の ApsaraDB for Redis Enhanced Edition (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	vSwitch ID。	vsw-bp1e7clcw529l773d****
ReplicaId	string	レプリカノードの ID。	bls-awxxxxxxxxxxxxx
NodeType	string	ノードタイプ。有効な値： double：インスタンスには 2 つのデータノードがあります。 single：インスタンスには 1 つのデータノードがあります。 readone：読み書き分離インスタンスには 1 つの読み取り専用ノードがあります。 readthree：読み書き分離インスタンスには 3 つの読み取り専用ノードがあります。	double
Connections	integer	最大接続数。	10000
BackupLogStartTime	string	データを復元できる最も早い時点。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。説明このパラメーターは、データフラッシュバック機能がインスタンスで有効になっている場合にのみ返されます。 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	拡張 SSD (ESSD) を使用する ApsaraDB for Redis Enhanced Edition (Tair) インスタンスのストレージ容量。	50
CloudType	string	このパラメーターは、Alibaba Cloud クラウドで作成された ApsaraDB for Redis インスタンスに対してのみ返されます。	cloudbox
IsOrderCompleted	boolean	構成変更が完了したかどうかを示します。有効な値： true：構成変更は完了したか、進行中の構成変更はありません。 false：構成変更は進行中です。	true
IsSupportTDE	boolean	TDE (透過的データ暗号化) がサポートされているかどうかを示します。有効な値： true：TDE はサポートされています。この機能は、ApsaraDB for Redis Enhanced Edition (Tair) メモリタイプインスタンスでのみサポートされます。 false：TDE はサポートされていません。	true
Tags	object
Tag	array<object>	タグ。
	object	タグ。
Key	string	タグのキー。	tagkey
Value	string	タグの値。	tagvalue
AutoSecondaryZone	boolean	セカンダリゾーンが自動的に選択されるかどうかを示します。有効な値： true：セカンダリゾーンは自動的に選択されます。 false：セカンダリゾーンは自動的に選択されません。	true
ComputingType	string

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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