yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/rds/api-ref/rds_17_0002.html
wangdengke2 1ddaec1a62 rds_api 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2026-01-29 11:28:26 +00:00

192 lines
19 KiB
HTML
Raw Blame History

<a name="rds_17_0002"></a><a name="rds_17_0002"></a>
<h1 class="topictitle1">Obtaining the Result of a Specific Diagnosis Item</h1>
<div id="body0000002376198718"><div class="section" id="rds_17_0002__en-us_topic_0000001745910893_section61759636"><h4 class="sectiontitle">Function</h4><p id="rds_17_0002__en-us_topic_0000001745910893_p33831530">This API is used to obtain the result of a specific diagnosis item.</p>
<ul id="rds_17_0002__ul10163594121"><li id="rds_17_0002__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_17_0002__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="rds_17_0002__en-us_topic_0000001745910893_section18965813"><h4 class="sectiontitle">URI</h4><ul id="rds_17_0002__en-us_topic_0000001745910893_ul13194498"><li id="rds_17_0002__en-us_topic_0000001745910893_li41603465301">URI format<p id="rds_17_0002__en-us_topic_0000001745910893_p11160246123012"><a name="rds_17_0002__en-us_topic_0000001745910893_li41603465301"></a><a name="en-us_topic_0000001745910893_li41603465301"></a>GET https://{<em id="rds_17_0002__en-us_topic_0000001745910893_i1288545311165">endpoint</em>}/v3/{project_id}/instances/diagnosis/info</p>
</li></ul>
<ul id="rds_17_0002__en-us_topic_0000001745910893_ul55999443"><li id="rds_17_0002__en-us_topic_0000001745910893_li21405046">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_17_0002__en-us_topic_0000001745910893_table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_17_0002__en-us_topic_0000001745910893_row1482002"><th align="left" class="cellrowborder" valign="top" width="21.3%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="rds_17_0002__en-us_topic_0000001745910893_p52933326">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.899999999999999%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="rds_17_0002__en-us_topic_0000001745910893_p59740974">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="63.800000000000004%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="rds_17_0002__en-us_topic_0000001745910893_p7180698">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rds_17_0002__en-us_topic_0000001745910893_row44765691"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_17_0002__en-us_topic_0000001745910893_p2142393">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_17_0002__en-us_topic_0000001745910893_p39316155">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="63.800000000000004%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_17_0002__p30492010">Specifies the project ID of a tenant in a region.</p>
<p id="rds_17_0002__p7139608914">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_17_0002__en-us_topic_0000001745910893_table10505152913256" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="rds_17_0002__en-us_topic_0000001745910893_row13549129152512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.1.2.2.5.1.1"><p id="rds_17_0002__en-us_topic_0000001745910893_p13549172916259">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.1.2.2.5.1.2"><p id="rds_17_0002__en-us_topic_0000001745910893_p14549182913258">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.1.2.2.5.1.3"><p id="rds_17_0002__en-us_topic_0000001745910893_p9549182942510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.1.2.2.5.1.4"><p id="rds_17_0002__en-us_topic_0000001745910893_p195492292258">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rds_17_0002__en-us_topic_0000001745910893_row9549529142513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.1 "><p id="rds_17_0002__en-us_topic_0000001745910893_p18549829192515">engine</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.2 "><p id="rds_17_0002__en-us_topic_0000001745910893_p75491229152515">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.3 "><p id="rds_17_0002__en-us_topic_0000001745910893_p554932912516">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.1.2.2.5.1.4 "><p id="rds_17_0002__en-us_topic_0000001745910893_p145491129202516">Engine type.</p>
<p id="rds_17_0002__en-us_topic_0000001745910893_p1654962912255">Enumerated values:</p>
<ul id="rds_17_0002__en-us_topic_0000001745910893_ul185491929182510"><li id="rds_17_0002__en-us_topic_0000001745910893_li19549132919250">mysql</li><li id="rds_17_0002__en-us_topic_0000001745910893_li135501829112510">postgresql</li><li id="rds_17_0002__en-us_topic_0000001745910893_li105501229122511">sqlserver</li></ul>
</td>
</tr>
<tr id="rds_17_0002__en-us_topic_0000001745910893_row129298118306"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.1 "><p id="rds_17_0002__en-us_topic_0000001745910893_p14916151193020">diagnosis</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.2 "><p id="rds_17_0002__en-us_topic_0000001745910893_p19916813303">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.3 "><p id="rds_17_0002__en-us_topic_0000001745910893_p1191621173018">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.1.2.2.5.1.4 "><p id="rds_17_0002__en-us_topic_0000001745910893_p199164153020">Diagnosis item.</p>
<p id="rds_17_0002__en-us_topic_0000001745910893_p1191610113309">Enumerated values:</p>
<ul id="rds_17_0002__en-us_topic_0000001745910893_ul5916618305"><li id="rds_17_0002__en-us_topic_0000001745910893_li39171214301">high_pressure</li><li id="rds_17_0002__en-us_topic_0000001745910893_li49171613301">lock_wait</li><li id="rds_17_0002__en-us_topic_0000001745910893_li191715119305">insufficient_capacity</li><li id="rds_17_0002__en-us_topic_0000001745910893_li129172163019">slow_sql_frequency</li><li id="rds_17_0002__en-us_topic_0000001745910893_li199176115308">disk_performance_cap</li><li id="rds_17_0002__en-us_topic_0000001745910893_li179171817308">mem_overrun</li><li id="rds_17_0002__en-us_topic_0000001745910893_li109174111303">age_exceed</li><li id="rds_17_0002__en-us_topic_0000001745910893_li39171311301">connections_exceed</li></ul>
</td>
</tr>
<tr id="rds_17_0002__en-us_topic_0000001745910893_row492910120301"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.1 "><p id="rds_17_0002__en-us_topic_0000001745910893_p191718117308">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.2 "><p id="rds_17_0002__en-us_topic_0000001745910893_p1191717113010">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.3 "><p id="rds_17_0002__en-us_topic_0000001745910893_p119179143012">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.1.2.2.5.1.4 "><p id="rds_17_0002__en-us_topic_0000001745910893_p176772573157">Index offset.</p>
<p id="rds_17_0002__en-us_topic_0000001745910893_p87484387137">If <strong id="rds_17_0002__b5463191064310">offset</strong> is set to <em id="rds_17_0002__i114636109437">N</em>, the resource query starts from the <em id="rds_17_0002__i1846319107432">N</em>+1 piece of data. The value is <strong id="rds_17_0002__b646471014437">0</strong> by default, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number.</p>
</td>
</tr>
<tr id="rds_17_0002__en-us_topic_0000001745910893_row392811153013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.1 "><p id="rds_17_0002__en-us_topic_0000001745910893_p791713112309">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.2 "><p id="rds_17_0002__en-us_topic_0000001745910893_p191719115302">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.1.2.2.5.1.3 "><p id="rds_17_0002__en-us_topic_0000001745910893_p791761183013">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.1.2.2.5.1.4 "><p id="rds_17_0002__en-us_topic_0000001745910893_p1552833141019">Number of returned results. Default value: <strong id="rds_17_0002__b521112414435">10</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="rds_17_0002__en-us_topic_0000001745910893_section36474591"><h4 class="sectiontitle">Request</h4><ul id="rds_17_0002__en-us_topic_0000001745910893_ul1183180183717"><li id="rds_17_0002__en-us_topic_0000001745910893_li1283110163719">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_17_0002__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="rds_17_0002__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="rds_17_0002__p95111733143318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="rds_17_0002__p13511123373311">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="rds_17_0002__p125111433133312">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="rds_17_0002__p551110331335">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rds_17_0002__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_17_0002__p1163015550331">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="rds_17_0002__p1963035563316">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="rds_17_0002__p1630105520331">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="rds_17_0002__p1086851153317">Specifies the user token.</p>
<p id="rds_17_0002__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="rds_17_0002__en-us_topic_0000001745910893_li4411135064210">URI example<p id="rds_17_0002__en-us_topic_0000001745910893_p1454414211213"><a name="rds_17_0002__en-us_topic_0000001745910893_li4411135064210"></a><a name="en-us_topic_0000001745910893_li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/diagnosis/info?engine=sqlserver&amp;diagnosis=high_pressure&amp;offset=1&amp;limit=10</p>
</li></ul>
</div>
<div class="section" id="rds_17_0002__en-us_topic_0000001745910893_section59835867"><h4 class="sectiontitle">Response</h4><ul id="rds_17_0002__en-us_topic_0000001745910893_ul66273227"><li id="rds_17_0002__en-us_topic_0000001745910893_li59588135">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_17_0002__en-us_topic_0000001745910893_table66531170" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="rds_17_0002__en-us_topic_0000001745910893_row12984378"><th align="left" class="cellrowborder" valign="top" width="19.220000000000002%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_17_0002__en-us_topic_0000001745910893_p45101667">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.01%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_17_0002__en-us_topic_0000001745910893_p29356372">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.77%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_17_0002__en-us_topic_0000001745910893_p29055926">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rds_17_0002__en-us_topic_0000001745910893_row825019248308"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_17_0002__en-us_topic_0000001745910893_p7244102410308">diagnosis</p>
</td>
<td class="cellrowborder" valign="top" width="13.01%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_17_0002__en-us_topic_0000001745910893_p8244122411308">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.77%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_17_0002__en-us_topic_0000001745910893_p1824482418306">Diagnosis item.</p>
<p id="rds_17_0002__en-us_topic_0000001745910893_p19244142418304">Enumerated values:</p>
<ul id="rds_17_0002__en-us_topic_0000001745910893_ul10244112415303"><li id="rds_17_0002__en-us_topic_0000001745910893_li724442415309">high_pressure</li><li id="rds_17_0002__en-us_topic_0000001745910893_li14244152463010">lock_wait</li><li id="rds_17_0002__en-us_topic_0000001745910893_li12441924183018">insufficient_capacity</li><li id="rds_17_0002__en-us_topic_0000001745910893_li11244142417309">slow_sql_frequency</li><li id="rds_17_0002__en-us_topic_0000001745910893_li224422483013">disk_performance_cap</li><li id="rds_17_0002__en-us_topic_0000001745910893_li8244172433013">mem_overrun</li><li id="rds_17_0002__en-us_topic_0000001745910893_li2024411243305">age_exceed</li><li id="rds_17_0002__en-us_topic_0000001745910893_li1424452418304">connections_exceed</li></ul>
</td>
</tr>
<tr id="rds_17_0002__en-us_topic_0000001745910893_row32501224103019"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_17_0002__en-us_topic_0000001745910893_p02441248301">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="13.01%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_17_0002__en-us_topic_0000001745910893_p17245524153018">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="67.77%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_17_0002__en-us_topic_0000001745910893_p1824562453020">Number of instances.</p>
</td>
</tr>
<tr id="rds_17_0002__en-us_topic_0000001745910893_row0250172413305"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_17_0002__en-us_topic_0000001745910893_p16245624103013">instances</p>
</td>
<td class="cellrowborder" valign="top" width="13.01%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_17_0002__en-us_topic_0000001745910893_p0788124273010">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="67.77%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_17_0002__en-us_topic_0000001745910893_p152451824123010">Specifies the DB instance ID.</p>
<p id="rds_17_0002__en-us_topic_0000001745910893_p14486235163017">For details, see <a href="#rds_17_0002__en-us_topic_0000001745910893_table1950773843311">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rds_17_0002__en-us_topic_0000001745910893_table1950773843311"></a><a name="en-us_topic_0000001745910893_table1950773843311"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_17_0002__en-us_topic_0000001745910893_table1950773843311" frame="border" border="1" rules="all"><caption><b>Table 5 </b>instances field data structure description</caption><thead align="left"><tr id="rds_17_0002__en-us_topic_0000001745910893_row1950719385338"><th align="left" class="cellrowborder" valign="top" width="19.220000000000002%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_17_0002__en-us_topic_0000001745910893_p165072385333">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.04%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_17_0002__en-us_topic_0000001745910893_p175081838173315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.74%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_17_0002__en-us_topic_0000001745910893_p1250813820337">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rds_17_0002__en-us_topic_0000001745910893_row20508638193311"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_17_0002__en-us_topic_0000001745910893_p108776183110">id</p>
</td>
<td class="cellrowborder" valign="top" width="13.04%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_17_0002__en-us_topic_0000001745910893_p68715611314">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.74%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_17_0002__en-us_topic_0000001745910893_p157511543162620">Specifies the DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="rds_17_0002__en-us_topic_0000001745910893_ul26818564"><li id="rds_17_0002__en-us_topic_0000001745910893_li40040492">Example normal response<pre class="screen" id="rds_17_0002__en-us_topic_0000001745910893_screen6425191110919">{
"diagnosis" : "high_pressure",
"total_count" : 1,
"instances" : [ {
"id" : "abd21a25fdedfd6db69721f4b761bc38in04"
} ]
}</pre>
</li><li id="rds_17_0002__en-us_topic_0000001745910893_li15461118163817">Abnormal response<p id="rds_17_0002__p46896054"><a name="rds_17_0002__en-us_topic_0000001745910893_li15461118163817"></a><a name="en-us_topic_0000001745910893_li15461118163817"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
</li></ul>
</div>
<div class="section" id="rds_17_0002__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_17_0002__en-us_topic_0032347778_ul7858132212142"><li id="rds_17_0002__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_17_0002__en-us_topic_0032347778_p1040982941020"><a name="rds_17_0002__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
</li><li id="rds_17_0002__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_17_0002__en-us_topic_0032347778_p0723374409"><a name="rds_17_0002__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
</li></ul>
</div>
<div class="section" id="rds_17_0002__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_17_0002__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_17_0000.html">Instance Diagnosis</a></div>
</div>
</div>
View Git Blame Copy Permalink