更新时间:2024-09-11 GMT+08:00

查询专属资源池列表

功能介绍

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

URI

GET /v3/{project_id}/dedicated-resources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

limit

Integer

查询记录数。默认为100,不能为负数,最小值为1,最大值为100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us
  • zh-cn

响应参数

状态码: 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:已删除。

枚举值:

  • 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" ]
  } ]
}

状态码

请参见状态码

错误码

请参见错误码