ListGatewayFeatures - 查询网关特性参数配置列表-API 网关(API Gateway)-阿里云帮助中心

查询网关特性参数配置列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:ListGatewayFeatures

none

*Gateway

acs:apig:{#regionId}:{#accountId}:gateway/{#GatewayId}

无

请求语法

GET /v1/gateways/{gatewayId}/gateway-features HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
gatewayId	string	否	网关 ID。	gw-cpv4sqdl****

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID。	393E2630-DBE7-5221-AB35-9E740675491A
code	string	响应状态码。	Ok
message	string	响应消息。	success
data	object	响应数据。
items	array<object>	参数配置列表。
	array<object>	参数配置信息。
definition	object	参数定义。
name	string	参数名称。	enable-gzip
displayName	string	参数的显示名。	EnableGzip
valueType	string	参数值支持的类型: bool: 布尔类型。 string: 字符串类型。 int32: 整型。 int64: 长整型。 json: json 格式。 array: json 数组格式。 float: 浮点型。枚举值： bool : bool string : string int32 : int32 array : array int64 : int64 float : float	bool
description	string	参数描述。	作用于请求与响应环节，启用gzip会对请求响应进行压缩，会减少网关流量，增加网关cpu消耗
group	string	参数分组: Telemetry: 属于可观测类型的参数。 Engine: 属于引擎类型的参数。枚举值： Telemetry : Telemetry Engine : Engine	Engine
defaultValue	string	默认值。	"true"
valueUnit	string	单位。	byte
readOnly	boolean	是否只读。	false
regex	string	参数值需要满足的正则表达式。当参数值类型为 string 的时候有效。	[a-z].*
minValue	string	参数值支持的最小值。当值类型为 int32, int64, float 的时候有效。	100
maxValue	string	参数值支持的最大值。当值类型为 int32, int64, float 的时候有效。	65535
minLength	integer	参数值支持的最小长度。当值类型为 string 时有效。	8
maxLength	integer	参数值支持的最大长度。当值类型为 string 时有效。	64
valueOptions	array<object>	参数值支持的选项列表。
	object	选项信息。
label	string	显示值。	保持不变
key	string	传参 key。	KEEP_UNCHANGED
inputType	string	参数的输入类型: Trigger: 开关型。 Input: 输入型。 SingleSelect: 单选型。 MultiSelect: 多选型。枚举值： SingleSelect : SingleSelect MultiSelect : MultiSelect Input : Input Trigger : Trigger	Trigger
value	string	参数值。	"true"
constraints	object	按当前网关形态计算的运行时约束，仅部分 Feature 返回
bodyMaxSizeLimit	integer	单个 body 采集大小上限（字节），按网关部署集群的托管形态返回；仅 log-request-response 返回该字段	5120

示例

正常返回示例

JSON格式

{
  "requestId": "393E2630-DBE7-5221-AB35-9E740675491A",
  "code": "Ok",
  "message": "success",
  "data": {
    "items": [
      {
        "definition": {
          "name": "enable-gzip",
          "displayName": "EnableGzip",
          "valueType": "bool",
          "description": "作用于请求与响应环节，启用gzip会对请求响应进行压缩，会减少网关流量，增加网关cpu消耗",
          "group": "Engine",
          "defaultValue": "\"true\"",
          "valueUnit": "byte",
          "readOnly": false,
          "regex": "[a-z].*",
          "minValue": "100",
          "maxValue": "65535",
          "minLength": 8,
          "maxLength": 64,
          "valueOptions": [
            {
              "label": "保持不变",
              "key": "KEEP_UNCHANGED"
            }
          ],
          "inputType": "Trigger"
        },
        "value": "\"true\"",
        "constraints": {
          "bodyMaxSizeLimit": 5120
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。