擷取非對稱金鑰的公開金鑰。可以在本地使用公開金鑰進行加密、驗簽。
介面說明
-
RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
-
本介面可以通過共用網關或專屬網關調用。詳細介紹，請參見阿里雲 SDK。
共用網關：通過公網、VPC 網域名稱訪問 KMS，該方式需要開啟公網開關。具體操作，請參見通過公網訪問 KMS 執行個體中的密鑰。
專屬網關：通過 KMS 私網地址（
<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）訪問 KMS。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| KeyId |
string |
是 |
主要金鑰（CMK）的通用唯一識別碼。該參數也可以被指定為 CMK 綁定的別名，詳情見別名使用說明。 |
5c438b18-05be-40ad-b6c2-3be6752c**** |
| KeyVersionId |
string |
是 |
密鑰版本的通用唯一識別碼。 |
2ab1a983-7072-4bbc-a582-584b5bd8**** |
| DryRun |
string |
否 |
是否開啟 DryRun 模式。
DryRun 模式用於測試 API 呼叫，驗證您是否具有相應資源的許可權，以及請求參數是否配置正確。DryRun 模式開啟後，KMS 會始終返回失敗並提示失敗原因。失敗原因包含如下：
|
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| KeyVersionId |
string |
對明文資料進行加密的主要金鑰版本號碼。 |
2ab1a983-7072-4bbc-a582-584b5bd8**** |
| KeyId |
string |
CMK 的通用唯一識別碼。 說明
如果請求中的 KeyId 參數使用的是 CMK 的別名，在響應中會返回別名對應的 CMK 標識符。 |
5c438b18-05be-40ad-b6c2-3be6752c**** |
| RequestId |
string |
隨機的訪問 ID。 |
475f1620-b9d3-4d35-b5c6-3fbdd941423d |
| PublicKey |
string |
PEM 格式的公開金鑰。 |
-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs5Yu9AEgATN2/e3nUz1K\nEy6ng8MSPutcse2/VECG/NUF9C6D4IsJ64ShzY3dcn34WYzTOe916eMJFxyrNrSw\nHtc4UOR5AvaoRrfpgu2uq+i70/ZXrWL+pGb1hgZV8cWheIHMxwrR3IiQlM5qN7EF\n9BdyWtyBfUGsp0Bn1VqlPc5G0x0a9xU2z9YtP994yDenNVIoIQ6Cov1lIEuwXAb2\n7boC41ePXwD0JWt41sP+rgCmpjBx00puIG+IlnoReEgI1ZGYmK98GgA/XzmNjZiD\nyvXJZAcM33Ue85+PkR5iHTtSEbi4QAoqpJabprUzz3Fin2j1dRrcacxGb7p31A9c\nJQIDAQAB\n-----END PUBLIC KEY-----\n |
樣本
正常返回樣本
JSON格式
{
"KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId": "5c438b18-05be-40ad-b6c2-3be6752c****",
"RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d",
"PublicKey": "-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs5Yu9AEgATN2/e3nUz1K\\nEy6ng8MSPutcse2/VECG/NUF9C6D4IsJ64ShzY3dcn34WYzTOe916eMJFxyrNrSw\\nHtc4UOR5AvaoRrfpgu2uq+i70/ZXrWL+pGb1hgZV8cWheIHMxwrR3IiQlM5qN7EF\\n9BdyWtyBfUGsp0Bn1VqlPc5G0x0a9xU2z9YtP994yDenNVIoIQ6Cov1lIEuwXAb2\\n7boC41ePXwD0JWt41sP+rgCmpjBx00puIG+IlnoReEgI1ZGYmK98GgA/XzmNjZiD\\nyvXJZAcM33Ue85+PkR5iHTtSEbi4QAoqpJabprUzz3Fin2j1dRrcacxGb7p31A9c\\nJQIDAQAB\\n-----END PUBLIC KEY-----\\n"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is not valid. | 參數非法。 |
| 404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. | |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密鑰不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。