API网关 APIGAPI网关 APIG

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

查看流控策略详情

功能介绍

查看指定流控策略的详细信息。

调试

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

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目编号

instance_id

String

实例编号

throttle_id

String

流控策略的ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

bind_num

Integer

流控绑定的API数量

is_include_special_throttle

Integer

是否包含特殊流控配置

  • 1:包含

  • 2:不包含

枚举值:

  • 1

  • 2

create_time

String

创建时间

remark

String

描述

type

Integer

流控策略的类型

  • 1:独享,表示绑定到流控策略的单个API流控时间内能够被调用多少次。

  • 2:共享,表示绑定到流控策略的所有API流控时间内能够被调用多少次

枚举值:

  • 1

  • 2

time_interval

Integer

流控的时长

ip_call_limits

Integer

单个IP流控时间内能够访问API的次数限制

app_call_limits

Integer

单个APP流控时间内能够访问API的次数限制

name

String

流控策略的名称

time_unit

String

流控的时间单位

枚举值:

  • SECOND

  • MINUTE

  • HOUR

  • DAY

api_call_limits

Integer

单个API流控时间内能够被访问的次数限制

id

String

流控策略的ID

user_call_limits

Integer

单个用户流控时间内能够访问API的次数限制

enable_adaptive_control

String

是否开启动态流控

暂不支持

枚举值:

  • true

  • false

状态码: 401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码: 200

OK

{
  "name" : "throttle_demo",
  "create_time" : "2020-07-31T08:44:02.205366118Z",
  "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
  "type" : 1,
  "time_interval" : 1,
  "ip_call_limits" : 600,
  "app_call_limits" : 300,
  "time_unit" : "SECOND",
  "api_call_limits" : 800,
  "id" : "3437448ad06f4e0c91a224183116e965",
  "user_call_limits" : 500,
  "enable_adaptive_control" : "FALSE",
  "bind_num" : 0,
  "is_inclu_special_throttle" : 2
}

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

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品