ApsaraDB for Redis インスタンスの詳細情報を照会するために使用する API について説明します。

デバッグ

この操作は、OpenAPI Explorer から呼び出すことができます。署名を手作業で計算する必要はありません。 操作の呼び出し後、OpenAPI Explorer は SDK サンプルコードを自動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
InstanceId String 必須 r-bp1xxxxxxxxxxxxx

詳細情報を照会するインスタンスの ID を設定します。

Action String 任意 DescribeInstanceAttribute

操作の実行に使用する API (DescribeSiteMonitorAttribute) に設定します。

AccessKeyId String 任意 Lxxxxxxxxxxxxxxw

サービスへのアクセスに使用する、Alibaba Cloud から提供される AccessKey ID を設定します。

レスポンスパラメーター

パラメーター データ型 説明
Instances

インスタンスの情報を示します。

ArchitectureType String standard

インスタンスのアーキテクチャを示します。 想定される値は次のとおりです。

  • cluster: クラスター構成
  • standard: 標準構成
  • SplitRW: 読み書き分離構成
  • NULL: すべての構成 (デフォルト値)。
AuditLogRetention String 15

監査ログの保存期間を示します。

現在、Alibaba Cloud の国際サイトは監査ログ機能をサポートしていません。
AvailabilityValue String 100%

当月分の可用性モニタリングの数値を示します。

Bandwidth Long 10

インスタンスの帯域幅を示します (単位: MByte/s)。

容量 Long 1024

インスタンスの残容量を示します (単位: MB)。

ChargeType String PostPaid

インスタンスの課金方法を示します。 想定される値は次のとおりです。

  • PrePaid: サブスクリプション
  • PostPaid: 従量課金
