更新时间:2022-02-21 GMT+08:00

查看流控策略详情

功能介绍

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

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

GET

/v1.0/apigw/throttles/{id}

URI中的参数说明如下表所示。

表2 参数说明

名称

是否必选

类型

说明

id

String

流控策略的ID。

请求消息

响应消息

表3 参数说明

参数

类型

说明

id

String

流控策略的ID

name

String

流控策略的名称

api_call_limits

Integer

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

user_call_limits

Integer

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

app_call_limits

Integer

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

ip_call_limits

Integer

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

time_interval

Integer

流控的时长

time_unit

String

流控的时间单位

remark

String

描述

create_time

Timestamp

创建时间

is_include_special_throttle

Integer

是否包含特殊流控配置:
  • 1:包含
  • 2:不包含

type

Integer

流控策略的类型,取值如下:

  • 1 独享
  • 2 共享

bind_num

Integer

流控绑定的API数量

enable_adaptive_control

String

是否开启动态流控:

  • TRUE
  • FALSE

暂不支持

响应消息样例:
{
	"id": "0325b671-2d50-4614-9868-22102262695d",
	"name": "每秒1000次",
	"api_call_limits": 1000,
	"user_call_limits": 500,
	"app_call_limits": 300,
        "ip_call_limits": 600,
	"time_interval": 1,
	"time_unit": "SECOND",
	"create_time": "2017-12-29T01:55:59Z",
	"remark": "API每秒1000次,用户500次,APP300次,IP600次",
	"is_inclu_special_throttle": 2,
        "type":1,
	"bind_num": 0,
        "enable_adaptive_control": "FALSE"
}

状态码

表4 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error