查看密钥详情
<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">描述</strong></p>
<p class="p">查看指定主用户密钥的详细信息。</p>
<p class="p"><strong class="ph b">请求参数</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">名称</p>
</th>
<th class="entry" id="DescribeKey__table_kbw_5x3_mlb__entry__2">
<p class="p">类型</p>
</th>
<th class="entry" id="DescribeKey__table_kbw_5x3_mlb__entry__3">
<p class="p">是否必需</p>
</th>
<th class="entry" id="DescribeKey__table_kbw_5x3_mlb__entry__4">
<p class="p">描述</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">是</p>
</td>
<td class="entry" headers="DescribeKey__table_kbw_5x3_mlb__entry__4 ">
<p class="p">密钥的全局唯一标识符</p>
</td>
</tr>
</tbody></table>
<p class="p"><strong class="ph b">返回参数</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">名称</p>
</th>
<th class="entry" id="DescribeKey__table_lbw_5x3_mlb__entry__2">
<p class="p">类型</p>
</th>
<th class="entry" id="DescribeKey__table_lbw_5x3_mlb__entry__3">
<p class="p">描述</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">返回码,成功返回"SUCCESS"</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</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</p>
</td>
</tr>
</tbody></table>
<p class="p"><strong class="ph b">请求示例</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">返回示例</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>
提交成功!非常感谢您的反馈,我们会继续努力做到更好!