{ "name": "kms", "display_name": "密钥管理系统", "description": "介绍如何使用API对密钥管理系统进行操作，包括非对称/白盒密钥的创建、禁用等。", "domain": "security", "api_version": "2019-01-18", "endpoint": "kms.tencentcloudapi.com", "actions": [ { "name": "ArchiveKey", "description": "对密钥进行归档，被归档的密钥只能用于解密，不能加密", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId" ] }, { "name": "AsymmetricRsaDecrypt", "description": "使用指定的RSA非对称密钥的私钥进行数据解密，密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK的唯一标识", "example": "554ef4b3-3071-11ea-a86a-5254006d0810" }, { "name": "Ciphertext", "type": "string", "required": true, "description": "使用PublicKey加密的密文，Base64编码", "example": "vlnJ/RrQE0mXiHGoya/xpKQJHkd5ImvdXug306BreYL60Kb8ucqQ0eurf5mX/mKZDSTGr8FDVK8b4HOopj7xuDQIzegObtvK2VGbXSaihI/fNDkmoWcgBF/V91scYJtrkwoISnvqsxcl9NeAp+H2A6E3vTiDpQK5oVb3OTG39FoYEvfbRNfef+iukiRiqOL7VGSPmx1nThi6Cd4XGBFzB0tvtmP2SnZhZuzryj+jnHVAz2bIuYP8M4OJYkk5muuACWxLGLQj5sh2FqIpbzT4nti4fOD4ieHnf/qCw/9yyiWUED67oelFKaBJEWGq3PT7bGtH4Sxx8SKx2BCBsR95sA==" }, { "name": "Algorithm", "type": "string", "required": true, "description": "在使用公钥加密时对应的算法：当前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256", "example": "RSAES_OAEP_SHA_256" } ], "required": [ "KeyId", "Ciphertext", "Algorithm" ] }, { "name": "AsymmetricSm2Decrypt", "description": "使用指定的SM2非对称密钥的私钥进行数据解密，密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。传入的密文的长度不能超过256字节。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK的唯一标识", "example": "fce1015e-9735-11ef-be86-6abd61583d2d" }, { "name": "Ciphertext", "type": "string", "required": true, "description": "使用PublicKey加密的密文，Base64编码，原始密文格式需要为C1C3C2_ASN1。原始密文长度不能超过256字节。", "example": "MG0CICuRefoqE7g5bpsZNYq+9d909cZl7nFuYFHiDhOqz8GAAiEA4lqmt3nGqpbu0qhbWsStkexXA2cA12nVWjgruFP5WKkEIG6JwYejm9gEr7CPOOhbirsGhga3W7J6C7kwdmf6VebRBATH1o2G" } ], "required": [ "KeyId", "Ciphertext" ] }, { "name": "BindCloudResource", "description": "记录当前key被哪个云产品的那个资源所使用。如果当前key设置了自动过期，则取消该设置，确保当前key不会自动失效。如果当前关联关系已经创建，也返回成功。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "cmk的ID", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "ProductId", "type": "string", "required": true, "description": "云产品的唯一性标识符", "example": "ssm" }, { "name": "ResourceId", "type": "string", "required": true, "description": "资源/实例ID，由调用方根据自己的云产品特征来定义，以字符串形式做存储。", "example": "resourceId" } ], "required": [ "KeyId", "ProductId", "ResourceId" ] }, { "name": "CancelDataKeyDeletion", "description": "取消计划删除数据密钥", "status": "online", "parameters": [ { "name": "DataKeyId", "type": "string", "required": true, "description": "数据密钥的唯一标志符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyId" ] }, { "name": "CancelKeyArchive", "description": "取消密钥归档，取消后密钥的状态变为Enabled。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId" ] }, { "name": "CancelKeyDeletion", "description": "取消CMK的计划删除操作", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "需要被取消删除的CMK的唯一标志", "example": "7fa07bcf-9753-11ef-947b-525400d834e5" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId" ] }, { "name": "CreateKey", "description": "创建用户管理数据密钥的主密钥CMK（Custom Master Key）。", "status": "online", "parameters": [ { "name": "Alias", "type": "string", "required": true, "description": "作为密钥更容易辨识，更容易被人看懂的别名， 不可为空，1-60个字母数字 - _ 的组合，首字符必须为字母或者数字。以 kms- 作为前缀的用于云产品使用，Alias 不可重复。", "example": "test6-lzc" }, { "name": "Description", "type": "string", "required": false, "description": "CMK 的描述，最大1024字节", "example": "描述信息" }, { "name": "KeyUsage", "type": "string", "required": false, "description": "指定key的用途，默认为 \"ENCRYPT_DECRYPT\" 表示创建对称加解密密钥，其它支持用途 “ASYMMETRIC_DECRYPT_RSA_2048” 表示创建用于加解密的RSA2048非对称密钥，“ASYMMETRIC_DECRYPT_SM2” 表示创建用于加解密的SM2非对称密钥，“ASYMMETRIC_SIGN_VERIFY_SM2” 表示创建用于签名验签的SM2非对称密钥，“ASYMMETRIC_SIGN_VERIFY_ECC” 表示创建用于签名验签的ECC非对称密钥，“ASYMMETRIC_SIGN_VERIFY_RSA_2048” 表示创建用...", "example": "ENCRYPT_DECRYPT" }, { "name": "Type", "type": "integer", "required": false, "description": "指定key类型，默认为1，1表示默认类型，由KMS创建CMK密钥，2 表示EXTERNAL 类型，该类型需要用户导入密钥材料，参考 GetParametersForImport 和 ImportKeyMaterial 接口", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "[{\"TagKey\":\"env\",\"TagValue\":\"dev\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "dev" } ] }, { "name": "HsmClusterId", "type": "string", "required": false, "description": "KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。", "example": "cluster-123" } ], "required": [ "Alias" ] }, { "name": "CreateWhiteBoxKey", "description": "创建白盒密钥。 密钥个数的上限为 50。", "status": "online", "parameters": [ { "name": "Alias", "type": "string", "required": true, "description": "作为密钥更容易辨识，更容易被人看懂的别名， 不可为空，1-60个字母数字 - _ 的组合，首字符必须为字母或者数字。Alias不可重复。", "example": "test-lzcw" }, { "name": "Algorithm", "type": "string", "required": true, "description": "创建密钥所有的算法类型，支持的取值：AES_256,SM4", "example": "SM4" }, { "name": "Description", "type": "string", "required": false, "description": "密钥的描述，最大1024字节", "example": "白盒测试" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "[{\"TagKey\":\"env\",\"TagValue\":\"dev\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "dev" } ] } ], "required": [ "Alias", "Algorithm" ] }, { "name": "Decrypt", "description": "本接口用于解密密文，得到明文数据。", "status": "online", "parameters": [ { "name": "CiphertextBlob", "type": "string", "required": true, "description": "待解密的密文数据", "example": "GPJUsGlmPcSjHKIktXGyzn33yestz+7NteW36M6FuL8hPfJ1xVfdO6Akr8sF69x3yBXMwto4njumJMIsi9WKow==-k-XqqalxTyNKIC1rITRePFGQ==-k-GqsANzNxvjjXhKwJAOY85vxYYm/2RtsCXRq7Q1iWbCAoeAtZ" }, { "name": "EncryptionContext", "type": "string", "required": false, "description": "key/value对的json字符串，如果Encrypt指定了该参数，则在调用Decrypt API时需要提供同样的参数，最大支持1024字符", "example": "{\"key1\":\"value1\"}" }, { "name": "EncryptionPublicKey", "type": "string", "required": false, "description": "PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。", "example": "-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAEtXY****ydfJiHQuh2Jr9lMAU+Hztyhd6Aw== -----END PUBLIC KEY-----" }, { "name": "EncryptionAlgorithm", "type": "string", "required": false, "description": "非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。", "example": "SM2" } ], "required": [ "CiphertextBlob" ] }, { "name": "DeleteImportedKeyMaterial", "description": "用于删除导入的密钥材料，仅对EXTERNAL类型的CMK有效，该接口将CMK设置为PendingImport 状态，并不会删除CMK，在重新进行密钥导入后可继续使用。彻底删除CMK请使用 ScheduleKeyDeletion 接口。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "指定需要删除密钥材料的EXTERNAL CMK。", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" } ], "required": [ "KeyId" ] }, { "name": "DeleteWhiteBoxKey", "description": "删除白盒密钥, 注意：必须先禁用后，才可以删除。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "白盒密钥的全局唯一标识符", "example": "244dab8c-6dad-11ea-80c6-5254006d0810" } ], "required": [ "KeyId" ] }, { "name": "DescribeDataKey", "description": "获取数据密钥的详情", "status": "online", "parameters": [ { "name": "DataKeyId", "type": "string", "required": true, "description": "数据密钥全局唯一标识符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyId" ] }, { "name": "DescribeDataKeys", "description": "返回数据密钥属性信息列表", "status": "online", "parameters": [ { "name": "DataKeyIds", "type": "array", "required": true, "description": "查询DataKey的ID列表，批量查询一次最多支持100个DataKeyId", "example": "[\"87ff856e-973c-11ef-947b-525400d834e5\"]", "item_type": "string" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyIds" ] }, { "name": "DescribeKey", "description": "用于获取指定KeyId的主密钥属性详情信息。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK全局唯一标识符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId" ] }, { "name": "DescribeKeys", "description": "该接口用于批量获取主密钥属性信息。", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": true, "description": "查询CMK的ID列表，批量查询一次最多支持100个KeyId", "example": "[\"87ff856e-973c-11ef-947b-525400d834e5\"]", "item_type": "string" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyIds" ] }, { "name": "DescribeWhiteBoxDecryptKey", "description": "获取白盒解密密钥", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "白盒密钥的全局唯一标识符", "example": "244dab8c-6dad-11ea-80c6-5254006d0810" } ], "required": [ "KeyId" ] }, { "name": "DescribeWhiteBoxDeviceFingerprints", "description": "获取指定密钥的设备指纹列表", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "白盒密钥ID", "example": "cd850a3d-9b1b-11ea-a96a-5254006d0810" } ], "required": [ "KeyId" ] }, { "name": "DescribeWhiteBoxKey", "description": "展示白盒密钥的信息", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "白盒密钥的全局唯一标识符", "example": "244dab8c-6dad-11ea-80c6-5254006d0810" } ], "required": [ "KeyId" ] }, { "name": "DescribeWhiteBoxKeyDetails", "description": "获取白盒密钥列表", "status": "online", "parameters": [ { "name": "KeyStatus", "type": "integer", "required": false, "description": "过滤条件：密钥的状态，0：disabled，1：enabled", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为0, 表示不分页", "example": "10" }, { "name": "TagFilters", "type": "array", "required": false, "description": "标签过滤条件", "example": "[{\"TagKey\":\"env\",\"TagValue\":[\"dev\"]}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签值", "example": "dev", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeWhiteBoxServiceStatus", "description": "获取白盒密钥服务状态", "status": "online", "parameters": [], "required": [] }, { "name": "DisableDataKey", "description": "禁用数据密钥", "status": "online", "parameters": [ { "name": "DataKeyId", "type": "string", "required": true, "description": "数据密钥唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyId" ] }, { "name": "DisableDataKeys", "description": "批量禁用数据密钥", "status": "online", "parameters": [ { "name": "DataKeyIds", "type": "array", "required": true, "description": "需要批量禁用的DataKey Id 列表，数据密钥数量最大支持100", "example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\"]", "item_type": "string" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyIds" ] }, { "name": "DisableKey", "description": "本接口用于禁用一个主密钥，处于禁用状态的Key无法用于加密、解密操作。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId" ] }, { "name": "DisableKeyRotation", "description": "对指定的CMK禁止密钥轮换功能。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId" ] }, { "name": "DisableKeys", "description": "该接口用于批量禁止CMK的使用。", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": true, "description": "需要批量禁用的CMK Id 列表，CMK数量最大支持100", "example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\\r\\n\"]", "item_type": "string" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyIds" ] }, { "name": "DisableWhiteBoxKey", "description": "禁用白盒密钥", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "白盒密钥的全局唯一标识符", "example": "244dab8c-6dad-11ea-80c6-5254006d0810" } ], "required": [ "KeyId" ] }, { "name": "DisableWhiteBoxKeys", "description": "批量禁用白盒密钥", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": true, "description": "白盒密钥的全局唯一标识符列表。注意：要确保所有提供的KeyId是格式有效的，没有重复，个数不超过50个，并且都是有效存在的。", "example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\\r\\n\"]", "item_type": "string" } ], "required": [ "KeyIds" ] }, { "name": "EnableDataKey", "description": "启用数据密钥", "status": "online", "parameters": [ { "name": "DataKeyId", "type": "string", "required": true, "description": "数据密钥唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyId" ] }, { "name": "EnableDataKeys", "description": "批量启用数据密钥", "status": "online", "parameters": [ { "name": "DataKeyIds", "type": "array", "required": true, "description": "需要批量启用的DataKey Id 列表， 数据密钥数量最大支持100", "example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\"]", "item_type": "string" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyIds" ] }, { "name": "EnableKey", "description": "用于启用一个指定的CMK。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId" ] }, { "name": "EnableKeyRotation", "description": "对指定的CMK开启密钥轮换功能。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "RotateDays", "type": "integer", "required": false, "description": "密钥轮转周期，单位天，允许范围 7 ~ 365，默认值 365。", "example": "365" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId" ] }, { "name": "EnableKeys", "description": "该接口用于批量启用CMK。", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": true, "description": "需要批量启用的CMK Id 列表， CMK数量最大支持100", "example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\"]", "item_type": "string" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyIds" ] }, { "name": "EnableWhiteBoxKey", "description": "启用白盒密钥", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "白盒密钥的全局唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" } ], "required": [ "KeyId" ] }, { "name": "EnableWhiteBoxKeys", "description": "批量启用白盒密钥", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": true, "description": "白盒密钥的全局唯一标识符列表。注意：要确保所有提供的KeyId是格式有效的，没有重复，个数不超过50个，并且都是有效存在的。", "example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\\r\\n\"]", "item_type": "string" } ], "required": [ "KeyIds" ] }, { "name": "Encrypt", "description": "本接口用于加密最多为4KB任意数据，可用于加密数据库密码，RSA Key，或其它较小的敏感信息。对于应用的数据加密，使用GenerateDataKey生成的DataKey进行本地数据的加解密操作", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "调用CreateKey生成的CMK全局唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "Plaintext", "type": "string", "required": true, "description": "被加密的明文数据，该字段必须使用base64编码，原文最大长度支持4K", "example": "dGVzdAo=" }, { "name": "EncryptionContext", "type": "string", "required": false, "description": "key/value对的json字符串，如果指定了该参数，则在调用Decrypt API时需要提供同样的参数，最大支持1024个字符", "example": "{\"key1\":\"value1\"}" } ], "required": [ "KeyId", "Plaintext" ] }, { "name": "EncryptByWhiteBox", "description": "使用白盒密钥进行加密", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "白盒密钥的全局唯一标识符", "example": "738c7598-6a69-11ef-9d7c-525400dc620c" }, { "name": "PlainText", "type": "string", "required": true, "description": "待加密的文本， base64编码，文本的原始长度最大不超过4KB", "example": "dGVzdAo=" }, { "name": "InitializationVector", "type": "string", "required": false, "description": "初始化向量，大小为 16 Bytes，加密算法会使用到, base64编码；如果不传，则由后端服务随机生成。用户需要自行保存该值，作为解密的参数。", "example": "3t+gDx/YmtnJuokqAg+cOw==" } ], "required": [ "KeyId", "PlainText" ] }, { "name": "GenerateDataKey", "description": "本接口生成一个数据密钥，您可以用这个密钥进行本地数据的加密。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK全局唯一标识符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "KeySpec", "type": "string", "required": false, "description": "指定生成Datakey的加密算法以及Datakey大小，AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个", "example": "AES_256" }, { "name": "NumberOfBytes", "type": "integer", "required": false, "description": "生成的DataKey的长度，同时指定NumberOfBytes和KeySpec时，以NumberOfBytes为准。最小值为1， 最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个", "example": "32" }, { "name": "EncryptionContext", "type": "string", "required": false, "description": "key/value对的json字符串，如果使用该字段，则返回的DataKey在解密时需要填入相同的字符串", "example": "{\"key1\":\"value1\"}" }, { "name": "EncryptionPublicKey", "type": "string", "required": false, "description": "PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。", "example": "-----BEGIN PUBLIC KEY----- MFkwEwY*****fJiHQuh2Jr9lMspgK58UVMJTvQCAU+Hztyhd6Aw== -----END PUBLIC KEY-----" }, { "name": "EncryptionAlgorithm", "type": "string", "required": false, "description": "非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。", "example": "SM2" }, { "name": "IsHostedByKms", "type": "integer", "required": false, "description": "表示生成的数据密钥是否被KMS托管。1:表示被KMS托管保存,0:表示KMS不托管。", "example": "0" }, { "name": "DataKeyName", "type": "string", "required": false, "description": "数据密钥的名称，当IsHostedByKms为1时,必须填写。当IsHostedByKms为0时,可以不填，KMS不托管。", "example": "testdataKey" }, { "name": "Description", "type": "string", "required": false, "description": "数据密钥 的描述，最大100字节", "example": "Description" }, { "name": "HsmClusterId", "type": "string", "required": false, "description": "KMS 独享版对应的 HSM 集群 ID。如果指定HsmClusterId，表明根密钥在此集群里，会校验KeyId是否和HsmClusterId对应。", "example": "cluster-123" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表,当参数IsHostedByKms=1，数据密钥托管到kms时有效.", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "dev" } ] } ], "required": [ "KeyId" ] }, { "name": "GenerateRandom", "description": "随机数生成接口。", "status": "online", "parameters": [ { "name": "NumberOfBytes", "type": "integer", "required": true, "description": "生成的随机数的长度。最小值为1， 最大值为1024。", "example": "16" } ], "required": [ "NumberOfBytes" ] }, { "name": "GetDataKeyCiphertextBlob", "description": "下载数据密钥密文", "status": "online", "parameters": [ { "name": "DataKeyId", "type": "string", "required": true, "description": "数据密钥的唯一标志符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyId" ] }, { "name": "GetDataKeyPlaintext", "description": "获取数据密钥明文", "status": "online", "parameters": [ { "name": "DataKeyId", "type": "string", "required": true, "description": "数据密钥的唯一标志符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "EncryptionPublicKey", "type": "string", "required": false, "description": "PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。", "example": "-----BEGIN PUBLIC KEY----- MFkwEwY*****fJiHQuh2Jr9lMspgK58UVMJTvQCAU+Hztyhd6Aw== -----END PUBLIC KEY-----" }, { "name": "EncryptionAlgorithm", "type": "string", "required": false, "description": "非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。", "example": "SM2" } ], "required": [ "DataKeyId" ] }, { "name": "GetKeyRotationStatus", "description": "查询指定的CMK是否开启了密钥轮换功能。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId" ] }, { "name": "GetParametersForImport", "description": "获取导入主密钥（CMK）材料的参数，返回的Token作为执行ImportKeyMaterial的参数之一，返回的PublicKey用于对自主导入密钥材料进行加密。返回的Token和PublicKey 24小时后失效，失效后如需重新导入，需要再次调用该接口获取新的Token和PublicKey。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK的唯一标识，获取密钥参数的CMK必须是EXTERNAL类型，即在CreateKey时指定Type=2 类型的CMK。", "example": "1ff78c0d-c54b-11e9-9cc9-5254006d0810" }, { "name": "WrappingAlgorithm", "type": "string", "required": true, "description": "指定加密密钥材料的算法，目前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256", "example": "RSAES_OAEP_SHA_1" }, { "name": "WrappingKeySpec", "type": "string", "required": true, "description": "指定加密密钥材料的类型，目前只支持RSA_2048", "example": "RSA_2048" } ], "required": [ "KeyId", "WrappingAlgorithm", "WrappingKeySpec" ] }, { "name": "GetPublicKey", "description": "该接口用于获取非对称密钥的公钥信息，可用于本地数据加密或验签。只有处于Enabled状态的非对称密钥才可能获取公钥。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK的唯一标识。", "example": "554ef4b3-3071-11ea-a86a-5254006d0810" } ], "required": [ "KeyId" ] }, { "name": "GetRegions", "description": "获取可以提供KMS服务的地域列表", "status": "online", "parameters": [], "required": [] }, { "name": "GetServiceStatus", "description": "用于查询该用户是否已开通KMS服务", "status": "online", "parameters": [], "required": [] }, { "name": "ImportDataKey", "description": "数据密钥导入接口，并托管到KMS", "status": "online", "parameters": [ { "name": "DataKeyName", "type": "string", "required": true, "description": "数据密钥的名称", "example": "testDataKey" }, { "name": "ImportKeyMaterial", "type": "string", "required": true, "description": "如果导入的是明文数据密钥，则是base64 转换后的明文数据密钥， 如果导入的是密文数据密钥，则是由KMS GenerateDataKey接口生成的密文数据密钥。", "example": "YLbjnjPPIYjPb1XhyBYNmcx" }, { "name": "ImportType", "type": "integer", "required": true, "description": "1:密文导入(由KMS接口生成的密文数据密钥)，2:明文导入。", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "数据密钥 的描述，最大100字节", "example": "描述信息" }, { "name": "KeyId", "type": "string", "required": false, "description": "当导入密文数据密钥时，无需传入根密钥,如果传入会校验此KeyId是否和密文中一致。 当导入明文数据密钥，KeyId 不能为空，会根据指定的根密钥加密数据密钥。", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "HsmClusterId", "type": "string", "required": false, "description": "KMS 独享版对应的 HSM 集群 ID。如果指定HsmClusterId，表明根密钥在此集群里，会校验KeyId是否和HsmClusterId对应。", "example": "hsm-cluster-123" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "dev" } ] } ], "required": [ "DataKeyName", "ImportKeyMaterial", "ImportType" ] }, { "name": "ImportKeyMaterial", "description": "用于导入密钥材料。只有类型为EXTERNAL 的CMK 才可以导入，导入的密钥材料使用 GetParametersForImport 获取的密钥进行加密。可以为指定的 CMK 重新导入密钥材料，并重新指定过期时间，但必须导入相同的密钥材料。CMK 密钥材料导入后不可以更换密钥材料。导入的密钥材料过期或者被删除后，指定的CMK将无法使用，需要再次导入相同的密钥材料才能正常使用。CMK是独立的，同样的密\ufffd...", "status": "online", "parameters": [ { "name": "EncryptedKeyMaterial", "type": "string", "required": true, "description": "使用GetParametersForImport 返回的PublicKey加密后的密钥材料base64编码。对于国密版本region的KMS，导入的密钥材料长度要求为 128 bit，FIPS版本region的KMS， 导入的密钥材料长度要求为 256 bit。", "example": "YLbjnjPPIYjPb1XhyBYNmcr7yv1YMnfDmuHX8D0qCmUAP3Qi+2URkLJvZ/zCWuJK0Y23/QHX8a8lrKz4WVgUVuoleOriQMNx+AcRkjCegkcqkdJ8BNlaXsNJ67zjSZWDu9qI+bHXEqSIcXcz/l5jdBEum6tYViIDrNKIY6FaLC0Ex7y3eoN5A3YFhQoL7F7upNXZHhogP+YXqLqD7fKzsM8qgMW25qSddlhW4H1s1zOfwfobLAQDXofu9OAZ58Xf8KjnqEoA1Bn60kuJBoqqUV4BqOG3egTqCQaCdcn98oZFPTQpB/SVCE4hENncEV3tNihv2IwjFxSCjZHcJzhYuQ==" }, { "name": "ImportToken", "type": "string", "required": true, "description": "通过调用GetParametersForImport获得的导入令牌。", "example": "+b1d61DykcbWNoKUIjj+OQA5M+Iu5BiXfxldNy/wDbZL31mB2+SAA29TZgXBKYXbCts9ULktWZxU6X81O4jRrvmKwKET2gEg4A6koZrJW+KMAzqTazyWtP464EV4/6Gp" }, { "name": "KeyId", "type": "string", "required": true, "description": "指定导入密钥材料的CMK，需要和GetParametersForImport 指定的CMK相同。", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "ValidTo", "type": "integer", "required": false, "description": "密钥材料过期时间 unix 时间戳，不指定或者 0 表示密钥材料不会过期，若指定过期时间，需要大于当前时间点，最大支持 2147443200。", "example": "0" } ], "required": [ "EncryptedKeyMaterial", "ImportToken", "KeyId" ] }, { "name": "ListAlgorithms", "description": "列出当前Region支持的加密方式", "status": "online", "parameters": [], "required": [] }, { "name": "ListDataKeyDetail", "description": "根据指定Offset和Limit获取数据密钥列表详情。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200", "example": "10" }, { "name": "Role", "type": "integer", "required": false, "description": "根据创建者角色筛选，默认 0 表示用户自己创建的数据密钥， 1 表示授权其它云产品自动创建的数据密钥", "example": "0" }, { "name": "OrderType", "type": "integer", "required": false, "description": "根据DataKey创建时间排序， 0 表示按照降序排序，1表示按照升序排序", "example": "0" }, { "name": "KeyState", "type": "integer", "required": false, "description": "根据DataKey状态筛选， 0表示全部DataKey， 1 表示仅查询Enabled DataKey， 2 表示仅查询Disabled DataKey，3 表示查询PendingDelete 状态的DataKey(处于计划删除状态的Key)。", "example": "0" }, { "name": "SearchKeyAlias", "type": "string", "required": false, "description": "根据DataKeyId或者DataKeyName进行模糊匹配查询", "example": "lzctest" }, { "name": "Origin", "type": "string", "required": false, "description": "根据DateKey类型筛选， \"TENCENT_KMS\" 表示筛选密钥材料由KMS创建的数据密钥， \"EXTERNAL\" 表示筛选密钥材料需要用户导入的 EXTERNAL类型数据密钥，\"ALL\" 或者不设置表示两种类型都查询，大小写敏感。", "example": "ALL" }, { "name": "HsmClusterId", "type": "string", "required": false, "description": "KMS 高级版对应的 HSM 集群 ID。", "example": "cls-hsm-3dflmo9g" }, { "name": "KeyId", "type": "string", "required": false, "description": "根密钥全局唯一标识符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "DataKeyLen", "type": "integer", "required": false, "description": "数据密钥的长度", "example": "16" }, { "name": "TagFilters", "type": "array", "required": false, "description": "标签过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签值", "example": "dev", "item_type": "string" } ] }, { "name": "MemberAccounts", "type": "array", "required": false, "description": "成员账号信息数组", "example": "无", "item_type": "object", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [] }, { "name": "ListDataKeys", "description": "用于查询数据密钥的列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200", "example": "2" }, { "name": "Role", "type": "integer", "required": false, "description": "根据创建者角色筛选，默认 0 表示用户自己创建的数据密钥， 1 表示授权其它云产品自动创建的数据密钥", "example": "0" }, { "name": "HsmClusterId", "type": "string", "required": false, "description": "KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）", "example": "cls-hsm-3dflmo9g" } ], "required": [] }, { "name": "ListKeyDetail", "description": "根据指定Offset和Limit获取主密钥列表详情。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200", "example": "10" }, { "name": "Role", "type": "integer", "required": false, "description": "根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk", "example": "0" }, { "name": "OrderType", "type": "integer", "required": false, "description": "根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序", "example": "0" }, { "name": "KeyState", "type": "integer", "required": false, "description": "根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK", "example": "0" }, { "name": "SearchKeyAlias", "type": "string", "required": false, "description": "根据KeyId或者Alias进行模糊匹配查询", "example": "lzctest" }, { "name": "Origin", "type": "string", "required": false, "description": "根据CMK类型筛选， \"TENCENT_KMS\" 表示筛选密钥材料由KMS创建的CMK， \"EXTERNAL\" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，\"ALL\" 或者不设置表示两种类型都查询，大小写敏感。", "example": "ALL" }, { "name": "KeyUsage", "type": "string", "required": false, "description": "根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型", "example": "ASYMMETRIC_SIGN_VERIFY_RSA_2048" }, { "name": "TagFilters", "type": "array", "required": false, "description": "标签过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签值", "example": "dev", "item_type": "string" } ] }, { "name": "HsmClusterId", "type": "string", "required": false, "description": "KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。", "example": "cls-hsm-3dflmo9g" }, { "name": "MemberAccounts", "type": "array", "required": false, "description": "可信服务成员账号信息数组", "example": "无", "item_type": "object", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [] }, { "name": "ListKeys", "description": "列出账号下面状态为Enabled， Disabled 和 PendingImport 的CMK KeyId 列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "含义跟 SQL 查询的 Limit 一致，表示本次获最多获取 Limit 个元素。缺省值为10，最大值为200", "example": "2" }, { "name": "Role", "type": "integer", "required": false, "description": "根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk", "example": "0" }, { "name": "HsmClusterId", "type": "string", "required": false, "description": "KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。", "example": "cls-hsm-3dflmo9g" } ], "required": [] }, { "name": "OverwriteWhiteBoxDeviceFingerprints", "description": "覆盖指定密钥的设备指纹信息", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "白盒密钥ID", "example": "5551ef2e-6742-11ef-8133-525400b2f623" }, { "name": "DeviceFingerprints", "type": "array", "required": false, "description": "设备指纹列表，如果列表为空，则表示删除该密钥对应的所有指纹信息。列表最大长度不超过200。", "example": "[{\"Identity\":\"0177ebba-5ad6930a*******bba2b703-ddfd218bab945f-0c275b7f7d2c8c68\",\"Description\":\"test2\"}]", "item_type": "object", "children": [ { "name": "Identity", "type": "string", "required": true, "description": "指纹信息，由设备指纹采集工具采集获得，格式满足正则表达式：^[0-9a-f]{8}[\\-][0-9a-f]{14}[\\-][0-9a-f]{14}[\\-][0-9a-f]{14}[\\-][0-9a-f]{16}$", "example": "0177ebba-5ad6930a52d808-ce5e6fbba2b******75b7f7d2c8c68" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息，如：IP，设备名称等，最大1024字节", "example": "lzctest" } ] } ], "required": [ "KeyId" ] }, { "name": "PostQuantumCryptoDecrypt", "description": "本接口使用后量子密码算法密钥，解密密文，并得到明文数据。", "status": "online", "parameters": [ { "name": "CiphertextBlob", "type": "string", "required": true, "description": "待解密的密文数据", "example": "Ade234dasdeEWdGVzdCUyMHBsYWlJJlIHL" }, { "name": "EncryptionPublicKey", "type": "string", "required": false, "description": "PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。", "example": "-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYI******VWhjH2dhziiH/NWCkk3FjIhjIwqjmnWhmUTg== -----END PUBLIC KEY-----" }, { "name": "EncryptionAlgorithm", "type": "string", "required": false, "description": "非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。", "example": "SM2" } ], "required": [ "CiphertextBlob" ] }, { "name": "PostQuantumCryptoEncrypt", "description": "本接口使用后量子密码算法密钥，可加密最多为4KB任意数据，可用于加密数据库密码，RSA Key，或其它较小的敏感信息。对于应用的数据加密，使用GenerateDataKey生成的DataKey进行本地数据的加解密操作。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "调用CreateKey生成的CMK全局唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "PlainText", "type": "string", "required": true, "description": "被加密的明文数据，该字段必须使用base64编码，原文最大长度支持4K", "example": "dGVzdAo=" } ], "required": [ "KeyId", "PlainText" ] }, { "name": "PostQuantumCryptoSign", "description": "使用后量子密码算法签名验签密钥进行签名。", "status": "online", "parameters": [ { "name": "Message", "type": "string", "required": true, "description": "Base64 编码的消息原文。消息原文的长度（Base64编码前的长度）不超过4096字节。", "example": "dGVzdAo=" }, { "name": "KeyId", "type": "string", "required": true, "description": "密钥的唯一标识", "example": "b2b90f78-df57-11ed-979b-525400cf6ac4" } ], "required": [ "Message", "KeyId" ] }, { "name": "PostQuantumCryptoVerify", "description": "使用后量子密码算法密钥对签名进行验证。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "密钥的唯一标识", "example": "b2b90f78-df57-11ed-979b-525400cf6ac4" }, { "name": "SignatureValue", "type": "string", "required": true, "description": "签名值，通过调用KMS PostQuantumCryptoSign签名接口生成", "example": "wb8u5CM+MnlZ2tlDCxwT8OmhslNZ8rMGCDC78iJJe8FA6eZKmxcIM5MVGh6TqFU53qOaJc7fOOjR4DTl4Pp1Mcrr6aFyw1bVErnaF8G8q6jBVGNZ52O+b8H+kFuySy6xWMcEuTKnaZRFlMU566d0TqLXlqntR641oP0X9UuzHvpMdRYKorg5IDPq3x5aWOtRIsyDBG7Pa6X7+XOdE1+uWbzjP4bOClm+Q/fl3KPdcbICxEuDvfdb1qdR4qBZ4uy5bG7JElk0z+NpKcpxiaFz4RaHJO8o64FFyD2F3A6rrKY5jku4Il3kXbklYlW93KKGGnJI9sEaqSQjETeLgwPaQECQBByPyzD+fYes9tvUbttQuZ18frl2bnmlCvFzpeigl7nzznxByFSYGBefNjnuzzTX26zUhy54I+sNijYzJyur/nKXXnX6ltcOLYBDke06bjPaPW73HryD1WesWgrL4m0kKoyIy8TdGDVbI5sGNmSOvOBvccMQ7b/jD2DWoVh7dGWJcLiroITUfUQLvKp71OGEkXKwTpeH1PFwFVTSz+F5zXAlTpvcF9h3Ao4e/fpB+zwRlZlKQQ3TAeCJXdnE3Qqos83Xd804kQ+Y/l7vERw//OJ6YIEWzxkcycTUbqi/DHJOexppQFMu0pPntlU32u+NASkqxpyE4EEp62T/rU2kYcn8eoHYCAVmU6mxoNsHsLZnt3DIcxc4VOby/ruSznQ/BPextecELaaKPA2ARN4Tb2aUUftlDYgYW4M/p3TEJxLO4LPCMIHPpNp3Gj9stsT4rlwvkw9ZYYMaR4IdBjJhd0Lod7lG5HzMiJC1D5KL4UqLIpN8bjfX+22U+gN0sVG91ruOhO3/epnsDPvDzoVtYHqkWX7a3XMhgoNxJxr0/KRFFEHlOgn250qwXg/czqEz1EN/obCKvkRHLdzU2iIJujAkUZb4Z0J7GlYznd8GGUOtraDgeKDEnAukU4L5PDVM4jYdrzAF1oF7SNAyePdnNLnWWp8RJNkFDoCZS/eBawq3vYa9avt3++5kwU+BSVBXiqQDmv1VYrlVTHeX7PoEYNpSwNvWSXVw9rTb1I/ek4painANi+QcWJdjVe+z29J5VDpuvrcSONzlep2zMItocxZRxr6VIs1FQLs7McN66enolxJfl/yIaAKP4KxdB1Dt+P2tH+Mqkl1NhvqCAfwm0f7LoDFWQ6ecAQ/8Pj9gA1bc0Tpq9wLvumS5qmVmTxySr0p5zvJ5NN71mYKAEUzuT/AyKKPHKT/F6iEJd5eWG4njUL128bjaENuDBD12BLxAwmBXiKCrEqCrkGIbKd/VQ8KTc7PDCH15/R79Xvnu14tEXckfpULcvC8Krfsutf5edDMOy0VossBpiyzBmfDOiGX4jxYpg5dK17vQ9q/+Ms/ORR5SUA+TT0wIlKzRwfr7sNR1D1cgg4+4Ma8WxZOKxPHEPwC7azKLZYmuWWYx74qdny0yUa2r2KYlxlbiPi3Jqk91fGyVXoMVucnW2i0X2rtjvV7KZ2MWDBXOkxmDvs6uWMipPO3X6Co3a6VWpuzT+5v19qswHIwIEaN+ovmpBYm57OZxZThfkJFf+TtlZAnknO7Q2F7uERQZr8yMM+nOMUN04SNubavm75NaL/mlnNpSrr0pa6IT9iMOYw/Q6HyVMpWEIz5vBOpTKsIAEd/8coDcvSeN9e/dokzhfSTtzgfEX6m4vGefPL1Lr2u7BwkyJRgmefCq6MWCxPA0UO89x8oar0PS2tF5Pgw1KI/ypzkVQiehLUC9MbTNQIgMXtdaiGrWIbZ80o7BkWkFWzoQ08tbWK7QbhxhNO3bZXkOwkiobFWBREAO3NzL4vRcXI47BMOdygbTd9KmrOK425hN08rfDeO7PfNWYIajtPtF/alsk1Jnn4MdHooQDsFJJ5dNfCY+menl3ukgmujn5WZERJ+WXV/7X3JOtajb3CXbYclnVUMtly5/B7KOMCS3+8uC46i2I2UgXbfKM4D8DmRscxmGtuaxuSyZE/XEgPc0aFsVEHaUuGmupaoUnxGqSrXp0rR+xmTlYNt95IPkwQmQms8R/PmmdXczksrERD6e5grFqZouMgjZP/kmbE4SSltBDdZDSQfq8DCTQcTmjQd5pu/Vl/I2xIy3qUfqLOQE+0z4g4B048DNHimo+w5W2MbWZAigwCsBwwYIL+xZEizUlrE7znd2/ua3WzYB+cD/Di0PJ4sDlzcOn1Vy2tEM7tIPS9oHlA8nYX6qLGUl8eg6BC3GNLr+RR/OkNffuTEBMTac36Dk+W9+lHD3CgNwtWpzSJUS9pqnvTWkCEG4bieFA1NrbK9zPnI1PFbAd8i1pFgv9sLGzQpEBS7ZRsM4bIPcje2BTvdcb9k2sG9Gj7BQ1RCeISo7mSL04eb4d0Bl8JuqGhN1shAcK5ts/n/Di5Jk9aBCteGwZrkAwx9W8EXy9rFFNYuq41RH345C6qV+LcxrZWBEqnSx3jvGFRB+Kru11b3Hfw4nd+pwZZ1O/ER3LrvWMq+wWhqPBAqCKnG/Mrc7blJGUu2us2WlHViPxEQhyiVjNzJanBk47RvdCqEAXND8hx+mlrzKwIYZer0aQCtEnvFpqVoHxKbQKXS7XAY3DX9TF3luCFQegsaXF6IehJAfL4yoTeJRl/+TNKHUr+D2AMu3VL35H6OFbMJVPBiPjFaJpVUXrOH3lACP+YymHmvRBdhbVSXBAFktjM7myj7AzuCGRcO2wrSzpJ5vR7Clrzgl4q+9Rqt/iwrE5FwtLBRVW9CqDozIAfeAhPLMAys8GehIHK7n6AXXX3/RLR9RZ30j4Egt5FYCVkU9Bf9iq6s17Hyy++MLH9W8W+N5avdVxaV4JtwJPyYzOTzRWfneLYt/r+2/9MYRTJSPPt4TEtvc+q7m4eC8750s2aZlvHnxahPeodfYMMhtRFQNUEYJ2Xei+CORbMuP03PyWbApjeDf9C27KuONNZX8lpPltVQYuoIS8nGJRPksPROX0CD58BP4/FT4VWZ365qnIAOrN0p9HjjjFhOlwAIeUYfLc0gZAMRQWOy3ye/110hSx27Vp4LlnXZsIuR2Y34jqT0arKUiCZW75myDvL5iUq3z4RDUvsCG0wESBmVZzlzJtGC0Pp4iu2HByZkI8GsDsGQ/GiSJqRzDZdQzgSJHX8t/gCp3ZZZpBbD7YWCKLEYti23h0y+y8sShKhJkGlhiJHpYCMFP5x0EnSRkuujoAmLI4pzyVhRgGXKqCagw6p+OWX1rVsweGPyLvVQzjqQsy1Ae5EmbOnzaIKYlndv8PNYqSN8BbtmX6m0jqrUNkFJdpm8YWMtwFn+HJwV7ONMzcG8R5PygB0CgMXPNZbiSrr/OOdI8qInyrUbFnF0j76mBkudftUKrMVm+gdvTWSfUCPkDkY/JRfNsxk6BJ44y78RXdR8QswxhW6cbP6S9IuZ2hHT29wKfigK0UanoUACtzQev9CVE8YCaPI6yLKT/JopiJI6u6IzxOhzttsRO1t+XiXxRNQNCGYWA+6IpIrp8WK+WJB91TWDe0WsKtzzbNzmZkkwB6u5vEsbJs2phv3fZjHa7njzEv7Lb+7QqbRPyEZTw6Hfpjr+zH2PDKiDX0j2PiogYqMB4lrmanZunP0bHY2Q7ON0IEYe5ZHKaHoaJHveL45drtOAMRDI/H0izKyCrgrdWZKjmjaLLcx7qIk4N/CzAdxPiNkYVun0pkZXXuVZlF9axy7RojOzmcAXquYpBvTdxuxi40oKGNQogBh/7H1nYQPYHb+k8TMv5CTVqj1Xqyu/ujv0BUePUbXMA1xxgNK8WfBYLzYlOH9k3BzMrhwditgtaLBUWp1pR62w5xxFNN7pn8GQVD/RQW5PIxDu4X1FyR3Yx40d9tuvLIbUSGDCmsHMcNg60A2S/NztiG6qjFKmF9VAZ5KsiRL8s+HZwMKbA1NDBMJdKjJpeMQwvMkrWgew6UFmRHsvxLGl4hMRe0Y3NylSfdPRLMMYppM+UpDtemx3Od7CreOikz0VUOj/8EQiY3gqZQBlrPKOklJKKv0Mf+5L5EBj/bVtm7Hv3SUz1jugRETc3jUW5CQniL26tnHZ9JsCrkKjD7b+7kov+Oycxll2o89zjxKqixW+fwFKJmEAIlxBBHpPRQb+Keu4ypL8hDZ4wMDHYuHhHiELixMaEJYABaa8xZJU0I9WNMmJNtTcNXOqR/iHGLkPRTDqLqcibPtKjFl1MjKSJpzq71WrxSJ5BI29ZwPnDqJ8yEVll48HkoiWtCjVGj7q8oyP4rDNv1osb8U7nNg41UkKzA4qESzcC1QoEsUxraVyMjG2e3sv+A7D6Pxs3hTT4W3sVHwHq+EQuCPBUn0mYyeH2GYfUCCpEPgoliQVdBng1dyn075nv1gKM72unWxWJWiczrPO/VoVy1WKxGTSlqiuhxx66+RfbkbX9m4FuGei6Zhw+Gxa5JwRYkRQt9vubOVYbxr2W6O0l068S5G+IMhVUthQ1O/WVHZZw1dPJ5NwkqrOads/xiAo/4dGh0898J627G6sQ1pm44slw9KGc7098FVeFHkRnXdXeAdh+vkm+7kQmogpG5W3691BAHeIMbVVXmGzipRSlW/S6OR1DOjGXGHuC1n4PnhnzZVBHqPSuas0BOrZvhmLcdbej8efn7IXmEy/swrUY/q9sCjVrTS/aQGUxROQ1Rgjxct3sj08akM5TkEOmEgb3RHTkOM5WKJABd18IaxPXwWX6+ZYYIbN3/NTxOzdaXqsVeF2LHjGNZRvvzuo47uG9Ivp5ERBapdR6We2PdnImkojvWqQmuVxkQ7dM8qjJqi4qnGrDKlBqM+PKhZcNl4dKf4CGRwQa5KN7h5Rm6TS6DtNInVu+hIe2VTSnyS9YxkJ4z2kbPVkzLrmijr/ZN21vwPFyrZRb/win/S6loBKtf+imWJnLVKArwymQnbAjbyOtWNdr2Kr1fAaep1wlqHvvxg1S6KQXjETg1kCXpy/lhJD8rMmsHVF3ZozmRVnOYFmfT1gRfYtKGi+7xW25pmKXXgdZgNz7H3o1qPTIbOty0K8ZCv8zxtncFNjf4O5qRwW02/OO9OCf79nzc1CKzN1BLsNnQpk1UR3pfinMuYSednc/ElWH8lfsisUa8ub7rH85SSD37tG3Ufe+bIDdSiqYdS/mX5GZ9d42m7G3FupviPsVMRvsBuy0POhplIOWlJWTGJvrrPlqbnC36uiW72GveRqyDCG5SUm9HP3oKFAZrAYf8kbz5M0Sn76T9SX1LUUuHCjWHSUnDsi+fL1AHkbouSoKHj8XOYxUrSrkpPLbJpREE6oA1N4OPWFttSays7b9sMWDxgE5VJQx2vsrUfSEX8pTdLxqaMCQTbO6eSgoDL5g8NMw3n/FDW5xRfBcJsCxIvXvHAYXoSpEBPgdkS3B12O3Y6wARwsp+VAkrDWgbdkjh4v2xECzVyrPcTE0Nmp+AyoofZwh7xF1n//gZv22xtQpEbsayAsJIdibma2gFlC+Bc7NwNHCRy3sTB+qb7I61ZTJDF66yXEI3RvJvoADujdvBDQ92mXBEnGi2kUbuUtJe4EF8Yz/x64f7hnfytz+OpuqCUvn2Hp6BZevQldvQyS1oijUcrdnkL/9JR5VtK/IvksngQ60subI8TSGsJq0K1Mh9+dJMaUxPxFXTLpcFxy346FrB1s6vX7W9PVY2/NGmDkjbypHDDxWAdlIVmg2gOg7Ksm6V14/7aMsRZPcJPFjc2dtytgaIWbSqYxGGVifPtFk7SpJ8VYtU6oT4NH/Mq8Y1YMg7rXnqCEVXdfeo4KY/C05AU0auF6WZYn5HWJRSnOiA+uAbRSZVC5ggAiD1eqP+Bb1ymgNpbTYoZKD9jiZiZjKkrPSP9DR/B0e29/NcWp8zsnnpbBRV2xlYtbZ557Y7h8/7gyjd43CZnYxCG3Rr7Q8r76dXJVmgBrb9P8mVOzDgRZBaYlwEalKBZLeJhmO9M0MeUkA+6DYwiup6ypPwa7INz1hiKLO5OUBcHWLp7naOmafrOT9YY6cqLEmOFhlm9vtKDM3VbHZ/EaBp2OmxgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACA8VGiEoKy4=" }, { "name": "Message", "type": "string", "required": true, "description": "Base64 编码的消息原文，消息原文的长度（Base64编码前的长度）不超过4096字节。", "example": "dGVzdAo=" } ], "required": [ "KeyId", "SignatureValue", "Message" ] }, { "name": "ReEncrypt", "description": "使用指定CMK对密文重新加密。", "status": "online", "parameters": [ { "name": "CiphertextBlob", "type": "string", "required": true, "description": "需要重新加密的密文", "example": "M1UPpYhWviWGrfn78MLVBG1n5G2H6+pGK5u7xOmoWoCcWpxVKC1OAQujzQSLHWBE54p3Kd8Qji+7FOPN3nkQeA==-k-fKVP3WIlGpg8m9LMW4jEkQ==-k-8VyKJSv97jE/+mKGeevmUUvCXLYzWs6Zxn3PZoeBW4aPCjYX" }, { "name": "DestinationKeyId", "type": "string", "required": false, "description": "重新加密使用的CMK，如果为空，则使用密文原有的CMK重新加密（若密钥没有轮换则密文不会刷新）", "example": "87ff856e-973c-11ef-947b-525400d834e5" }, { "name": "SourceEncryptionContext", "type": "string", "required": false, "description": "CiphertextBlob 密文加密时使用的key/value对的json字符串。如果加密时未使用，则为空", "example": "{\\\"key\\\":\\\"value\\\"}" }, { "name": "DestinationEncryptionContext", "type": "string", "required": false, "description": "重新加密使用的key/value对的json字符串，如果使用该字段，则返回的新密文在解密时需要填入相同的字符串", "example": "{\\\"key1\\\":\\\"value1\\\"}" } ], "required": [ "CiphertextBlob" ] }, { "name": "ScheduleDataKeyDeletion", "description": "计划删除数据密钥", "status": "online", "parameters": [ { "name": "DataKeyId", "type": "string", "required": true, "description": "数据密钥的唯一标志符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "PendingWindowInDays", "type": "integer", "required": true, "description": "计划删除时间区间[7,30]", "example": "7" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyId", "PendingWindowInDays" ] }, { "name": "ScheduleKeyDeletion", "description": "CMK计划删除接口，用于指定CMK删除的时间，可选时间区间为[7,30]天", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "CMK的唯一标志", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "PendingWindowInDays", "type": "integer", "required": true, "description": "计划删除时间区间[7,30]", "example": "7" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "KeyId", "PendingWindowInDays" ] }, { "name": "SignByAsymmetricKey", "description": "非对称密钥签名。 注意：只有 KeyUsage 为 ASYMMETRIC_SIGN_VERIFY_SM2、ASYMMETRIC_SIGN_VERIFY_ECC 或其他支持的 ASYMMETRIC_SIGN_VERIFY_${ALGORITHM} 的密钥才可以使用签名功能。", "status": "online", "parameters": [ { "name": "Algorithm", "type": "string", "required": true, "description": "签名算法，支持的算法：SM2DSA，ECC_P256_R1，RSA_PSS_SHA_256，RSA_PKCS1_SHA_256 等。更多支持的算法可通过 ListAlgorithms 接口进行查询。", "example": "SM2DSA" }, { "name": "Message", "type": "string", "required": true, "description": "消息原文或消息摘要。如果提供的是消息原文，则消息原文的长度（Base64编码前的长度）不超过4096字节。如果提供的是消息摘要，消息摘要长度（Base64编码前的长度）必须等于32字节", "example": "dGVzdAo=" }, { "name": "KeyId", "type": "string", "required": true, "description": "密钥的唯一标识", "example": "d79e97e5-69d1-11ef-bc87-02ac442a5a1f" }, { "name": "MessageType", "type": "string", "required": false, "description": "消息类型：RAW，DIGEST，如果不传，默认为RAW，表示消息原文。", "example": "RAW" } ], "required": [ "Algorithm", "Message", "KeyId" ] }, { "name": "UnbindCloudResource", "description": "删除指定（key, 资源，云产品）的记录，以表明：指定的云产品的资源已不再使用当前的key。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "cmk的ID", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "ProductId", "type": "string", "required": true, "description": "云产品的唯一性标识符", "example": "ssm" }, { "name": "ResourceId", "type": "string", "required": true, "description": "资源/实例ID，由调用方根据自己的云产品特征来定义，以字符串形式做存储。", "example": "resourceId" } ], "required": [ "KeyId", "ProductId", "ResourceId" ] }, { "name": "UpdateAlias", "description": "用于修改CMK的别名。对于处于PendingDelete状态的CMK禁止修改。", "status": "online", "parameters": [ { "name": "Alias", "type": "string", "required": true, "description": "新的别名，1-60个字符或数字的组合", "example": "NewAlias" }, { "name": "KeyId", "type": "string", "required": true, "description": "CMK的全局唯一标识符", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "Alias", "KeyId" ] }, { "name": "UpdateDataKeyDescription", "description": "修改数据密钥描述", "status": "online", "parameters": [ { "name": "DataKeyId", "type": "string", "required": true, "description": "数据密钥的唯一标志符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "Description", "type": "string", "required": true, "description": "数据密钥 的描述，最大100字节", "example": "描述信息" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyId", "Description" ] }, { "name": "UpdateDataKeyName", "description": "修改数据密钥名称", "status": "online", "parameters": [ { "name": "DataKeyId", "type": "string", "required": true, "description": "数据密钥的唯一标志符", "example": "93866e69-9755-11ef-8e65-52540089bc41" }, { "name": "DataKeyName", "type": "string", "required": true, "description": "数据密钥的名称", "example": "testDatakeyName" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "DataKeyId", "DataKeyName" ] }, { "name": "UpdateKeyDescription", "description": "该接口用于对指定的cmk修改描述信息。对于处于PendingDelete状态的CMK禁止修改。", "status": "online", "parameters": [ { "name": "Description", "type": "string", "required": true, "description": "新的描述信息，最大支持1024字节", "example": "NewDescription" }, { "name": "KeyId", "type": "string", "required": true, "description": "需要修改描述信息的CMK ID", "example": "23e80852-1e38-11e9-b129-5cb9019b4b01" }, { "name": "MemberAccount", "type": "object", "required": false, "description": "可信服务成员账号信息,当前账号时管理员或者委派管理员时有效。", "example": "无", "children": [ { "name": "MemberAppId", "type": "integer", "required": false, "description": "成员账号appid", "example": "260082377" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员账号uin", "example": "700002334915881" } ] } ], "required": [ "Description", "KeyId" ] }, { "name": "VerifyByAsymmetricKey", "description": "使用非对称密钥验签", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "密钥的唯一标识", "example": "d79e97e5-69d1-11ef-bc87-02ac442a5a1f" }, { "name": "SignatureValue", "type": "string", "required": true, "description": "签名值，通过调用KMS签名接口生成", "example": "MEUCIQDunw5PZuSVI6IPX2xxdce6ohrm9Rt8KBqpMr6yogDbdgIgVyqCOiOs9OVb/frwglpg+43QXMMRnFKmBd5VNpS4A/o=" }, { "name": "Message", "type": "string", "required": true, "description": "消息原文或消息摘要。如果提供的是消息原文，则消息原文的长度（Base64编码前的长度）不超过4096字节。如果提供的是消息摘要，则消息摘要长度（Base64编码前的长度）必须等于32字节", "example": "dGVzdAo=" }, { "name": "Algorithm", "type": "string", "required": true, "description": "签名算法，支持的算法：SM2DSA，ECC_P256_R1，RSA_PSS_SHA_256，RSA_PKCS1_SHA_256 等。更多支持的算法可通过 ListAlgorithms 接口进行查询。", "example": "SM2DSA" }, { "name": "MessageType", "type": "string", "required": false, "description": "消息类型：RAW，DIGEST，如果不传，默认为RAW，表示消息原文。", "example": "RAW" } ], "required": [ "KeyId", "SignatureValue", "Message", "Algorithm" ] } ] }