文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-API绑定流控策略/ 查看流控策略未绑定的API列表
更新时间：2024-11-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查看流控策略未绑定的API列表

功能介绍

查询所有未绑定到该流控策略上的自有API列表。需要API已经发布，未发布的API不予展示。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/unbinded-apis

表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

throttle_id

是

String

流控策略编号

env_id

否

String

环境的ID

group_id

否

String

API分组编号

api_id

否

String

API编号

api_name

否

String

API名称

tags

否

String

API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。

最小长度：0

最大长度：128

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

apis

Array of ApiForThrottle objects

本次查询返回的API列表
表5 ApiForThrottle

参数

参数类型

描述

auth_type

String

API的认证方式

group_name

String

API所属分组的名称

publish_id

String

API的发布记录编号

throttle_apply_id

String

与流控策略的绑定关系编号

apply_time

String

已绑定的流控策略的绑定时间

remark

String

API描述

run_env_id

String

发布的环境id

type

Integer

API类型

throttle_name

String

绑定的流控策略名称

req_uri

String

API的访问地址

run_env_name

String

发布的环境名

group_id

String

API所属分组的编号

name

String

API名称

id

String

API编号

req_method

String

API请求方法

tags

Array of strings

API绑定的标签，标签配额默认10条，可以联系技术调整。

最小长度：1

最大长度：128

数组长度：0 - 10

状态码： 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" : 2,
  "size" : 2,
  "apis" : [ {
    "run_env_name" : "RELEASE",
    "group_name" : "api_group_001",
    "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d",
    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "name" : "Api_mock",
    "remark" : "Mock backend API",
    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "id" : "3a955b791bd24b1c9cd94c745f8d1aad",
    "type" : 1,
    "auth_type" : "IAM",
    "req_uri" : "/test/mock"
  }, {
    "run_env_name" : "RELEASE",
    "group_name" : "APIGroup_d00511069",
    "publish_id" : "0c613568c8644a1b92172156f77a5759",
    "group_id" : "d7d0b9a54469424f942e16a6b6026936",
    "name" : "API_nevj",
    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "id" : "9e07bc00a1864ab4aafd4a23d19dd1c2",
    "type" : 1,
    "auth_type" : "APP",
    "req_uri" : "/fdasf"
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:throttle_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.3005",
  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 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

错误码

请参见错误码。