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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetSecretParameter

系统规定参数。取值:GetSecretParameter。

Name String MySecretParameter

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

RegionId String cn-hangzhou

地域ID。

ParameterVersion Integer 1

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

WithDecryption Boolean false

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

返回数据

名称 类型 示例值 描述
Parameter Struct

加密参数信息

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

参数约束条件

CreatedBy String root(130900000)

参数创建者

CreatedDate String 2020-09-01T09:28:47Z

参数创建时间

Description String SecretParameter

参数描述信息

Id String p-14ed150fdcd048xxxxxx

加密参数Id

Name String MySecretParameter

加密参数名称

ParameterVersion Integer 1

参数版本号

ShareType String Private

参数共享类型

Type String Secret

参数类型

UpdatedBy String root(130900000)

参数更新者

UpdatedDate String 2020-09-01T09:35:17Z

参数更新时间

Value String SecretParameter

参数内容

RequestId String 7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=GetSecretParameter
&Name=MySecretParameter
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2</RequestId>
<Parameter>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>Secret</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description>SecretParameter</Description>
    <UpdatedDate>2020-09-01T09:35:17Z</UpdatedDate>
    <ParameterVersion>1</ParameterVersion>
    <CreatedDate>2020-09-01T09:28:47Z</CreatedDate>
    <Id>p-14ed150fdcd048xxxxxx</Id>
    <Name>MySecretParameter</Name>
    <ShareType>Private</ShareType>
    <Value>SecretParameter</Value>
    <Constraints>{'AllowedValues':['secretparameter'],'AllowedPattern':'.*','MinLength':0,'MaxLength':20}</Constraints>
</Parameter>

JSON 格式

{
	"RequestId": "7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2",
	"Parameter": {
		"UpdatedBy": "root(130900000)",
		"Type": "Secret",
		"CreatedBy": "root(130900000)",
		"Description": "SecretParameter",
		"UpdatedDate": "2020-09-01T09:35:17Z",
		"ParameterVersion": 1,
		"CreatedDate": "2020-09-01T09:28:47Z",
		"Id": "p-14ed150fdcd048xxxxxx",
		"Name": "MySecretParameter",
		"ShareType": "Private",
        "Value": "SecretParameter",
        "Constraints":"{'AllowedValues':['secretparameter'],'AllowedPattern':'.*','MinLength':0,'MaxLength':20}"
	}
}

错误码

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