跳转到正文
皓量云擎文档
接口参考系统与健康检查

查看平台租户配额汇总

GET /api/admin/v1/quotas/summary,getQuotaSummary 的请求参数和响应结构。

GET /api/admin/v1/quotas/summary

项目内容
操作标识getQuotaSummary
认证登录会话 Cookie

需要平台 quota.read 权限。汇总全部租户(含已暂停租户)的配额上限,不代表平台物理容量或实际运行用量。

响应

HTTP 状态含义
200成功
400参数错误
401登录无效或已撤销
403权限、范围或 CSRF 校验失败
404记录不存在
409引用或唯一性冲突
429请求过于频繁
503数据库未配置或不可用
200 · application/json 响应结构
字段类型必填说明与约束
dataIAMQuotaSummary是各项 -1 表示不限制,0 表示禁止分配,正整数表示上限。汇总中任一租户该项不限制时,合计为 -1。
request_idstring是—
{
  "$ref": "#/$defs/IAMQuotaSummaryResponse",
  "$defs": {
    "IAMQuotaSummaryResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "data": {
          "$ref": "#/$defs/IAMQuotaSummary"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "data",
        "request_id"
      ]
    },
    "IAMQuotaSummary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "instances": {
          "type": "integer",
          "format": "int64",
          "minimum": -1,
          "description": "-1 表示不限制;0 表示禁止分配。"
        },
        "vcpu": {
          "type": "integer",
          "format": "int64",
          "minimum": -1,
          "description": "-1 表示不限制;0 表示禁止分配。"
        },
        "memory": {
          "type": "integer",
          "format": "int64",
          "minimum": -1,
          "description": "-1 表示不限制;0 表示禁止分配。"
        },
        "storage": {
          "type": "integer",
          "format": "int64",
          "minimum": -1,
          "description": "-1 表示不限制;0 表示禁止分配。"
        },
        "public_ips": {
          "type": "integer",
          "format": "int64",
          "minimum": -1,
          "description": "-1 表示不限制;0 表示禁止分配。"
        },
        "tenant_count": {
          "type": "integer",
          "format": "int64",
          "minimum": 0
        },
        "baremetal_nodes": {
          "type": "integer",
          "minimum": -1,
          "description": "-1 为不限制,0 为禁止分配;内存单位 GiB"
        },
        "baremetal_vcpu": {
          "type": "integer",
          "minimum": -1,
          "description": "-1 为不限制,0 为禁止分配;内存单位 GiB"
        },
        "baremetal_memory": {
          "type": "integer",
          "minimum": -1,
          "description": "-1 为不限制,0 为禁止分配;内存单位 GiB"
        }
      },
      "required": [
        "instances",
        "vcpu",
        "memory",
        "storage",
        "public_ips",
        "tenant_count"
      ],
      "description": "各项 -1 表示不限制,0 表示禁止分配,正整数表示上限。汇总中任一租户该项不限制时,合计为 -1。"
    }
  }
}
400 / 401 / 403 / 404 / 409 / 429 / 503 · application/json 响应结构
{
  "$ref": "#/$defs/ErrorResponse",
  "$defs": {
    "ErrorResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "error": {
          "$ref": "#/$defs/ErrorDetail"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "error",
        "request_id"
      ]
    },
    "ErrorDetail": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "NOT_IMPLEMENTED",
            "NOT_FOUND",
            "AUTH_REQUIRED",
            "FORBIDDEN",
            "VALIDATION_FAILED",
            "CONFLICT",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR",
            "RATE_LIMITED"
          ]
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "code",
        "message",
        "retryable"
      ]
    }
  }
}

响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。

本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。

本页目录