调用DescribeAvailableResource查询指定可用区内可创建的实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAvailableResource

系统规定参数,取值:DescribeAvailableResource

RegionId String cn-beijing

地域ID,您可以调用DescribeRegions查询。

ZoneId String cn-beijing-c

可用区ID,您可以调用DescribeZones查询。

InstanceChargeType String PrePaid

付费类型,取值:

  • PrePaid:包年包月。
  • PostPaid:按量付费。
说明 默认值:PrePaid
OrderType String BUY

订单类型,取值:

  • BUY:新购。
  • UPGRADE:变更配置。
  • RENEW:续费。
Engine String redis

引擎类型,取值:

  • redis
  • memcache
ResourceGroupId String rg-acfmyiu4e******

资源组ID。您可以通过调用ListResourceGroups接口获取资源组ID。

说明 您也可以通过控制台获取资源组ID,相关操作,请参见查看资源组基本信息
InstanceId String r-bp1zxszhcg******

实例ID。

说明OrderType取值为UPGRADERENEW时,本参数才可用且必须传入。
AcceptLanguage String zh-CN

返回值的语言,取值:

  • zh-CN:中文,默认值。
  • en-US:英文。

返回数据

名称 类型 示例值 描述
AvailableZones Array of AvailableZone

可用区详情。

AvailableZone
RegionId String cn-beijing

地域ID。

SupportedEngines Array of SupportedEngine

引擎类型。

SupportedEngine
Engine String Redis

实例的引擎类型。

SupportedEditionTypes Array of SupportedEditionType

实例类型。

SupportedEditionType
EditionType String Community

实例类型,返回值:

  • Community:社区版。
  • Enterprise:企业版。
SupportedSeriesTypes Array of SupportedSeriesType

实例的系列。

SupportedSeriesType
SeriesType String enhanced_performance_type

系列,返回值:

  • enhanced_performance_type:性能增强型。
  • hybrid_storage:混合存储型。
SupportedEngineVersions Array of SupportedEngineVersion

引擎版本(版本号)列表。

SupportedEngineVersion
SupportedArchitectureTypes Array of SupportedArchitectureType

架构类型。

SupportedArchitectureType
Architecture String cluster

架构,返回值:

  • standard:标准架构。
  • cluster:集群架构。
  • rwsplit:读写分离架构。
SupportedShardNumbers Array of SupportedShardNumber

可用分片数列表。

SupportedShardNumber
ShardNumber String 8

分片数。

SupportedNodeTypes Array of SupportedNodeType

节点类型列表。

SupportedNodeType
AvailableResources Array of AvailableResource

可用规格列表。

AvailableResource
InstanceClass String redis.logic.sharding.2g.8db.0rodb.8proxy.default

规格编码。可在帮助中心的搜索框中搜索规格编码,查看其对应的规格信息。

InstanceClassRemark String 16G集群版(Sharding)(QPS:2000000 Connections:80000)

实例规格描述。

SupportedNodeType String double

节点类型,返回值:

  • single:单副本。
  • double:双副本。
Version String 5.0

引擎版本。

ZoneId String cn-beijing-c

可用区ID。

ZoneName String 北京 可用区C

可用区名称。

RequestId String 128BD75D-A423-4235-B777-811429BB****

请求ID。

示例

请求示例

https://r-kvstore.aliyuncs.com?Action=DescribeAvailableResource
&RegionId=cn-beijing
&ZoneId=cn-beijing-c
&<公共请求参数>

正常返回示例

XML 格式

<DescribeAvailableResourceResponse>
      <RequestId>5094D428-5CC5-4494-A8B4-59BBBDED****</RequestId>
      <AvailableZones>
            <AvailableZone>
                  <ZoneName>北京 可用区C</ZoneName>
                  <ZoneId>cn-beijing-c</ZoneId>
                  <SupportedEngines>
                        <SupportedEngine>
                              <SupportedEditionTypes>
                                    <SupportedEditionType>
                                          <EditionType>Community</EditionType>
                                          <SupportedSeriesTypes>
                                                <SupportedSeriesType>
                                                      <SupportedEngineVersions>
                                                            <SupportedEngineVersion>
                                                                  <SupportedArchitectureTypes>
                                                                        <SupportedArchitectureType>
                                                                              <SupportedShardNumbers>
                                                                                    <SupportedShardNumber>
                                                                                          <ShardNumber>8</ShardNumber>
                                                                                          <SupportedNodeTypes>
                                                                                                <SupportedNodeType>
                                                                                                      <AvailableResources>
                                                                                                            <AvailableResource>
                                                                                                                  <InstanceClass>redis.logic.sharding.2g.8db.0rodb.8proxy.default</InstanceClass>
                                                                                                                  <InstanceClassRemark>16G集群版(Sharding)(QPS:2000000   Connections:80000)</InstanceClassRemark>
                                                                                                            </AvailableResource>
                                                                                                      </AvailableResources>
                                                                                                      <SupportedNodeType>double</SupportedNodeType>
                                                                                                </SupportedNodeType>
                                                                                          </SupportedNodeTypes>
                                                                                    </SupportedShardNumber>
                                                                              </SupportedShardNumbers>
                                                                              <Architecture>cluster</Architecture>
                                                                        </SupportedArchitectureType>
                                                                  </SupportedArchitectureTypes>
                                                                  <Version>5</Version>
                                                            </SupportedEngineVersion>
                                                      </SupportedEngineVersions>
                                                      <SeriesType>enhanced_performance_type</SeriesType>
                                                </SupportedSeriesType>
                                          </SupportedSeriesTypes>
                                    </SupportedEditionType>
                              </SupportedEditionTypes>
                              <Engine>redis</Engine>
                        </SupportedEngine>
                  </SupportedEngines>
            </AvailableZone>
      </AvailableZones>
</DescribeAvailableResourceResponse>

JSON 格式

{
    "RequestId": "5094D428-5CC5-4494-A8B4-59BBBDED****",
    "AvailableZones": {
        "AvailableZone": {
            "ZoneName": "北京 可用区C",
            "ZoneId": "cn-beijing-c",
            "SupportedEngines": {
                "SupportedEngine": {
                    "SupportedEditionTypes": {
                        "SupportedEditionType": {
                            "EditionType": "Community",
                            "SupportedSeriesTypes": {
                                "SupportedSeriesType": {
                                    "SupportedEngineVersions": {
                                        "SupportedEngineVersion": {
                                            "SupportedArchitectureTypes": {
                                                "SupportedArchitectureType": {
                                                    "SupportedShardNumbers": {
                                                        "SupportedShardNumber": {
                                                            "ShardNumber": 8,
                                                            "SupportedNodeTypes": {
                                                                "SupportedNodeType": {
                                                                    "AvailableResources": {
                                                                        "AvailableResource": {
                                                                            "InstanceClass": "redis.logic.sharding.2g.8db.0rodb.8proxy.default",
                                                                            "InstanceClassRemark": "16G集群版(Sharding)(QPS:2000000   Connections:80000)"
                                                                        }
                                                                    },
                                                                    "SupportedNodeType": "double"
                                                                }
                                                            }
                                                        }
                                                    },
                                                    "Architecture": "cluster"
                                                }
                                            },
                                            "Version": 5
                                        }
                                    },
                                    "SeriesType": "enhanced_performance_type"
                                }
                            }
                        }
                    },
                    "Engine": "redis"
                }
            }
        }
    }
}

错误码

访问错误中心查看更多错误码。