文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 接口版本和规格/ 查询专属资源列表
更新时间：2023-11-21 GMT+08:00
查看PDF
分享

查询专属资源列表

功能介绍

查询用户创建的专属资源列表。

接口约束

该接口支持GeminiDB Cassandra数据库实例。

调试

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

URI

GET https://{Endpoint}/v3/{project_id}/dedicated-resources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置偏移量，表示从指定project ID下最新的专属资源创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。

  • 取值大于或等于0。
  • 不传该参数时，查询偏移量默认为0，表示从最新的创建时间对应的专属资源开始查询。

limit

否

Integer

查询专属资源个数上限值。

  • 取值范围：1~100。
  • 不传该参数时，默认查询前100条实例信息。

请求参数

无。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total_count

Integer

总记录数。

resources

Array of DedicatedResource objects

专属资源信息列表。
表4 DedicatedResource

参数

参数类型

描述

id

String

专属资源ID。

resource_name

String

专属资源的名称。

engine_name

String

接口名称。

availability_zone

String

可用区信息。

architecture

String

专属资源中计算主机的类型，目前类型取值有"X86"和"ARM"。

capacity

DedicatedResourceCapacity object

专属资源的容量信息。

status

String

专属资源的状态信息，包含以下状态。

  • NORMAL，可用。
  • BUILDING，建设中。
表5 DedicatedResourceCapacity

参数

参数类型

描述

vcpus

Integer

CPU核数。

ram

Integer

内存大小，单位GB。

volume

Integer

存储大小，单位GB

请求示例

URI样例 
GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/dedicated-resources?offset=0&limit=10

响应示例

状态码： 200

Success

{
  "total_count" : 2,
  "resources" : [ {
    "id" : "300acc71-eca9-4c6b-9a4e-0d25e20fe54c",
    "resource_name" : "nosql-dedicated-resource-1",
    "engine_name" : "cassandra",
    "availability_zone" : "az1,az2,az3",
    "architecture" : "X86",
    "capacity" : {
      "vcpus" : 192,
      "ram" : 1536,
      "volume" : 300000
    },
    "status" : "NORMAL"
  }, {
    "id" : "4c423cd8-551f-4b74-934f-8534e4a9bf2b",
    "resource_name" : "nosql-dedicated-resource-2",
    "engine_name" : "cassandra",
    "availability_zone" : "az1,az2,az3",
    "architecture" : "X86",
    "capacity" : {
      "vcpus" : 192,
      "ram" : 1536,
      "volume" : 300000
    },
    "status" : "BUILDING"
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 接口版本和规格

相关文档