调用DescribeSystemParameters查询系统参数列表。

  • 此功能面向开放API的用户
  • 此接口返回定义API时可选择接收的系统参数列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSystemParameters

操作接口名,系统规定参数,取值:DescribeSystemParameters

返回数据

名称 类型 示例值 描述
RequestId String 0CCDF65E-6050-412D-AD68-FA3D9196836C

请求ID

SystemParams Array

由 SystemParam 组成的数组格式,返回系统参数信息

SystemParamItem

由 SystemParam 组成的数组格式,返回系统参数信息

DemoValue String 192.168.1.1

示例

Description String 客户端IP

参数描述

ParamName String CaClientIp

参数名称

ParamType String string

参数类型

示例

请求示例


https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeSystemParameters
&<公共请求参数>

正常返回示例

XML 格式

<DescribeSystemParametersResponse>
      <RequestId>0CCDF65E-6050-412D-AD68-FA3D9196836C</RequestId>
      <SystemParameters>
            <SystemParameter>
                  <Description>客户端IP</Description>
                  <DemoValue>192.168.1.1</DemoValue>
                  <ParamName>CaClientIp</ParamName>
                  <ParamType>string</ParamType>
            </SystemParameter>
            <SystemParameter>
                  <Description>请求域名</Description>
                  <DemoValue>api.aliyun.com</DemoValue>
                  <ParamName>CaDomain</ParamName>
                  <ParamType>string</ParamType>
            </SystemParameter>
            <SystemParameter>
                  <Description>请求时间(格林威治时间)</Description>
                  <DemoValue>2016-01-30T03:53:16Z</DemoValue>
                  <ParamName>CaRequestHandleTime</ParamName>
                  <ParamType>string</ParamType>
            </SystemParameter>
            <SystemParameter>
                  <Description>ConsumerAppId</Description>
                  <DemoValue>123456</DemoValue>
                  <ParamName>CaAppId</ParamName>
                  <ParamType>string</ParamType>
            </SystemParameter>
            <SystemParameter>
                  <Description>RequestId</Description>
                  <DemoValue>7157EBD9-4684-4827-B3B0-9B32D186819B</DemoValue>
                  <ParamName>CaRequestId</ParamName>
                  <ParamType>string</ParamType>
            </SystemParameter>
            <SystemParameter>
                  <Description>Http Schema</Description>
                  <DemoValue>https</DemoValue>
                  <ParamName>CaHttpSchema</ParamName>
                  <ParamType>string</ParamType>
            </SystemParameter>
            <SystemParameter>
                  <Description>代理</Description>
                  <DemoValue>AliCloudApiGateway</DemoValue>
                  <ParamName>CaProxy</ParamName>
                  <ParamType>string</ParamType>
            </SystemParameter>
      </SystemParameters>
</DescribeSystemParametersResponse>

JSON 格式

{
	"RequestId":"0CCDF65E-6050-412D-AD68-FA3D9196836C",
	"SystemParameters":{
		"SystemParameter":[
			{
				"Description":"客户端IP",
				"ParamName":"CaClientIp",
				"DemoValue":"192.168.1.1",
				"ParamType":"string"
			},
			{
				"Description":"请求域名",
				"ParamName":"CaDomain",
				"DemoValue":"api.aliyun.com",
				"ParamType":"string"
			},
			{
				"Description":"请求时间(格林威治时间)",
				"ParamName":"CaRequestHandleTime",
				"DemoValue":"2016-01-30T03:53:16Z",
				"ParamType":"string"
			},
			{
				"Description":"ConsumerAppId",
				"ParamName":"CaAppId",
				"DemoValue":"123456",
				"ParamType":"string"
			},
			{
				"Description":"RequestId",
				"ParamName":"CaRequestId",
				"DemoValue":"7157EBD9-4684-4827-B3B0-9B32D186819B",
				"ParamType":"string"
			},
			{
				"Description":"Http Schema",
				"ParamName":"CaHttpSchema",
				"DemoValue":"https",
				"ParamType":"string"
			},
			{
				"Description":"代理",
				"ParamName":"CaProxy",
				"DemoValue":"AliCloudApiGateway",
				"ParamType":"string"
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。