Import key material

Debug #

Request parameters #

The following table lists only the unique request parameters of this API and some common parameters. For more information, see Common parameters.

const columns = [ 
  { 
    width: '20%', 
title: 'Parameter', 
    dataIndex: 'Name', 
    className: 'openapi-doc-parameter-table-name' 
  }, 
  { 
    width: 130, 
title: 'Type', 
    dataIndex: 'DataType', 
    className: 'openapi-doc-parameter-table-type' 
  }, 
  { 
    width: 90, 
title: 'Is Required', 
    dataIndex: 'IsRequired', 
    className: 'openapi-doc-parameter-table-required' 
  }, 
  { 
    width: '20%', 
title: 'Example Value', 
    dataIndex: 'Example', 
    className: 'openapi-doc-parameter-table-example' 
  }, 
  { 
title: 'Description', 
    dataIndex: 'Description', 
    className: 'openapi-doc-parameter-table-description' 
  }, 
]; 

const data = [ 
  { 
    rowKey: '->Action', 
    Name: 'Action', 
    DataType: 'String', 
IsRequired: 'yes', 
    Example: <RenderMd content={"ImportKeyMaterial"} />, 
Description: <RenderMd content={"The operation to execute, values: ImportKeyMaterial."} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->Version', 
    Name: 'Version', 
    DataType: 'String', 
IsRequired: 'yes', 
    Example: <RenderMd content={"2021-02-18"} />, 
Description: <RenderMd content={"API version, value: 2021-02-18."} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->KeyID', 
    Name: 'KeyID', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"39a0e7c6-b7dd-4c83-b400-3449bb95403a"} />, 
Description: <RenderMd content={"Primary key ID, choose one of two options:\nKeyringName and KeyName\nKeyID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->KeyringName', 
    Name: 'KeyringName', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"keyring-test"} />, 
Description: <RenderMd content={"Keyring name, length between 2 and 31 characters. Allowed characters: [a-zA-Z0-9-_]"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->KeyName', 
    Name: 'KeyName', 
    DataType: 'String', 
IsRequired: 'no', 
    Example: <RenderMd content={"key-test"} />, 
Description: <RenderMd content={"Primary key name, length 2 - 31 characters. Valid characters: [a-zA-Z0-9-_]"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->EncryptedKeyMaterial', 
    Name: 'EncryptedKeyMaterial', 
    DataType: 'String', 
IsRequired: 'yes', 
    Example: <RenderMd content={"aA6qb/G1OY1hjADmUXVSciJtAfNFSuUsWOpfNM+em10KLxTjyVcLdrjmes7e+ixDx4Q6I3yCEXNih/AeBCdJ63WHRglh2Zo/hefbyFGRgR5RbjIrNfi0wkeN9jnxRYU+8H/5cmaa1SEWAduPkj64zIBZMWV3A0frmTTebNOaijNC++bqEOWfU5OHtcviPWtKPWRjX17/dQBGXLhGNt+j5BTZoD5ziSciLjahwi+IpPolwPYMI7sof68tpR2JNTvIYXdcUQ8SbvrkEJLK+wpoglB8GI0ztECTuIkSfZVryykMj5SlT14Rli7PK7GU5wgXXUmdr6bz5TxU7EDtJU1thA=="} />, 
Description: <RenderMd content={"Key material encrypted using the public key obtained from calling GetParametersForImport and then Base64 encoded"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ImportToken', 
    Name: 'ImportToken', 
    DataType: 'String', 
IsRequired: 'yes', 
    Example: <RenderMd content={"UlNBXzIwNDg6UlNBRVNfT0FFUF9TSEFfMjU2OpWOVgQfl0s2ji3Y02lzo8Z6IOEDCHFDeqEgmFECycV7WaUqYwAAAAB7pJCNwM8fEITQKnVO479+Of7Ap9PecZL7dl8XV8WNtHaPdenvVr13o/JwcbowWi5/vHWA8+ov747dlHvFMPtPZHX4ma5C9rgzD/hJfNk8vhZFeoCrpQRLes7u2oIja4bFr/Kff1A0XlILu2Xs89vSk3V/6nXhi3TfgXJSYsRZY2pHxXmcw6qll1B8vK6n1nj3mQGyYxAnZ13YRYBGmm12eTL/SmDGMgF86NTKlX/BgLJMt7NBsnHC288U1OtZ+tF9bKtRKcT6XxuhGVpLmMZmQXcRAjVnXTOAsmVIrTsCi0SvA4vJLS7C6Sww2WQ7L3nN3/EjomilLFAPuknWYk51KxWIWhoLbqQYe+j2ypx2Kixzh9LHFXw1juRF9u9JtrcQTeANPFFjbQANOJti1VgM4ySQHaAHmRBonpx0VWOFsTGrLGgikCDUh1h1lSVkcMPRWIn7EpuLlKz3BEVY6+vnTSnGTQeJY4nZohqkoDBvzvfDcVOFylIXJ9Y6HI3o9WHUw6hgpcVtSFnDWDBOnM/BeOH1mX0ZVTnZwDTy3WDvmRTT2kqk4PE+cX3WM4Q//m468RLOGAyEu0JZOc9hM0iPjhJ7dFykXrQj8PqVMhqUA/Ndtp+AVId2fYkmzgwOR90+6kdJM1ZnSki7aQWOUkTQ6gvvwFke+PDICYU8QzAeQs1NJxC4p7Cihys9xLlv3cudl4GnCKf+u40Kt5aTSMkbBYflnF+LVdVZYI7Fngd5qmx6gt9SgqOK31R64bEERj62GOmawayfOG+7xKOhGDuZyKcwa37KxYsZL1I/NYHpJlVO6Cjm7BD2ko7qwLT//MxwFzVc1fytMqneCpDnvQgvRDSattuQkCy7JazRTwzXVI5873SL0kwlXdi1fHJJxPjDl4hhC26XHbeQAZunkRZ6MWOY+rV4EmK87KfG6luykOAUKP+m4GbrV6VHindT+bCjfoc+63R7zwtiuSk21iiApPQjdWhuBkHr5CBv1vcl8oXsc7EgmRziZjsSjpJJbBsf6kD5Uq7RQeTcGIzX1v2zPYaZfvK46IpxS6/DGZCAiuLQO1Mjqq0Q21it4+osOlkz9b96FPx212yWsGXSsgC1FwL0jQbzPpD1+sa2ZCJ2e5n9yiYiJ4AlaPfgVTAiq2zExq0+S8yD4EYHeYY1AhQhcpCx63A2D3TY8d8EtDkSi5oGcLT6BF7KEzLtxF3YTPRI8puhJcUAyjFzWJYeaX6uis0RxZrCaTwafGu4xMesn6fAH1Ngxpc3dCdH1n+jnjaCnM4Lv2245VG4PLN3rHG73j7eLrtUt69MJeByL3X9z4QbxJztgg9UqrD6pBxNvv8doeRiCqtPZvh9LAMnQrTkhcSRywRM0tDVb2nDO0r8Yu6Jqs7jmsJCgl0OGQQ2ORX9RHSu59lLOD/CPzA2KomLLmPOsBtKW3XvCZCfSZxbQdlJhUc6iUoAa826ApH6pwYpjbMJHiQQ387BDUBPFdi0c52rkGPIwWH2NTrBPxRT9GjS+urBPRI/YG+cNCuap6MpzRxqecISFk2COh+ViAyRJr4orAkfO04yPAL1GL9+MTCn0ETzJIoheQV/Jt1kM2GJEmA6JsBHLhfJJM5IZq5Xo/lYQstZ/152h0qZTzt6j6NV+/FD+24NSubaPZ0n2fhIEnhc"} />, 
Description: <RenderMd content={"Import token obtained by calling GetParametersForImport"} /> 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ExpirationModel', 
    Name: 'ExpirationModel', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"KEY_MATERIAL_DOES_NOT_EXPIRE"} />, 
Description: <RenderMd content={"Key material expiration type, values:\nKEY_MATERIAL_DOES_NOT_EXPIRE (default)\nKEY_MATERIAL_EXPIRES"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->ValidTo', 
    Name: 'ValidTo', 
    DataType: 'Long', 
IsRequired: 'No', 
    Example: <RenderMd content={"0"} />, 
Description: <RenderMd content={"The validity period of the key material, required when the ExpirationModel parameter is set to KEY_MATERIAL_EXPIRES.\nIt must be a time point after the current time, based on server time."} />, 
    children: [ 
    ] 
  }, 

]; 

return (<Table 
  rowKey="rowKey" 
  className="openapi-doc-parameter-table" 
  columns={columns} 
  data={data} 
  border={ { cell: true, wrapper: true } } 
  scroll={ { x: "auto" } } 
  pagination={false} 
/>);

response parameters #

This API has no unique return parameters. See response structure for more information.

Request example #

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

{ 
  "EncryptedKeyMaterial": "aA6qb/G1OY1hjADmUXVSciJtAfNFSuUsWOpfNM+em10KLxTjyVcLdrjmes7e+ixDx4Q6I3yCEXNih/AeBCdJ63WHRglh2Zo/hefbyFGRgR5RbjIrNfi0wkeN9jnxRYU+8H/5cmaa1SEWAduPkj64zIBZMWV3A0frmTTebNOaijNC++bqEOWfU5OHtcviPWtKPWRjX17/dQBGXLhGNt+j5BTZoD5ziSciLjahwi+IpPolwPYMI7sof68tpR2JNTvIYXdcUQ8SbvrkEJLK+wpoglB8GI0ztECTuIkSfZVryykMj5SlT14Rli7PK7GU5wgXXUmdr6bz5TxU7EDtJU1thA==", 
  "ImportToken": "UlNBXzIwNDg6UlNBRVNfT0FFUF9TSEFfMjU2OpWOVgQfl0s2ji3Y02lzo8Z6IOEDCHFDeqEgmFECycV7WaUqYwAAAAB7pJCNwM8fEITQKnVO479+Of7Ap9PecZL7dl8XV8WNtHaPdenvVr13o/JwcbowWi5/vHWA8+ov747dlHvFMPtPZHX4ma5C9rgzD/hJfNk8vhZFeoCrpQRLes7u2oIja4bFr/Kff1A0XlILu2Xs89vSk3V/6nXhi3TfgXJSYsRZY2pHxXmcw6qll1B8vK6n1nj3mQGyYxAnZ13YRYBGmm12eTL/SmDGMgF86NTKlX/BgLJMt7NBsnHC288U1OtZ+tF9bKtRKcT6XxuhGVpLmMZmQXcRAjVnXTOAsmVIrTsCi0SvA4vJLS7C6Sww2WQ7L3nN3/EjomilLFAPuknWYk51KxWIWhoLbqQYe+j2ypx2Kixzh9LHFXw1juRF9u9JtrcQTeANPFFjbQANOJti1VgM4ySQHaAHmRBonpx0VWOFsTGrLGgikCDUh1h1lSVkcMPRWIn7EpuLlKz3BEVY6+vnTSnGTQeJY4nZohqkoDBvzvfDcVOFylIXJ9Y6HI3o9WHUw6hgpcVtSFnDWDBOnM/BeOH1mX0ZVTnZwDTy3WDvmRTT2kqk4PE+cX3WM4Q//m468RLOGAyEu0JZOc9hM0iPjhJ7dFykXrQj8PqVMhqUA/Ndtp+AVId2fYkmzgwOR90+6kdJM1ZnSki7aQWOUkTQ6gvvwFke+PDICYU8QzAeQs1NJxC4p7Cihys9xLlv3cudl4GnCKf+u40Kt5aTSMkbBYflnF+LVdVZYI7Fngd5qmx6gt9SgqOK31R64bEERj62GOmawayfOG+7xKOhGDuZyKcwa37KxYsZL1I/NYHpJlVO6Cjm7BD2ko7qwLT//MxwFzVc1fytMqneCpDnvQgvRDSattuQkCy7JazRTwzXVI5873SL0kwlXdi1fHJJxPjDl4hhC26XHbeQAZunkRZ6MWOY+rV4EmK87KfG6luykOAUKP+m4GbrV6VHindT+bCjfoc+63R7zwtiuSk21iiApPQjdWhuBkHr5CBv1vcl8oXsc7EgmRziZjsSjpJJbBsf6kD5Uq7RQeTcGIzX1v2zPYaZfvK46IpxS6/DGZCAiuLQO1Mjqq0Q21it4+osOlkz9b96FPx212yWsGXSsgC1FwL0jQbzPpD1+sa2ZCJ2e5n9yiYiJ4AlaPfgVTAiq2zExq0+S8yD4EYHeYY1AhQhcpCx63A2D3TY8d8EtDkSi5oGcLT6BF7KEzLtxF3YTPRI8puhJcUAyjFzWJYeaX6uis0RxZrCaTwafGu4xMesn6fAH1Ngxpc3dCdH1n+jnjaCnM4Lv2245VG4PLN3rHG73j7eLrtUt69MJeByL3X9z4QbxJztgg9UqrD6pBxNvv8doeRiCqtPZvh9LAMnQrTkhcSRywRM0tDVb2nDO0r8Yu6Jqs7jmsJCgl0OGQQ2ORX9RHSu59lLOD/CPzA2KomLLmPOsBtKW3XvCZCfSZxbQdlJhUc6iUoAa826ApH6pwYpjbMJHiQQ387BDUBPFdi0c52rkGPIwWH2NTrBPxRT9GjS+urBPRI/YG+cNCuap6MpzRxqecISFk2COh+ViAyRJr4orAkfO04yPAL1GL9+MTCn0ETzJIoheQV/Jt1kM2GJEmA6JsBHLhfJJM5IZq5Xo/lYQstZ/152h0qZTzt6j6NV+/FD+24NSubaPZ0n2fhIEnhc", 
  "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE", 
  "ValidTo": 0 
}

Return example #

{ 
  "ResponseMetadata": { 
    "RequestId": "2024070821555704510919023235B46A", 
    "Action": "ImportKeyMaterial", 
    "Version": "2021-02-18", 
    "Service": "kms", 
    "Region": "cn-beijing" 
  } 
}

Error codes #

The table below lists error codes related to this interface and business logic. For common error codes, refer to the common error codes document.