请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DeriveSharedSecret	要执行的操作，取值：DeriveSharedSecret。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
KeyringName	String	否	test	密钥环名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyName	String	否	test	主密钥名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyID	String	否	xxxxxx-xxxx-xxxx-xxxxxxxx	主密钥ID，二选一： KeyringName 和 KeyName KeyID
KeyAgreementAlgorithm	String	否	ECDH	密钥协商算法
PublicKey	String	是	xxxxxxxxxx	密钥协商对方的公钥，仅接受DER编码的X.509公钥

返回参数

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

参数	类型	示例值	描述
KeyID	String	xxxxxx-xxxx-xxxx-xxxxxxxx	主密钥唯一标识符，UUID形式
KeyAgreementAlgorithm	String	ECDH	密钥协商算法
KeyOrigin	String	CloudKMS	用户主密钥来源
SharedSecret	String	sdhfkshadkfhkshdkjsdhfkja	密钥协商生成的原始密钥

请求示例

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

{
  "KeyringName": "eIs94",
  "KeyName": "0NhOg",
  "KeyID": "BINTt",
  "KeyAgreementAlgorithm": "ECDH"
  "PublicKey": "xxx"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20260813134502189169225002131A97",
    "Action": "DeriveSharedSecret",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "KeyID": "V",
    "KeyAgreementAlgorithm": "ECDH",
    "KeyOrigin": "HPC",
    "SharedSecret": "Zq0H2bzw0R"
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The request parameter %s is invalid.	请求参数格式、类型或取值不合法，请根据参数说明检查并修正请求。
400	MissingParameter	The request is missing %s parameter.	缺少必填参数，请根据接口请求参数说明补充后重试。
400	InvalidKeyUsage	Current key usage only allows: %s. Please use different keys for encryption/decryption and signing/verification.	密钥用途不支持当前操作，请使用用途匹配的密钥。
403	Reject.Throttling.CMK	The request of CMK: %s upper limit is exceeded.	指定主密钥的请求频率超过限制，请降低该密钥相关请求速率后重试。
403	KMS_ServiceNotOpen	KMS service not open yet, please open the service and try again later.	KMS 服务尚未开通，请先在控制台开通服务后重试。
403	AccessDenied	User is not authorized to do this action	当前账号或子账号缺少执行该操作所需权限，请检查 IAM 授权策略。
403	Reject.Service.Overdue	Your account is overdue, please charge your account and try again later.	请求未能完成，请根据错误码、错误信息和当前资源状态检查请求后重试。
403	Reject.Service.Reclaimed	CloudKMS service is reclaimed, please contact Admin	请求未能完成，请根据错误码、错误信息和当前资源状态检查请求后重试。
403	KeyMaterialExpire	Key expire in, %s	密钥材料已过期或不可用，请重新导入有效密钥材料后重试。
404	Not Found	Not found %s [%s].	指定资源不存在或当前账号无权访问，请检查资源 ID、名称和地域是否正确。
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.	服务内部错误，请稍后重试；如持续出现，请联系技术支持。

最近更新时间：2026.09.10 16:59:29

这个页面对您有帮助吗？

有用

无用

密钥管理系统

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求参数

返回参数

请求示例

返回示例

错误码