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

操作説明

自己管理型アプリケーションが暗号化操作を実行し、シークレット値を取得するには、クライアントキーを使用して Key Management Service (KMS) インスタンスにアクセスする必要があります。次のプロセスでは、クライアントキーベースのアプリケーションアクセスポイント (AAP) を作成する方法を説明します。

1. アクセス制御ルールの作成：KMS インスタンスへのアクセスを許可するプライベート IP アドレスまたはプライベート CIDR ブロックを設定できます。詳細については、「CreateNetworkRule」をご参照ください。

2. 権限ポリシーの作成：アクセスを許可するキーとシークレットを設定し、アクセス制御ルールをキーとシークレットにバインドできます。詳細については、「CreatePolicy」をご参照ください。

3. AAP の作成：認証方式を設定し、権限ポリシーを AAP にバインドできます。詳細については、「CreateApplicationAccessPoint」をご参照ください。

4. クライアントキーの作成：クライアントキーの暗号化パスワードと有効期間を設定し、クライアントキーを AAP にバインドできます。

注意事項

クライアントキーには有効期間があります。クライアントキーの有効期限が切れると、そのクライアントキーが統合されたアプリケーションは、必要な KMS インスタンスにアクセスできなくなります。クライアントキーの有効期限が切れる前に、クライアントキーを置き換える必要があります。新しいクライアントキーが使用された後、KMS 内の期限切れのクライアントキーを削除することを推奨します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AapName	string	必須	実行する操作。値を CreateClientKey に設定します。	aap_test
Password	string	必須	AAP の名前。	bcfefe15-46f0****
NotAfter	string	任意	クライアントキーの暗号化パスワードです。パスワードは 8～64 文字で、数字、英字、特殊文字のうち、少なくとも 2 種類を含む必要があります。使用できる特殊文字は `~ ! @ # $ % ^ & * ? _ -` です。	2028-08-31T17:14:33Z
NotBefore	string	任意	クライアントキーの有効期間の終了日時。時刻は、ISO 8601 標準に準拠した UTC タイムゾーンの yyyy-MM-ddTHH:mm:ssZ フォーマットで指定します。説明 NotAfter を設定しない場合、デフォルト値はクライアントキーの作成時刻から 5 年後になります。 NotAfter を設定する場合は、NotBefore も設定する必要があります。	2023-08-31T17:14:33Z

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	クライアントキーの有効期間の開始日時。時刻は、ISO 8601 標準に準拠した UTC で指定する必要があります。フォーマットは `yyyy-MM-ddTHH:mm:ssZ` です。説明 `NotBefore` を設定しない場合、デフォルト値はクライアントキーが作成された時刻になります。 `NotBefore` を設定する場合、`NotAfter` も設定する必要があります。	2312e45f-b2fa-4c34-ad94-3eca50932916
ClientKeyId	string	クライアントキーの ID。	KAAP.66abf237-63f6-4625-b8cf-47e1086e****
KeyAlgorithm	string	クライアントキーの ID。	RSA_2048
PrivateKeyData	string	クライアントキーの秘密鍵を暗号化するためのアルゴリズムです。現在サポートされているのは、RSA_2048 のみです。	MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******
NotBefore	string	クライアントキーの秘密鍵。	2023-08-31T17:14:33Z
NotAfter	string	クライアントキーの有効期間の開始日時。	2028-08-31T17:14:33Z

例

成功レスポンス

JSONJSON

{
  "RequestId": "2312e45f-b2fa-4c34-ad94-3eca50932916",
  "ClientKeyId": "KAAP.66abf237-63f6-4625-b8cf-47e1086e****",
  "KeyAlgorithm": "RSA_2048",
  "PrivateKeyData": "MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******",
  "NotBefore": "2023-08-31T17:14:33Z",
  "NotAfter": "2028-08-31T17:14:33Z"
}

エラーコード

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

変更履歴

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