文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 实例管理/ 查询专属资源信息详情- ShowDedicatedResourceInfo
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询专属资源信息详情 - ShowDedicatedResourceInfo

功能介绍

查询专属资源信息详情。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:getDcc

    Read

    -

    -

    gaussdb:instance:list

    -

URI

GET /v3/{project_id}/dedicated-resource/{dedicated_resource_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

dedicated_resource_id

是

String

参数解释：

专属资源池ID。

获取方法参见查询专属资源池列表 - ListGaussMySqlDedicatedResources。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释：

专属资源池ID。

取值范围：

不涉及。

resource_name

String

参数解释：

专属资源池名称。

取值范围：

不涉及。

engine_name

String

参数解释：

数据库引擎名称。

取值范围：

不涉及。

availability_zone_ids

Array of strings

参数解释：

可用区列表。

architecture

String

参数解释：

资源规格类型。

取值范围：

不涉及。

status

String

参数解释：

专属资源池状态。

取值范围：

  • NORMAL: 专属资源池状态正常。

  • BUILDING: 专属资源池创建中。

  • DELETED: 专属资源池已删除。

dedicated_compute_info

DedicatedComputeInfo object

参数解释：

计算资源信息。

dedicated_storage_info

DedicatedStorageInfo object

参数解释：

存储资源信息。
表4 DedicatedComputeInfo

参数

参数类型

描述

vcpus_total

Integer

参数解释：

专属资源池中CPU总数。

取值范围：

不涉及。

vcpus_used

Integer

参数解释：

专属资源池已使用的CPU数。

取值范围：

不涉及。

ram_total

Integer

参数解释：

专属资源池计算内存大小, 单位GB。

取值范围：

不涉及。

ram_used

Integer

参数解释：

专属资源池已使用的计算内存大小，单位GB。

取值范围：

不涉及。

spec_code

String

参数解释：

专属资源池计算资源规格码。

取值范围：

不涉及。

host_num

Integer

参数解释：

专属资源池计算主机数量。

取值范围：

不涉及。
表5 DedicatedStorageInfo

参数

参数类型

描述

spec_code

String

参数解释：

专属资源池存储资源规格码。

取值范围：

不涉及。

host_num

Integer

参数解释：

专属资源池存储主机数量。

取值范围：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询专属资源信息详情。

GET https://{endpoint}/v3/058497e1c100d3eb2f3cc01160616934/dedicated-resource/6e097c33-d6b9-4ca5-83cb-6cc79dcf4f06

响应示例

状态码： 200

Success.

{
  "id" : "e097c33-d6b9-4ca5-83cb-6cc79dcf4f06",
  "resource_name" : "test_dcc",
  "engine_name" : "taurus",
  "availability_zone_ids" : [ "az1xahz", "az2xahz" ],
  "architecture" : "ARM",
  "status" : "normal",
  "dedicated_compute_info" : {
    "vcpus_total" : 128,
    "vcpus_used" : 64,
    "ram_total" : 512,
    "ram_used" : 256,
    "spec_code" : "gaussdb.mysql.c6.host",
    "host_num" : 1
  },
  "dedicated_storage_info" : {
    "spec_code" : "gaussdb.mysql.dfvpool.30tb.host",
    "host_num" : 1
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理