You need to enable JavaScript to run this app.
导航

生成数据密钥

最近更新时间2023.06.21 16:55:00

首次发布时间2021.11.24 19:45:10

描述
生成数据密钥

请求业务参数

名称类型是否必选示范值描述
ActionStringGenerateDataKey接口名,取值:GenerateDataKey
VersionString2021-02-18版本号,取值:2021-02-18
KeyringNameStringtest_keyring-1密钥环的别名。长度为 2 - 31 个字符合法字符:[a-zA-Z0-9-_]
KeyNameStringtest_key-1密钥的别名。长度为 2 - 31 个字符合法字符:[a-zA-Z0-9-_]
EncryptionContextString{"user": "bob","path": "/path/to/plaintext.txt"}key/value的JSON字符串。如果指定了该参数,则在调用Decrypt时需要提供同样的参数。
NumberOfBytesInteger32生成数据密钥的长度,取值:[1, 1024]

返回业务参数

名称类型描述
ResponseMetaDataResponseMetaData返回公共参数
PlaintextString数据密钥明文,Base64编码
CiphertextBlobString数据密钥密文,Base64编码

请求示例:

POST https://kms.volcengineapi.com?Action=GenerateDataKey&Version=2021-02-18&KeyringName=test_keyring-1&KeyName=test_key-1&NumberOfBytes=512

返回示例:

{
    "ResponseMetadata": {
        "RequestId": "2021071218400501022524310001132F93",
        "Action": "GenerateDataKey",
        "Version": "2021-02-18",
        "Service": "kms",
        "Region": "cn-north-1"
    },
    "Result": {
        "Plaintext": "kFw2RqALpWkHzLBNY8Q6x2F0viIebT4uIPkUOpCiitxZcA9ADwCoVVXLdfe3jJA997rWGYa7b6ifbjK06NSVpV9Nf5PnqHQvLy8cJkP0YHBp2dMhRtSP6JVDyShKhQN8yJyYMaKaD3URH7o8Xv1QltKHjpr18+w9ZrxWu1i54y2+2bRzUO9oPZt4breNSBN7mLqCutfL3EQuwKH0Zb0wpRdcKSwMpVbrnGGjV/hFxblAhmeJe4e32IUQKj0vVbTV1s2hY3jYguZ49Hl4JjVDbqqnM/nU79nHubQ/MoD5vFKe/sLX+sGgkGbx0SOa1wqQvk0FBNgkInNTzXGoyEWGd4OE8+cBaPmOxjRCsL51ckTHKkqGLIXZAigIH3B1A/BM5B51yjxS4xuyx0kk9vLQvYWCAY7g5N9DN5Rz10OdgX4ziyr80WufXziSvjdYf46Q+m3kzdeyknHP/JFpBP3E85FUxtrIARR4IAruHt6FwPEMIAs1NKCkEfDvGhEBds4CwbHSKJM916TBTLUwMZMJGSAMJgGVKLbh3VV8hVZWsK1+e6D7Vi/DvBYOjWovjTZ6UJH6nrBhXkcptWXO0y1mhG37sijm2w8B0PvqHyHYVXSP0mYMX2709awZ5MInO0X35nZi4iuwlxHcoFQbAXAKlpCMMfItYyOPrejRqdhcBb4=",
        "CiphertextBlob": "43y7grE9TjamX4P7ZOHFbwAAfdbxOzMLcyZqlPRh9rMVL2exoGbn53zKUTyt0jZD+Q5YWTmQf/z0Dm6WS+JvSKB3qchbUDVTZPrhUA0amFtBks6+s/rFXtUeBA4iirycN9j0/+BBmHVqAKiPFGJ4/83LdFA2MgoAMdcUaM6nhMZ7XCMaTvAH//Okx0bLJ2dqKf1R9DSFbcQtyYQBaJBfXMzM0cN5wya9M1KlXZZqqDGJQwLCf1ecuP3590dS1uvTJ9XQLlJUQWI/pLG2RxqKh00DlQf5E0+riLol5ocsMeDLefgc3w6pQ6lIOR4JsBsJZH1867r62x+dh8nAEY0AtOuVo8jjtS62QBoFtbI7WSekZUBVr2yao4817+xOC+oUF7JlZxuzPheFUsxkaiXvNxt08QiSZkX9qcjod5IaL4WqouffBf8XsWsoEqJlEW5hHnEJUzSzwrnpx/pz2km5rTvSMeczoLOM3Yo1o3oCv18Xg5FW2/SRHrBi6hjyGdMPhIwiMUENiBhgC4RFEqSWKdLTY2kgT0EO6H44X7piuz3qVyuiDlcM/thDrpJObNSEeaDkWgtPVacmoJ3Qh6xrCS4NyM8nOhp3lTYuOP1lGLn8Xlc14Kn95+qtdP3vQgyz9s4mMvuOzDa085QJxCZjpB/D1cIowf/hISKUioZwDtjLcnYAShV4p3LjW3JO5QC/wipdaug7x+RwjcWGIA4zLt54fIukKCcfI8QwwuHg7rwUPW1fpXiGuDKKWBt7egzJ2/4RU9wKiHiLSnsbNxw="
    }
}