首页 运维编排服务 API参考 API目录 参数 普通参数 ListParameters - 查询普通参数

ListParameters - 查询普通参数

查询普通参数,支持多种查询。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。

cn-hangzhou
Namestring

参数名称。本Action下的Name为模糊匹配。

MyParameter
MaxResultsinteger

分页大小。取值范围:10-100。默认为50。

50
NextTokenstring

翻页标记的Token。

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
SortFieldstring

根据字段排序。取值范围:

  • Name(参数名称)

  • CreatedDate(创建时间)

Name
SortOrderstring

排序顺序。取值范围:

  • Ascending(升序)

  • Descending(默认值):降序

Descending
Typestring

参数类型。取值范围:

  • String

  • StringList

String
Pathstring

参数路径。例如:Name为/path/path1/Myparameter 此时包含参数路径。

/path1/path2/
Recursiveboolean

参数路径是否递归。 默认:false

false
Tagsobject

标签。

ResourceGroupIdstring

资源组ID。

rg-acfmxsn4m4******

返回参数

名称类型描述示例值
object
NextTokenstring

翻页标记的Token

gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb
RequestIdstring

请求ID

A81E4B2E-6B33-4BAE-9856-55DB7C893E01
TotalCountinteger

返回结果总数

5
MaxResultsinteger

分页大小

50
Parametersarray

普通参数信息

object
Typestring

参数类型

String
UpdatedDatestring

参数更新时间

2020-09-01T08:01:43Z
UpdatedBystring

参数更新者

root(130900000)
Tagsobject

标签

Descriptionstring

参数描述信息

parameter
CreatedBystring

参数创建者

root(130900000)
ResourceGroupIdstring

资源组

rg-acfmxsn4m4******
CreatedDatestring

参数创建时间

2020-09-01T08:01:43Z
ParameterVersionstring

参数版本

1
Namestring

参数名称

MyParameter
Idstring

普通参数Id

p-4c4b401cab6747xxxxxx
ShareTypestring

参数共享类型

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": {
        "test": "test",
        "test2": 1
      },
      "Description": "parameter",
      "CreatedBy": "root(130900000)",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedDate": "2020-09-01T08:01:43Z",
      "ParameterVersion": "1",
      "Name": "MyParameter",
      "Id": "p-4c4b401cab6747xxxxxx",
      "ShareType": "Private"
    }
  ]
}

错误码

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

阿里云首页 运维编排 相关技术圈