All Products
Search
Document Center

API Gateway:DescribeSystemParameters

Last Updated:Mar 01, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

0CCDF65E-6050-412D-AD68-FA3D9196836C
SystemParamsobject []

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

DemoValuestring

Examples

192.168.1.1
Descriptionstring

The description of a parameter.

Client IP Address
ParamNamestring

The name of the parameter.

CaClientIp
ParamTypestring

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 timeSummary of changesOperation
No change history