更新时间:2023-11-21 GMT+08:00

查询租户配额

功能介绍

查询资源的配额相关信息。

约束与限制

URI

  • URI格式

    GET /v1/{project_id}/sdrs/quotas

  • 参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID。

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

请求消息

  • 请求参数

  • 请求样例

    GET https://{Endpoint}/v1/{project_id}/sdrs/quotas

响应

  • 要素说明

    参数名称

    参数类型

    说明

    quotas

    Object

    租户配额信息。

    详情请参见表1

    表1 quotas字段说明

    参数名称

    参数类型

    说明

    resources

    Array of objects

    租户资源配额信息列表。

    详情请参见表2

    表2 resources字段说明

    参数名称

    参数类型

    说明

    type

    String

    资源类型

    • server_groups:表示保护组资源类型。
    • replications:表示复制对资源类型。

    used

    Integer

    已经使用的资源个数。

    quota

    Integer

    资源配额。

    -1:表示无穷大。

    min

    Integer

    设置该资源配额允许的最小值。

    max

    Integer

    设置该资源配额允许的最大值。

    -1:表示无穷大。

  • 响应样例
    {
        "quotas": {
            "resources": [
                {
                    "type": "server_groups",
                    "used": 10,
                    "quota": 50,
                    "min": 0,
                    "max": -1
                },
                {
                    "type": "replications",
                    "used": 1,
                    "quota": 100,
                    "min": 0,
                    "max": -1
                }
            ]
        }
    }

    { 
         "error": { 
             "message": "XXXX",  
             "code": "XXX" 
         } 
     }

    其中error是泛指的错误,有badrequest、itemNotFound等,如报错为:

    { 
         "badrequest": { 
             "message": "XXXX",  
             "code": "XXX" 
         } 
     }

返回值

  • 正常

    返回值

    说明

    200

    服务器已接受请求。

  • 异常

    返回值

    说明

    400 Bad Request

    服务器未能处理请求。

    401 Unauthorized

    被请求的页面需要用户名和密码。

    403 Forbidden

    对被请求页面的访问被禁止。

    404 Not Found

    服务器无法找到被请求的页面。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    406 Not Acceptable

    服务器生成的响应无法被客户端所接受。

    407 Proxy Authentication Required

    用户必须首先使用代理服务器进行验证,这样请求才会被处理。

    408 Request Timeout

    请求超出了服务器的等待时间。

    409 Conflict

    由于冲突,请求无法被完成。

    500 Internal Server Error

    请求未完成。服务异常。

    501 Not Implemented

    请求未完成。服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成。服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成。系统暂时异常。

    504 Gateway Timeout

    网关超时。