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

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

功能介绍

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

接口约束

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

调用方法

请参见如何调用API

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

资源列表对象。

表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

实例个数配额。取值范围0~100000。(如果已经存在实例,应该大于已经存在的实例个数)

vcpus_quota

Integer

CPU核数配额。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的cpu个数)

ram_quota

Integer

内存使用配额,单位为GB。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的内存数)

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

设置资源配额。

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

SDK代码示例

SDK代码示例如下。

设置资源配额。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class SetGaussMySqlQuotasSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        SetGaussMySqlQuotasRequest request = new SetGaussMySqlQuotasRequest();
        SetQuotasRequestBody body = new SetQuotasRequestBody();
        List<SetQuota> listbodyQuotaList = new ArrayList<>();
        listbodyQuotaList.add(
            new SetQuota()
                .withEnterpriseProjectId("0")
                .withInstanceQuota(20)
                .withVcpusQuota(20)
                .withRamQuota(40)
        );
        body.withQuotaList(listbodyQuotaList);
        request.withBody(body);
        try {
            SetGaussMySqlQuotasResponse response = client.setGaussMySqlQuotas(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

设置资源配额。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SetGaussMySqlQuotasRequest()
        listQuotaListbody = [
            SetQuota(
                enterprise_project_id="0",
                instance_quota=20,
                vcpus_quota=20,
                ram_quota=40
            )
        ]
        request.body = SetQuotasRequestBody(
            quota_list=listQuotaListbody
        )
        response = client.set_gauss_my_sql_quotas(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

设置资源配额。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SetGaussMySqlQuotasRequest{}
	instanceQuotaQuotaList:= int32(20)
	vcpusQuotaQuotaList:= int32(20)
	ramQuotaQuotaList:= int32(40)
	var listQuotaListbody = []model.SetQuota{
        {
            EnterpriseProjectId: "0",
            InstanceQuota: &instanceQuotaQuotaList,
            VcpusQuota: &vcpusQuotaQuotaList,
            RamQuota: &ramQuotaQuotaList,
        },
    }
	request.Body = &model.SetQuotasRequestBody{
		QuotaList: listQuotaListbody,
	}
	response, err := client.SetGaussMySqlQuotas(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档