vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/fg/api-ref/functiongraph_06_0138.html
Chen, Junjie 7914103af1 FG API 20230725 version 
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-04-09 08:59:29 +00:00

286 lines
18 KiB
HTML
Raw Permalink Blame History

<a name="functiongraph_06_0138"></a><a name="functiongraph_06_0138"></a>
<h1 class="topictitle1">Querying Metrics in a Specified Period</h1>
<div id="body362051711510"><div class="section" id="functiongraph_06_0138__section2620121715110"><h4 class="sectiontitle">Function</h4><p id="functiongraph_06_0138__p762015175519">This API is used to query metrics of a function in a specified period.</p>
</div>
<div class="section" id="functiongraph_06_0138__section7621917175119"><h4 class="sectiontitle">URI</h4><p id="functiongraph_06_0138__p962251735119">GET /v2/{project_id}/fgs/functions/{func_urn}/statistics/{period}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0138__table1362415174517" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="functiongraph_06_0138__row66231117115113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="functiongraph_06_0138__p562451714519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="functiongraph_06_0138__p3624111717519">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="functiongraph_06_0138__p1762421715119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="functiongraph_06_0138__p96241817175119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="functiongraph_06_0138__row06231117195111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="functiongraph_06_0138__p126251517155114">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="functiongraph_06_0138__p8625111718510">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="functiongraph_06_0138__p8625191755113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="functiongraph_06_0138__p15626217155111">Project ID. For details, see <a href="functiongraph_06_0260.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row1062351717512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="functiongraph_06_0138__p462631711518">func_urn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="functiongraph_06_0138__p196262172513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="functiongraph_06_0138__p12626191719515">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="functiongraph_06_0138__p3627181775113">Function URN. For details, see the function model description.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row1362331755114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="functiongraph_06_0138__p136271317155110">period</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="functiongraph_06_0138__p462715179518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="functiongraph_06_0138__p5627171785113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="functiongraph_06_0138__p1962721775114">Time range specified to query function execution metrics.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="functiongraph_06_0138__section20628131785111"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0138__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="functiongraph_06_0138__row1628191715513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="functiongraph_06_0138__p662912178513">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="functiongraph_06_0138__p166291917145112">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="functiongraph_06_0138__p186301017165110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="functiongraph_06_0138__p163012178517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="functiongraph_06_0138__row46291617135114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="functiongraph_06_0138__p4630317195110">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="functiongraph_06_0138__p19631817165118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="functiongraph_06_0138__p11631217195112">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="functiongraph_06_0138__p36311717105115">User token.</p>
<p id="functiongraph_06_0138__p2631917125120">It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row146291175512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="functiongraph_06_0138__p126311017135116">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="functiongraph_06_0138__p563213174512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="functiongraph_06_0138__p18632117155112">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="functiongraph_06_0138__p163212171519">Message body type (format).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="functiongraph_06_0138__section146321817185112"><h4 class="sectiontitle">Response Parameters</h4><p id="functiongraph_06_0138__p5633101718511"><strong id="functiongraph_06_0138__b1633191775116">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0138__response_ListFunctionStatisticsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="functiongraph_06_0138__row1163317173515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="functiongraph_06_0138__p7635171713516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="functiongraph_06_0138__p26354172516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="functiongraph_06_0138__p1663561717518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="functiongraph_06_0138__row106331178518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p116357174513">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p1063631718516">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p863613174518">Function invocations.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row106331217175117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p13637151719517">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p1964151711515">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p106419177517">Average latency, in milliseconds.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row166341517165112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p146411717135111">fail_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p2642101765117">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p1364241735110">Number of errors.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row146341717155113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p15642161717517">max_duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p7642121712518">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p4642121717512">Maximum latency, in milliseconds.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row7634131713511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p764351710517">min_duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p1564371755116">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p156431417115110">Minimum latency, in milliseconds.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row10634141720518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p1264341795113">reject_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p1364311715514">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p176441917115114">Number of throttles.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row166341017135119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p19644817125113">function_error_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p1464420176511">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p66447172517">Number of function errors.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row863411725115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p9644121710510">system_error_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p2064520179516">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p17645617205110">Number of system errors.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row1163441785113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p16645161785111">reserved_instance_num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p5645121725116">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p14645111710516">Reserved instance metrics.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row1634181719512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0138__p116453175512">concurrency_num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0138__p16646171713514">Array of <a href="#functiongraph_06_0138__response_SlaReportsValue">SlaReportsValue</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0138__p126461817125116">Elastic instance metrics.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="functiongraph_06_0138__response_SlaReportsValue"></a><a name="response_SlaReportsValue"></a><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0138__response_SlaReportsValue" frame="border" border="1" rules="all"><caption><b>Table 4 </b>SlaReportsValue</caption><thead align="left"><tr id="functiongraph_06_0138__row1364611714510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="functiongraph_06_0138__p564741705113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="functiongraph_06_0138__p664771725111">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="functiongraph_06_0138__p196480170518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="functiongraph_06_0138__row8646161795112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="functiongraph_06_0138__p3648151713513">timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="functiongraph_06_0138__p66481717195119">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="functiongraph_06_0138__p064918175512">Timestamp.</p>
</td>
</tr>
<tr id="functiongraph_06_0138__row16647717145110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="functiongraph_06_0138__p565111711519">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="functiongraph_06_0138__p17651121765119">Double</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="functiongraph_06_0138__p965121720518">Value. If the value is -1, the metric has no data in the current period. The possible cause is that the function is not executed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="functiongraph_06_0138__section18651121716513"><h4 class="sectiontitle">Example Requests</h4><p id="functiongraph_06_0138__p1465115176518">Query metrics of a function in a specified period.</p>
<pre class="screen" id="functiongraph_06_0138__screen36521817115117">GET /v2/{project_id}/fgs/functions/{func_urn}/statistics/{period}</pre>
</div>
<div class="section" id="functiongraph_06_0138__section26521517105116"><h4 class="sectiontitle">Example Responses</h4><p id="functiongraph_06_0138__p2065291717512"><strong id="functiongraph_06_0138__b17652191785111">Status code: 200</strong></p>
<p id="functiongraph_06_0138__p2065218174515">ok</p>
<pre class="screen" id="functiongraph_06_0138__screen86550172512">{
"count" : [ {
"timestamp" : 1596679200000,
"value" : -1
}, {
"timestamp" : 1596682800000,
"value" : 2
}, {
"timestamp" : 1596686400000,
"value" : -1
} ],
"duration" : [ {
"timestamp" : 1596679200000,
"value" : -1
}, {
"timestamp" : 1596682800000,
"value" : 950
}, {
"timestamp" : 1596686400000,
"value" : -1
} ],
"fail_count" : [ {
"timestamp" : 1596679200000,
"value" : -1
}, {
"timestamp" : 1596682800000,
"value" : 0
}, {
"timestamp" : 1596686400000,
"value" : -1
} ],
"max_duration" : [ {
"timestamp" : 1596679200000,
"value" : -1
}, {
"timestamp" : 1596682800000,
"value" : 740
}, {
"timestamp" : 1596686400000,
"value" : -1
} ],
"min_duration" : [ {
"timestamp" : 1596679200000,
"value" : -1
}, {
"timestamp" : 1596682800000,
"value" : 210
}, {
"timestamp" : 1596686400000,
"value" : -1
} ],
"reject_count" : [ {
"timestamp" : 1596679200000,
"value" : -1
}, {
"timestamp" : 1596682800000,
"value" : 0
}, {
"timestamp" : 1596686400000,
"value" : -1
} ]
}</pre>
</div>
<div class="section" id="functiongraph_06_0138__section11661141745116"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0138__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="functiongraph_06_0138__row566241719515"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="functiongraph_06_0138__p156631917155120">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="functiongraph_06_0138__p2663617135116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="functiongraph_06_0138__row16662151735116"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="functiongraph_06_0138__p136631417185114">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="functiongraph_06_0138__p06644177519">ok</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="functiongraph_06_0138__section5664171705115"><h4 class="sectiontitle">Error Codes</h4><p id="functiongraph_06_0138__p0664141718515">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="FunctionMetrics.html">Function Metrics</a></div>
</div>
</div>
View Git Blame Copy Permalink