华为云用户手册

请求示例 创建一个名字为demo的凭据，使用kms密钥ID为0d0466b0-e727-4d9c-b35d-f84bb474a37f对“this is a demo secret string”凭据值加密。 { "name" : "demo", "kms_key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "secret_string" : "this is a demo secret string" }

响应示例 状态码： 200 请求已成功 { "secret" : { "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "name" : "test", "state" : "ENABLED", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "description" : "description", "create_time" : 1581507580000, "update_time" : 1581507580000, "scheduled_delete_time" : 1581507580000, "secret_type" : "RDS-FG", "auto_rotation" : true, "rotation_config" : "{'InstanceId':'63616bceef2c45409575d762a498318bin01','SecretSubType':'MultiUser'}", "rotation_period" : "1d", "rotation_time" : 1668567940000, "next_rotation_time" : 1668629140000, "event_subscriptions" : [ "pocEvent" ], "rotation_func_urn" : "urn:fss:{region}:46b6f338fc3445b8846c71dfb1fbxxxx:function:default:test2-0:latest" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 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：GaussDB凭据。专门针对GaussDB的凭据，用于存储GaussDB的账号信息。 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 表4 响应Body参数 参数 参数类型 描述 secret Secret object 凭据对象。 表5 Secret 参数 参数类型 描述 id String 凭据的资源标识符。 name String 凭据名称。 state String 凭据状态，取值如下： ENABLED：表示启用状态 DISABLED：表示禁用状态 PENDING_DELETE：表示待删除状态 FROZEN：表示冻结状态 kms_key_id String 用于加密凭据值的KMS主密钥的ID值。 description String 凭据的描述信息。 create_time Long 凭据创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 update_time Long 凭据上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数。 scheduled_delete_time Long 凭据计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。 凭据不在删除计划中时，本项值为null。 secret_type String 凭据类型 COMMON：通用凭据(默认)。用于应用系统中的各种敏感信息储存。 RDS：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息。（已不支持，使用RDS-FG替代） RDS-FG：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息。 GaussDB-FG：GaussDB凭据。专门针对GaussDB的凭据，用于存储GaussDB的账号信息。 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":""} 说明：当secret_type为RDS-FG、GaussDB-FG时，必须填写该值 InstanceId为实例ID,SecretSubType为轮转子类型，取值为：SingleUser，MultiUser。 SingleUser：指定轮转类型为单用户模式轮转，每次轮转将指定账号重置为新的口令。 MultiUser：指定轮转类型为双用户模式轮转，SYSCURRENT和SYSPREVIOUS分别引用其中一个账号。凭据轮转时，SYSPREVIOUS引用的账号口令会被重置为新的随机口令，随后凭据交换SYSCURRENT和SYSPREVIOUS对账号的引用。 rotation_time Long 轮转时间戳 next_rotation_time Long 下一次轮转时间戳 event_subscriptions Array of strings 凭据订阅的事件列表，当前最大可订阅一个事件。当事件包含的基础事件触发时，通知消息将发送到事件对应的通知主题。 enterprise_project_id String 企业项目ID rotation_func_urn String FunctionGraph函数的urn。 状态码： 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 请求已成功 { "key_info" : { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd", "key_alias" : "test", "realm" : "test", "key_description" : "key_description", "creation_date" : "1502799822000", "scheduled_deletion_date" : "", "key_spec" : "AES_256", "key_usage" : "ENCRYPT_DECRYPT", "key_state" : "2", "default_key_flag" : "0", "key_type" : "1", "expiration_time" : "1501578672000", "origin" : "kms", "key_rotation_enabled" : "false", "sys_enterprise_project_id" : "0" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_info KeyDetails object 密钥详情。 表5 KeyDetails 参数 参数类型 描述 key_id String 密钥ID。 domain_id String 用户域ID。 key_alias String 密钥别名。 realm String 密钥区域。 key_spec String 密钥生成算法。 AES_256 SM4 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 key_usage String 密钥用途。 ENCRYPT_DECRYPT SIGN_VERIFY key_description String 密钥描述。 creation_date String 密钥创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 scheduled_deletion_date String 密钥计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。 key_state String 密钥状态，满足正则匹配“^[1-5]{1}$”，枚举如下： “1”表示待激活状态 “2”表示启用状态 “3”表示禁用状态 “4”表示计划删除状态 “5”表示等待导入状态 default_key_flag String 默认主密钥标识，默认主密钥标识为1，非默认标识为0。 key_type String 密钥类型。 expiration_time String 密钥材料失效时间，时间戳，即从1970年1月1日至该时间的总秒数。 origin String 密钥来源，默认为“kms”，枚举如下： kms表示密钥材料由kms生成 external表示密钥材料由外部导入 key_rotation_enabled String 密钥轮换状态，默认为“false”，表示关闭密钥轮换功能。 sys_enterprise_project_id String 企业项目ID，默认为“0”。 对于开通企业项目的用户，表示资源处于默认企业项目下。 对于未开通企业项目的用户，表示资源未处于企业项目下。 keystore_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 错误请求返回的错误信息

请求参数 表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

URI PUT /v1/{project_id}/secrets/{secret_name}/stages/{stage_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 secret_name 是 String 凭据名称。 stage_name 是 String 凭据版本状态的名称。满足 '^[a-zA-Z0-9_-]{1,64}$'

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 stage Stage object 凭据状态。 表5 Stage 参数 参数类型 描述 name String 凭据的版本状态名称。 约束：最小长度1，最大长度64。 update_time Long 凭据的版本状态更新的时间戳，时间戳，即从1970年1月1日至该时间的总秒数。 secret_name String 凭据名称。 version_id String 凭据的版本号标识符。 状态码： 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 错误描述

请求示例 导入密文密钥材料到ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥中。 { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "import_token" : "AACIBjY2ZTQxYItNDU4Ny04OTIxLWVhZTVhZjg5NDZm....", "encrypted_key_material" : "e0wTU/YJT/HDxsEv2NE+3CKT1..." }

响应参数 状态码： 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。 import_token 是 String 密钥导入令牌，base64格式，满足正则匹配“^[0-9a-zA-Z+/=]{200,6144}$”。 encrypted_key_material 是 String 加密后的对称密钥材料，base64格式，满足正则匹配“^[0-9a-zA-Z+/=]{344,360}$”。若导入非对称密钥，则该参数为用于加密私钥的临时中间密钥。 encrypted_privatekey 否 String 使用临时中间密钥加密后的私钥，导入非对称密钥需要该参数，base64格式，满足正则匹配“^[0-9a-zA-Z+/=]{200,6144}$”。 expiration_time 否 Long 密钥材料到期时间，时间戳，即从1970年1月1日至该时间的总秒数，KMS会在该时间的24小时内删除密钥材料。 例如：1550291833 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

场景描述 在大量数据加解密的场景，您的程序会经常使用到对数据密钥的加解密。 大量 数据加密 的流程如下： 在KMS中创建一个用户主密钥。 调用KMS的“create-datakey”接口创建数据加密密钥。用户得到一个明文的数据加密密钥和一个密文的数据加密密钥。其中密文的数据加密密钥是由指定的用户主密钥加密明文的数据加密密钥生成的。 用户使用明文的数据加密密钥来加密明文文件，生成密文文件。 用户将密文的数据加密密钥和密文文件一同存储到持久化存储设备或服务中。 大量数据解密的流程如下： 用户从持久化存储设备或服务中读取密文的数据加密密钥和密文文件。 用户调用KMS的“decrypt-datakey”接口，使用对应的用户主密钥（即生成密文的数据加密密钥时所使用的用户主密钥）来解密密文的数据加密密钥，取得明文的数据加密密钥。 若对应的用户主密钥被误删除，会导致解密失败。因此，需要妥善管理好用户主密钥。 用户使用明文的数据加密密钥来解密密文文件。

操作步骤 创建用户主密钥。 接口相关信息 URI格式：POST /v1.0/{project_id}/kms/create-key 详情请参见创建密钥。 别名“/default”为服务默认主密钥的后缀名，由服务自动创建。因此用户创建的主密钥别名不能与服务默认主密钥的别名相同，即后缀名不能为“/default”。 请求示例 POST: https://{endpoint}/v1.0/53d1aefc533f4ce9a59c26b01667cbcf/kms/create-key {endpoint}信息请从地区和终端节点获取。 Body： { "key_alias": "test" } 响应示例 { "key_info": { "key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "domain_id": "b168fe00ff56492495a7d22974df2d0b" } } 创建数据密钥。 接口相关信息 URI格式：POST /v1.0/{project_id}/kms/create-datakey 详情请参见创建数据密钥。 请求示例 POST https://{endpoint}/v1.0/53d1aefc533f4ce9a59c26b01667cbcf/kms/create-datakey {endpoint}信息请从地区和终端节点获取。 您可使用查询密钥列表接口获取当前用户密钥列表，包括key_id等信息 。 Body： { "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "datakey_length": "512" } 响应示例 { "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "plain_text": "8151014275E426C72EE7D44267EF11590DCE0089E19863BA8CC832187B156A72A5A17F17B5EF0D525872C59ECEB72948AF85E18427F8BE0D46545C979306C08D", "cipher_text": "020098009EEAFCE122CAA5927D2E020086F9548BA1675FDB022E4ECC01B96F2189CF4B85E78357E73E1CEB518DAF7A4960E7C7DE8885ED3FB2F1471ABF400119CC1B20BD3C4A9B80AF590EFD0AEDABFDBB0E2B689DA7B6C9E7D3C5645FCD9274802586BE63779471F9156F2CDF07CD8412FFBE9230643034363662302D653732372D346439632D623335642D6638346262343734613337660000000045B05321483BD9F9561865EE7DFE9BE267A42EB104E98C16589CE46940B18E52" } 加密数据密钥。 接口相关信息 URI格式：POST /v1.0/{project_id}/kms/encrypt-datakey 详情请参见加密数据密钥。 请求示例 POST https://{endpoint}/v1.0/53d1aefc533f4ce9a59c26b01667cbcf/kms/encrypt-datakey {endpoint}信息请从地区和终端节点获取。 您可使用查询密钥列表接口获取当前用户密钥列表，包括key_id等信息 。 Body： { "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "plain_text": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000F5A5FD42D16A20302798EF6ED309979B43003D2320D9F0E8EA9831A92759FB4B", "datakey_plain_length": "64" } 响应示例 { "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "cipher_text": "020098005273E14E6E8E95F5463BECDC27E80AF820B9FC086CB47861899149F67CF07DAFF2810B7D27BDF19AB7632488E0926A48DB2FC85BEA905119411B46244C5E6B8036C60A0B0B4842FFE6994518E89C19B1C1D688D9043BCD6053EA7BA0652642CE59F2543C80669139F4F71ABB9BD9A24330643034363662302D653732372D346439632D623335642D66383462623437346133376600000000D34457984F9730D57F228C210FD22CA6017913964B21D4ECE45D81092BB9112E", "datakey_length": "64" } 解密数据密钥。 接口相关信息 URI格式：POST /v1.0/{project_id}/kms/decrypt-datakey 详情请参见解密数据密钥。 请求示例 POST https://{endpoint}/v1.0/53d1aefc533f4ce9a59c26b01667cbcf/kms/decrypt-datakey {endpoint}信息请从地区和终端节点获取。 您可使用查询密钥列表接口获取当前用户密钥列表，包括key_id等信息 。 Body： { "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "datakey_cipher_length": "64", "cipher_text": "020098005273E14E6E8E95F5463BECDC27E80AF820B9FC086CB47861899149F67CF07DAFF2810B7D27BDF19AB7632488E0926A48DB2FC85BEA905119411B46244C5E6B8036C60A0B0B4842FFE6994518E89C19B1C1D688D9043BCD6053EA7BA0652642CE59F2543C80669139F4F71ABB9BD9A24330643034363662302D653732372D346439632D623335642D66383462623437346133376600000000D34457984F9730D57F228C210FD22CA6017913964B21D4ECE45D81092BB9112E" } 响应示例 { "data_key": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "datakey_length": "64", "datakey_dgst": "F5A5FD42D16A20302798EF6ED309979B43003D2320D9F0E8EA9831A92759FB4B" }

响应示例 状态码： 200 OK { "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c", "task_status" : "RUNNING_RESET", "server_id" : "c9aa197b-a6b6-4c33-b3a6-fa0b4ec50006" } 状态码： 400 Error response { "error_code" : "KPS.XXX", "error_msg" : "XXX" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 server_id String 租户虚拟机ID task_id String 任务下发成功返回的ID task_status String 密钥对正在处理的状态。 READY_RESET 准备重置 RUNNING_RESET 正在重置 FAILED_RESET 重置失败 SUC CES S_RESET 重置成功 READY_REPLACE 准备替换 RUNNING_REPLACE 正在替换 FAILED_RESET 替换失败 SUCCESS_RESET 替换成功 READY_UNBIND 准备解绑 RUNNING_UNBIND 正在解绑 FAILED_UNBIND 解绑失败 SUCCESS_UNBIND 解绑成功 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 { "batch_keypairs" : [ { "keypair_name" : "1", "server" : { "id" : "fxxx16e3-74b8-4025-9852-1f451932c20c", "disable_password" : false, "auth" : { "type" : "password", "key" : "password" } } }, { "keypair_name" : "1", "server" : { "id" : "4xxxxfc4-b4bf-49c2-b983-a1811c9760c1", "disable_password" : false, "auth" : { "type" : "password", "key" : "password" } } } ] }

响应示例 状态码： 202 请求已成功。 { "tasks" : [ { "server_id" : "xxx", "task_id" : "xxx", "status" : "SUCCESS" }, { "server_id" : "xxx", "status" : "Failed", "error_code" : "xxxx", "error_msg" : "xxxx" } ] } 状态码： 400 Error response { "error_code" : "KPS.XXX", "error_msg" : "XXX" }

响应参数 状态码： 202 表7 响应Body参数 参数 参数类型 描述 tasks Array of TaskResponseBody objects 批量绑定密钥对任务。 表8 TaskResponseBody 参数 参数类型 描述 task_id String 任务下发成功返回的ID。 server_id String 绑定的虚拟机id。 status String 任务下发的状态。SUCCESS或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 错误请求返回的错误信息