文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-凭据配额管理/ 查询凭据配额可绑定的凭据列表 - ListAppQuotaBindableApps
更新时间：2025-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询凭据配额可绑定的凭据列表 - ListAppQuotaBindableApps

功能介绍

查询凭据配额可绑定的凭据列表。支持按凭据名称模糊搜索

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    apig:clientQuota:listUnboundApp

    List

    instance *

    g:ResourceTag/<tag-key>

    -
    • apig:instance:get
    • apig:clientQuota:get

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}/bindable-apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

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

app_quota_id

是

String

凭据配额编号
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

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

缺省值：0

limit

否

Integer

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

最小值：1

最大值：500

缺省值：20

app_name

否

String

应用名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

apps

Array of AppQuotaAppInfo objects

凭据列表
表5 AppQuotaAppInfo

参数

参数类型

描述

app_id

String

APP凭据编号。

name

String

APP凭据名称。

status

Integer

凭据状态：

  • 1：启用

  • 2：禁用

app_key

String

APP凭据的key。

remark

String

APP凭据描述。

register_time

String

创建时间

update_time

String

更新时间

app_quota_id

String

APP凭据配额编号。

app_quota_name

String

配额名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3-255字符

bound_time

String

绑定时间

状态码：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" : 1,
  "size" : 1,
  "apps" : [ {
    "app_id" : "ac18a23f-8f06-40ac-8093-f790de2ba95b",
    "app_key" : "ac18a23f-8f06-40ac-8093-f790de2ba95b",
    "bound_time" : "0001-01-01T00:00:00Z",
    "name" : "app-test",
    "register_time" : "2020-08-22T07:57:01Z",
    "status" : 1,
    "update_time" : "2020-08-22T07:57:01Z"
  } ]
}

状态码：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.3093",
  "error_msg" : "The App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist"
}

状态码：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

错误码

请参见错误码。

相关文档