All Products
Search

This Product

    Query the system parameter list

    Document Center
    Product Details

    Query the system parameter list

    Last Updated: May 17, 2017

    Description

    For querying the list of system parameters.

    • This function is intended for API activators.
    • You can select the list of system parameters you want to receive when this interface returns API definition.

    Request parameters

    Name Type Required? Description
    Action String Yes Operation interface name, which is a required parameter; value: DescribeSystemParameters.

    Return parameters

    Name Type Description
    RequestId String ID of the current request.
    SystemParams SystemParamItem Returned information of system parameters, which is an array consisting of SystemParam.

    Examples

    Request example

    1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeSystemParameters
    2. &<Public request parameters>

    Response example

    XML format

    1. <DescribeSystemParametersResponse>
    2.     <RequestId>0CCDF65E-6050-412D-AD68-FA3D9196836C</RequestId>
    3.     <SystemParameters>
    4.         <SystemParameter>
    5.             <Description> Client IP address</Description>
    6.             <DemoValue>192.168.1.1</DemoValue>
    7.             <ParamName>CaClientIp</ParamName>
    8.             <ParamType>string</ParamType>
    9.         </SystemParameter>
    10.         <SystemParameter>
    11.             <Description> Request domain name</Description>
    12.             <DemoValue>api.aliyun.com</DemoValue>
    13.             <ParamName>CaDomain</ParamName>
    14.             <ParamType>string</ParamType>
    15.         </SystemParameter>
    16.         <SystemParameter>
    17.             <Description> Request time (Greenwich mean time)</Description>
    18.             <DemoValue>2016-01-30T03:53:16Z</DemoValue>
    19.             <ParamName>CaRequestHandleTime</ParamName>
    20.             <ParamType>string</ParamType>
    21.         </SystemParameter>
    22.         <SystemParameter>
    23.             <Description>ConsumerAppId</Description>
    24.             <DemoValue>123456</DemoValue>
    25.             <ParamName>CaAppId</ParamName>
    26.             <ParamType>string</ParamType>
    27.         </SystemParameter>
    28.         <SystemParameter>
    29.             <Description>RequestId</Description>
    30.             <DemoValue>7157EBD9-4684-4827-B3B0-9B32D186819B</DemoValue>
    31.             <ParamName>CaRequestId</ParamName>
    32.             <ParamType>string</ParamType>
    33.         </SystemParameter>
    34.         <SystemParameter>
    35.             <Description>Http Schema</Description>
    36.             <DemoValue>https</DemoValue>
    37.             <ParamName>CaHttpSchema</ParamName>
    38.             <ParamType>string</ParamType>
    39.         </SystemParameter>
    40.         <SystemParameter>
    41.             <Description> Proxy</Description>
    42.             <DemoValue>AliCloudApiGateway</DemoValue>
    43.             <ParamName>CaProxy</ParamName>
    44.             <ParamType>string</ParamType>
    45.         </SystemParameter>
    46.     </SystemParameters>
    47. </DescribeSystemParametersResponse>

    JSON format

    1. {
    2.     "RequestId": "0CCDF65E-6050-412D-AD68-FA3D9196836C",
    3.     "SystemParameters": {
    4.         "SystemParameter": [
    5.             {
    6.                 "Description": " Client IP address",
    7.                 "DemoValue": "192.168.1.1",
    8.                 "ParamName": "CaClientIp",
    9.                 "ParamType": "string"
    10.             },
    11.             {
    12.                 "Description": " Request domain name",
    13.                 "DemoValue": "api.aliyun.com",
    14.                 "ParamName": "CaDomain",
    15.                 "ParamType": "string"
    16.             },
    17.             {
    18.                 "Description": " Request time (Greenwich mean time)",
    19.                 "DemoValue": "2016-01-30T03:53:16Z",
    20.                 "ParamName": "CaRequestHandleTime",
    21.                 "ParamType": "string"
    22.             },
    23.             {
    24.                 "Description": "ConsumerAppId",
    25.                 "DemoValue": "123456",
    26.                 "ParamName": "CaAppId",
    27.                 "ParamType": "string"
    28.             },
    29.             {
    30.                 "Description": "RequestId",
    31.                 "DemoValue": "7157EBD9-4684-4827-B3B0-9B32D186819B",
    32.                 "ParamName": "CaRequestId",
    33.                 "ParamType": "string"
    34.             },
    35.             {
    36.                 "Description": "Http Schema",
    37.                 "DemoValue": "https",
    38.                 "ParamName": "CaHttpSchema",
    39.                 "ParamType": "string"
    40.             },
    41.             {
    42.                 "Description": " Proxy",
    43.                 "DemoValue": "AliCloudApiGateway",
    44.                 "ParamName": "CaProxy",
    45.                 "ParamType": "string"
    46.             }
    47.         ]
    48.     }
    49. }