调用ListParameters查询普通参数_系统运维管理(OOS)-阿里云帮助中心

查询普通参数和公共参数，支持多种查询。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
oos:ListParameters	list	Parameter acs:oos:{#regionId}:{#accountId}:parameter/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
Name	string	否	参数名称。本 Action 下的 Name 为模糊匹配。	MyParameter
MaxResults	integer	否	分页大小。取值范围：10-100。默认为 50。	50
NextToken	string	否	翻页标记的 Token。	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
SortField	string	否	根据字段排序。取值范围： Name（参数名称） CreatedDate（创建时间）	Name
SortOrder	string	否	排序顺序。取值范围： Ascending（升序） Descending（默认值）：降序	Descending
Type	string	否	参数类型。取值范围： String StringList	String
Path	string	否	参数路径。例如：Name 为/path/path1/Myparameter 此时包含参数路径。	/path1/path2/
Recursive	boolean	否	参数路径是否递归。默认：false	false
Tags	object	否	标签。	{"k1": "v1", "k2": "v2"}
ResourceGroupId	string	否	资源组 ID。	rg-acfmxsn4m4******
ShareType	string	否	是否为公共参数，取值范围 Public Private 默认为 'Private'	‘Private’

返回参数

名称	类型	描述	示例值
	object
NextToken	string	翻页标记的 Token	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb
RequestId	string	请求 ID	A81E4B2E-6B33-4BAE-9856-55DB7C893E01
TotalCount	integer	返回结果总数	5
MaxResults	integer	分页大小	50
Parameters	array<object>	参数信息
Parameter	object
Type	string	参数类型	String
UpdatedDate	string	参数更新时间	2020-09-01T08:01:43Z
UpdatedBy	string	参数更新者	root(130900000)
Tags	object	标签	{"k1": "v1", "k2": "v2"}
Description	string	参数描述信息	parameter
CreatedBy	string	参数创建者	root(130900000)
ResourceGroupId	string	资源组	rg-acfmxsn4m4******
CreatedDate	string	参数创建时间	2020-09-01T08:01:43Z
ParameterVersion	string	参数版本	1
Name	string	参数名称	MyParameter
Id	string	普通参数 Id	p-4c4b401cab6747xxxxxx
ShareType	string	参数共享类型	Private

示例

正常返回示例

JSON格式

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb",
  "RequestId": "A81E4B2E-6B33-4BAE-9856-55DB7C893E01",
  "TotalCount": 5,
  "MaxResults": 50,
  "Parameters": [
    {
      "Type": "String",
      "UpdatedDate": "2020-09-01T08:01:43Z",
      "UpdatedBy": "root(130900000)",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "Description": "parameter",
      "CreatedBy": "root(130900000)",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedDate": "2020-09-01T08:01:43Z",
      "ParameterVersion": "1",
      "Name": "MyParameter",
      "Id": "p-4c4b401cab6747xxxxxx",
      "ShareType": "Private"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-05-15	OpenAPI 入参发生变更	查看变更详情