调用GetSecretParameters获取加密参数的详细信息_系统运维管理(OOS)-阿里云帮助中心

获取一个或多个加密参数的详细信息。请确保在使用该接口前有操作kms GetSecretValue API的权限。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
oos:GetSecretParameters	get	secretparameter acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
Names	string	是	参数名称，可以由多个参数名称组成一个 JSON 数组，格式为 ["xxxxxxxxx", "yyyyyyyyy", … "zzzzzzzzz"] ，最多支持 10 个参数名称，参数名称之间用半角逗号（,）隔开。	["secretParameter","secretParameter1"]
WithDecryption	boolean	否	是否解密参数值。取值范围： true false（默认）	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	A5320F1D-92D9-44BB-A416-5FC525ED6D57
InvalidParameters	array	无效的参数
InvalidParameter	string	无效的参数名称列表	[ "InvalidSecretParameter"]
Parameters	array<object>	参数信息
Parameter	object
Type	string	参数类型	Secret
UpdatedDate	string	参数更新时间	2020-10-22T03:11:13Z
UpdatedBy	string	参数更新者	root(130900000)
KeyId	string	密钥 ID	ssh-bp67acfmxazb4p****
Tags	object	标签	{"k1": "v1", "k2": "v2"}
Value	string	参数值	secretParameter,secretParameter1
Description	string	参数的描述信息	secretParameter
Constraints	string	参数的约束条件	{\"AllowedValues\": [\"test\"]}
ResourceGroupId	string	资源组 ID	rg-acfmxsn4m4******
CreatedBy	string	参数创建者	root(130900000)
CreatedDate	string	参数创建时间	2020-10-22T03:11:13Z
ParameterVersion	integer	参数版本号	1
Name	string	参数名称	MySecretParameter
Id	string	参数 ID	p-7cdc0000000000000000
ShareType	string	参数共享类型	Private

示例

正常返回示例

JSON格式

{
  "RequestId": "A5320F1D-92D9-44BB-A416-5FC525ED6D57",
  "InvalidParameters": [
    "[ \"InvalidSecretParameter\"]"
  ],
  "Parameters": [
    {
      "Type": "Secret",
      "UpdatedDate": "2020-10-22T03:11:13Z",
      "UpdatedBy": "root(130900000)",
      "KeyId": "ssh-bp67acfmxazb4p****",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "Value": "secretParameter,secretParameter1",
      "Description": "secretParameter",
      "Constraints": "{\\\"AllowedValues\\\": [\\\"test\\\"]}",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedBy": "root(130900000)",
      "CreatedDate": "2020-10-22T03:11:13Z",
      "ParameterVersion": 1,
      "Name": "MySecretParameter",
      "Id": "p-7cdc0000000000000000",
      "ShareType": "Private"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史