全部产品
Search
文档中心

运维编排服务:GetSecretParameters - 获取一个或多个加密参数的详细信息

更新时间:Dec 07, 2022

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

调试

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

调试

授权信息

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

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

请求参数

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

地域ID。

cn-hangzhou
Namesstring

参数名称,可以由多个参数名称组成一个JSON数组,格式为 ["xxxxxxxxx", "yyyyyyyyy", … "zzzzzzzzz"] ,最多支持10个参数名称,参数名称之间用半角逗号(,)隔开。

["secretParameter","secretParameter1"]
WithDecryptionboolean

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

  • true
  • false(默认)
false

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

A5320F1D-92D9-44BB-A416-5FC525ED6D57
InvalidParametersarray

无效的参数

string

无效的参数名称列表

[ "InvalidSecretParameter"]
Parametersarray

参数信息

object
Typestring

参数类型

Secret
UpdatedDatestring

参数更新时间

2020-10-22T03:11:13Z
UpdatedBystring

参数更新者

root(130900000)
KeyIdstring

密钥ID

ssh-bp67acfmxazb4p****
Tagsobject

标签

Valuestring

参数值

secretParameter,secretParameter1
Descriptionstring

参数的描述信息

secretParameter
Constraintsstring

参数的约束条件

{\"AllowedValues\": [\"test\"]}
ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
CreatedBystring

参数创建者

root(130900000)
CreatedDatestring

参数创建时间

2020-10-22T03:11:13Z
ParameterVersioninteger

参数版本号

1
Namestring

参数名称

MySecretParameter
Idstring

参数ID

p-7cdc0000000000000000
ShareTypestring

参数共享类型

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": {
        "test": "test",
        "test2": 1
      },
      "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"
    }
  ]
}

错误码

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