文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-配置管理/ 查询某个实例的租户配置列表
更新时间：2024-11-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询某个实例的租户配置列表

功能介绍

查询某个实例的租户配置列表，用户可以通过此接口查看各类型资源配置及使用情况。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

缺省值：0

limit

否

Integer

每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500

最小值：1

最大值：500

缺省值：20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

configs

Array of Config objects

配额列表
表5 Config

参数

参数类型

描述

config_id

String

配额编号

config_name

String

配额名称

config_value

String

配额值

当前实例所在租户该配额对应的数量

config_time

String

配额创建时间

remark

String

配额描述：

  • API_NUM_LIMIT：租户可以创建的API个数限制

  • APP_NUM_LIMIT：租户可以创建的APP个数限制

  • APIGROUP_NUM_LIMIT：租户可以创建的API分组个数限制

  • ENVIRONMENT_NUM_LIMIT：租户可以创建的环境个数限制

  • VARIABLE_NUM_LIMIT：每个API分组上可以创建的环境变量个数限制

  • SIGN_NUM_LIMIT：租户可以创建的签名密钥个数限制

  • THROTTLE_NUM_LIMIT：租户可以创建的流控策略个数限制

  • APIGROUP_DOMAIN_NUM_LIMIT：每个API分组上可以绑定的自定义域名个数限制

  • API_VERSION_NUM_LIMIT：每个API可以保留的发布版本个数限制

  • VPC_NUM_LIMIT：租户可以创建的VPC通道个数限制

  • VPC_INSTANCE_NUM_LIMIT：每个VPC通道上可以绑定的弹性云服务器个数限制

  • API_PARAM_NUM_LIMIT：每个API可以设置的参数个数限制

  • API_USER_CALL_LIMIT：每个租户的API单位时间内的请求默认限制

  • ACL_NUM_LIMIT：每个租户可以创建的ACL策略个数限制

  • APP_THROTTLE_LIMIT：特殊应用流控策略个数限制

  • USER_THROTTLE_LIMIT：特殊用户流控策略个数限制

  • API_NUM_LIMIT_PER_GROUP：租户每个API分组可以创建的API数量限制

  • API_POLICY_NUM_LIMIT：每个API可以设置的策略后端个数限制

  • API_CONDITION_NUM_LIMIT：每个API策略后端可以设置的条件个数限制

  • SL_DOMAIN_CALL_LIMIT：每个二级域名单位时间内的请求默认限制

  • ELB_SWITCH：是否启用ELB通道

  • AUTHORIZER_NUM_LIMIT：租户可创建的自定义认证个数限制

  • AUTHORIZER_IDENTITY_NUM_LIMIT：每个自定义认证可以设置的身份来源个数限制

  • APP_CODE_NUM_LIMIT：每个APP可以创建的APP code数量限制

  • REGION_MANAGER_WHITELIST_SERVICES：不校验region manager服务白名单列表，暂不支持

  • API_SWAGGER_NUM_LIMIT：单个API分组可以绑定的swagger文档数量限制

  • API_TAG_NUM_LIMIT：每个API可以设置的标签个数限制

  • LTS_SWITCH：是启用LTS上报

  • APP_KEY_SECRET_SWITCH：是否打开APP支持自定义KEY和SECRET的开关，1：开启；2：关闭

  • RESPONSE_NUM_LIMIT：分组自定义响应个数限制

  • CONFIG_NUM_LIMIT_PER_APP：每个APP可以设置的配置项个数限制

  • BACKEND_TOKEN_ALLOW_SWITCH：是否支持普通租户透传后端token，1：开启；2：关闭

  • APP_TOKEN_SWITCH：是否启用APPTOKEN

  • API_DESIGNER_SWITCH：是否启用api设计器，1：开启；2：关闭

  • APP_API_KEY_SWITCH：是否启用APP_API_KEY认证方式

  • APP_BASIC_SWITCH：是否启用APP_BASIC认证方式

  • APP_JWT_SWITCH：是否启用APP_JWT认证方式

  • APP_ROUTE_SWITCH：是否启用APP路由

  • PUBLIC_KEY_SWITCH：是否启用PUBLIK_KEY后端认证方式

  • APP_SECRET_SWITCH：是否启用APP_SECRET认证方式

  • CASCADE_SWITCH：是否启用级联网关

  • IS_INIT_API_PATH_HASH：是否执行过API PATH HASH刷新

used

Long

该实例对应配额已使用数量

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码： 200

OK

{
  "total" : 43,
  "size" : 2,
  "configs" : [ {
    "config_id" : "9",
    "config_name" : "API_VERSION_NUM_LIMIT",
    "config_value" : "10",
    "config_time" : "2019-02-12T19:42:19.914989Z",
    "remark" : "xxx",
    "used" : 0
  }, {
    "config_id" : "8",
    "config_name" : "APIGROUP_DOMAIN_NUM_LIMIT",
    "config_value" : "5",
    "config_time" : "2019-02-12T19:42:19.914989Z",
    "remark" : "xxx",
    "used" : 0
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}

状态码： 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 专享版-配置管理

相关文档