文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API(推荐)/ 配额管理/ 设置租户基于企业项目的资源配额
更新时间:2024-09-11 GMT+08:00

设置租户基于企业项目的资源配额

功能介绍

设置指定企业项目的资源配额。

接口约束

该接口目前公测阶段,如需使用,请提交工单联系客服人员申请权限。

URI

POST /v3/{project_id}/quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

X-Language

String

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

取值范围:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

quota_list

Array of setQuota objects

配额详细信息。一次最多设置10个。

表4 setQuota

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID。

instance_quota

Integer

实例个数配额。取值范围:0~100000。

说明:

如果已经存在实例,应该大于已经存在的实例个数。

vcpus_quota

Integer

CPU核数配额。取值范围:0~2147483646。

说明:

如果已经存在实例,应该大于已经占用的CPU个数。

ram_quota

Integer

内存使用配额,单位为GB。取值范围:0~2147483646。

说明:

如果已经存在实例,应该大于已经占用的内存数。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

quota_list

Array of setQuota objects

已经设置的配额信息。

表6 setQuota

参数

参数类型

描述

enterprise_project_id

String

企业项目ID。

instance_quota

Integer

实例个数配额。

vcpus_quota

Integer

CPU核数配额。

ram_quota

Integer

内存使用配额,单位为GB。

请求示例

设置资源配额。

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas
{
  "quota_list" : [ {
    "enterprise_project_id" : "0",
    "instance_quota" : 20,
    "vcpus_quota" : 20,
    "ram_quota" : 40
  } ]
}

响应示例

状态码: 200

Success.

{
  "quota_list" : [ {
    "enterprise_project_id" : "0",
    "instance_quota" : 20,
    "vcpus_quota" : 20,
    "ram_quota" : 40
  } ]
}

状态码

请参见状态码

错误码

请参见错误码