调用DescribeInstanceAttribute查询Redis实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstanceAttribute |
系统规定参数。取值:DescribeInstanceAttribute。 |
RegionId | String | 否 | cn-hangzhou |
实例所属的地域ID,可调用DescribeRegions接口获取。 |
InstanceId | String | 是 | r-bp1zxszhcgatnx**** |
实例ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | CA40C261-EB72-4EDA-AC57-958722162595 |
请求ID。 |
Instances | Array of DBInstanceAttribute |
实例详细信息列表。 |
|
DBInstanceAttribute | |||
VpcId | String | vpc-bp1nme44gek34slfc**** |
专有网络(VPC)的ID。 |
PrivateIp | String | 172.16.49.*** |
专有网络IP地址。 说明 实例的网络类型为经典网络时,不会返回本参数。
|
Capacity | Long | 1024 |
存储容量,单位:MB。 |
CreateTime | String | 2019-03-06T10:42:03Z |
实例创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
ConnectionDomain | String | r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com |
实例的内网连接地址。 |
IsRds | Boolean | true |
是否属RDS管控,返回值:
|
ChargeType | String | PostPaid |
付费类型,返回值:
|
VpcAuthMode | String | Open |
VPC认证模式,返回值:
|
ArchitectureType | String | standard |
实例的架构,返回值:
|
AvailabilityValue | String | 100% |
当月的可用性指标。 |
NetworkType | String | CLASSIC |
网络类型,返回值:
|
Port | Long | 6379 |
Redis服务端口。 |
SecondaryZoneId | String | cn-hongkong-h |
备可用区ID。 说明 实例没有备可用区ID时,不返回本参数。
|
PackageType | String | standard |
套餐类型,返回值:
|
EngineVersion | String | 4.0 |
数据库版本,返回值:2.8、4.0、5.0或6.0。 |
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,详情请参见参数说明。 |
VpcCloudInstanceId | String | r-bp1d72gwl41z7f**** |
VPC实例ID。 |
Bandwidth | Long | 10 |
带宽,单位:MB/s。 |
InstanceName | String | apitest |
实例名称。 |
SecurityIPList | String | 127.0.0.1 |
IP白名单。 |
ShardCount | Integer | 2 |
分片数,本参数仅适用于中国站。 当Redis实例为集群架构的云盘实例时,才会返回本参数。 |
GlobalInstanceId | String | gr-bp14rkqrhac**** |
所属的分布式实例ID。 说明 当Redis实例为分布式实例中的子实例时,才会返回本参数。
|
QPS | Long | 100000 |
理论最大QPS值。 |
AuditLogRetention | String | 15 |
审计日志中设置的日志保留时间,单位为天。0代表未开通审计日志,开通方式请参见开通新版审计日志。 |
ZoneType | String | singlezone |
可用区类型,返回值:
|
MaintainStartTime | String | 18:00Z |
可运维开始时间,格式为HH:mmZ(UTC时间)。 |
InstanceClass | String | redis.master.small.default |
实例规格,请参见实例规格表。 |
MaintainEndTime | String | 22:00Z |
可运维结束时间,格式为HH:mmZ(UTC时间)。 |
InstanceId | String | r-bp1d72gwl41z7f**** |
实例ID。 |
InstanceType | String | Redis |
实例类型,取值:
|
HasRenewChangeOrder | String | false |
是否有未生效的续费变配订单,返回值:
|
InstanceReleaseProtection | Boolean | false |
是否开启了实例释放保护,返回值:
|
ReplicationMode | String | master-slave |
副本架构,返回值:
|
RegionId | String | cn-hangzhou |
地域ID。 |
EndTime | String | 2019-04-06T10:42:03Z |
预付费实例到期时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
VSwitchId | String | vsw-bp1e7clcw529l773d**** |
虚拟交换机ID。 |
ReplicaId | String | bls-awxxxxxxxxxxxxx |
副本ID。 |
NodeType | String | double |
节点类型,返回值:
|
Connections | Long | 10000 |
实例连接数限制。 |
BackupLogStartTime | String | 2021-07-06T05:49:55Z |
允许闪回的最早时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明
|
ResourceGroupId | String | rg-acfmyiu4ekp**** |
实例所属的资源组ID。 |
ZoneId | String | cn-hongkong-b |
可用区ID。 |
InstanceStatus | String | Normal |
实例状态,返回值:
|
Engine | String | Redis |
数据库类型,返回值固定为Redis。 |
CloudType | String | cloudbox |
仅云盒实例显示该参数。 |
Tags | Array of Tag |
标签信息。 |
|
Tag | |||
Key | String | tagkey |
标签key。 |
Value | String | tagvalue |
标签value。 |
示例
请求示例
https://r-kvstore.aliyuncs.com/?Action=DescribeInstanceAttribute
&InstanceId=r-bp1zxszhcgatnx****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInstanceAttributeResponse>
<Instances>
<DBInstanceAttribute>
<Connections>10000</Connections>
<ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
<Config>{"EvictionPolicy":"volatile-lru","hash-max-ziplist-entries":512,"zset-max-ziplist-entries":128,"list-max-ziplist-entries":512,"list-max-ziplist-value":64,"zset-max-ziplist-value":64,"set-max-intset-entries":512,"hash-max-ziplist-value":64}</Config>
<Port>6379</Port>
<HasRenewChangeOrder>false</HasRenewChangeOrder>
<ZoneType>singlezone</ZoneType>
<ConnectionDomain>r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com</ConnectionDomain>
<MaintainEndTime>22:00Z</MaintainEndTime>
<Capacity>1024</Capacity>
<QPS>100000</QPS>
<PrivateIp>172.16.49.***</PrivateIp>
<SecurityIPList>127.0.0.1</SecurityIPList>
<InstanceStatus>Normal</InstanceStatus>
<NetworkType>VPC</NetworkType>
<Bandwidth>10</Bandwidth>
<PackageType>standard</PackageType>
<InstanceReleaseProtection>false</InstanceReleaseProtection>
<InstanceType>Redis</InstanceType>
<AvailabilityValue>100.0%</AvailabilityValue>
<Engine>Redis</Engine>
<MaintainStartTime>18:00Z</MaintainStartTime>
<Tags>
<Tag>
<Value>社区版</Value>
<Key>类型</Key>
</Tag>
</Tags>
<ArchitectureType>standard</ArchitectureType>
<EngineVersion>5.0</EngineVersion>
<ZoneId>cn-hangzhou-f</ZoneId>
<InstanceId>r-bp1wcw2rlw76ac****</InstanceId>
<VSwitchId>vsw-bp1w9ouei2nm66qlz****</VSwitchId>
<CreateTime>2020-03-31T14:56:22Z</CreateTime>
<InstanceClass>redis.master.small.default</InstanceClass>
<AuditLogRetention>7</AuditLogRetention>
<IsRds>true</IsRds>
<ReplicationMode>master-slave</ReplicationMode>
<InstanceName>社区主从50</InstanceName>
<VpcId>vpc-bp1opxu1zkhn00gzv****</VpcId>
<ChargeType>PostPaid</ChargeType>
<VpcAuthMode>Open</VpcAuthMode>
<NodeType>double</NodeType>
<VpcCloudInstanceId>r-bp1wcw2rlw76ac****</VpcCloudInstanceId>
<RegionId>cn-hangzhou</RegionId>
</DBInstanceAttribute>
</Instances>
<RequestId>D67A69DF-C1FC-4B01-B239-B17888CCFD2A</RequestId>
</DescribeInstanceAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Instances" : {
"DBInstanceAttribute" : [ {
"Connections" : 10000,
"ResourceGroupId" : "rg-acfmyiu4ekp****",
"Config" : "{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}",
"Port" : 6379,
"HasRenewChangeOrder" : "false",
"ZoneType" : "singlezone",
"ConnectionDomain" : "r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com",
"MaintainEndTime" : "22:00Z",
"Capacity" : 1024,
"QPS" : 100000,
"PrivateIp" : "172.16.49.***",
"SecurityIPList" : "127.0.0.1",
"InstanceStatus" : "Normal",
"NetworkType" : "VPC",
"Bandwidth" : 10,
"PackageType" : "standard",
"InstanceReleaseProtection" : false,
"InstanceType" : "Redis",
"AvailabilityValue" : "100.0%",
"Engine" : "Redis",
"MaintainStartTime" : "18:00Z",
"Tags" : {
"Tag" : [ {
"Value" : "社区版",
"Key" : "类型"
} ]
},
"ArchitectureType" : "standard",
"EngineVersion" : "5.0",
"ZoneId" : "cn-hangzhou-f",
"InstanceId" : "r-bp1wcw2rlw76ac****",
"VSwitchId" : "vsw-bp1w9ouei2nm66qlz****",
"CreateTime" : "2020-03-31T14:56:22Z",
"InstanceClass" : "redis.master.small.default",
"AuditLogRetention" : "7",
"IsRds" : true,
"ReplicationMode" : "master-slave",
"InstanceName" : "社区主从50",
"VpcId" : "vpc-bp1opxu1zkhn00gzv****",
"ChargeType" : "PostPaid",
"VpcAuthMode" : "Open",
"NodeType" : "double",
"VpcCloudInstanceId" : "r-bp1wcw2rlw76ac****",
"RegionId" : "cn-hangzhou"
} ]
},
"RequestId" : "D67A69DF-C1FC-4B01-B239-B17888CCFD2A"
}
错误码
访问错误中心查看更多错误码。