GetPublicKey - - Alibaba Cloud ドキュメントセンター

操作説明

RAM ユーザーまたは RAM ロールがこの OpenAPI 操作を呼び出すために必要なアクセスポリシーの詳細については、「リソースアクセス管理」をご参照ください。
この操作は、共有ゲートウェイまたは専用ゲートウェイを使用して呼び出すことができます。詳細については、「Alibaba Cloud SDK」をご参照ください。
- 共有ゲートウェイ: インターネット経由または VPC ドメイン名を使用して KMS にアクセスできます。インターネット経由で KMS にアクセスする場合は、インターネットアクセスを有効にする必要があります。詳細については、「インターネット経由での KMS インスタンスのアクセスキー」をご参照ください。
- 専用ゲートウェイ: KMS のプライベートエンドポイント（<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）を使用して KMS にアクセスできます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
KeyId	string	必須	カスタマーマスターキー（CMK）のグローバル一意識別子。このパラメーターは、CMK にバインドされているエイリアスにすることもできます。詳細については、「エイリアスの使用」をご参照ください。	5c438b18-05be-40ad-b6c2-3be6752c****
KeyVersionId	string	必須	キーバージョンのグローバル一意識別子。	2ab1a983-7072-4bbc-a582-584b5bd8****
DryRun	string	任意	DryRun モードを有効にするかどうかを指定します。 true: DryRun モードを有効にします。 false（デフォルト）: DryRun モードを無効にします。 DryRun モードは、API 呼び出しのテスト、リソースに対する権限の検証、およびパラメーターが有効かどうかを確認するために使用されます。 DryRun モードを有効にすると、KMS は常に失敗応答と失敗理由を返します。失敗理由には、次のものが含まれます。 DryRunOperationError: DryRun パラメーターが指定されていない場合、リクエストは成功していたでしょう。 ValidationError: リクエストで指定されたパラメーターが無効です。 AccessDeniedError: KMS リソースに対する操作を実行する権限がありません。	false

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object
KeyVersionId	string	キーバージョンのグローバル一意識別子。	2ab1a983-7072-4bbc-a582-584b5bd8****
KeyId	string	CMK のグローバル一意識別子。説明リクエストの KeyId パラメーターに CMK のエイリアスを指定した場合、エイリアスがバインドされている CMK の ID が返されます。	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

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
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.	アクセスキーが有効になっていません。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。