调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	SetSecretValue	要执行的操作，取值：SetSecretValue。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
SecretName	String	是	secret-9527	凭据名称，长度为 2 ~ 128 个字符。合法字符：[a-zA-Z0-9/_+=.@-]。可通过 CreateSecret 创建凭据时指定，或通过 DescribeSecrets 查询获取。
SecretValue	String	是	{"username":"root","password":"123456"}	凭据值，长度不超过 30720 字节。用户自定义，建议使用 JSON 格式的键值对。
VersionName	String	否	v1	版本别名，长度为 2 ~ 128 个字符。合法字符：[a-zA-Z0-9/_+=.@-]。不传时由系统自动生成或不设置自定义别名，以接口实际返回为准。

返回参数

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

参数	类型	示例值	描述
VersionID	String	54487470-102a-4f35-bfb1-b819e78f7579	存入的凭据值的新版本号
VersionName	String	v1	存入的凭据值的版本别名
VersionStage	String	CURRENT	凭据版本标签。取值：CURRENT（当前版本）、PENDING（待生效版本）、PREVIOUS/OLDER（历史版本）。
CreationDate	Long	1723104729	凭据版本创建时间，Unix 秒级时间戳。

请求示例

POST /?Action=SetSecretValue&Version=2021-02-18 HTTP/1.1
Host: kms.cn-beijing.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.	当前凭据类型不支持该操作，请确认 SecretType 是否符合接口要求。
400	InvalidParameter	The request parameter %s is invalid.	请求参数格式、类型或取值不合法，请根据参数说明检查并修正请求。
403	Reject.Throttling.Action	The request of Action: %s upper limit is exceeded.	接口级请求频率超过限制，请降低请求速率后重试。
403	AccessDenied	User is not authorized to do this action	当前账号或子账号缺少执行该操作所需权限，请检查 IAM 授权策略。
404	Not Found	Not found %s [%s].	指定资源不存在或当前账号无权访问，请检查资源 ID、名称和地域是否正确。
409	Conflict	The version resource v1 is conflict.	凭据版本别名冲突
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.	服务内部错误，请稍后重试；如持续出现，请联系技术支持。

最近更新时间：2026.09.03 18:02:14

这个页面对您有帮助吗？

有用

无用

密钥管理系统

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码