华为云用户手册

响应参数 状态码： 202 表7 响应Body参数 参数 参数类型 描述 tasks Array of TaskResponseBody objects 批量绑定密钥对任务。 表8 TaskResponseBody 参数 参数类型 描述 task_id String 任务下发成功返回的ID。 server_id String 绑定的虚拟机id。 status String 任务下发的状态。SUC CES S或FAILED。 error_code String 任务下发失败返回的错误码。 error_msg String 任务下发失败返回的错误信息。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 batch_keypairs 是 Array of AssociateKeypairRequestBody objects 最多可同时选择10个弹性云服务器绑定密钥对。 约束：只支持选择相同的密钥对，弹性云服务器处于“运行中”状态，并未绑定密钥对。 表4 AssociateKeypairRequestBody 参数 是否必选 参数类型 描述 keypair_name 是 String SSH密钥对的名称 server 是 EcsServerInfo object 需要绑定密钥对的虚拟机信息。 表5 EcsServerInfo 参数 是否必选 参数类型 描述 id 是 String 需要绑定(替换或重置)SSH密钥对的虚拟机id auth 否 Auth object 可选字段，鉴权认证类型。替换时需要该参数，重置时不需要该参数。 disable_password 否 Boolean true：禁用虚拟机的ssh登录。 false：不禁用虚拟机的ssh登录。 port 否 Long SSH监听端口。 表6 Auth 参数 是否必选 参数类型 描述 type 否 String 取值为枚举类型。password或keypair。 key 否 String type为枚举值password时，key表示密码； type为枚举值keypair时，key表示私钥；

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表5 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表14 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表16 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 key_id 是 String 密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。 例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表15 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表17 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表18 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

