ListKeys

<p class="shortdesc"></p> <section class="section" id="ListKeys__section_tnr_cy3_mlb"><h2 class="doc-tairway">ListKeys </h2> <p class="p"><strong class="ph b">Description</strong></p> <p class="p">Returning the information of all CMKs of the requester in the calling region. </p> <p class="p"><strong class="ph b">Request Parameters</strong></p> <table class="table" id="ListKeys__table_mll_dy3_mlb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="ListKeys__table_mll_dy3_mlb__entry__1">Name </th> <th class="entry" id="ListKeys__table_mll_dy3_mlb__entry__2">Type </th> <th class="entry" id="ListKeys__table_mll_dy3_mlb__entry__3">Necessary or Not </th> <th class="entry" id="ListKeys__table_mll_dy3_mlb__entry__4">Description </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="ListKeys__table_mll_dy3_mlb__entry__1 ">pageSize </td> <td class="entry" headers="ListKeys__table_mll_dy3_mlb__entry__2 ">Integer </td> <td class="entry" headers="ListKeys__table_mll_dy3_mlb__entry__3 ">Yes </td> <td class="entry" headers="ListKeys__table_mll_dy3_mlb__entry__4 ">Number of items displayed on each page. Valid value: 1 to100. The default value is 10. </td> </tr> <tr class="row"> <td class="entry" headers="ListKeys__table_mll_dy3_mlb__entry__1 ">pageNumber </td> <td class="entry" headers="ListKeys__table_mll_dy3_mlb__entry__2 ">Integer </td> <td class="entry" headers="ListKeys__table_mll_dy3_mlb__entry__3 ">Yes </td> <td class="entry" headers="ListKeys__table_mll_dy3_mlb__entry__4 ">Current page number. Valid value: larger than 0. The default value is 1. </td> </tr> </tbody></table> <p class="p"><strong class="ph b">Return Parameters</strong></p> <table class="table" id="ListKeys__table_nll_dy3_mlb"><caption></caption><colgroup><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="ListKeys__table_nll_dy3_mlb__entry__1">Name </th> <th class="entry" id="ListKeys__table_nll_dy3_mlb__entry__2">Type </th> <th class="entry" id="ListKeys__table_nll_dy3_mlb__entry__3">Description </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__1 ">code </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__2 ">String </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__3 ">Return code. “SUCCESS” will be returned if the request is succeeded. </td> </tr> <tr class="row"> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__1 ">keyId </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__2 ">String </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__3 ">Globally unique identifier of the CMK. </td> </tr> <tr class="row"> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__1 ">pageNumber </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__2 ">Integer </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__3 ">Current page number. </td> </tr> <tr class="row"> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__1 ">pageSize </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__2 ">Integer </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__3 ">Number of items displayed on each page. </td> </tr> <tr class="row"> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__1 ">totalCount </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__2 ">Long </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__3 ">Total number of query results. </td> </tr> <tr class="row"> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__1 ">requestId </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__2 ">String </td> <td class="entry" headers="ListKeys__table_nll_dy3_mlb__entry__3 ">ID of the current request. </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=ListKeys &pageNumber=<page number> &pageSize=<page size> &<公共请求参数> </code></pre> <p class="p"><strong class="ph b">Return Example</strong></p> <pre class="pre codeblock"><code>{       "code": "SUCCESS",       "keys": {             "key": [                   {                         "keyId": "84df0516-51c7-4f24-be03-f6a5d7c23f58"                   },                   {                         "keyId": "08a19976-d039-4469-9a03-af4ff13783fa"                   },                   {                         "keyId": "d82f0bb2-89e7-4d7b-98ce-1546e9ae14d3"                   }             ]       },       "pageNumber": 1,       "pageSize": 10,       "totalCount": 3,       "requestId": "90fbc80a-c0aa-4655-8d9d-051c786b415e" } } </code></pre> </section>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products