文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 实例管理/ 查询DDM可用区规格信息V3
更新时间：2024-11-05 GMT+08:00
查看PDF
分享

查询DDM可用区规格信息V3

功能介绍

查询DDM可用区规格信息详情V3接口。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

  • URL格式

GET /v3/{project_id}/flavors?engine_id={engine_id}&offset={offset}&limit={limit}&engine_version={engine_version}&available_zones={available_zones}

  • 参数说明
表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

engine_id

否

String

引擎ID,通过查询DDM引擎信息接口获取，引擎ID与引擎版本至少指定一个。

engine_version

否

String

引擎版本,通过查询DDM引擎信息接口获取，引擎ID与引擎版本至少指定一个。

available_zones

否

String

可用区，多个用","分割，如cn-southwest-244a,cn-southwest-244b。取值非空，请参见地区和终端节点。

offset

否

Integer

索引位置，偏移量。

从第一条数据偏移offset条数据后开始查询，默认为0。

取值必须为数字，且不能为负数。

limit

否

Integer

查询个数上限值。

取值范围：1~128。

不传该参数时，默认值为10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务的“获取用户Token”接口来获取。

请求示例

查询可用区规格信息。

GET https://{endpoint}/v3/{project_id}/flavors?engine_id=xxxxxx-xxxx-xxxx-f7ab-100f2cd33008&engine_version=3.x.x.x&available_zones=cn-north-1a,cn-north-1b&offset=0&limit=10

响应消息

  • 正常响应参数说明
表4 响应Body参数

参数

参数类型

描述

flavor_groups

Array of FlavorGroupInfo objects

引擎信息列表。
表5 FlavorGroupInfo

参数

参数类型

描述

flavors

Array of Flavor objects

引擎ID。

group_type

String

计算资源架构类型，目前分X86和ARM两种。

offset

Integer

分页参数: 起始值。

limit

Integer

分页参数：每页多少条。

total

Integer

引擎信息总数。
表6 Flavor

参数

参数类型

描述

az_infos

Array of AvailableZone objects

可用区信息。

normal：在售。

unsupported：暂不支持该规格。

sellout：售罄。

id

String

规格ID。

spec_code

String

资源规格编码。

vcpus

String

CPU大小。例如：1表示1U。

ram

String

内存大小，单位:GB。
表7 AvailableZone

参数

参数类型

描述

code

String

可用区CODE。

description

String

可用区描述。

status

String

可用区状态。

support_ipv6

Boolean

是否支持IPV6。
  • 正常响应示例
{
  "flavor_groups": [
    {
      "offset": 0,
      "limit": 1,
      "total": 4,
      "group_type": "X86",
      "flavors": [
        {
          "id": "xxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
          "spec_code": "ddm.c6.xlarge.2",
          "vcpus": "4",
          "ram": "8",
          "az_infos": [
            {
              "code": "cn-north-7a",
              "status": "normal",
              "description": "可用区1",
              "support_ipv6": true
            }
          ]
        }
      ]
    },
    {
      "offset": 0,
      "limit": 1,
      "total": 5,
      "group_type": "ARM",
      "flavors": [
        {
          "id": "xxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
          "spec_code": "ddm.kc1.large.2",
          "vcpus": "2",
          "ram": "4",
          "az_infos": [
            {
              "code": "cn-north-7a",
              "status": "normal",
              "description": "可用区1",
              "support_ipv6": true
            }
          ]
        }
      ]
    }
  ]
}

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档