错误码 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 CS MS.0002 The value of parameter is invalid. 请求XX参数错误 输入合法参数 400 C SMS .0003 the request is invalud. 请求非法 传递正确URL 400 CSMS.0004 The requested body format is wrong. 请求Body体格式错误 输入合法body体 400 CSMS.0005 The resource does not exist. 资源不存在 输入正确的凭据信息 400 CSMS.0103 The secret is in the scheduled deletion state. 凭据处于“计划删除”状态，不能使用. 确认凭据处于enable或disable状态 400 CSMS.0105 Can not delete the system internal stage. 禁止删除系统内置的版本状态 禁止删除内置版本 400 CSMS.0106 The secret name not found int the db. 数据库中不存在凭据名称 输入系统中存在的凭据的名称 400 CSMS.0107 The secret is in schedule delete state. 凭据已处于“计划删除"状态. 凭据已处于计划删除状态，输入其余凭据 400 CSMS.0108 The secret is not in schedule delete state. 凭据未处于“计划删除”状态. 凭据未处于计划删除状态，输入其他凭据 400 CSMS.0202 The number of secret has reached the upper limit. 凭据数量达到配额上限. 删除其余凭据 400 CSMS.0203 The number of stage has reached the upper limit. 凭据的版本状态数量达到配额上限. 删除其余版本状态 400 CSMS.0204 The number of stage is greater than the quota limit. 凭据的版本状态数量超出配额上限. 删除其余版本状态 400 CSMS.0301 Invalid X-Auth-Token. X-Auth-Token无效. 请重新获取token，并在使用时确保token字符串的完整性。 400 CSMS.0401 Can not get the protected secret value using the provided KMS key. 凭据值通过KMS服务加密解密失败. 请确保密钥存在且处于启用状态 403 CSMS.0109 The secret state is not enabled. 凭据对象未处于启用状态. 启用凭据后再进行其他操作 403 CSMS.0302 The user role has no permission to access the interface. 用户角色无权限访问接口. 请联系管理员给账户添加CSMS Fullacess权限。 404 CSMS.0205 Version quota not found for secret 凭据XX未发现相应的版本配额. 凭据已被删除，请选择其他凭据操作 404 CSMS.0206 Stage quota not found for secret 凭据XX未发现相应的版本状态配额. 凭据已被删除，请选择其他凭据操作 404 CSMS.0207 Secret quota not found. 未发现凭据配额信息. 凭据已被删除，请选择其他凭据操作 409 CSMS.0101 The secret name already exists. 凭据名称已存在. 输入其他合法的凭据名称 409 CSMS.0102 The version id already exists. 凭据版本号已存在. 输入其他合法的凭据版本号 409 CSMS.0104 The stage name already exists. 版本状态名称已存在. 输入其他合法的版本状态名称 500 CSMS.0001 An internal error occurred. 服务内部错误 请重试或联系客服。 500 CSMS.0006 AES encrypt secret value occurred an error. AES加密凭据值时发生错误. 请重试或联系客服。 500 CSMS.0201 The number of secret has reached the upper limit. 超出配额上限. 删除其余凭据 400 KMS.0105 A system exception occurred. Contact technical support. 发生系统异常。请联系技术支持。 请联系技术支持。 400 KMS.0106 It is replica service, readonly api allowed. 副本服务只允许只读操作。 副本服务只允许只读操作。 400 KMS.0201 Invalid request URL. 请求URL非法。 请传递正确的URL。 400 KMS.0202 Invalid JSON format of the request message. 请求消息JSON格式非法。 请传递正确的消息体。 400 KMS.0203 Request message too long. 请求消息长度超出限制。 请传递正确的消息体。 400 KMS.0204 Parameters missing in the request message. 请求消息缺少参数。 请传递正确的消息体。 400 KMS.0205 Invalid key ID. 密钥key_id非法。 请传递正确的密钥id。 400 KMS.0206 Invalid sequence number. sequence序号非法。 请传递正确的序列号。 400 KMS.0208 Invalid value of value encryption_context. encryption_context参数非法。 请检查encryption_context字段是否合法。 400 KMS.0209 The key has been disabled. 密钥已被禁用，不能使用。 请启用该密钥。 400 KMS.0210 The key is in Scheduled deletion state and cannot be used. 密钥处于计划删除状态，不能使用。 请启用该密钥。 400 KMS.0211 Cannot perform this operation on Default Master Keys. 默认主密钥不支持该操作。 请使用普通主密钥操作该任务。 400 KMS.0212 Invalid resource type. 资源类型非法。 请使用正确的资源类型。 400 KMS.0214 The request format is invalid. 请求格式非法。 请使用正确的请求格式。 400 KMS.0308 Invalid parameter. 字段非法。 请传递正确的参数。 400 KMS.0309 External keys required. 密钥来源应为外部导入。 请使用外部导入密钥进行此操作。 400 KMS.0310 The key is not in Pending import state. 密钥未处于等待导入状态。 请确保密钥状态处于“等待导入”状态。 400 KMS.0311 Failed to decrypt data using the RSA private key. RSA私钥解密数据失败。 请确保传入的密文的正确性，或联系技术支持。 400 KMS.0312 External keys cannot be rotated. 外部密钥不支持轮换操作。 请使用普通主密钥。 400 KMS.0313 Key rotation is not enabled. 密钥轮换未被启用。 请启用密钥轮换。 400 KMS.0315 Invalid partition_id. 分区类型非法。 输入正确的分区类型。 400 KMS.0317 The cmk partition is not enabled. 密钥分区类型未启用。 输入启用的分区类型。 400 KMS.0318 Partition name has exist. 分区类型名称已存在。 输入正确的分区类型名称。 400 KMS.0319 Rotation not supported in the current KMS version. 当前版本密钥管理系统不支持密钥轮换操作。 请重试或联系客服。 400 KMS.0320 Resource frozen. 资源已冻结，请您尽快续费。 请续费后重试。 400 KMS.0323 Failed to obtain the partition of the key. 获取密钥所在分区信息失败。 请重试或联系客服。 400 KMS.0324 RSA keys cannot be rotated. RSA密钥不支持轮换。 请使用普通主密钥。 400 KMS.0325 The asymmetric key is not support this operation. 非对称密钥不支持此操作。 请使用对称密钥重试。 400 KMS.0327 Failed to obtain user permissions. 获取用户操作权限失败。 请联系管理员给账户添加KMS CMKFullaccess权限。 400 KMS.0329 Hash algorithm does not match the digest length. 哈希算法与消息摘要长度不匹配。 请传递正确的参数，或者联系技术支持。 400 KMS.0331 The symmetric key is not support this operation. 对称密钥不支持此操作。 请使用正确的密钥类型重试。 400 KMS.0332 This key is not support the signing algorithm. 此密钥不支持签名算法。 请使用正确的签名算法，或者联系技术支持。 400 KMS.0333 The signing algorithm SM2DSA_SM3 not support RAW signing. 签名算法SM2DSA_SM3不支持RAW签名。 请使用正确的签名算法，或者联系技术支持。 400 KMS.0334 The cmk is used to encrypt and decrypt. 该密钥用于加解密。 该密钥用于加解密。 400 KMS.0335 The cmk is used to sign and verify. 该密钥用于签名和验证。 该密钥用于签名和验证。 400 KMS.0336 The current region does not support SM4. 当前区域不支持SM4。 更换算法，或者联系技术支持。 400 KMS.0337 The current region does not support SM2. 当前区域不支持SM2。 更换算法，或者联系技术支持。 400 KMS.0338 The custom keystore do not support rotation. 自定义密钥库不支持轮转。 联系技术支持。 400 KMS.0339 The custom keystore do not support import key. 自定义密钥库不支持导入密钥。 联系技术支持。 400 KMS.0340 not support keystore. 当前不支持密钥库。 联系技术支持。 400 KMS.0341 The hmac key do not support this operation. hmac密钥不支持该操作。 请传递正确的参数。 400 KMS.0401 Tag list cannot be empty. 标签列表不能为空。 请传递正确的参数。 400 KMS.0402 Invalid match value. match中value字段不合法。 请传递正确的参数。 400 KMS.0403 Invalid match key. match中key字段不合法。 请传递正确的参数。 400 KMS.0404 Invalid action. action字段不合法。 请传递正确的参数。 400 KMS.0405 Invalid tag value. tag中value字段不合法。 请传递正确的参数。 400 KMS.0406 Invalid tag key. tag中key字段不合法。 请传递正确的参数。 400 KMS.0407 Invalid tag list size. tag列表长度不合法。 请传递正确的参数。 400 KMS.0408 Invalid resourceType. resourceType字段不合法。 请传递正确的参数。 400 KMS.0409 Too many tags. tag达到上限。 标签配额已达到上限，请删除部分标签后再重试。 400 KMS.0410 Invalid tag value length. tag中value长度不合法。 请传递正确的参数。 400 KMS.0411 Invalid tag key length. tag中key长度不合法。 请传递正确的参数。 400 KMS.0412 Invalid tag list. tag list不合法。 请传递正确的参数。 400 KMS.0413 Too many tag values. tag中values列表长度超过限制。 请传递正确的参数。 400 KMS.0414 Invalid tags. tags字段不合法。 请传递正确的参数。 400 KMS.0415 Invalid matches. matches字段不合法。 请传递正确的参数。 400 KMS.0417 Invalid offset. offset不在有效数字范围内。 请传递正确的参数。 400 KMS.0418 Offset is not required. 不需要offset。 请传递正确的参数。 400 KMS.1101 Invalid key_alias. key_alias密钥别名非法。 请传递正确的参数。 400 KMS.1102 Invalid realm. realm密钥区域非法。 请传递正确的参数。 400 KMS.1103 Invalid key_description. key_description密钥描述非法。 请传递正确的参数。 400 KMS.1104 Duplicate key aliases. 密钥别名已经存在。 请更换别名。 400 KMS.1105 Too many keys. 密钥个数已达上限。 配额已达到上限，增加配额或者删除部分密钥。 400 KMS.1108 Failed to create the default partition for the key. 创建密钥所在默认分区失败。 请重试或联系客服。 400 KMS.1109 Failed to create the route for the key. 创建密钥路由信息失败。 请重试或联系客服。 400 KMS.1110 Invalid alg_type. 非法的算法类型。 请使用正确的算法类型。 400 KMS.1114 EC keys do not support to encrypt/decrypt. 该密钥不支持加解密。 请使用正确的密钥去加解密。 400 KMS.1115 Symmetric keys do not support to sign/verify. 对称密钥不支持签名/验证。 请使用非对称密钥重试。 400 KMS.1201 The key is not disabled. 密钥未被禁用。 请先禁用密钥。 400 KMS.1301 The key is not enabled. 密钥未被启用。 请先启用密钥。 400 KMS.1401 Set the pending deletion period between 7 to 1096 days. 计划删除密钥时间范围：7天h至1096天。 请传递正确的参数。 400 KMS.1402 The key is already in Pending deletion state. 密钥已处于计划删除状态。 密钥已经处于“计划删除”状态，无需再操作。 400 KMS.1404 This region is not the original region of the key, and it is not allowed to import-key-material. 此区域不是密钥的原始区域，不允许导入密钥材料。 当前局点不支持导入密钥材料。 400 KMS.1501 The key is not in Pending deletion state. 密钥未处于计划删除状态。 请先“计划删除”密钥。 400 KMS.1601 Invalid limit. limit不在有效数字范围内。 请传递正确的参数。 400 KMS.1602 marker must be greater than or equals 0. marker参数需大于等于0。 请传递正确的参数。 400 KMS.1603 Invalid offset. offset不在有效数字范围内。 请传递正确的参数。 400 KMS.1801 random_data_length must be 512 bits. random_data_length随机数长度需等于512位。 请传递正确的参数。 400 KMS.1802 random_data_length must be a multiple of 8. random_data_length必须能被8整除，即必须为整字节数。 请传递正确的参数。 400 KMS.1901 datakey_length must be in the range 8 bits to 8,192 bits. datakey_length必须介于8-8192比特之间。 请传递正确的参数。 400 KMS.1902 key_spec can only be AES_128 or AES_256. key_spec必须为AES_128或者AES_256。 请传递正确的参数。 400 KMS.1903 datakey_length must be a multiple of 8. datakey_length必须能被8整除，即必须为整字节数。 请传递正确的参数。 400 KMS.1904 The rsa wrapping data key is over length 1520 bits. rsa wrapping data key超过了1520字节。 请传递正确的参数。 400 KMS.2001 datakey_length must be 512 bits. datakey_length数据密钥长度需等于512位。 请传递正确的参数。 400 KMS.2101 Invalid plain_text. plain_text数据密钥明文非法。 请传递正确的参数。 400 KMS.2102 datakey_plain_length must be 64 bytes. datakey_plain_length数据密钥明文长度需等于64字节。 请传递正确的参数。 400 KMS.2103 Failed to verify the DEK hash. 数据密钥hash校验失败。 请确认数据密钥是否合法或联系客服。 400 KMS.2104 The length of plain_text does not match datakey_plain_length. plain_text实际长度与datakey_plain_length不匹配。 请传递正确的参数。 400 KMS.2105 The symmetric key not support this encryption algorithm. symmetric key不支持该加密算法。 请传递正确的参数。 400 KMS.2106 The rsa key not support this encryption algorithm. rsa key不支持该加密算法。 请传递正确的参数。 400 KMS.2107 The sm2 key not support this encryption algorithm. sm2 key不支持该加密算法。 请传递正确的参数。 400 KMS.2108 The rsa encryption plain_text is over length. rsa encryption plain_text长度过长。 请传递正确的参数。 400 KMS.2201 Invalid cipher_text. cipher_text数据密钥密文非法。 请传递正确的参数。 400 KMS.2202 datakey_cipher_length must be 64 bytes. datakey_cipher_length数据密钥密文长度需等于64字节。 请传递正确的参数。 400 KMS.2203 Failed to verify the DEK hash. 数据密钥hash校验失败。 请确认数据密钥是否合法或联系客服。 400 KMS.2204 The length of cipher_text does not match datakey_cipher_length. cipher_text实际长度与datakey_cipher_length不匹配。 请传递正确的参数。 400 KMS.2301 The quota value is beyond the maximum configurable limit. 配额值超出可配置的最大限制。 请传递正确的参数。 400 KMS.2302 New quota value must not less than old. 新配额值不得小于旧配额值。 请传递正确的参数。 400 KMS.2303 The quota type is not supported. 配额类型不支持。 请传递正确的参数。 400 KMS.2304 Can not update grant quota when no grant has created. 未创建授权时无法更新授权配额。 创建授权后重试。 400 KMS.2305 Can not update cmk quota when no cmk has created. 未创建cmk时无法更新cmk配额。 创建密钥后重试。 400 KMS.2401 Specify an operation in addition to create-grant. 操作不能只包含create-grant。 请传递正确的参数。 400 KMS.2402 Invalid user ID. 授权/退役主体非法。 请传递正确的参数。 400 KMS.2403 Failed to create the grant. 创建授权失败。 请重试或联系客服。 400 KMS.2404 Too many CMK grants. 用户主密钥授权超过上限。 配额已达到上限，增加配额或者删除部分授权。 400 KMS.2405 Too many grants. 主体授权超过上限。 配额已达到上限，增加配额或者删除部分授权。 400 KMS.2406 The basic partition has no right to create grant. 基本分区没有创建授权的权限。 联系技术支持。 400 KMS.2501 Invalid grant ID. grant不存在。 请传递存在的授权ID。 400 KMS.2502 grant_id and key_id do not match. grant_id与key_id不匹配。 请确保grant_id与key_id匹配。 400 KMS.2601 Token expired. 令牌已失效。 请重新获取令牌。 400 KMS.2602 Key expiration time must be later than the current time. 导入密钥失效时间必须大于当前时间。 请重新选择导入密钥失效时间。 400 KMS.2603 Key IDs in the imported key and token do not match. 导入密钥key_id与令牌中key_id不匹配。 请确保导入密钥key_id与令牌中key_id匹配。 400 KMS.2604 The external key plaintext length must be 32 bits. 外部密钥明文长度必须为32位。 请传递正确的参数。 400 KMS.2605 Token verification failed. 令牌校验失败。 请重新获取令牌。 400 KMS.2606 You are importing a deleted key again. The imported plaintext must be the same as the deleted key plaintext. 重新导入一个已删除的密钥材料时，外部密钥明文应与之前导入的一致。 请确保导入密钥明文与之前导入密钥明文数据一致。 400 KMS.2607 The import sm4 plain key length must 16. 导入sm4纯密钥长度必须为16。 请传递正确的参数。 400 KMS.2608 The imported asymmetric private key can not be null. 导入的非对称私钥不能为空。 请传递正确的参数。 400 KMS.2609 The imported asymmetric private is invalid. 导入的非对称私有非法。 请传递正确的参数。 400 KMS.2610 The temporary key length must be 16 or 32. 临时密钥长度必须为16或32。 请传递正确的参数。 400 KMS.2701 Key material is not in Enabled or Disabled state and cannot be deleted. 密钥材料只有在启用、禁用状态下方可被删除。 请确保密钥在“启用”、“禁用”状态。 400 KMS.2702 The imported private key material can not be deleted. 导入的私钥材料无法删除。 导入的私钥材料无法删除。 400 KMS.2801 End_time must bigger than start_time. End time必须大于start time。 请传递正确的参数。 400 KMS.2901 Key rotation is not disabled. 密钥轮换未被禁用。 请禁用密钥轮换。 400 KMS.3001 Invalid rotation_interval. rotation_interval不在有效数字范围内。 请传递正确的参数。 400 KMS.3103 Invalid id of tenant. 租户id非法。 请输入合法的租户id。 400 KMS.3201 Generate order id failed. 生成订单失败。 请重试或联系技术支持。 400 KMS.3202 KMS error. 订单资源错误。 请重试或联系技术支持。 400 KMS.3702 Invalid kms status parameter. kms状态参数非法。 请传递正确的参数。 400 KMS.3801 KMS key sync enable and configuration failed. KMS密钥同步和配置失败。 请重试或联系技术支持。 400 KMS.3802 Failed to sync operation convert to born region. 当前不支持密钥库。 联系技术支持。 400 KMS.3803 The key of born region is turn off sync ,so no operating can be performed. 当前不支持密钥库。 联系技术支持。 400 KMS.3804 AttestationDocument parsing failed. 文档解析失败。 请重试或联系技术支持。 400 KMS.3902 Invalid Service-Transaction-Id in request header. 请求header的Service-Transaction-Id参数非法。 请联系技术支持。 400 KMS.3903 Service-Transaction-Id is missing in request header. 请求header不存在Service-Transaction-Id参数。 请联系技术支持。 400 KMS.4001 Service name to notify is illegal. 用于通知的服务名称非法。 请联系技术支持。 400 KMS.4002 Service url to notify is illegal. 用于通知的服务url非法。 请联系技术支持。 400 KMS.5022 Tags are not compliant. 标签不合规。 请重试或联系技术支持。 400 KMS.5023 Pdp5 Header is invalid. Header参数非法。 请重试或联系技术支持。 403 KMS.0301 Invalid or null X-Auth-Token. X-Auth-Token为null或字符非法。 请重新获取token，并在使用时确保token字符串的完整性。 403 KMS.0302 Invalid X-Auth-Token. X-Auth-Token无效。 请重新获取token，并在使用时确保token字符串的完整性。 403 KMS.0303 X-Auth-Token expired. X-Auth-Token过期。 请重新获取token，并在使用时确保token字符串的完整性。 403 KMS.0304 X-Auth-Token contains the OBT tag and cannot be used to access services. X-Auth-Token包含公测标签，不能访问服务。 请重新获取token，并在使用时确保token字符串的完整性。 403 KMS.0305 Invalid X-Auth-Token project name. X-Auth-Token Project Name区域非法。 请重新获取token，并在使用时确保token字符串的完整性。 403 KMS.0306 No access permissions. 用户无权限访问密钥。 请联系管理员给账户添加KMS CMKFullaccess权限。 403 KMS.0307 No access permissions. 用户角色无权限访问接口。 请联系管理员给账户添加KMS CMKFullaccess权限。 403 KMS.0314 Real-name authentication is required to access the API. 用户未通过实名认证，不能访问该接口。 请完成实名认证后重试。 403 KMS.0321 URIs in URL and X-Auth-Token do not match. URL中包含的URL和X-Auth-Token中包含的URL不一致。 请确保URI和token中的项目ID一致后重试。 403 KMS.0322 The user has no permission to access the partition. 用户缺少分区类型的权限。 请配置权限后重试。 403 KMS.0326 No access permissions. 用户角色无权限访问接口。 请联系管理员给账户添加KMS CMKFullaccess权限。 403 KMS.0328 KMS has been frozen. Renew it and try again. 密钥管理已冻结，请续费解冻后重试。 请续费后重试。 403 KMS.0330 User has no permission. 用户缺少相关权限。 配置KMS CMKFullaccess权限后重试。 404 KMS.0207 The key does not exist. 密钥不存在。 请先创建密钥。 404 KMS.0316 No exist partition_id. 分区类型不存在。 输入分区类型。 404 KMS.0416 Invalid tag ID. tag不存在。 请传递存在的密钥标签。 404 KMS.3901 The requested jobId cannot be found. 任务id未找到。 请联系技术支持。 405 KMS.0215 Request method not supported. 请求方法不支持。 请使用支持的请求方式。 500 KMS.0100 Get-status error. 获取服务状态失败。 请联系技术支持。 500 KMS.0101 KMS error. KMS服务错误。 请重试或联系客服。 500 KMS.0102 Abnormal KMS I/O. KMS I/O异常。 请重试或联系客服。 500 KMS.0103 A system exception occurred. Contact technical support. 发生系统异常。请联系技术支持。 请联系技术支持。 500 KMS.3805 Failed to build digital envelope. 无法构建数字信封。 请重试或联系技术支持。 500 KMS.3806 Unable to obtain enclave root certificate, please contact technical support. 无法获取根证书，请联系技术支持。 联系技术支持。 500 KMS.5012 Request PDP service failed. 访问PDP服务失败。 请重试或联系技术支持。 500 KMS.5021 Check pdp5 auth failed. PDP5鉴权失败。 请重试或联系技术支持。 503 KMS.0104 A system exception occurred. Contact technical support. 发生系统异常。请联系技术支持。 请联系技术支持。 400 KPS.0001 taskId is illegal. task id非法。 使用合法的task id。 400 KPS.0002 parameter error. 参数错误。 使用正确的参数。 400 KPS.0005 Failed task is not found. task id错误。 填入正确的task id。 400 KPS.0006 User not found. 用户名错误。 使用正确的用户名。 400 KPS.4016 The key pair is not exist. 密钥对名称错误。 填入正确的密钥对名称。 400 KPS.6004 No Keypair find. 未找到密钥对。 填入正确的密钥对名称。 400 KPS.6005 No private key managed. 未找到托管的私钥。 确认私钥是否已托管。 400 KPS.6008 Encrypt private key failed. 加密私钥失败。 确认kms密钥是否存在以及状态是否可用。 400 KPS.6010 Save privatekey failed. 保存私钥失败。 确认kms密钥是否存在以及状态是否可用。 400 KPS.6011 The imported private key not match public key. 导入的私钥和公钥不匹配。 确认导入的公私钥对是否匹配。 401 KPS.9001 The token of the request is not or failed to be authenticated. token不合法。 使用合法的token。 401 KPS.9002 Public test service denied. 访问失败。 使用非公测账号。 403 KPS.6009 Keypair verify failed. 密钥对校验失败。 使用正确的托管校验码。 403 KPS.9003 No operation permission. 无权限访问。 添加对应的用户DEW KeypairFullaccess权限。 403 KPS.9004 The account is frozen. 账户被冻结。 账户被冻结。 403 KPS.9005 The account is restricted. 账户被限制。 账户被限制。 403 KPS.9006 Unknown user type. 账户无权限。 添加对应的用户DEW KeypairFullaccess权限。 父主题： 附录

