All Products
Search

This Product

    API Gateway:DescribeSystemParameters

    Document Center

    API Gateway:DescribeSystemParameters

    Last Updated:Mar 30, 2026

    Queries the common parameters supported by the system.

    Operation description

    • This API is intended for API callers.

    • The response of this API contains the system parameters that are optional in API definitions.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    apigateway:DescribeSystemParameters

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    0CCDF65E-6050-412D-AD68-FA3D9196836C
    SystemParams

    object

    SystemParamItem

    array<object>

    The returned information about system parameters. It is an array that consists of SystemParam data.

    object

    DemoValue

    string

    Examples

    192.168.1.1
    Description

    string

    The description of a parameter.

    ClientIP
    ParamName

    string

    The name of the parameter.

    CaClientIp
    ParamType

    string

    The type of the parameter.

    string

    Examples

    Success response

    JSON format

    {
  "RequestId": "0CCDF65E-6050-412D-AD68-FA3D9196836C",
  "SystemParams": {
    "SystemParamItem": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "ClientIP",
        "ParamName": "CaClientIp",
        "ParamType": "string"
      }
    ]
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.