通过路径获取加密参数。请确保在使用该接口前有操作kms GetSecretValue API的权限。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
oos:GetSecretParametersByPath |
get |
*secretparameter
|
|
无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
Path |
string |
是 |
参数路径,参数长度小于 200 个字符串。例如参数/secretParameter/mySecretParameter,其中/secretParameter 为此参数的路径。 |
/secretParameter |
Recursive |
boolean |
否 |
是否递归查询路径。如参数/secretParameter/mySecretParameter 与/secretParameter/secretParameter1/mySecretParameter,取值范围:
|
false |
NextToken |
string |
否 |
翻页标记的 Token。 |
MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA |
MaxResults |
integer |
否 |
分页大小。取值范围:1-10。默认为 10。 |
10 |
WithDecryption |
boolean |
否 |
是否解密参数值。 取值范围:
|
true |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
NextToken |
string |
翻页标记的 Token |
gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC |
RequestId |
string |
请求 ID |
25156E99-7437-4590-AA58-2ACA17DE405C |
TotalCount |
integer |
查询到的加密参数总数 |
10 |
MaxResults |
integer |
分页大小 |
10 |
Parameters |
array<object> |
参数信息 |
|
object |
|||
Type |
string |
参数类型 |
Secret |
UpdatedDate |
string |
参数更新时间 |
2020-10-21T06:22:48Z |
UpdatedBy |
string |
参数更新者 |
root(130900000) |
KeyId |
string |
密钥 ID |
090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex |
Value |
string |
参数内容 |
secretParameter |
Description |
string |
参数的描述信息 |
secretParameter |
Constraints |
string |
参数的约束条件 |
{\"AllowedPattern\": \"^[a-g]*$\"} |
CreatedBy |
string |
参数创建者 |
root(130900000) |
CreatedDate |
string |
参数更新时间 |
2020-10-21T06:22:48Z |
ParameterVersion |
integer |
参数版本号 |
1 |
Name |
string |
参数名称 |
mySecretParameter |
Id |
string |
参数 ID |
p-7cdc0000000000000000 |
ShareType |
string |
参数共享类型 |
Private |
示例
正常返回示例
JSON
格式
{
"NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
"RequestId": "25156E99-7437-4590-AA58-2ACA17DE405C",
"TotalCount": 10,
"MaxResults": 10,
"Parameters": [
{
"Type": "Secret",
"UpdatedDate": "2020-10-21T06:22:48Z",
"UpdatedBy": "root(130900000)",
"KeyId": "090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex",
"Value": "secretParameter",
"Description": "secretParameter",
"Constraints": "{\\\"AllowedPattern\\\": \\\"^[a-g]*$\\\"}",
"CreatedBy": "root(130900000)",
"CreatedDate": "2020-10-21T06:22:48Z",
"ParameterVersion": 1,
"Name": "mySecretParameter",
"Id": "p-7cdc0000000000000000",
"ShareType": "Private"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。