更新时间:2025-09-18 GMT+08:00
分享

批量导入凭据

功能介绍

批量导入凭据。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/secrets/batch-import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户token

表3 请求Body参数

参数

是否必选

参数类型

描述

secrets

Array of CreateSecretRequestBody objects

批量创建凭据参数

表4 CreateSecretRequestBody

参数

是否必选

参数类型

描述

name

String

待创建凭据的名称。

约束:取值范围为1到64个字符,满足正则匹配“^[a-zA-Z0-9_-]{1,64}$”。

kms_key_id

String

用于加密保护凭据值的KMS主密钥ID,如果您未指定此参数,凭据管理服务将默认使用名为csms/default的默认主密钥,用于加密您账号在本项目中创建的凭据值。如果用户账号下不存在该名称的主密钥,则凭据管理服务自动为您创建该名称的密钥。

description

String

凭据的描述信息。

约束:2048字节。

secret_binary

String

二进制类型凭据在base64编码后的明文,凭据管理服务将其加密后,存入凭据的初始版本中。

类型:base64编码的二进制数据对象。

约束:secret_binary和secret_string必须且只能设置一个,最大32K。

secret_string

String

文本类型凭据的明文,凭据管理服务将其加密后,存入凭据的初始版本中。

约束:secret_binary和secret_string必须且只能设置一个,最大32K。

secret_type

String

凭据类型

  • COMMON:通用凭据(默认)。用于应用系统中的各种敏感信息储存。

  • RDS:RDS凭据 。专门针对RDS的凭据,用于存储RDS的账号信息。(已不支持,使用RDS-FG替代)

  • RDS-FG:RDS凭据 。专门针对RDS的凭据,用于存储RDS的账号信息。

  • GaussDB-FG:TaurusDB凭据。专门针对TaurusDB的凭据,用于存储TaurusDB的账号信息。

auto_rotation

Boolean

自动轮转

取值:true 开启 ,false 关闭 (默认)

rotation_period

String

轮转周期

约束:6小时-8,760小时 (365天)

类型:Integer[unit] ,Integer表示时间长度 。unit表示时间单位,d(天)、h(小时)、m(分钟)、s(秒)。例如 1d 表示一天,24h也表示一天

说明:当开启自动轮转时,必须填写该值

rotation_config

String

轮转配置

约束:范围不超过1024个字符。

当secret_type为RDS-FG、GaussDB-FG时,必须填写本参数,参数格式为{"InstanceId":"","SecretSubType":""}

参数说明:InstanceId为实例ID,SecretSubType为轮转子类型,取值为:SingleUser,MultiUser。

SingleUser:指定轮转类型为单用户模式轮转,每次轮转将指定账号重置为新的口令。

MultiUser:指定轮转类型为双用户模式轮转,SYSCURRENT和SYSPREVIOUS分别引用其中一个账号。凭据轮转时,SYSPREVIOUS引用的账号口令会被重置为新的随机口令,随后凭据交换SYSCURRENT和SYSPREVIOUS对账号的引用。

event_subscriptions

Array of strings

凭据订阅的事件列表,当前最大可订阅一个事件。当事件包含的基础事件触发时,通知消息将发送到事件对应的通知主题。

enterprise_project_id

String

该参数针对企业用户使用。如果您是企业用户,且已创建企业项目,则请从下拉列表中为密钥选择需要绑定的企业项目,默认项目为“default”。

未开通企业管理的用户页面则没有“企业项目”参数项,无需进行配置。

rotation_func_urn

String

FunctionGraph函数的urn。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

error_list

Array of ErrorInfo objects

失败描述

total

Integer

总条数

success

Integer

成功条数

failed

Integer

失败条数

表6 ErrorInfo

参数

参数类型

描述

name

String

名称

error_msg

String

失败原因

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误编号。

error_msg

String

错误详情。

请求示例

响应示例

状态码

状态码

描述

200

请求已成功

400

请求失败

错误码

请参见错误码

相关文档