All Products
Search
Document Center

API Gateway:ListGatewayFeatures

Last Updated:Dec 25, 2025

Queries the feature parameter configurations of an instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apig:ListGatewayFeaturesnone
*Gateway
acs:apig:{#regionId}:{#accountId}:gateway/{#GatewayId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
gatewayIdstringNo

The instance ID.

gw-cpv4sqdl****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

The request ID.

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

The status code.

Ok
messagestring

The response message returned.

success
dataobject

The returned data.

itemsarray<object>

The list of parameter configurations.

featureobject

The parameter configurations.

definitionobject

The parameter definition.

namestring

The parameter name.

enable-gzip
displayNamestring

The display name of the parameter.

EnableGzip
valueTypestring

The value type of the parameter. Valid values:

  • bool: boolean
  • string
  • int32: integer
  • int64: long integer
  • json
  • array: JSON array
  • float: floating point
bool
descriptionstring

The parameter description.

groupstring

The parameter group to which the parameter belongs. Valid values:

  • Telemetry: an observability parameter
  • Engine: an engine parameter
Engine
defaultValuestring

The default value of the parameter.

"true"
valueUnitstring

The value unit.

byte
readOnlyboolean

Indicates whether the parameter is read-only.

false
regexstring

The regular expression that the parameter value must fulfill. This parameter is valid when the value type is string.

[a-z].*
minValuestring

The minimum value of the parameter. This parameter is valid when the value type is int32, int64, or float.

100
maxValuestring

The maximum value of the parameter. This parameter is valid when the value type is int32, int64, or float.

65535
minLengthinteger

The minimum length of the value. This parameter is valid when the value type is string.

8
maxLengthinteger

The maximum length of the value. This parameter is valid when the value type is string.

64
valueOptionsarray<object>

The list of options supported by the parameter value.

valueOptionobject

The option information.

labelstring

The display value.

keystring

The key to pass the parameter.

KEEP_UNCHANGED
inputTypestring

The input type of the parameter. Valid values:

  • Trigger
  • Input
  • SingleSelect
  • MultiSelect
Trigger
valuestring

The parameter value.

"true"

Examples

Sample success responses

JSONformat

{
  "requestId": "393E2630-DBE7-5221-AB35-9E740675491A",
  "code": "Ok",
  "message": "success",
  "data": {
    "items": [
      {
        "definition": {
          "name": "enable-gzip",
          "displayName": "EnableGzip",
          "valueType": "bool",
          "description": "",
          "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
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-11-19Add OperationView Change Details