密钥对管理 权限 对应API接口 授权项（Action） 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 创建和导入SSH密钥对（OpenStack原生） POST /v2.1/{project_id}/os-keypairs ecs:serverKeypairs:create - √ x 查询SSH密钥对详情（OpenStack原生） GET /v2.1/{project_id}/os-keypairs/{keypair_name} ecs:serverKeypairs:get - √ x 查询SSH密钥对列表（OpenStack原生） GET /v2.1/{project_id}/os-keypairs ecs:serverKeypairs:list - √ x 删除SSH密钥对（OpenStack原生） DELETE /v2.1/{project_id}/os-keypairs/{keypair_name} ecs:serverKeypairs:delete - √ x 父主题： 权限和授权项

响应示例 状态码： 200 请求已成功 { "resources" : [ { "resource_id" : "90c03e67-5534-4ed0-acfa-89780e47a535", "resource_detail" : [ { "key_id" : "90c03e67-5534-4ed0-acfa-89780e47a535", "domain_id" : "4B688Fb77412Aee5570E7ecdbeB5afdc", "key_alias" : "tagTest_xmdmi", "key_description" : "123", "creation_date" : 1521449277000, "scheduled_deletion_date" : "", "key_state" : 2, "default_key_flag" : 0, "key_type" : 1, "key_rotation_enabled" : false, "expiration_time" : "", "origin" : "kms", "sys_enterprise_project_id" : "0", "realm" : "test" } ], "resource_name" : "tagTest_xmdmi", "tags" : [ { "key" : "key", "value" : "testValue!" }, { "key" : "haha", "value" : "testValue" } ] } ], "total_count" : 1 }

