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

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:ListGatewayFeaturesnone
*Gateway
acs:apig:{#regionId}:{#accountId}:gateway/{#GatewayId}

请求语法

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

请求参数

名称类型必填描述示例值
gatewayIdstring

网关 ID。

gw-cpv4sqdl****

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID。

393E2630-DBE7-5221-AB35-9E740675491A
codestring

响应状态码。

Ok
messagestring

响应消息。

success
dataobject

响应数据。

itemsarray<object>

参数配置列表。

featureobject

参数配置信息。

definitionobject

参数定义。

namestring

参数名称。

enable-gzip
displayNamestring

参数的显示名。

EnableGzip
valueTypestring

参数值支持的类型:

  • bool: 布尔类型。
  • string: 字符串类型。
  • int32: 整型。
  • int64: 长整型。
  • json: json 格式。
  • array: json 数组格式。
  • float: 浮点型。
bool
descriptionstring

参数描述。

作用于请求与响应环节,启用gzip会对请求响应进行压缩,会减少网关流量,增加网关cpu消耗
groupstring

参数分组:

  • Telemetry: 属于可观测类型的参数。
  • Engine: 属于引擎类型的参数。
Engine
defaultValuestring

默认值。

"true"
valueUnitstring

单位。

byte
readOnlyboolean

是否只读。

false
regexstring

参数值需要满足的正则表达式。当参数值类型为 string 的时候有效。

[a-z].*
minValuestring

参数值支持的最小值。当值类型为 int32, int64, float 的时候有效。

100
maxValuestring

参数值支持的最大值。当值类型为 int32, int64, float 的时候有效。

65535
minLengthinteger

参数值支持的最小长度。当值类型为 string 时有效。

8
maxLengthinteger

参数值支持的最大长度。当值类型为 string 时有效。

64
valueOptionsarray<object>

参数值支持的选项列表。

valueOptionobject

选项信息。

labelstring

显示值。

保持不变
keystring

传参 key。

KEEP_UNCHANGED
inputTypestring

参数的输入类型:

  • Trigger: 开关型。
  • Input: 输入型。
  • SingleSelect: 单选型。
  • MultiSelect: 多选型。
Trigger
valuestring

参数值。

"true"

示例

正常返回示例

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
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-11-19新增 OpenAPI查看变更详情