调用CreateSecretParameter创建一个加密参数。请确保在使用该接口前有操作CreateSecret API的权限。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateSecretParameter |
系统规定参数。取值:CreateSecretParameter。 |
Name | String | 是 | MySecretParameter |
参数名称。取值范围:内容限制为字母、数字、中划线、下划线,长度不能超过180字符,且不能以ALIYUN、ACS、ALIBABA、ALICLOUD、OOS开头。 |
Type | String | 是 | Secret |
参数类型。取值范围:Secret。 |
Value | String | 是 | SecretParameter |
参数内容。长度限制为4096。 |
RegionId | String | 否 | cn-hangzhou |
地域ID。 |
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}' |
参数的约束条件,默认为空,取值范围:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Parameter | Struct |
加密参数信息 |
|
Constraints | String | '{ "AllowedValues": ["secretparameter"], "AllowedPattern": "secretparameter", "MinLength": 0, "MaxLength": 20 }' |
参数约束条件 |
CreatedBy | String | root(130900000) |
参数创建者 |
CreatedDate | String | 2020-09-01T09:30:36Z |
参数创建时间 |
Description | String | SecretParameter |
参数描述信息 |
Id | String | p-0b0fff9919c946xxxxxx |
参数ID |
Name | String | MyParameter |
参数名称 |
ParameterVersion | Integer | 1 |
参数版本号 |
ShareType | String | Private |
参数共享类型 |
Type | String | Secret |
参数类型 |
UpdatedBy | String | root(130900000) |
参数更新者 |
UpdatedDate | String | 2020-09-01T09:30:36Z |
参数更新时间 |
RequestId | String | 0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateSecretParameter
&Name=MySecretParameter
&Type=Secret
&Value=SecretParameter
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF</RequestId>
<Parameter>
<UpdatedBy>root(130900000)</UpdatedBy>
<Type>Secret</Type>
<CreatedBy>root(130900000)</CreatedBy>
<Description>SecretParameter</Description>
<UpdatedDate>2020-09-01T09:30:36Z</UpdatedDate>
<ParameterVersion>1</ParameterVersion>
<CreatedDate>2020-09-01T09:30:36Z</CreatedDate>
<Id>p-0b0fff9919c946xxxxxx</Id>
<Name>MyParameter</Name>
<ShareType>Private</ShareType>
<Constraints>{'AllowedValues':['secretparameter'],'AllowedPattern':'secretparameter','MinLength':0,'MaxLength':20}</Constraints>
</Parameter>
JSON
格式
{
"RequestId": "0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF",
"Parameter": {
"UpdatedBy": "root(130900000)",
"Type": "Secret",
"CreatedBy": "root(130900000)",
"Description": "SecretParameter",
"UpdatedDate": "2020-09-01T09:30:36Z",
"ParameterVersion": 1,
"CreatedDate": "2020-09-01T09:30:36Z",
"Id": "p-0b0fff9919c946xxxxxx",
"Name": "MyParameter",
"ShareType": "Private",
"Constraints":"{'AllowedValues':['secretparameter'],'AllowedPattern':'secretparameter','MinLength':0,'MaxLength':20}"
}
}
错误码
访问错误中心查看更多错误码。