文档首页/ 云数据库 TaurusDB/ API参考/ API/ 实例管理/ 查询实例存储空间信息 - ShowInstanceStorageInfo
更新时间:2026-11-10 GMT+08:00
分享

查询实例存储空间信息 - ShowInstanceStorageInfo

功能介绍

查询指定实例的存储空间信息。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:get

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/storage

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

租户在某一Region下的project ID。

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID,此参数是实例的唯一标识。

获取方法请参见查询实例列表。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值:

不涉及。

请求参数

表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参数

参数

参数类型

描述

used

Double

参数解释:

已使用存储空间大小,单位是GB。

取值范围:

大于等于0。

prepaid_size

Double

参数解释:

包年/包月购买的存储空间大小,单位是GB。

取值范围:

大于0。

limit

Double

参数解释:

实例可使用的存储空间上限,单位是GB。

取值范围:

大于0。

type

String

参数解释:

存储类型。

取值范围:

  • POOL:DL6存储类型。

  • STANDARDPOOL:DL5存储类型。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询指定实例的存储空间信息。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/storage

响应示例

状态码:200

{
  "used" : 40.5,
  "prepaid_size" : 100.0,
  "limit" : 128000.0,
  "type" : "POOL"
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

相关文档