forked from docs/doc-exports
Li, Qiao
dfe65b9551
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
298 lines
24 KiB
HTML
298 lines
24 KiB
HTML
<a name="kms_02_0042"></a><a name="kms_02_0042"></a>
|
|
|
|
<h1 class="topictitle1">Querying CMK Instances</h1>
|
|
<div id="body1521020894928"><div class="section" id="kms_02_0042__en-us_topic_0112992313_section22636485491"><h4 class="sectiontitle">Function</h4><p id="kms_02_0042__en-us_topic_0112992313_p106114211505">This API allows you to query CMK instances.</p>
|
|
<p id="kms_02_0042__en-us_topic_0112992313_p10555123474310">You can use the tag filtering function to query the detailed information about a specified CMK.</p>
|
|
</div>
|
|
<div class="section" id="kms_02_0042__en-us_topic_0112992313_section2920193835019"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0042__en-us_topic_0112992313_ul16795114665017"><li id="kms_02_0042__en-us_topic_0112992313_li19795164665020">URI format<p id="kms_02_0042__en-us_topic_0112992313_p88471512517"><a name="kms_02_0042__en-us_topic_0112992313_li19795164665020"></a><a name="en-us_topic_0112992313_li19795164665020"></a>POST /v1.0/{project_id}/kms/resource_instances/action</p>
|
|
</li><li id="kms_02_0042__en-us_topic_0112992313_li1429132310514">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0042__en-us_topic_0112992313_table9289163655118" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="kms_02_0042__en-us_topic_0112992313_row12289153695114"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="kms_02_0042__en-us_topic_0112992313_p2739096916511">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="kms_02_0042__en-us_topic_0112992313_p407603016511">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="kms_02_0042__en-us_topic_0112992313_p6172299916511">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="kms_02_0042__en-us_topic_0112992313_p3350702116511">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0042__en-us_topic_0112992313_row1329013695117"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p172905364515">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p172901236145118">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p4386100291125">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p172907366512">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0042__en-us_topic_0112992313_section1274672844719"><h4 class="sectiontitle">Requests</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0042__en-us_topic_0112992313_table976404617134" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0042__en-us_topic_0112992313_row376117465134"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0042__en-us_topic_0112992313_p20270144855616">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.5.1.2"><p id="kms_02_0042__en-us_topic_0112992313_p4270348125619">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.3"><p id="kms_02_0042__en-us_topic_0112992313_p102705482561">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="kms_02_0042__en-us_topic_0112992313_p6270174895617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0042__en-us_topic_0112992313_row18761194611312"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p876110465139">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p1376164651317">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p47611446111315">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><div class="p" id="kms_02_0042__en-us_topic_0112992313_p4742733103512">list of tags, including tag keys and tag values.<ul id="kms_02_0042__en-us_topic_0112992313_ul17835144253711"><li id="kms_02_0042__en-us_topic_0112992313_li883514219377"><strong id="kms_02_0042__en-us_topic_0112992313_b842352706165737">key</strong> indicates the tag key. A CMK can have a maximum of 10 keys, and each of them is unique and cannot be empty. A key cannot have duplicate values. The value of <strong id="kms_02_0042__en-us_topic_0112992313_b842352706165433">key</strong> contains a maximum of 36 characters.</li><li id="kms_02_0042__en-us_topic_0112992313_li6835144219377"><strong id="kms_02_0042__en-us_topic_0112992313_b842352706165447">value</strong> indicates the tag value. Each tag value can contain a maximum of 43 characters. The relationship between values is <strong id="kms_02_0042__en-us_topic_0112992313_b842352706165526">AND</strong>.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0042__en-us_topic_0112992313_row127611646171314"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p15761124616138">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p13761134621319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p85873323810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p376164681318">Number of queried records. If <strong id="kms_02_0042__en-us_topic_0112992313_b82380259319">action</strong> is set to <strong id="kms_02_0042__en-us_topic_0112992313_b11170930113112">count</strong>, this parameter does not need to be set. If <strong id="kms_02_0042__en-us_topic_0112992313_b685412464311">action</strong> is set to <strong id="kms_02_0042__en-us_topic_0112992313_b31861351193114">filter</strong>, the default value is <strong id="kms_02_0042__en-us_topic_0112992313_b112171459153117">10</strong>.</p>
|
|
<p id="kms_02_0042__en-us_topic_0112992313_p20761124616132">The value ranges from 1 to 1000.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0042__en-us_topic_0112992313_row17762646121311"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p12762194621317">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p12762846131315">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p15931432486">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p11632145062412">Index location. The query starts from the next piece of data indexed by this parameter. When data on the first page is queried, the value of this parameter queried on previous page is contained. If <strong id="kms_02_0042__en-us_topic_0112992313_b1514816455336">action</strong> is <strong id="kms_02_0042__en-us_topic_0112992313_b85661349143317">count</strong>, this parameter does not need to be set. If <span class="parmname" id="kms_02_0042__en-us_topic_0112992313_parmname1439498334142844"><b>action</b></span> is set to <span class="parmvalue" id="kms_02_0042__en-us_topic_0112992313_parmvalue475733516142844_3"><b>filter</b></span>, the default value is <span class="parmvalue" id="kms_02_0042__en-us_topic_0112992313_parmvalue863128038142844_3"><b>0</b></span>.</p>
|
|
<p id="kms_02_0042__en-us_topic_0112992313_p9762144641316">The value must be a numeral and cannot be a negative number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0042__en-us_topic_0112992313_row6762114621311"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p1876204631319">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p5762184631314">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p559923213819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p157622046191316">Operation ID, which can be set to <strong id="kms_02_0042__en-us_topic_0112992313_b84235270614519">filter</strong> or <strong id="kms_02_0042__en-us_topic_0112992313_b842352706145114">count</strong>.</p>
|
|
<ul id="kms_02_0042__en-us_topic_0112992313_ul11762134612133"><li id="kms_02_0042__en-us_topic_0112992313_li8762134616138"><strong id="kms_02_0042__en-us_topic_0112992313_b842352706103947">filter</strong>: indicates filtering.</li><li id="kms_02_0042__en-us_topic_0112992313_li17621462132"><strong id="kms_02_0042__en-us_topic_0112992313_b842352706104030">count</strong>: indicates the number of queried records.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0042__en-us_topic_0112992313_row3762154641318"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p1376254621313">matches</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p8762134616139">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p776212466137">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p8762114611131">Search field.</p>
|
|
<ul id="kms_02_0042__en-us_topic_0112992313_ul6762124671319"><li id="kms_02_0042__en-us_topic_0112992313_li8762134621314"><strong id="kms_02_0042__en-us_topic_0112992313_b842352706122740">key</strong> indicates the field to be matched, for example, <strong id="kms_02_0042__en-us_topic_0112992313_b842352706122731">resource_name</strong>.</li><li id="kms_02_0042__en-us_topic_0112992313_li117623467132"><strong id="kms_02_0042__en-us_topic_0112992313_b842352706165641">value</strong> indicates the value to be matched, which contains a maximum of 255 characters and cannot be empty.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0042__en-us_topic_0112992313_row97646460134"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p1376211466130">sequence</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p2764746171314">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p19221940781">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p1176410465135">36-byte serial number of a request message</p>
|
|
<p id="kms_02_0042__en-us_topic_0112992313_p1676444617136">Example: 919c82d4-8046-4722-9094-35c3c6524cff</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0042__en-us_topic_0112992313_section15410161125617"><h4 class="sectiontitle">Responses</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0042__en-us_topic_0112992313_table126197419146" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0042__en-us_topic_0112992313_row1161915414146"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0042__en-us_topic_0112992313_p367742135716">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.2.5.1.2"><p id="kms_02_0042__en-us_topic_0112992313_p667717245711">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.3"><p id="kms_02_0042__en-us_topic_0112992313_p116771326575">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.5.1.4"><p id="kms_02_0042__en-us_topic_0112992313_p36771211579">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0042__en-us_topic_0112992313_row56194419141"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p1061934121414">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p1161912410148">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p196197441413">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p13619846149">Resource instance list. For details, see <a href="#kms_02_0042__en-us_topic_0112992313_table824381161412">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0042__en-us_topic_0112992313_row1761916418144"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p186192421420">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p196191148143">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p136196401419">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p1961964201412">Total number of records</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="kms_02_0042__en-us_topic_0112992313_table824381161412"></a><a name="en-us_topic_0112992313_table824381161412"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0042__en-us_topic_0112992313_table824381161412" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="kms_02_0042__en-us_topic_0112992313_b89413882312">resource</strong> field description</caption><thead align="left"><tr id="kms_02_0042__en-us_topic_0112992313_row15243311101418"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.1"><p id="kms_02_0042__en-us_topic_0112992313_p41414565715">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.3.2.5.1.2"><p id="kms_02_0042__en-us_topic_0112992313_p714114519571">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.3"><p id="kms_02_0042__en-us_topic_0112992313_p1014111525720">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.5.1.4"><p id="kms_02_0042__en-us_topic_0112992313_p814111519579">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0042__en-us_topic_0112992313_row1243141113142"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p5243181131415">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p1424310113149">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p811955119813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p424391112145">Resource ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0042__en-us_topic_0112992313_row14243711161415"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p724391181414">resource_detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p1424331191415">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p1124145115811">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p62431811191414">Resource details. For details, see <a href="kms_02_0018.html#kms_02_0018__en-us_topic_0112992343_t98d238e10953421e84a073707024c329">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0042__en-us_topic_0112992313_row162431117146"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p22431211171410">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p524310116145">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p230293620205">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p142433117141">Lists of tags. If there is no tag, the array is empty by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0042__en-us_topic_0112992313_row172431311111416"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_p5243141171420">resource_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_p324361181410">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_p74418531586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0042__en-us_topic_0112992313_p142431511141415">Resource name. This parameter is an empty string by default.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0042__en-us_topic_0112992313_section169496492213"><h4 class="sectiontitle">Examples</h4><p id="kms_02_0042__en-us_topic_0112992313_p1020884013238">The following example describes how to query key instances.</p>
|
|
<ul id="kms_02_0042__en-us_topic_0112992313_ul186717349266"><li id="kms_02_0042__en-us_topic_0112992313_li167534112613">Example request<pre class="screen" id="kms_02_0042__en-us_topic_0112992313_screen91601325152315"> {
|
|
"offset": "100",
|
|
"limit": "100",
|
|
"action": "filter",
|
|
"matches":[
|
|
{
|
|
"key": "resource_name",
|
|
"value": "resource1"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"key": "key1",
|
|
"values": [
|
|
"value1",
|
|
"value2"
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</li><li id="kms_02_0042__en-us_topic_0112992313_li15358195112277">Example response<pre class="screen" id="kms_02_0042__en-us_topic_0112992313_screen7665443192717">{
|
|
"resources": [{
|
|
"resource_id": "90c03e67-5534-4ed0-acfa-89780e47a535",
|
|
"resource_detail": {
|
|
"key_id": "90c03e67-5534-4ed0-acfa-89780e47a535",
|
|
"domain_id": "4B688Fb77412Aee5570E7ecdbeB5afdc",
|
|
"key_alias": "tagTest_xmdmi",
|
|
"key_description": "123",
|
|
"creation_date": 1521449277000,
|
|
"scheduled_deletion_date": "",
|
|
"key_state": 2,
|
|
"default_key_flag": 0,
|
|
"key_type": 1
|
|
},
|
|
"resource_name": "tagTest_xmdmi",
|
|
"tags": [{
|
|
"key": "$",
|
|
"value": "testValue!"
|
|
}, {
|
|
"key": "1",
|
|
"value": "ccwZ"
|
|
}, {
|
|
"key": "1&",
|
|
"value": "testValue!"
|
|
}, {
|
|
"key": "abcd",
|
|
"value": "1&"
|
|
}, {
|
|
"key": "efg",
|
|
"value": "1&"
|
|
}, {
|
|
"key": "faregbqer",
|
|
"value": "AAaa00-99"
|
|
}, {
|
|
"key": "fcwefwq",
|
|
"value": "$"
|
|
}, {
|
|
"key": "fwqegqwrg",
|
|
"value": "1&"
|
|
}, {
|
|
"key": "haha",
|
|
"value": "qzzahnzgoqbkabppdehnbrrgbrkvlxkkfoosqyhdylq"
|
|
}, {
|
|
"key": "quapxpysduboguiluwargcgmvcgxinianbhl",
|
|
"value": "testValue!"
|
|
}]
|
|
}]
|
|
"total_count": "1"}</pre>
|
|
<p id="kms_02_0042__en-us_topic_0112992313_p661713202710">or</p>
|
|
<pre class="screen" id="kms_02_0042__en-us_topic_0112992313_screen11291516122913">{
|
|
"error": {
|
|
"error_code": "KMS.XXXX",
|
|
"error_msg": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0042__en-us_topic_0112992313_section655115613254"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_en-us_topic_0079615001_table20596071">Table 5</a> lists the normal status code returned by the response.
|
|
<div class="tablenoborder"><a name="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0112992313_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_en-us_topic_0079615001_table20596071" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_en-us_topic_0079615001_row9746163"><th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.6.2.2.2.4.1.1"><p id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_p57545694203043">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.28%" id="mcps1.3.6.2.2.2.4.1.2"><p id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_p4531342288">Status</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.6.2.2.2.4.1.3"><p id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_p30689603203043">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_en-us_topic_0079615001_row48621261"><td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_en-us_topic_0079615001_p46008046">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.28%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_p7538425819">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="kms_02_0042__en-us_topic_0112992313_en-us_topic_0112992294_p5626181018551">Exception status code. For details, see <a href="kms_02_0301.html#kms_02_0301">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
|
</div>
|
|
</div>
|
|
|