首页 API 网关 开发指南 API参考指南 API目录 服务 DescribeSystemParameters - 查询系统参数列表

DescribeSystemParameters - 查询系统参数列表

查询系统支持的公共参数。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeSystemParametersRead
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

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

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

object
DemoValuestring

示例

192.168.1.1
Descriptionstring

参数描述

客户端IP
ParamNamestring

参数名称

CaClientIp
ParamTypestring

参数类型

string

示例

正常返回示例

JSON格式

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

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>

错误码

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

阿里云首页 API 网关 相关技术圈