文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 实例管理/ 查询实例可变更规格 - QueryingInstanceSpecificationsThatCanBeChanged
更新时间:2026-05-28 GMT+08:00
分享

查询实例可变更规格 - QueryingInstanceSpecificationsThatCanBeChanged

功能介绍

查询实例可变更规格。

接口约束

该接口支持如下数据库实例:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

调试

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:listFlavors

    List

    -

    -

    nosql:instance:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/available-flavors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一region下的project ID。获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释

索引位置,偏移量,表示从第一条数据偏移offset条数据后开始查询。

约束限制

不涉及。

取值范围

取值大于或等于0。

默认取值

0。

limit

Integer

参数解释

查询个数上限值。

约束限制

不涉及。

取值范围

  • 取值范围:1~100。
  • 不传该参数时,默认查询前100条信息。

默认取值

100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

instance_id

String

参数解释

实例id。

取值范围

不涉及。

instance_name

String

参数解释

实例名称。

取值范围

不涉及。

current_flavor

ComputeFlavor object

参数解释

实例当前规格信息。

取值范围

不涉及。

optional_flavors

OptionalFlavorsInfo object

参数解释

实例规格变更时可用的规格列表信息。

取值范围

不涉及。

表5 ComputeFlavor

参数

参数类型

描述

vcpus

String

参数解释

cpu核数。

取值范围

不涉及。

ram

String

参数解释

内存大小,单位为GB。

取值范围

不涉及。

spec_code

String

参数解释

规格码。

取值范围

不涉及。

az_status

Map<String,String>

参数解释

可用区状态。

取值范围

  • normal:表示正常商用。
  • abandon:表示下线。
  • sellout:表示售罄。

region_status

String

参数解释

Region状态。

取值范围

  • normal:表示正常商用。
  • abandon:表示下线。
  • sellout:表示售罄。
说明:

该参数已弃用,不再生效,请忽略并停止使用。

表6 OptionalFlavorsInfo

参数

参数类型

描述

list

Array of ComputeFlavor object

参数解释

实例规格变更时可用的规格列表。

取值范围

不涉及。

total_count

Integer

参数解释

总记录数。

取值范围

不涉及。

请求示例

URI样例
GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/094424666ef04f79a2dfbe9f5b8b31a5in06/available-flavors

响应示例

状态码: 200

Success.
{ 
  "instance_id" : "094424666ef04f79a2dfbe9f5b8b31a5in06", 
  "instance_name" : "geminidb_instance_noreuse_0_ZKv2FSkxgoc3F8bGzsaxNg", 
  "current_flavor" : { 
    "vcpus" : "4", 
    "ram" : "16", 
    "spec_code" : "geminidb.cassandra.xlarge.4", 
    "az_status" : { 
      "az2***" : "unknown", 
      "az1***" : "normal", 
      "az3***" : "unknown" 
    }, 
    "region_status" : null 
  }, 
  "optional_flavors" : {
    "list" : [ { 
      "vcpus" : "2", 
      "ram" : "8", 
      "spec_code" : "geminidb.cassandra.large.4", 
      "az_status" : { 
        "az2***" : "unknown", 
        "az1***" : "normal", 
        "az4***" : "normal", 
        "az3***" : "unknown" 
      }, 
      "region_status" : "normal" 
    }, { 
      "vcpus" : "8", 
      "ram" : "32", 
      "spec_code" : "geminidb.cassandra.2xlarge.4", 
      "az_status" : { 
        "az2***" : "unknown", 
        "az1***" : "normal", 
        "az3***" : "unknown" 
      }, 
      "region_status" : "normal" 
    }, { 
      "vcpus" : "16", 
      "ram" : "64", 
      "spec_code" : "geminidb.cassandra.4xlarge.4", 
      "az_status" : { 
        "az2***" : "unknown", 
        "az1***" : "normal", 
        "az3***" : "unknown" 
      }, 
      "region_status" : "normal" 
    }, { 
      "vcpus" : "32", 
      "ram" : "128", 
      "spec_code" : "geminidb.cassandra.8xlarge.4", 
      "az_status" : { 
        "az2***" : "unknown", 
        "az1***" : "normal", 
        "az3***" : "unknown" 
      }, 
      "region_status" : "normal" 
    } ], 
    "total_count": 4
  }
}

状态码

请参见状态码

错误码

请参见错误码

相关文档