更新时间:2025-07-29 GMT+08:00

查询专属资源池列表

功能介绍

获取专属资源池列表,包括用户开通的所有专属资源池信息。

URI

GET /v3/{project_id}/dedicated-resources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释

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

约束限制

必须为整数,不能为负数。

取值范围

≥0。

默认取值

0。

limit

Integer

参数解释

查询记录数。

约束限制

必须为整数,不能为负数。

取值范围

1-100。

默认取值

100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

resources

Array of DedicatedResource objects

参数解释

专属资源池信息。

total_count

Integer

参数解释

专属资源池数量。

取值范围

不涉及。

表5 DedicatedResource

参数

参数类型

描述

id

String

参数解释

专属资源池ID。

取值范围

不涉及。

resource_name

String

参数解释

专属资源池名称。

取值范围

不涉及。

engine_name

String

参数解释

数据库引擎名称。

取值范围

不涉及。

architecture

String

参数解释

CPU架构。

取值范围

不涉及。

status

String

参数解释

专属资源池状态。

取值范围

  • NORMAL:正常。

  • BUILDING:构建中。

  • EXTENDING:扩容中。

  • DELETED:已删除。

capacity

DedicatedResourceCapacity object

参数解释

专属资源池容量信息。

availability_zone

Array of strings

参数解释

专属资源池可用区信息。

取值范围

不涉及。

表6 DedicatedResourceCapacity

参数

参数类型

描述

ram

Integer

参数解释

内存大小,单位GB。

取值范围

不涉及。

volume

Long

参数解释

磁盘容量,单位GB。

取值范围

不涉及。

vcpus

Integer

参数解释

CPU核数。

取值范围

不涉及。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询专属资源池列表。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dedicated-resources

响应示例

状态码: 200

Success.

{
  "resources" : [ {
    "id" : "1d07f7ba-f140-46a7-b002-58ba22ee6ff3",
    "resource_name" : "testdcc",
    "engine_name" : "gaussdb-mysql",
    "architecture" : "ARM",
    "status" : "NORMAL",
    "capacity" : {
      "ram" : 256,
      "volume" : 10000000,
      "vcpus" : 64
    },
    "availability_zone" : [ "az1xahz" ]
  } ]
}

状态码

请参见状态码

错误码

请参见错误码