调用GetSecretParametersByPath通过路径获取加密参数。请确保在使用该接口前有操作GetSecretValue API的权限。

调试

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

请求参数

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

系统规定参数。取值：GetSecretParametersByPath。
Path String 是 /secretParameter

参数路径，参数长度小于200个字符串。例如参数/secretParameter/mySecretParameter，其中/secretParameter为此参数的路径。
RegionId String 否 cn-hangzhou

地域ID。
Recursive Boolean 否 false

是否递归查询路径。如参数/secretParameter/mySecretParameter与/secretParameter/secretParameter1/mySecretParameter，取值范围：

  • true（搜索出//secretParameter/mySecretParameter与/secretParameter/secretParameter1/mySecretParameter两个结果）
  • false（仅能搜索出/secretParameter/mySecretParameter这一个结果）
NextToken String 否 MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA

翻页标记的Token。
MaxResults Integer 否 10

分页大小。取值范围：1-10。默认为10。
WithDecryption Boolean 否 true

是否解密参数值。

取值范围：

  • true
  • false（默认）

返回数据

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

分页大小
NextToken String gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC

翻页标记的Token
Parameters Array of Parameter

参数信息
Constraints String {\"AllowedPattern\": \"^[a-g]*$\"}

参数的约束条件
CreatedBy String root(130900000)

参数创建者
CreatedDate String 2020-10-21T06:22:48Z

参数更新时间
Description String secretParameter

参数的描述信息
Id String p-7cdc0000000000000000

参数ID
KeyId String 090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex

密钥ID
Name String mySecretParameter

参数名称
ParameterVersion Integer 1

参数版本号
ShareType String Private

参数共享类型
Type String Secret

参数类型
UpdatedBy String root(130900000)

参数更新者
UpdatedDate String 2020-10-21T06:22:48Z

参数更新时间
Value String secretParameter

参数内容
RequestId String 25156E99-7437-4590-AA58-2ACA17DE405C

请求ID
TotalCount Integer 10

查询到的加密参数总数

示例

请求示例

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

正常返回示例

XML 格式 

<Parameters>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>Secret</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description>secretParameter</Description>
    <Constraints>{"AllowedPattern": "^[a-g]*$"}</Constraints>
    <UpdatedDate>2020-10-21T06:22:48Z</UpdatedDate>
    <ParameterVersion>3</ParameterVersion>
    <CreatedDate>2020-10-21T03:28:33Z</CreatedDate>
    <Value>secretParameter</Value>
    <KeyId>090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex</KeyId>
    <Id>p-7cdc0000000000000000</Id>
    <Name>mySecretParameter</Name>
    <ShareType>Private</ShareType>
</Parameters>
<RequestId>14F404A1-0863-4BB3-B884-78FCE6075DA8</RequestId>
<MaxResults>10</MaxResults>

JSON 格式 

{
	"Parameters": [
		{
			"UpdatedBy": "root(130900000)",
			"Type": "Secret",
			"CreatedBy": "root(130900000)",
			"Description": "secretParameter",
			"Constraints": "{\"AllowedPattern\": \"^[a-g]*$\"}",
			"UpdatedDate": "2020-10-21T06:22:48Z",
			"ParameterVersion": 3,
			"CreatedDate": "2020-10-21T03:28:33Z",
            "Value": "secretParameter",
			"KeyId": "090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex",
			"Id": "p-7cdc0000000000000000",
			"Name": "mySecretParameter",
			"ShareType": "Private"
		}
	],
	"RequestId": "14F404A1-0863-4BB3-B884-78FCE6075DA8",
	"MaxResults": 10
}

错误码

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