文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 配额管理/ 查询租户的实例配额
更新时间：2024-05-31 GMT+08:00
查看PDF
分享

查询租户的实例配额

功能介绍

获取指定租户的资源配额。

该接口计划于2025-03-31下线，建议及时切换到新接口查询租户的实例配额。

调试

您可以在API Explorer中调试该接口。

URI

GET /mysql/v3/{project_id}/project-quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

type

否

String

根据type过滤查询指定类型的配额。

取值范围：instance

枚举值：instance

请求参数

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

参数

参数类型

描述

quotas

project-quotas object

租户实例配额信息。
表5 project-quotas

参数

参数类型

描述

resources

Array of resource objects

资源列表对象。
表6 resource

参数

参数类型

描述

mode

String

资源类型。

  • cluster: 表示主备版实例的配额

枚举值：

  • cluster

type

String

指定类型的配额。

  • instance: 表示实例的配额

枚举值：

  • instance

used

Integer

已创建的资源个数。

quota

Integer

资源最大的配额数。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

GET https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/quotas?type=instance

响应示例

状态码： 200

Success.

{
  "quotas" : {
    "resources" : [ {
      "type" : "instance",
      "used" : "4",
      "quota" : 50,
      "mode" : "cluster"
    } ]
  }
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 配额管理

相关文档