首页 运维编排服务 API参考 API目录 参数 加密参数 GetSecretParameter - 获取一个加密参数和参数值

GetSecretParameter - 获取一个加密参数和参数值

获取一个加密参数,包括参数值。请确保在使用该接口前有操作GetSecretValue API的权限。

调试

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

调试

授权信息

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

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

请求参数

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

地域ID。

cn-hangzhou
Namestring

参数名称。取值范围:内容限制为字母、数字、中划线、下划线,长度不能超过180字符,且不能以ALIYUN、ACS、ALIBABA、ALICLOUD、OOS开头。

MySecretParameter
ParameterVersioninteger

参数版本号。取值范围:1-100。

1
WithDecryptionboolean

是否解密参数值。只有参数为true时,返回值的value才会有结果,否则为空。

false

返回参数

名称类型描述示例值
object

加密参数的信息。

RequestIdstring

请求ID。

7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2
Parameterobject

加密参数信息

Typestring

参数类型

Secret
UpdatedDatestring

参数更新时间

2020-09-01T09:35:17Z
UpdatedBystring

参数更新者

root(130900000)
KeyIdstring

加密使用的KMS 的KeyId

80e9409f-78fa-42ab-84bd-83f40c******
Tagsobject

标签

Valuestring

参数内容

SecretParameter
Descriptionstring

参数描述信息

SecretParameter
Constraintsstring

参数约束条件

'{''AllowedValues":["secretparameter"],"AllowedPattern":".*","MinLength":0,"MaxLength":20}'
ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
CreatedBystring

参数创建者

root(130900000)
CreatedDatestring

参数创建时间

2020-09-01T09:28:47Z
ParameterVersioninteger

参数版本号

1
Namestring

加密参数名称

MySecretParameter
Idstring

加密参数Id

p-14ed150fdcd048xxxxxx
ShareTypestring

参数共享类型

Private

示例

正常返回示例

JSON格式

{
  "RequestId": "7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2",
  "Parameter": {
    "Type": "Secret",
    "UpdatedDate": "2020-09-01T09:35:17Z",
    "UpdatedBy": "root(130900000)",
    "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "Value": "SecretParameter",
    "Description": "SecretParameter",
    "Constraints": "'{''AllowedValues\":[\"secretparameter\"],\"AllowedPattern\":\".*\",\"MinLength\":0,\"MaxLength\":20}'",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T09:28:47Z",
    "ParameterVersion": 1,
    "Name": "MySecretParameter",
    "Id": "p-14ed150fdcd048xxxxxx",
    "ShareType": "Private"
  }
}

错误码

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

阿里云首页 运维编排服务 相关技术圈