特定の証明書を使用してデータを暗号化します。

制限: リクエストパラメーターの暗号化アルゴリズムは、キータイプと一致する必要があります。

The following table describes the mapping between encryption algorithms and key types.

アルゴリズム

キータイプ

RSAES_OAEP_SHA_1

RSA_2048

RSAES_OAEP_SHA_256

RSA_2048

SM2PKE

EC_SM2

この例では、IDが12345678-1234-1234-1234-12345678 **** および暗号化アルゴリズムRSAES_OAEP_SHA_256を使用してデータVGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4= を暗号化します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 CertificatePublicKeyEncrypt

実行する操作です。 値をCertificatePublicKeyEncryptに設定します。

アルゴリズム String 必須 RSAES_OAEP_SHA_256

暗号化アルゴリズム。 設定可能な値は以下のとおりです。

  • RSAES_OAEP_SHA_1
  • RSAES_OAEP_SHA_256
  • SM2PKE
    注 SM2PKE暗号化アルゴリズムは、中国本土のリージョンでのみサポートされています。 In these regions, managed hardware security modules (HSMs) are used. 詳細については、「マネージHSMの概要」をご参照ください。
CertificateId String 必須 12345678-1234-1234-1234-12345678 ****

証明書の ID 。 It is the globally unique identifier (GUID) of the certificate in Certificates Manager.

Plaintext String 必須 VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4=

The data that you want to encrypt.

値はBase64でエンコードする必要があります。 たとえば、暗号化する16進データが [0x31, 0x32, 0x33, 0x34] の場合、Base64-encodedデータはMTIzNA= です。

暗号化できるデータのサイズは、使用する暗号化アルゴリズムによって異なります。

  • RSAES_OAEP_SHA_1: 214バイト
  • RSAES_OAEP_SHA_256: 190バイト

  • SM2PKE: 6,047バイト

暗号化するデータのサイズが上記の制限を超える場合は、GenerateDataKey操作を呼び出して、データを暗号化するためのデータキーを生成します。 次に、CertificatePublicKeyEncrypt操作を呼び出して、データキーを暗号化します。

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター データ型 例 説明
CertificateId String 12345678-1234-1234-1234-12345678 ****

証明書の ID 。

CiphertextBlob String ZOyyygCyaOW6Gj **** MlNKiuyjfzw=

データが暗号化された後の暗号文。

値はBase64でエンコードされます。

RequestId String 5979d897-d69f-4fc9-87dd-f3bb73c40b80

リクエストの ID です。

例

リクエストの例

http(s)://[Endpoint]/?Action=CertificatePublicKeyEncrypt
&Algorithm=RSAES_OAEP_SHA_256
&CertificateId=12345678-1234-1234-1234-12345678****
&Plaintext=VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4=
&<Common request parameters>

正常に処理された場合のレスポンス例

XML 形式 

<KMS>
        <CertificateId>12345678-1234-1234-1234-12345678 ****</CertificateId>
        <CiphertextBlob>ZOyIygCyaOW6Gj****MlNKiuyjfzw=</CiphertextBlob>
        <RequestId>5979d897-d69f-4fc9-87dd-f3bb73c40b80</RequestId>
</KMS>

JSON 形式 

{
  "CertificateId": "12345678-1234-1234-1234-12345678 ****" 、
  "CiphertextBlob": "ZOyIygCyaOW6Gj **** MlNKiuyjfzw=" 、
  "RequestId": "5979d897-d69f-4fc9-87dd-f3bb73c40b80"
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
404 証明書. NotFound 指定された証明書が見つかりません。 指定された証明書が存在しない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。