调用GetParametersByPath通过路径获取普通参数。

调试

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

请求参数

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

系统规定参数。取值:GetParametersByPath。

Path String /parameter

参数路径,参数长度小于200个字符串。例如参数/parameter/myparameter,其中/parameter为此参数的路径。

RegionId String cn-hangzhou

地域ID。

Recursive Boolean false

是否递归查询路径。如参数/parameter/myparameter与/parameter/prameter1/myparameter,取值范围:

  • true(搜索出/parameter/myparameter与/parameter/prameter1/myparameter两个结果)
  • false(仅能搜索出/parameter/myparameter这一个结果)
NextToken String MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA

翻页标记的Token。

MaxResults Integer 10

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

返回数据

名称 类型 示例值 描述
MaxResults Integer 10

分页大小

NextToken String gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC

翻页标记的Token

Parameters Array of Parameter

参数信息

Constraints String {\"MaxLength\": 2}

参数的约束条件

CreatedBy String root(130900000)

参数创建者

CreatedDate String 2020-10-21T04:03:12Z

参数创建时间

Description String parameter

参数的描述信息

Id String p-7cdc0000000000000000

参数ID

Name String myParameter

参数名称

ParameterVersion Integer 1

参数版本号

ShareType String Private

参数共享类型

Type String StringList

参数类型

UpdatedBy String root(130900000)

参数更新者

UpdatedDate String 2020-10-21T04:03:12Z

参数更新时间

Value String "parameter1,parameter2"

参数内容

RequestId String 25156E99-7437-4590-AA58-2ACA17DE405C

请求ID

TotalCount Integer 1

查询到的参数总数。

示例

请求示例

http(s)://[Endpoint]/?Action=GetParametersByPath
&Path=/parameter
&<公共请求参数>

正常返回示例

XML 格式

<Parameters>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>StringList</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description/>
    <Constraints>{"MaxLength": 2}</Constraints>
    <UpdatedDate>2020-10-21T04:03:12Z</UpdatedDate>
    <ParameterVersion>1</ParameterVersion>
    <CreatedDate>2020-10-21T04:02:40Z</CreatedDate>
    <Value>parameter1,parameter2</Value>
    <Id>p-7cdc0000000000000000</Id>
    <Name>/parameter/myparameter</Name>
    <ShareType>Private</ShareType>
</Parameters>
<RequestId>25156E99-7437-4590-AA58-2ACA17DE405C</RequestId>
<MaxResults>10</MaxResults>

JSON 格式

{
	"Parameters": [
		{
			"UpdatedBy": "root(130900000)",
			"Type": "StringList",
			"CreatedBy": "root(130900000)",
			"Description": "",
			"Constraints": "{\"MaxLength\": 2}",
			"UpdatedDate": "2020-10-21T04:03:12Z",
			"ParameterVersion": 1,
			"CreatedDate": "2020-10-21T04:02:40Z",
			"Value": "parameter1,parameter2",
			"Id": "p-7cdc0000000000000000",
			"Name": "/parameter/myparameter",
			"ShareType": "Private"
		}
	],
	"RequestId": "25156E99-7437-4590-AA58-2ACA17DE405C",
	"MaxResults": 10
}

错误码

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