请求示例 查询标签键为”key1“，标签值为”value1“或”value2“的密钥实例，起始位置为100，显示条数100。 { "offset" : "100", "limit" : "100", "action" : "filter", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }

响应示例 状态码： 200 请求已成功 { "event" : { "name" : "event-test", "event_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "state" : "ENABLED", "event_types" : [ "SECRET_VERSION_CREATED", "SECRET_VERSION_EXPIRED" ], "create_time" : 1581507580000, "update_time" : 1581507580000, "notification" : { "target_type" : " SMN ", "target_id" : "urn:smn:cn-north-4:SecertExpirationTest", "target_name" : "SecertExpirationNotificationTest" } } }

请求示例 创建事件。 { "name" : "demo-event", "event_types" : [ "SECRET_VERSION_CREATED", "SECRET_VERSION_EXPIRED" ], "state" : "ENABLED", "notification" : { "target_type" : "SMN", "target_id" : "urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:test-poc", "target_name" : "demo-smn-name" } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 event Event object 事件通知对象。 表6 Event 参数 参数类型 描述 name String 事件通知名称。 event_id String 事件通知的资源标识符。 event_types Array of strings 设置事件的基础事件类型列表,。 约束：数组大小：最小1，最大12。 state String 事件通知状态，取值如下。 ENABLED：表示启用状态 DISABLED：表示禁用状态 create_time Long 事件通知创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 update_time Long 事件通知上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数。 notification Notification object 通知主题对象。 表7 Notification 参数 参数类型 描述 target_type String 事件通知的对象类型。 target_id String 事件通知的对象ID。 target_name String 事件通知的对象名称。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表14 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表16 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表18 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表20 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表21 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 新创建事件通知的名称。 约束：取值范围为1到64个字符，满足正则匹配“^[a-zA-Z0-9_-]{1,64}$”。 event_types 是 Array of strings 本次事件通知的基础事件列表，基础事件类型如下。 SECRET_VERSION_CREATED：版本创建 SECRET_VERSION_EXPIRED：版本过期 SECRET_ROTATED：凭据轮转 SECRET_DELETED：凭据删除 SECRET_ROTATED_FAILED:凭据轮转失败 列表包含的基础事件类型不能重复。 state 是 String 控制事件是否生效，只有启用状态才能触发包含的基础事件类型 ENABLED：启用 DISABLED：禁用 notification 是 Notification object 通知主题对象。 表4 Notification 参数 是否必选 参数类型 描述 target_type 是 String 事件通知的对象类型。 target_id 是 String 事件通知的对象ID。 target_name 是 String 事件通知的对象名称。

响应示例 状态码： 200 请求已成功 { "keypair" : { "name" : "demo2", "private_key" : "-----BEGIN RSA PRIVATE KEY-----..." } } 状态码： 400 Error response { "error_code" : "KPS.XXX", "error_msg" : "XXX" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 keypair ExportPrivateKeyKeypairBean object 导出的私钥信息。 表6 ExportPrivateKeyKeypairBean 参数 参数类型 描述 name String SSH密钥对的名称。 private_key String SSH密钥对的私钥 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 keypair 是 KeypairBean object 待导出私钥的的密钥对信息。 表4 KeypairBean 参数 是否必选 参数类型 描述 name 是 String SSH密钥对名称。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 version_metadata VersionMetadata object 凭据版本被标记的状态。 表5 VersionMetadata 参数 参数类型 描述 id String 凭据的版本号标识符，凭据对象下唯一。 create_time Long 凭据版本创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 expire_time Long 凭据版本过期时间，时间戳，即从1970年1月1日至该时间的总秒数。默认为空，凭据订阅“版本过期”事件类型时，有效期判断所依据的值。 kms_key_id String 加密版本凭据值的KMS主密钥ID。 secret_name String 凭据名称。 version_stages Array of strings 凭据版本被标记的状态列表。每个版本标签对于凭据对象下版本是唯一存在的，如果创建版本时，指定的是同一凭据对象下的一个已经标记在其他版本上的状态，该标签将自动从其他版本上删除，并附加到此版本上。 如果未指定version_stage的值，则凭据管理服务会自动移动临时标签SYSCURRENT到此新版本。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 502 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 504 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 请求已成功 { "version_metadata" : { "id" : "v3", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "create_time" : 1581507580000, "secret_name" : "secret-name-demo", "version_stages" : [ "SYSCURRENT" ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 expire_time 是 Long 凭据版本过期时间，时间戳，即从1970年1月1日至该时间的总秒数。默认为空，凭据订阅“版本过期”事件类型时，有效期判断所依据的值。

请求示例 签名消息信息，使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥，采用"RSASSA_PKCS1_V1_5_SHA_256"签名算法，对摘要消息进行签名。 { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "signing_algorithm" : "RSASSA_PKCS1_V1_5_SHA_256", "message" : "MmFiZWE0ZjI3ZGIxYTkzY2RmYmEzM2YwMTA1YmJjYw==" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 key_id 是 String 密钥ID，36字节，满足正则匹配“^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$”。 例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。 message 是 String 待签名的消息摘要或者消息，消息长度要求小于4096字节，使用Base64编码。 signing_algorithm 是 String 签名算法，枚举如下： RSASSA_PSS_SHA_256 RSASSA_PSS_SHA_384 RSASSA_PSS_SHA_512 RSASSA_PKCS1_V1_5_SHA_256 RSASSA_PKCS1_V1_5_SHA_384 RSASSA_PKCS1_V1_5_SHA_512 ECDSA_SHA_256 ECDSA_SHA_384 ECDSA_SHA_512 SM2DSA_SM3 message_type 否 String 消息类型，默认为“DIGEST”，枚举如下： DIGEST 表示消息摘要 RAW 表示消息原文 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_id String 密钥ID。 signature String 签名值，使用base64编码。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表15 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表17 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表18 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

响应消息 表3 响应参数 参数 是否必选 参数类型 描述 changed 是 Integer 复制的密钥对数量。 success 是 Array of objects 复制成功的密钥对列表，详情请参见表4。 failed 是 Array of objects 复制失败的密钥对列表，详情请参见表4。 表4 success/failed字段数据结构说明 参数 是否必选 参数类型 描述 keypair 是 String 密钥对名称。 message 是 String 任务消息

响应示例 状态码： 200 请求已成功 { "total_count" : 1, "resources" : [ { "resource_id" : "2d1152f2-290d-4756-a1d2-e12c14992416" }, { "resource_detail" : { "id" : "2d1152f2-290d-4756-a1d2-e12c14992416", "name" : "example_name", "state" : "ENABLED", "description" : "", "kms_key_id" : "1213d410-ass1-1254-1a2d-3cca2sa2w554", "create_time" : 1581507580000, "update_time" : 1581507580000, "scheduled_delete_time" : 1581507580000 } }, { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }, { "sys_tags" : null }, { "resource_name" : "example_name" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 limit 否 String 查询记录数（“action”为“count”时，无需设置此参数），如果“action”为“filter”，默认为“10”。 limit的取值范围为“1-1000”。 offset 否 String 索引位置。从offset指定的下一条数据开始查询。查询第一页数据时，将查询前一页数据时响应体中的值带入此参数（“action”为“count”时，无需设置此参数）。如果“action”为“filter”，offset默认为“0”。 offset必须为数字，不能为负数。 action 是 String 操作标识（可设置为“filter”或者“count”）。 filter：表示过滤。 count：表示查询总条数。 tags 否 Array of Tag objects 标签列表，key和value键值对的集合。最多不超过10个。 matches 否 Array of TagMatches objects 搜索字段。 key为搜索的字段，目前仅支持搜索凭据名称，值为“resource_name”。 value为模糊匹配的值，最大长度为255个字符。为空返回空值。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff 表4 Tag 参数 是否必选 参数类型 描述 key 否 String 标签键。 values 否 Array of strings 标签值集合。 约束：最多包含10个value。标签列表中的标签value值不允许重复。标签列表如果为空列表，表示匹配任意值。标签列表中多个value之间是“或”的关系，在key已经满足要求的前提下，满足请求中的某个value就会匹配出来。 表5 TagMatches 参数 是否必选 参数类型 描述 key 否 String 为要匹配的字段。 约束：值只能为resource_name。 value 否 String 模糊匹配的值。 约束：最大长度为255个字符，为空返回空值。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户来进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见企业管理应用场景。

概述 欢迎使用 数据加密 服务（Data Encryption Workshop，DEW）。数据加密服务是一个综合的云上数据加密服务。它可以提供专属加密、密钥管理、凭据管理、密钥对管理等服务，安全可靠地为用户解决了数据安全、密钥安全、密钥管理复杂等问题。其密钥由硬件安全模块（Hardware Security Module，HSM） 保护，并与多个华为云服务集成。您也可以借此服务开发自己的加密应用。 在调用数据加密服务API之前，请确保已经充分了解数据加密服务相关概念，详细信息请参见产品介绍。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_info KeKInfo object 密钥详细信息。 表5 KeKInfo 参数 参数类型 描述 key_id String 密钥ID。 domain_id String 用户域ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表16 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表18 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

接口约束 别名“/default”为服务默认主密钥的后缀名，由服务自动创建。因此用户创建的主密钥别名不能与服务默认主密钥的别名相同，即后缀名不能为“/default”。 对于开通企业项目的用户，服务默认主密钥属于且只能属于默认企业项目下，且不支持企业资源的迁入迁出。服务默认主密钥为用户提供基础的云上加密功能，满足合规要求。因此，在企业多项目下，其他非默认企业项目下的用户均可使用该密钥。若客户有企业管理资源诉求，请自行创建和使用密钥。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 key_alias 是 String 非默认主密钥别名，取值范围为1到255个字符，满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”，且不与系统服务创建的默认主密钥别名重名。 key_spec 否 String 密钥生成算法，默认为“AES_256”，枚举如下： AES_256 SM4 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 key_usage 否 String 密钥用途，对称密钥默认为“ENCRYPT_DECRYPT”，非对称密钥默认为“SIGN_VERIFY”，枚举如下： ENCRYPT_DECRYPT SIGN_VERIFY key_description 否 String 密钥描述，取值0到255字符。 origin 否 String 密钥来源，默认为“kms”，枚举如下： kms：表示密钥材料由kms生成。 external：表示密钥材料由外部导入。 enterprise_project_id 否 String 企业多项目ID。 用户未开通企业多项目时，不需要输入该字段。 用户开通企业多项目时，创建资源可以输入该字段。若用户户不输入该字段，默认创建属于默认企业多项目ID（ID为“0”）的资源。 注意：若用户没有默认企业多项目ID（ID为“0”）下的创建权限，则接口报错。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff keystore_id 否 String 密钥库ID，默认使用KMS默认密钥库