调用DescribeSystemParameters查询系统参数列表_API 网关(API Gateway)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeSystemParameters	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	0CCDF65E-6050-412D-AD68-FA3D9196836C
SystemParams	array<object>	由 SystemParam 组成的数组格式，返回系统参数信息
SystemParamItem	object
DemoValue	string	示例	192.168.1.1
Description	string	参数描述	客户端IP
ParamName	string	参数名称	CaClientIp
ParamType	string	参数类型	string

示例

正常返回示例

JSON格式

{
  "RequestId": "0CCDF65E-6050-412D-AD68-FA3D9196836C",
  "SystemParams": {
    "SystemParamItem": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "客户端IP",
        "ParamName": "CaClientIp",
        "ParamType": "string"
      }
    ]
  }
}

JSON格式

{
  "RequestId": "0CCDF65E-6050-412D-AD68-FA3D9196836C",
  "SystemParams": {
    "SystemParamItem": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "客户端IP",
        "ParamName": "CaClientIp",
        "ParamType": "string"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史