全部产品
Search

搜索本产品

    系统运维管理：CreateSecretParameter - 创建一个加密参数

    文档中心

    系统运维管理：CreateSecretParameter - 创建一个加密参数

    更新时间：Oct 14, 2024

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

    调试

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

    授权信息

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

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

    请求参数

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

    地域 ID。

    		cn-hangzhou
    Namestring是

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

    		MySecretParameter
    Typestring否

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

    		Secret
    Valuestring是

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

    		SecretParameter
    Descriptionstring否

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

    		SecretParameter
    KeyIdstring否

    加密使用的 KMS 的 KeyId。

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

    保证请求的幂等性。该值由客户端生成，并且必须是全局唯一的。 长度不超过 64 个字符，可包含英文字母、数字、短划线（-）和下划线（_）。 更多详情，请参见如何保证幂等性。

    		123e4567-e89b-12d3-a456-42665544****
    Constraintsstring否

    参数的约束条件，默认为空，取值范围：

    • AllowedValues 参数允许值，数组类型的字符串

    • AllowedPattern 正则字符串

    • MinLength 参数最小长度

    • MaxLength 参数最大长度

    		'{''AllowedValues":["secretparameter"],"AllowedPattern":"secretparameter","MinLength":0,"MaxLength":20}'
    Tagsobject否

    标签。

    		{"k1": "v1", "k2": "v2"}
    ResourceGroupIdstring否

    资源组 ID。

    		rg-acfmxsn4m4******
    DKMSInstanceIdstring否

    KMS 实例的实例 ID。

    		kst-hzz****

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF
    Parameterobject

    加密参数信息

    Typestring

    参数类型

    		Secret
    UpdatedDatestring

    参数更新时间

    		2020-09-01T09:30:36Z
    UpdatedBystring

    参数更新者

    		root(130900000)
    KeyIdstring

    加密使用的 KMS 的 KeyId

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

    标签

    		{"k1": "v1", "k2": "v2"}
    Descriptionstring

    参数描述信息

    		SecretParameter
    Constraintsstring

    参数约束条件

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

    资源组。

    		rg-acfmxsn4m4******
    CreatedBystring

    参数创建者

    		root(130900000)
    CreatedDatestring

    参数创建时间

    		2020-09-01T09:30:36Z
    ParameterVersioninteger

    参数版本号

    		1
    Namestring

    参数名称

    		MyParameter
    Idstring

    参数 ID

    		p-0b0fff9919c946xxxxxx
    ShareTypestring

    参数共享类型

    		Private
    DKMSInstanceIdstring

    KMS 实例的实例 ID。

    		kst-hzz****

    示例

    正常返回示例

    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",
    "DKMSInstanceId": "kst-hzz****"
  }
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-04-18OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-10-10API 内部配置变更，不影响调用查看变更详情