SetSecretValue - 存入凭据值--密钥管理系统-火山引擎

文档中心

立即注册

导航

SetSecretValue - 存入凭据值

最近更新时间：2024.10.18 12:34:53首次发布时间：2024.10.18 12:34:53

存入凭据值

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	SetSecretValue	要执行的操作，取值：SetSecretValue。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
SecretName	String	是	secret-9527	凭据名称，长度为 2 ~ 31 个字符。合法字符：[a-zA-Z0-9-_]
SecretValue	String	是	{"username":"root","password":"123456"}	凭据值，长度不超过 30720 字节。用户自定义，建议使用 JSON 格式的键值对。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
VersionID	String	54487470-102a-4f35-bfb1-b819e78f7579	存入的凭据值的新版本号
VersionStage	String	CURRENT	存入的凭据值的新版本标签
CreationDate	Long	1723104729	凭据版本创建时间

请求示例

POST /?Action=SetSecretValue&Version=2021-02-18 HTTP/1.1
Host: kms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240811T015427Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240811/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "SecretName": "secret-9527",
  "SecretValue": "{\"username\":\"root\",\"password\":\"123456\"}"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240811095501069218106058666D53",
    "Action": "SetSecretValue",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "VersionID": "54487470-102a-4f35-bfb1-b819e78f7579",
    "VersionStage": "CURRENT",
    "CreationDate": 1723104729
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	InvalidSecretType	The secret type [%s] does not allow to perform this action.
400	InvalidParameter	The request parameter %s is invalid.
403	AccessDenied	User is not authorized to do this action
403	Reject.Throttling.Action	The request of Action: %s upper limit is exceeded.
404	Not Found	Not found %s [%s].
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.