DescribeSystemParameters - API Gateway - Alibaba Cloud Documentation Center

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.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0CCDF65E-6050-412D-AD68-FA3D9196836C
SystemParams	array<object>	The returned information about system parameters. It is an array that consists of SystemParam data.
SystemParamItem	object
DemoValue	string	Examples	192.168.1.1
Description	string	The description of a parameter.	Client IP Address
ParamName	string	The name of the parameter.	CaClientIp
ParamType	string	The type of the parameter.	string

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history