Queries the types of ApsaraDB for Redis instances that can be created in a specific zone.
Debugging
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | DescribeAvailableResource |
The operation that you want to perform. Set the value to DescribeAvailableResource. |
| RegionId | String | Yes | cn-hangzhou |
The ID of the region. You can call the DescribeRegions operation to query region IDs. |
| ZoneId | String | No | cn-hangzhou-h |
The ID of the zone. You can call the DescribeZones operation to query zone IDs. |
| InstanceChargeType | String | No | PrePaid |
The billing method. Valid values:
Note Default value: PrePaid.
|
| OrderType | String | No | BUY |
The order type. Valid values:
|
| Engine | String | No | Redis |
The engine type. Valid values:
|
| ResourceGroupId | String | No | rg-acfmyiu4e****** |
The ID of the resource group. You can call the ListResourceGroups operation to query the IDs of resource groups. Note You can also query the IDs of resource groups in the Resource Management console.
For more information, see View basic information about a resource group.
|
| InstanceId | String | No | r-bp1zxszhcgatnx**** |
The ID of the instance. Note This parameter is required only if the OrderType parameter is set to UPGRADE or RENEW.
|
| AcceptLanguage | String | No | zh-CN |
The language of the return values. Valid values:
|
| ProductType | String | No | Local |
The edition or series of instances. Valid values:
|
| NodeId | String | No | r-bp1zxszhcgatnx****-db-0 |
The ID of the data node for which you want to query available instance types. You
can call the DescribeLogicInstanceTopology operation to query the ID of the data node. Remove the number sign ( Note Before you set this parameter, you must set the InstanceId parameter to the ID of an instance in the cluster or read/write splitting architecture.
|
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| AvailableZones | Array of AvailableZone |
The detailed information about the zones that are queried. |
|
| AvailableZone | |||
| RegionId | String | cn-hangzhou |
The region ID of the zone. |
| SupportedEngines | Array of SupportedEngine |
The engine types that are supported. |
|
| SupportedEngine | |||
| Engine | String | Redis |
The engine type. |
| SupportedEditionTypes | Array of SupportedEditionType |
The instance editions that are supported. |
|
| SupportedEditionType | |||
| EditionType | String | Enterprise |
The instance edition. Valid values:
|
| SupportedSeriesTypes | Array of SupportedSeriesType |
The series that are supported. |
|
| SupportedSeriesType | |||
| SeriesType | String | enhanced_performance_type |
The series. Valid values:
|
| SupportedEngineVersions | Array of SupportedEngineVersion |
The engine versions that are supported. |
|
| SupportedEngineVersion | |||
| SupportedArchitectureTypes | Array of SupportedArchitectureType |
The architectures that are supported. |
|
| SupportedArchitectureType | |||
| Architecture | String | cluster |
The architecture. Valid values:
|
| SupportedShardNumbers | Array of SupportedShardNumber |
The numbers of available shards. |
|
| SupportedShardNumber | |||
| ShardNumber | String | 8 |
The number of available shards. |
| SupportedNodeTypes | Array of SupportedNodeType |
The node types that are supported. |
|
| SupportedNodeType | |||
| AvailableResources | Array of AvailableResource |
The available instance types. |
|
| AvailableResource | |||
| Capacity | Long | 16384 |
The memory size of the instance type. Unit: MB. |
| InstanceClass | String | redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread |
The code of the instance type. If you want to view the code of an instance type, you can search for the code of the instance type in the search box in Document Center. |
| InstanceClassRemark | String | 16 GB performance-enhanced cluster instance (Eight nodes) (QPS: 1,920,000 Number of connections: 240,000) |
The description of the instance type. |
| SupportedNodeType | String | DOUBLE |
The node type. Valid values:
|
| Version | String | 5.0 |
The engine version. |
| ZoneId | String | cn-hangzhou-h |
The ID of the zone. |
| ZoneName | String | Hangzhou Zone H |
The name of the zone. |
| RequestId | String | 493B7308-D9C2-55F6-B042-0313BD63**** |
The ID of the request. |
Examples
Sample requests
https://r-kvstore.aliyuncs.com?Action=DescribeAvailableResource
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-h
&OrderType=UPGRADE
&InstanceId=r-bp1zxszhcg******
&ProductType=Local
&<Common request parameters>Sample success responses
XML format
<DescribeAvailableResourceResponse>
<RequestId>493B7308-D9C2-55F6-B042-0313BD63****</RequestId>
<AvailableZones>
<AvailableZone>
<ZoneName>Hangzhou Zone H</ZoneName>
<ZoneId>cn-hangzhou-h</ZoneId>
<SupportedEngines>
<SupportedEngine>
<SupportedEditionTypes>
<SupportedEditionType>
<SupportedSeriesTypes>
<SupportedSeriesType>
<SeriesType>enhanced_performance_type</SeriesType>
<SupportedEngineVersions>
<SupportedEngineVersion>
<SupportedArchitectureTypes>
<SupportedArchitectureType>
<Architecture>cluster</Architecture>
<SupportedShardNumbers>
<SupportedShardNumber>
<SupportedNodeTypes>
<SupportedNodeType>
<SupportedNodeType>double</SupportedNodeType>
<AvailableResources>
<AvailableResource>
<Capacity>16384</Capacity>
<InstanceClassRemark>16 GB performance-enhanced cluster instance (Eight nodes) (QPS: 1,920,000 Number of connections: 240,000)</InstanceClassRemark>
<InstanceClass>redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread</InstanceClass>
</AvailableResource>
<AvailableResource>
<Capacity>32768</Capacity>
<InstanceClassRemark>32 GB performance-enhanced cluster instance (Eight nodes) (QPS: 1,920,000 Number of connections: 240,000)</InstanceClassRemark>
<InstanceClass>redis.amber.logic.sharding.4g.8db.0rodb.24proxy.multithread</InstanceClass>
</AvailableResource>
<AvailableResource>
<Capacity>65536</Capacity>
<InstanceClassRemark>64 GB performance-enhanced cluster instance (Eight nodes) (QPS: 1,920,000 Number of connections: 240,000)</InstanceClassRemark>
<InstanceClass>redis.amber.logic.sharding.8g.8db.0rodb.24proxy.multithread</InstanceClass>
</AvailableResource>
</AvailableResources>
</SupportedNodeType>
</SupportedNodeTypes>
<ShardNumber>8</ShardNumber>
</SupportedShardNumber>
</SupportedShardNumbers>
</SupportedArchitectureType>
</SupportedArchitectureTypes>
<Version>5.0</Version>
</SupportedEngineVersion>
</SupportedEngineVersions>
</SupportedSeriesType>
</SupportedSeriesTypes>
<EditionType>Enterprise</EditionType>
</SupportedEditionType>
</SupportedEditionTypes>
<Engine>redis</Engine>
</SupportedEngine>
</SupportedEngines>
</AvailableZone>
</AvailableZones>
</DescribeAvailableResourceResponse>JSON format
{
"RequestId": "493B7308-D9C2-55F6-B042-0313BD63****",
"AvailableZones": {
"AvailableZone": [
{
"ZoneName": "Hangzhou Zone H",
"ZoneId": "cn-hangzhou-h",
"SupportedEngines": {
"SupportedEngine": [
{
"SupportedEditionTypes": {
"SupportedEditionType": [
{
"SupportedSeriesTypes": {
"SupportedSeriesType": [
{
"SeriesType": "enhanced_performance_type",
"SupportedEngineVersions": {
"SupportedEngineVersion": [
{
"SupportedArchitectureTypes": {
"SupportedArchitectureType": [
{
"Architecture": "cluster",
"SupportedShardNumbers": {
"SupportedShardNumber": [
{
"SupportedNodeTypes": {
"SupportedNodeType": [
{
"SupportedNodeType": "double",
"AvailableResources": {
"AvailableResource": [
{
"Capacity": 16384,
"InstanceClassRemark": "16 GB performance-enhanced cluster instance (Eight nodes) (QPS: 1,920,000 Number of connections: 240,000)",
"InstanceClass": "redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread"
},
{
"Capacity": 32768,
"InstanceClassRemark": "32 GB performance-enhanced cluster instance (Eight nodes) (QPS: 1,920,000 Number of connections: 240,000)",
"InstanceClass": "redis.amber.logic.sharding.4g.8db.0rodb.24proxy.multithread"
},
{
"Capacity": 65536,
"InstanceClassRemark": "64 GB performance-enhanced cluster instance (Eight nodes) (QPS: 1,920,000 Number of connections: 240,000)",
"InstanceClass": "redis.amber.logic.sharding.8g.8db.0rodb.24proxy.multithread"
}
]
}
}
]
},
"ShardNumber": "8"
}
]
}
}
]
},
"Version": "5.0"
}
]
}
}
]
},
"EditionType": "Enterprise"
}
]
},
"Engine": "redis"
}
]
}
}
]
}
}Error codes
For a list of error codes, visit the API Error Center.