文档

GetSecretParametersByPath - 通过路径获取加密参数

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:GetSecretParametersByPathget
  • secretparameter
    acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
Pathstring

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

/secretParameter
Recursiveboolean

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

  • true(搜索出//secretParameter/mySecretParameter 与/secretParameter/secretParameter1/mySecretParameter 两个结果)
  • false(仅能搜索出/secretParameter/mySecretParameter 这一个结果)
false
NextTokenstring

翻页标记的 Token。

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
MaxResultsinteger

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

10
WithDecryptionboolean

是否解密参数值。 取值范围:

  • true
  • false(默认)
true

返回参数

名称类型描述示例值
object
NextTokenstring

翻页标记的 Token

gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestIdstring

请求 ID

25156E99-7437-4590-AA58-2ACA17DE405C
TotalCountinteger

查询到的加密参数总数

10
MaxResultsinteger

分页大小

10
Parametersarray<object>

参数信息

object
Typestring

参数类型

Secret
UpdatedDatestring

参数更新时间

2020-10-21T06:22:48Z
UpdatedBystring

参数更新者

root(130900000)
KeyIdstring

密钥 ID

090xxbex-xexx-xxxx-axfc-ddxxcxxxxcex
Valuestring

参数内容

secretParameter
Descriptionstring

参数的描述信息

secretParameter
Constraintsstring

参数的约束条件

{\"AllowedPattern\": \"^[a-g]*$\"}
CreatedBystring

参数创建者

root(130900000)
CreatedDatestring

参数更新时间

2020-10-21T06:22:48Z
ParameterVersioninteger

参数版本号

1
Namestring

参数名称

mySecretParameter
Idstring

参数 ID

p-7cdc0000000000000000
ShareTypestring

参数共享类型

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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史