调用DescribeAvailableResource接口查询某地域可售卖资源信息。

说明 1分钟内最多调用20次本接口。

调试

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

请求参数

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

系统规定参数,取值:DescribeAvailableResource

InstanceChargeType String Postpaid

付费类型,取值:

  • Prepaid:包年包月
  • Postpaid:按量付费
RegionId String cn-hangzhou

地域ID,可以通过接口DescribeRegions查看可用的地域ID。

ZoneId String cn-hangzhou-b

可用区ID。多可用区用英文冒号(:)分隔。

Engine String MySQL

数据库类型,取值:

  • MySQL
  • SQLServer
  • PostgreSQL
  • PPAS
  • MariaDB
EngineVersion String 5.7

数据库版本,取值:

  • MySQL:5.5/5.6/5.7/8.0
  • SQL Server:2008r2/2012/2012_ent_ha/2012_std_ha/2012_web/2014_std_ha/2016_ent_ha/2016_std_ha/2016_web/2017_ent
  • PostgreSQL:9.4/10.0
  • PPAS:9.3/10.0
  • MariaDB:10.3
DBInstanceClass String rds.mysql.s1.small

实例规格,详情请参见实例规格表

OrderType String BUY

订单类型。仅唯一取值:BUY

DBInstanceStorageType String local_ssd

实例储存类型,取值:

  • local_ssd/ephemeral_ssd:本地SSD盘
  • cloud_ssd:SSD云盘
  • cloud_essd:ESSD云盘

返回数据

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

支持售卖资源的可用区列表。

AvailableZone
RegionId String cn-hangzhou

地域ID。

Status String Enable

当前地域是否可以售卖资源。取值:

  • Enable:可售卖
  • Disable:不可售卖
SupportedEngines Array of SupportedEngine

支持售卖的数据库类型列表。

SupportedEngine
Engine String MySQL

数据库类型。

SupportedEngineVersions Array of SupportedEngineVersion

支持售卖的数据库版本列表。

SupportedEngineVersion
SupportedCategorys Array of SupportedCategory

支持售卖的系列列表。

SupportedCategory
Category String HighAvailability

实例系列。

SupportedStorageTypes Array of SupportedStorageType

支持售卖的存储类型列表。

SupportedStorageType
AvailableResources Array of AvailableResource

可售卖的资源列表。

AvailableResource
DBInstanceClass String rds.mysql.s1.small

实例规格。

DBInstanceStorageRange Struct

可售卖的存储空间范围列表。

Max Integer 2000

可售卖的存储空间最大值。单位:GB。

Min Integer 5

可售卖的存储空间最小值。单位:GB。

Step Integer 5

存储空间的递增大小。单位:GB。

StorageRange String "{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}"

可售卖的存储空间的规格。包括最大值、最小值和递增大小。

StorageType String local_ssd

存储类型。

Version String 5.7

数据库版本。

ZoneId String cn-hangzhou-b

可用区ID。

RequestId String A32E046E-2643-4B65-828D-23FEED4853A3

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeAvailableResource
&InstanceChargeType=Postpaid
&<公共请求参数>

正常返回示例

XML 格式

<DescribeAvailableResourceResponse>
  <RequestId>A32E046E-2643-4B65-828D-23FEED4853A3</RequestId>
	  <AvailableZones>
		    <AvailableZone>
			      <Status>Enable</Status>
			      <RegionId>cn-hangzhou</RegionId>
			      <ZoneId>cn-hangzhou-b</ZoneId>
			      <SupportedEngines>
				        <SupportedEngine>
					          <SupportedEngineVersions>
						            <SupportedEngineVersion>
							              <Version>5.6</Version>
							              <SupportedCategorys>
								                <SupportedCategory>
									                  <Category>HighAvailability</Category>
									                  <SupportedStorageTypes>
										                    <SupportedStorageType>
											                      <AvailableResources>
												                        <AvailableResource>
													                          <StorageRange>{"values":[{"max":2000,"min":5,"step":5}]}</StorageRange>
													                          <DBInstanceClass>rds.mysql.s1.small</DBInstanceClass>
													                          <DBInstanceStorageRange>
														                            <Step>5</Step>
														                            <Max>2000</Max>
														                            <Min>5</Min>
													                          </DBInstanceStorageRange>
												                        </AvailableResource>
											                      </AvailableResources>
											                      <StorageType>local_ssd</StorageType>
										                    </SupportedStorageType>
									                  </SupportedStorageTypes>
								                </SupportedCategory>
							              </SupportedCategorys>
						            </SupportedEngineVersion>
					          </SupportedEngineVersions>
					          <Engine>MySQL</Engine>
				        </SupportedEngine>
			      </SupportedEngines>
		    </AvailableZone>
	  </AvailableZones>
</DescribeAvailableResourceResponse>

JSON 格式

{
	"RequestId": "A32E046E-2643-4B65-828D-23FEED4853A3",
	"AvailableZones": {
		"AvailableZone": [
			{
				"Status": "Enable",
				"RegionId": "cn-hangzhou",
				"ZoneId": "cn-hangzhou-b",
				"SupportedEngines": {
					"SupportedEngine": [
						{
							"SupportedEngineVersions": {
								"SupportedEngineVersion": [
									{
										"Version": "5.6",
										"SupportedCategorys": {
											"SupportedCategory": [
												{
													"Category": "HighAvailability",
													"SupportedStorageTypes": {
														"SupportedStorageType": [
															{
																"AvailableResources": {
																	"AvailableResource": [
																		{
																			"StorageRange": "{\"values\":[{\"max\":2000,\"min\":5,\"step\":5}]}",
																			"DBInstanceClass": "rds.mysql.s1.small",
																			"DBInstanceStorageRange": {
																				"Step": 5,
																				"Max": 2000,
																				"Min": 5
																			}
																		}
																	]
																},
																"StorageType": "local_ssd"
															}
														]
													}
												}
											]
										}
									}
								]
							},
							"Engine": "MySQL"
						}
					]
				}
			}
		]
	}
}

错误码

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