文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 服务集成API/ API绑定流控策略/ 查看流控策略绑定的API列表
更新时间：2024-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

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

功能介绍

查询某个流控策略上已经绑定的API列表。

调试

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

URI

GET /v2/{project_id}/apic/instances/{instance_id}/throttle-bindings/binded-apis

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

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

缺省值：0

limit

否

Integer

每页显示的条目数量

最小值：1

最大值：500

缺省值：20

throttle_id

是

String

流控策略编号

env_id

否

String

环境的ID

group_id

否

String

API分组编号

api_id

否

String

API编号

api_name

否

String

API名称

请求参数

表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的认证方式

run_env_name

String

发布的环境名

group_name

String

API所属分组的名称

publish_id

String

发布记录的编号

group_id

String

API所属分组的编号

name

String

API名称

remark

String

API描述

run_env_id

String

发布的环境ID

id

String

API编号

req_uri

String

API的请求地址

type

Integer

API类型

throttle_apply_id

String

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

throttle_name

String

绑定的流控策略名称

apply_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,
  "apis" : [ {
    "run_env_name" : "RELEASE",
    "group_name" : "api_group_001",
    "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c",
    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "throttle_apply_id" : "3e06ac135e18477e918060d3c59d6f6a",
    "name" : "Api_http",
    "apply_time" : "2020-08-03T12:25:52Z",
    "remark" : "Web backend Api",
    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "id" : "5f918d104dc84480a75166ba99efff21",
    "type" : 1,
    "throttle_name" : "throttle_demo",
    "auth_type" : "APP",
    "req_uri" : "/test/http"
  } ]
}

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

错误码

请参见错误码。

父主题： API绑定流控策略

相关文档