GetSecretParameter - API参考| 阿里云

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetSecretParameter	系统规定参数。取值：GetSecretParameter。
RegionId	String	否	cn-hangzhou	地域ID。
Name	String	是	MySecretParameter	参数名称。取值范围：内容限制为字母、数字、中划线、下划线，长度不能超过180字符，且不能以ALIYUN、ACS、ALIBABA、ALICLOUD、OOS开头。
ParameterVersion	Integer	否	1	参数版本号。取值范围：1-100。
WithDecryption	Boolean	否	false	是否解密参数值。只有参数为true时，返回值的value才会有结果，否则为空。

返回数据


名称	类型	示例值	描述
RequestId	String	7F14FB7C-C9BE-44AE-92ED-21ACC02FBFD2	请求ID。
Parameter	Object		加密参数信息
Type	String	Secret	参数类型
UpdatedDate	String	2020-09-01T09:35:17Z	参数更新时间
UpdatedBy	String	root(130900000)	参数更新者
KeyId	String	80e9409f-78fa-42ab-84bd-83f40c******	加密使用的KMS 的KeyId
Tags	Map		标签
Value	String	SecretParameter	参数内容
Description	String	SecretParameter	参数描述信息
Constraints	String	'{''AllowedValues":["secretparameter"],"AllowedPattern":".*","MinLength":0,"MaxLength":20}'	参数约束条件
ResourceGroupId	String	rg-acfmxsn4m4******	资源组ID
CreatedBy	String	root(130900000)	参数创建者
CreatedDate	String	2020-09-01T09:28:47Z	参数创建时间
ParameterVersion	Integer	1	参数版本号
Name	String	MySecretParameter	加密参数名称
Id	String	p-14ed150fdcd048xxxxxx	加密参数Id
ShareType	String	Private	参数共享类型

示例

请求示例

http(s)://[Endpoint]/?Action=GetSecretParameter
&RegionId=cn-hangzhou
&Name=MySecretParameter
&ParameterVersion=1
&WithDecryption=false
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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******",
    "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",
    "Tags" : {
      "k1" : "v1",
      "k2" : "v2"
    },
    "ShareType" : "Private"
  }
}

错误码

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