Config String {\"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}

インスタンスのパラメーター設定を JSON 文字列で示します。 詳細については、「パラメーター設定」をご参照ください。

ConnectionDomain String r-j6cxxxxxxxxxxxxx.redis.rds.aliyuncs.com

インスタンスのエンドポイントを示します。

Connections Long 10000

インスタンスでサポートされる接続数の上限を示します。

CreateTime String 2019-03-06T10:42:03Z

インスタンスが作成された時刻を示します。 時刻は ISO 8601 標準の形式に従い、UTC で表示されます。 表示形式は yyyy-MM-ddTHH:mm:ssZ です。

EndTime String 2019-04-06T10:42:03Z

サブスクリプションインスタンスの有効期限を示します。 時刻は ISO 8601 標準の形式に従い、UTC で表示されます。 表示形式は yyyy-MM-ddTHH:mm:ssZ です。

Engine String Redis

インスタンスのエンジンタイプを示します。

EngineVersion String 4.0

インスタンスのエンジンバージョンを示します。 想定される値は次のとおりです。

  • 2.8
  • 4.0
  • 5.0
HasRenewChangeOrder String false

設定変更が反映されていない更新オーダーの有無を示します。 想定される値は次のとおりです。

  • true
  • false
InstanceClass String redis.master.small.default

インスタンスタイプを示します。

InstanceId String r-j6cxxxxxxxxxxxxx

インスタンスの ID を示します。

InstanceName String apitest

インスタンスの名前を示します。

InstanceStatus String Normal

インスタンスのステータスを示します。

InstanceType String Redis

インスタンスのエンジンタイプを示します。

IsRds Boolean true

インスタンスが RDS (リレーショナルデータベースサービス) によって管理されているかどうかを示します。 想定される値は次のとおりです。

  • true
  • false
MaintainEndTime String 22:00Z

メンテナンスの終了時刻を示します。 時刻の表示形式は、HH:mmZ です (例: 02:00Z)。

MaintainStartTime String 18:00Z

メンテナンスの開始時刻を示します。 時刻の表示形式は、HH:mmZ です (例: 02:00Z)。

NetworkType String CLASSIC

インスタンスのネットワークタイプを示します。 想定される値は次のとおりです。

  • CLASSIC
  • VPC
NodeType String double

インスタンスのノードタイプを示します。 想定される値は次のとおりです。

  • double
  • single
NodeType String double

インスタンスのノードタイプを示します。 想定される値は次のとおりです

  • double
  • single
PackageType String 標準

パッケージのタイプを示します。 想定される値は次のとおりです。

  • standard
  • customized
Port Long 6379

インスタンスのサービスポートを示します。

PrivateIp String xxx.xxx.xxx.222

インスタンスの内部 IP アドレスを示します。

QPS Long 100000

理論上の毎秒あたりの最大クエリ数 (QPS) を示します。

RegionId String cn-hongkong

リージョンの ID を示します。

ReplicaId String bls-awxxxxxxxxxxxxx

レプリカの ID を示します。

ReplicationMode String master-slave

インスタンスのアーキテクチャを示します。

  • master-slave: Master-Slave 構成およびスタンドアロン構成を示します。
  • cluster: 読み書き分離構成およびクラスター構成を示します。
SecurityIPList String 127.0.0.1

IP アドレスのホワイトリストを示します。

Tags

タグの情報を示します。

Key String tagkey

タグのキーを示します。

Value String tagvalue

タグの値を示します。

VSwitchId String vsw-xxxxxxxxxxxxxxxxxxxxx

VSwitch の ID を示します。

VpcAuthMode String Open

VPC 内のアクセスにパスワード認証を使用しているかどうかを示します。 想定される値は次のとおりです。

  • Open: パスワード認証を使用しています。
  • Close: パスワード認証を使用していません。
VpcId String vpc-bp1cxxxxxxxxxxxxxxxxx

VPC の ID を示します。

ZoneId String cn-hongkong-b

ゾーンの ID を示します。 最新のリージョン一覧は、「DescribeRegions」を呼び出して取得できます。

RequestId String CA40C261-EB72-4EDA-AC57-958722162595

リクエストの ID を示します。

リクエストの例


https://r-kvstore.aliyuncs.com/
? Action=DescribeInstanceAttribute
&InstanceId=r-bp1xxxxxxxxxxxxx
&<Common request parameters>

操作が正常に完了した場合のレスポンス例

XML 形式

<DescribeEventRuleAttributeResponse>
  <RequestId>5553161D-11B1-43E1-9D95-523B2C82304F</RequestId>
	  <Instances>
		    <DBInstanceAttribute>
			      <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"}</Config>
			      <HasRenewChangeOrder>false</HasRenewChangeOrder>
			      <InstanceId>r-bp1xxxxxxxxxxxxx</InstanceId>
			      <ArchitectureType>cluster</ArchitectureType>
			      <ZoneId>cn-hangzhou-e</ZoneId>
			      <PrivateIp>xxx.xxx.xxx.224</PrivateIp>
			      <VSwitchId>vsw-bp1xxxxxxxxxxxxxxxxxx</VSwitchId>
			      <VpcId>vpc-bp1xxxxxxxxxxxxxxxxxx</VpcId>
			      <Engine>Redis</Engine>
			      <NetworkType>VPC</NetworkType>
			      <PackageType>standard</PackageType>
			      <QPS>200000</QPS>
			      <ReplicaId>grr-bp1xxxxxxxxxxxxx</ReplicaId>
			      <IsRds>true</IsRds>
			      <MaintainStartTime>18:00Z</MaintainStartTime>
			      <VpcAuthMode>Close</VpcAuthMode>
			      <ConnectionDomain>cluster40.redis.rds.aliyuncs.com</ConnectionDomain>
			      <EngineVersion>4.0</EngineVersion>
			      <InstanceName>cluster40</InstanceName>
			      <Bandwidth>96</Bandwidth>
			      <ChargeType>PostPaid</ChargeType>
			      <AuditLogRetention>30</AuditLogRetention>
			      <MaintainEndTime>22:00Z</MaintainEndTime>
			      <ReplicationMode>cluster</ReplicationMode>
			      <InstanceType>Redis</InstanceType>
			      <Tags></Tags>
			      <InstanceStatus>Normal</InstanceStatus>
			      <Port>6379</Port>
			      <InstanceClass>redis.logic.sharding.2g.2db.0rodb.4proxy.default</InstanceClass>
			      <AvailabilityValue>100.0%</AvailabilityValue>
			      <RegionId>cn-hangzhou</RegionId>
			      <NodeType>double</NodeType>
			      <CreateTime>2018-11-07T16:49:00Z</CreateTime>
			      <Capacity>4096</Capacity>
			      <SecurityIPList>172.0.0.1</SecurityIPList>
			      <Connections>20000</Connections>
		    </DBInstanceAttribute>
	  </Instances>
</DescribeInstanceAttributeResponse>

JSON 形式

{
	"RequestId":"5553161D-11B1-43E1-9D95-523B2C82304F",
	"Instances":{
		"DBInstanceAttribute":[
			{
				"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\"}",
				"HasRenewChangeOrder":"false",
				"InstanceId":"r-bp1xxxxxxxxxxxxx",
				"ZoneId":"cn-hangzhou-e",
				"ArchitectureType":"cluster",
				"PrivateIp":"xxx.xxx.xxx.224",
				"VSwitchId":"vsw-bp1xxxxxxxxxxxxxxxxxx",
				"Engine":"Redis",
				"VpcId":"vpc-bp1xxxxxxxxxxxxxxxxxx",
				"NetworkType":"VPC",
				"QPS":200000,
				"PackageType":"standard",
				"ReplicaId":"grr-bp1xxxxxxxxxxxxx",
				"IsRds":true,
				"MaintainStartTime":"18:00Z",
				"VpcAuthMode":"Close",
				"ConnectionDomain":"cluster40.redis.rds.aliyuncs.com",
				"EngineVersion":"4.0",
				"InstanceName":"cluster40",
				"Bandwidth":96,
				"ChargeType":"PostPaid",
				"AuditLogRetention":"30",
				"MaintainEndTime":"22:00Z",
				"ReplicationMode":"cluster",
				"InstanceType":"Redis",
				"InstanceStatus":"Normal",
				"Tags":{
					"Tag":[]
				},
				"Port":6379,
				"InstanceClass":"redis.logic.sharding.2g.2db.0rodb.4proxy.default",
				"CreateTime":"2018-11-07T16:49:00Z",
				"NodeType":"double",
				"RegionId":"cn-hangzhou",
				"AvailabilityValue":"100.0%",
				"Capacity":4096,
				"Connections":20000,
				"SecurityIPList":"172.0.0.1"
			}
		]
	}
}

エラーコード

詳細については、「Error codes」をご参照ください。