<p class="shortdesc"></p> <section class="section" id="DescribeKey__section_ly2_5x3_mlb"><h2 class="doc-tairway">DescribeKey </h2> <p class="p"><strong class="ph b">Description</strong></p> <p class="p">Viewing the details of a specified customer master key (CMK). </p> <p class="p"><strong class="ph b">Request Parameters</strong></p> <table class="table" id="DescribeKey__table_kbw_5x3_mlb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="DescribeKey__table_kbw_5x3_mlb__entry__1"> <p class="p">Name </p> </th> <th class="entry" id="DescribeKey__table_kbw_5x3_mlb__entry__2"> <p class="p">Type </p> </th> <th class="entry" id="DescribeKey__table_kbw_5x3_mlb__entry__3"> <p class="p">Necessary or Not </p> </th> <th class="entry" id="DescribeKey__table_kbw_5x3_mlb__entry__4"> <p class="p">Description </p> </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="DescribeKey__table_kbw_5x3_mlb__entry__1 "> <p class="p">keyId </p> </td> <td class="entry" headers="DescribeKey__table_kbw_5x3_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="DescribeKey__table_kbw_5x3_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="DescribeKey__table_kbw_5x3_mlb__entry__4 "> <p class="p">Globally unique identifier of the CMK. </p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">Return Parameters</strong></p> <table class="table" id="DescribeKey__table_lbw_5x3_mlb"><caption></caption><colgroup><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="DescribeKey__table_lbw_5x3_mlb__entry__1"> <p class="p">Name </p> </th> <th class="entry" id="DescribeKey__table_lbw_5x3_mlb__entry__2"> <p class="p">Type </p> </th> <th class="entry" id="DescribeKey__table_lbw_5x3_mlb__entry__3"> <p class="p">Description </p> </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="DescribeKey__table_lbw_5x3_mlb__entry__1 "> <p class="p">code </p> </td> <td class="entry" headers="DescribeKey__table_lbw_5x3_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="DescribeKey__table_lbw_5x3_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="DescribeKey__table_lbw_5x3_mlb__entry__1 "> <p class="p">keyMetadata </p> </td> <td class="entry" headers="DescribeKey__table_lbw_5x3_mlb__entry__2 "> <p class="p">KeyMetadata </p> </td> <td class="entry" headers="DescribeKey__table_lbw_5x3_mlb__entry__3 "> <p class="p">Metadata of the CMK. </p> </td> </tr> <tr class="row"> <td class="entry" headers="DescribeKey__table_lbw_5x3_mlb__entry__1 "> <p class="p">requestId </p> </td> <td class="entry" headers="DescribeKey__table_lbw_5x3_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="DescribeKey__table_lbw_5x3_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=DescribeKey &keyId=<cmkid> &<公共请求参数> </code></pre> <p class="p"><strong class="ph b">Return Example</strong></p> <pre class="pre codeblock"><code>{ “code”: “SUCCESS”, “requestId”: “f64d833a-584d-40df-9272-4f69b3b807d3”, “keyMetadata”: { “keyUsage”: “ENCRYPT_DECRYPT”, “origin”: “平安云产生”, “keyState”: “ENABLE|已启用”, “keyId”: “08a19976-d039-4469-9a03-af4ff13783fa”, “alias”: “your key alias”, “description”: “your key description “, “ownerId”: “123456”, “creationDate”: “2018-12-04 14:40:03” } } </code></pre> </section>