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

调试

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

请求参数

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

系统规定参数。取值:ListParameters

RegionId String cn-hangzhou

地域ID。

Name String MyParameter

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

MaxResults Integer 50

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

NextToken String MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA

翻页标记的Token。

SortField String Name

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

  • Name(参数名称)
  • CreatedDate(创建时间)
SortOrder String Descending

排序顺序。取值范围:

  • Ascending(升序)
  • Descending(默认值):降序
Type String String

参数类型。取值范围:

  • String
  • StringList
Path String /path1/path2/

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

Recursive Boolean false

参数路径是否递归。

默认:false

Tags Map {"k1": "v1", "k2": "v2"}

标签。

ResourceGroupId String rg-acfmxsn4m4******

资源组ID。

返回数据

名称 类型 示例值 描述
NextToken String gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC6KPDUL0FIIb

翻页标记的Token

RequestId String A81E4B2E-6B33-4BAE-9856-55DB7C893E01

请求ID

TotalCount Integer 5

返回结果总数

MaxResults Integer 50

分页大小

Parameters Array of Parameter

普通参数信息

Type String String

参数类型

UpdatedDate String 2020-09-01T08:01:43Z

参数更新时间

UpdatedBy String root(130900000)

参数更新者

Tags Map

标签

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 p-4c4b401cab6747xxxxxx

普通参数Id

ShareType String Private

参数共享类型

示例

请求示例

http(s)://[Endpoint]/?Action=ListParameters
&RegionId=cn-hangzhou
&Name=MyParameter
&MaxResults=50
&NextToken=MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
&SortField=Name
&SortOrder=Descending
&Type=String
&Path=/path1/path2/
&Recursive=false
&ResourceGroupId=rg-acfmxsn4m4******
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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)",
    "Description" : "parameter",
    "CreatedBy" : "root(130900000)",
    "ResourceGroupId" : "rg-acfmxsn4m4******",
    "CreatedDate" : "2020-09-01T08:01:43Z",
    "ParameterVersion" : 1,
    "Name" : "MyParameter",
    "Id" : "p-4c4b401cab6747xxxxxx",
    "Tags" : {
      "k1" : "v1",
      "k2" : "v2"
    },
    "ShareType" : "Private"
  }
}

错误码

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