通过路径获取加密参数。请确保在使用该接口前有操作GetSecretValue API的权限。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| oos:GetSecretParametersByPath | READ |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
返回参数
示例
正常返回示例
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"
}
]
}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"
}
]
}错误码
访问错误中心查看更多错误码。