更新时间:2023-12-12 GMT+08:00
分享

查询配额

功能介绍

查询当前租户的配额,未特殊配置过的会返回默认配额。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

type

String

指定查询资源类型的配额

枚举值:

  • CHANNEL

  • CHANNEL_SUBSCRIPTION

  • SOURCE

  • SUBSCRIPTION

  • SUBSCRIPTION_TARGET

  • SCHEMA

  • SCHEMA_VERSION

  • CONNECTION

  • PRIVATE_ENDPOINT

  • SOURCE_RABBITMQ

  • SOURCE_ROCKETMQ

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:16384

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

quotas

QuotaResourceResp object

配额描述

表5 QuotaResourceResp

参数

参数类型

描述

resources

Array of QuotaItemInfo objects

错误描述

表6 QuotaItemInfo

参数

参数类型

描述

name

String

名称

type

String

配额类型

枚举值:

  • CHANNEL

  • CHANNEL_SUBSCRIPTION

  • SOURCE

  • SUBSCRIPTION

  • SUBSCRIPTION_TARGET

  • SCHEMA

  • SCHEMA_VERSION

  • CONNECTION

  • PRIVATE_ENDPOINT

  • SOURCE_RABBITMQ

  • SOURCE_ROCKETMQ

max

Integer

配额最大值

min

Integer

配额最小值

quota

Integer

当前租户的配额

used

Integer

当前租户已使用的配额

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

请求示例

响应示例

状态码: 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

状态码: 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

状态码: 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

状态码: 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

配额

400

非法请求

401

未授权

403

禁止访问

404

未找到资源

500

内部服务错误

错误码

请参见错误码

分享:

    相关文档

    相关产品