查看实例特性列表
功能介绍
查看实例特性列表。注意:实例不支持以下特性的需要联系技术支持升级实例版本。
当前支持的特性列表如下:
特性名称 | 特性描述 | 特性是否可配置 |
---|---|---|
lts | 是否支持shubao访问日志上报功能。 | 是 |
gateway_responses | 是否支持网关自定义响应。 | 否 |
ratelimit | 是否支持自定义流控值。 | 是 |
request_body_size | 是否支持设置请求体大小上限。 | 是 |
backend_timeout | 是否支持配置后端API最大超时时间。 | 是 |
app_token | 是否开启app_token认证方式。 | 是 |
app_api_key | 是否开启app_api_key认证方式。 | 是 |
app_basic | 是否开启app_basic认证方式。 | 是 |
app_secret | 是否支持app_secret认证方式。 | 是 |
app_jwt | 是否支持app_jwt认证方式。 | 是 |
public_key | 是否支持public_key类型的后端签名。 | 是 |
backend_token_allow | 是否支持普通租户透传token到后端。 | 是 |
sign_basic | 签名密钥是否支持basic类型。 | 否 |
multi_auth | API是否支持双重认证方式。 | 否 |
backend_client_certificate | 是否开启后端双向认证。 | 是 |
ssl_ciphers | 是否支持https加密套件。 | 是 |
route | 是否支持自定义路由。 | 否 |
cors | 是否支持API使用插件功能。 | 否 |
real_ip_from_xff | 是否开启使用xff头作为访问控制、流控策略的源ip生效依据。 | 是 |
app_route | 是否支持ip访问。 | 是 |
vpc_name_modifiable | 是否支持修改负载通道名称。 | 是 |
default_group_host_trustlist | DEFAULT分组是否支持配置非本实例IP访问。 | 是 |
throttle_strategy | 是否支持配置流控算法策略。 | 是 |
custom_log | 是否支持用户自定义API请求中的HEADER、QUERY、COOKIE参数值打印到日志。 | 是 |
real_ip_header_getter | 是否开启通过用户自定义的Header获取用户源IP地址。 | 是 |
policy_cookie_param | 是否开启策略后端条件支持cookie类型。 | 是 |
app_quota | 是否支持客户端配额策略。 | 否 |
app_acl | 是否支持流控策略。 | 否 |
set_resp_headers | 是否支持响应header插件。 | 否 |
vpc_backup | 是否支持VPC通道的主备配置。 | 否 |
sign_aes | 签名密钥是否支持AES加密方式。 | 否 |
kafka_log | 是否支持增删改查kafka日志插件。 | 否 |
backend_retry_count | 是否支持API配置重试次数。 | 否 |
policy_sys_param | 策略后端条件来源是否支持系统参数。 | 否 |
breaker | 是否支持断路器。 | 否 |
content_type_configurable | 获取API列表的接口返回信息中是否存在API的请求参数类型信息(Content-Type)。 | 否 |
rate_limit_plugin | 是否支持流控插件。 | 否 |
breakerv2 | 是否支持断路器,能够实现过载情况下服务能力降级。 | 否 |
sm_cipher_type | 加密本地敏感数据时,是否支持应用商密加密算法。 | 否 |
rate_limit_algorithm | 是否支持切换流控算法。 | 否 |
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/features
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
instance_id |
是 |
String |
实例ID,在API网关控制台的“实例信息”中获取。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Long |
偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 |
limit |
否 |
Integer |
每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
size |
Integer |
本次返回的列表长度 |
total |
Long |
满足条件的记录数 |
features |
Array of FeatureInfo objects |
实例特性列表 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
特性编号 |
name |
String |
特性名称 最小长度:1 最大长度:64 |
enable |
Boolean |
是否开启特性 |
config |
String |
特性参数配置 |
instance_id |
String |
实例编号 |
update_time |
String |
实例特性更新时间 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码: 200
OK
{ "total" : 1, "size" : 1, "features" : [ { "config" : "on", "enable" : true, "id" : "db9a9260cd3e4a16a9b5747a65d3ffaa", "instance_id" : "eddc4d25480b4cd6b512f270a1b8b341", "name" : "app_api_key", "update_time" : "2020-08-24T01:17:31.041984Z" } ] }
状态码: 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.3030", "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341" }
状态码: 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 |
错误码
请参见错误码。