调用CreateSecretParameter创建一个加密参数。请确保在使用该接口前有操作CreateSecret API的权限。

调试

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

请求参数

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

系统规定参数。取值:CreateSecretParameter

RegionId String cn-hangzhou

地域ID。

Name String MySecretParameter

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

Type String Secret

参数类型。取值范围:Secret。

Value String SecretParameter

参数内容。长度限制为4096。

Description String SecretParameter

要给参数添加的描述信息。长度限制为200字符

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

加密使用的KMS的KeyId。

ClientToken String 123e4567-e89b-12d3-a456-42665544****

保证请求的幂等性。该值由客户端生成,并且必须是全局唯一的。

长度不超过64个字符,可包含英文字母、数字、短划线(-)和下划线(_)。

更多详情,请参见如何保证幂等性。

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

参数的约束条件,默认为空,取值范围:

  • AllowedValues 参数允许值,数组类型的字符串
  • AllowedPattern 正则字符串
  • MinLength 参数最小长度
  • MaxLength 参数最大长度
Tags String {"k1": "v1", "k2": "v2"}

标签。

ResourceGroupId String rg-acfmxsn4m4******

资源组ID。

返回数据

名称 类型 示例值 描述
RequestId String 0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF

请求ID。

Parameter Object

加密参数信息

Type String Secret

参数类型

UpdatedDate String 2020-09-01T09:30:36Z

参数更新时间

UpdatedBy String root(130900000)

参数更新者

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

加密使用的KMS的KeyId

Tags String {"k1": "v1", "k2": "v2"}

标签

Description String SecretParameter

参数描述信息

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

参数约束条件

ResourceGroupId String rg-acfmxsn4m4******

资源组。

CreatedBy String root(130900000)

参数创建者

CreatedDate String 2020-09-01T09:30:36Z

参数创建时间

ParameterVersion Integer 1

参数版本号

Name String MyParameter

参数名称

Id String p-0b0fff9919c946xxxxxx

参数ID

ShareType String Private

参数共享类型

示例

请求示例

http(s)://[Endpoint]/?Action=CreateSecretParameter
&RegionId=cn-hangzhou
&Name=MySecretParameter
&Type=Secret
&Value=SecretParameter
&Description=SecretParameter
&KeyId=80e9409f-78fa-42ab-84bd-83f40c******
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&Constraints='{''AllowedValues":["secretparameter"],"AllowedPattern":"secretparameter","MinLength":0,"MaxLength":20}'
&Tags={"k1": "v1", "k2": "v2"}
&ResourceGroupId=rg-acfmxsn4m4******
&公共请求参数

正常返回示例

XML格式

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

<CreateSecretParameterResponse>
    <RequestId>0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF</RequestId>
    <Parameter>
        <Type>Secret</Type>
        <UpdatedDate>2020-09-01T09:30:36Z</UpdatedDate>
        <UpdatedBy>root(130900000)</UpdatedBy>
        <KeyId>80e9409f-78fa-42ab-84bd-83f40c******</KeyId>
        <Tags>
            <k1>v1</k1>
            <k2>v2</k2>
        </Tags>
        <Description>SecretParameter</Description>
        <Constraints>'{ 	"AllowedValues": ["secretparameter"], 	"AllowedPattern": "secretparameter", 	"MinLength": 0, 	"MaxLength": 20 }'</Constraints>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <CreatedBy>root(130900000)</CreatedBy>
        <CreatedDate>2020-09-01T09:30:36Z</CreatedDate>
        <ParameterVersion>1</ParameterVersion>
        <Name>MyParameter</Name>
        <Id>p-0b0fff9919c946xxxxxx</Id>
        <ShareType>Private</ShareType>
    </Parameter>
</CreateSecretParameterResponse>

JSON格式

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

{
  "RequestId" : "0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF",
  "Parameter" : {
    "Type" : "Secret",
    "UpdatedDate" : "2020-09-01T09:30:36Z",
    "UpdatedBy" : "root(130900000)",
    "KeyId" : "80e9409f-78fa-42ab-84bd-83f40c******",
    "Tags" : {
      "k1" : "v1",
      "k2" : "v2"
    },
    "Description" : "SecretParameter",
    "Constraints" : "'{ \t\"AllowedValues\": [\"secretparameter\"], \t\"AllowedPattern\": \"secretparameter\", \t\"MinLength\": 0, \t\"MaxLength\": 20 }'",
    "ResourceGroupId" : "rg-acfmxsn4m4******",
    "CreatedBy" : "root(130900000)",
    "CreatedDate" : "2020-09-01T09:30:36Z",
    "ParameterVersion" : 1,
    "Name" : "MyParameter",
    "Id" : "p-0b0fff9919c946xxxxxx",
    "ShareType" : "Private"
  }
}

错误码

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