API网关 APIGAPI网关 APIG

更新时间:2021/06/18 GMT+08:00
分享

查询租户实例配置列表

功能介绍

查询租户实例配置列表

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目编号

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

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

缺省值:0

limit

Integer

每页显示的条目数量

最小值: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 InstanceConfig objects

配额列表

表5 InstanceConfig

参数

参数类型

描述

config_id

String

配额编号

config_name

String

配额名称

枚举值:

  • INSTANCE_NUM_LIMIT

config_value

String

配额值

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

config_time

String

配额创建时间

remark

String

配额描述

  • INSTANCE_NUM_LIMIT:租户可以创建的实例个数限制

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码: 200

OK

{
  "total" : 1,
  "size" : 1,
  "configs" : [ {
    "config_id" : "1",
    "config_name" : "INSTANCE_NUM_LIMIT",
    "config_value" : "5",
    "config_time" : 1597981093255,
    "remark" : "xxx"
  } ]
}

状态码: 401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

状态码: 500

Internal Server Error

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品