文档

DescribeAvailableResources - 获取可用资源信息

更新时间:

获取AnalyticDB PostgreSQL版的可用售卖资源。

接口说明

您在新建 AnalyticDB PostgreSQL 版实例时,可以通过该接口查询目标可用区下的实例售卖资源信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:DescribeAvailableResourcesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Regionstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看可用的地域 ID。
cn-hangzhou
ZoneIdstring

可用区 ID。

说明 您可以调用 DescribeRegions 接口查看可用的可用区 ID。
cn-hangzhou-h
ChargeTypestring

付费类型。取值说明:

  • Postpaid:按量付费。
  • Prepaid:包年包月。
PostPaid

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

61DC563C-F8E4-593A-8D27-CE**********
RegionIdstring

地域 ID。

cn-hangzhou
Resourcesobject []

售卖资源信息。

SupportedEnginesobject []

支持的引擎和规格信息。

SupportedEngineVersionstring

支持的引擎版本。

6.0
SupportedInstanceClassesobject []

支持的规格。

Descriptionstring

Segment 节点规格描述。

单segment节点2核配置,含16GB 内存
DisplayClassstring

Segment 规格信息。

2C16G
InstanceClassstring

Segment 规格信息。

2C16G
NodeCountobject

Segment 节点信息。

Stepstring

增加节点时的步长。

例如该参数取值为 4 时,则表示增加 Segment 节点时,增加的节点数量必须为 4 的倍数。

4
MinCountstring

Segment 节点的最小值。

4
MaxCountstring

Segment 节点的最大值。

256
StorageTypestring

存储类型。取值说明:

  • cloud_essd:ESSD 云盘。
  • cloud_efficiency:高效云盘。
  • oss:OSS。
cloud_essd
StorageSizeobject

Segment 存储容量。

Stepstring

Segment 存储扩容步长。

50
MinCountstring

Segment 最小存储容量。

50
MaxCountstring

Segment 最大存储容量。

1000
Categorystring

实例系列。取值说明:

  • HighAvailability:高可用版。
  • Basic:基础版
HighAvailability
Modestring

实例资源类型。取值说明:

  • ecs:存储弹性模式。
  • serverless:Serverless 模式。
ecs
ZoneIdstring

可用区 ID。

cn-hangzhou-h

示例

正常返回示例

JSON格式

{
  "RequestId": "61DC563C-F8E4-593A-8D27-CE**********",
  "RegionId": "cn-hangzhou",
  "Resources": [
    {
      "SupportedEngines": [
        {
          "SupportedEngineVersion": "6.0",
          "SupportedInstanceClasses": [
            {
              "Description": "单segment节点2核配置,含16GB 内存",
              "DisplayClass": "2C16G",
              "InstanceClass": "2C16G",
              "NodeCount": {
                "Step": "4",
                "MinCount": "4",
                "MaxCount": "256"
              },
              "StorageType": "cloud_essd",
              "StorageSize": {
                "Step": "50",
                "MinCount": "50",
                "MaxCount": "1000"
              },
              "Category": "HighAvailability"
            }
          ],
          "Mode": "ecs"
        }
      ],
      "ZoneId": "cn-hangzhou-h"
    }
  ]
}

错误码

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

  • 本页导读 (1)
文档反馈