<p class="shortdesc"></p> <section class="section" id="UNDERCUSTODY__section_z1b_cfj_mlb"><h2 class="doc-tairway">GetKeychainPassword </h2> <p class="p"><strong class="ph b">Description</strong></p> <p class="p">Querying a managed password. The returned value is the ciphertext of the password encrypted using AES_128 symmetric encryption. You need to decrypt the ciphertext before using it. </p> <p class="p"><strong class="ph b">Request Parameters</strong></p> <table class="table" id="UNDERCUSTODY__table_lnj_cfj_mlb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="UNDERCUSTODY__table_lnj_cfj_mlb__entry__1"> <p class="p">Name </p> </th> <th class="entry" id="UNDERCUSTODY__table_lnj_cfj_mlb__entry__2"> <p class="p">Type </p> </th> <th class="entry" id="UNDERCUSTODY__table_lnj_cfj_mlb__entry__3"> <p class="p">Necessary or Not </p> </th> <th class="entry" id="UNDERCUSTODY__table_lnj_cfj_mlb__entry__4"> <p class="p">Description </p> </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__1 "> <p class="p">requestTime </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__4 "> <p class="p">Request time in the format of yyyyMMddhhmmssSSS. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__1 "> <p class="p">appId </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__4 "> <p class="p">Unique identifier of the application, which is assigned by the system. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__1 "> <p class="p">keychainAccount </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__3 "> <p class="p">No </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__4 "> <p class="p">Name of the managed account (for example, the name of a database account). </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__1 "> <p class="p">reason </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__3 "> <p class="p">No </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__4 "> <p class="p">Reason for getting the password. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__1 "> <p class="p">encryptVersion </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__3 "> <p class="p">No </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__4 "> <p class="p">Encryption version (encryption method used for the obtained password). </p> <p class="p">Optional field. You can use this parameter to distinguish between cryptographic modes. KMS is compatible with ECB mode and CBC mode AES encryption. </p> <p class="p">If you pass the parameter encryptVersion = “2.0”, it indicates CBC mode AES encryption. </p> <p class="p">If you do not pass a parameter, it is ECB mode AES encryption by default. </p> <p class="p">KMS supports only AES and ECB encryptions. Otherwise, you will receive an error report. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__1 "> <p class="p">sign </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="UNDERCUSTODY__table_lnj_cfj_mlb__entry__4 "> <p class="p">Signature value. For more information, see Signature Algorithm. </p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">Return Parameters</strong></p> <table class="table" id="UNDERCUSTODY__table_mnj_cfj_mlb"><caption></caption><colgroup><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1"> <p class="p">Name </p> </th> <th class="entry" id="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2"> <p class="p">Type </p> </th> <th class="entry" id="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3"> <p class="p">Description </p> </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1 "> <p class="p">code </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3 "> <p class="p">Return code. “SUCCESS” will be returned if the request is succeeded. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1 "> <p class="p">responseTime </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3 "> <p class="p">Response time in the format of yyyyMMddhhmmssSSS. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1 "> <p class="p">appId </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3 "> <p class="p">Unique identifier of the application, which is assigned by the system. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1 "> <p class="p">keychainAccount </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3 "> <p class="p">Name of the managed account (for example, the name of a database account). </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1 "> <p class="p">region </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3 "> <p class="p">Region of the managed account. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1 "> <p class="p">reason </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3 "> <p class="p">Reason for getting the password. This parameter returns the same code sent in the request. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1 "> <p class="p">keychainPassword </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3 "> <p class="p">Ciphertext of the managed password. For more information about encryption, see Encryption Algorithm. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1 "> <p class="p">sign </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3 "> <p class="p">For more information, see Signature Algorithm. </p> </td> </tr> <tr class="row"> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__1 "> <p class="p">requestId </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="UNDERCUSTODY__table_mnj_cfj_mlb__entry__3 "> <p class="p">ID of the current request. </p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">Request Example</strong></p> <pre class="pre codeblock"><code>https://kms-cn-shanghai.yun.pingan.com/?action=GetKeychainPassword &reason=<get password reason> &sign=<sign> &requestTime=<requestTime> &appId=<app id> &keychainAccount=<keychainAccount> &<公共请求参数> </code></pre> <p class="p"><strong class="ph b">返回示例</strong></p> <pre class="pre codeblock"><code>{ "code": "SUCCESS", "reason": "your get password reason", "responseTime": "20181204162959982", "appId": "your appId", "sign": "sign value", "keychainAccount": "keychainAccount", "keychainPassword": "password" "requestId": "7d5e94eb-75b6-45fc-a974-30d21296f48b", } </code></pre> </section>