mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
Update documentation
This commit is contained in:
Sebastian Thiel
@@ -5,7 +5,7 @@
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Optimized Host Stats Get - Apigee v2.0.4+20210319</title>
|
||||
<title>Optimized Host Stats Get - Apigee v3.0.0+20220301</title>
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> Apigee v2.0.4+20210319</a>
|
||||
<a href=".." class="icon icon-home"> Apigee v3.0.0+20220301</a>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -130,6 +130,31 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_apiproducts-rateplans-create">Apiproducts Rateplans Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_apiproducts-rateplans-delete">Apiproducts Rateplans Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_apiproducts-rateplans-get">Apiproducts Rateplans Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_apiproducts-rateplans-list">Apiproducts Rateplans List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_apiproducts-rateplans-update">Apiproducts Rateplans Update</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_apiproducts-update">Apiproducts Update</a>
|
||||
|
||||
@@ -170,6 +195,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_apis-patch">Apis Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_apis-revisions-delete">Apis Revisions Delete</a>
|
||||
|
||||
@@ -360,6 +390,16 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-balance-adjust">Developers Balance Adjust</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-balance-credit">Developers Balance Credit</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-create">Developers Create</a>
|
||||
|
||||
@@ -375,6 +415,16 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-get-balance">Developers Get Balance</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-get-monetization-config">Developers Get Monetization Config</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-list">Developers List</a>
|
||||
|
||||
@@ -385,11 +435,56 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-subscriptions-create">Developers Subscriptions Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-subscriptions-expire">Developers Subscriptions Expire</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-subscriptions-get">Developers Subscriptions Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-subscriptions-list">Developers Subscriptions List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-update">Developers Update</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_developers-update-monetization-config">Developers Update Monetization Config</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_endpoint-attachments-create">Endpoint Attachments Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_endpoint-attachments-delete">Endpoint Attachments Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_endpoint-attachments-get">Endpoint Attachments Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_endpoint-attachments-list">Endpoint Attachments List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_envgroups-attachments-create">Envgroups Attachments Create</a>
|
||||
|
||||
@@ -510,6 +605,41 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_environments-archive-deployments-create">Environments Archive Deployments Create</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_environments-archive-deployments-delete">Environments Archive Deployments Delete</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_environments-archive-deployments-generate-download-url">Environments Archive Deployments Generate Download Url</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_environments-archive-deployments-generate-upload-url">Environments Archive Deployments Generate Upload Url</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_environments-archive-deployments-get">Environments Archive Deployments Get</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_environments-archive-deployments-list">Environments Archive Deployments List</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_environments-archive-deployments-patch">Environments Archive Deployments Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_environments-caches-delete">Environments Caches Delete</a>
|
||||
|
||||
@@ -820,6 +950,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_get-runtime-config">Get Runtime Config</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_get-sync-authorization">Get Sync Authorization</a>
|
||||
|
||||
@@ -930,6 +1065,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_instances-patch">Instances Patch</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_instances-report-status">Instances Report Status</a>
|
||||
|
||||
@@ -1009,6 +1149,11 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_set-addons">Set Addons</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="toctree-l1 ">
|
||||
<a class="" href="../organizations_set-sync-authorization">Set Sync Authorization</a>
|
||||
|
||||
@@ -1136,7 +1281,7 @@
|
||||
</div>
|
||||
<div role="main">
|
||||
<div class="section">
|
||||
<p>This api is similar to GetHostStats except that the response is less verbose.</p>
|
||||
<p>Similar to GetHostStats except that the response is less verbose.</p>
|
||||
<h1 id="scopes">Scopes</h1>
|
||||
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
||||
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
||||
@@ -1144,7 +1289,7 @@ You can set the scope for this method like this: <code>apigee1 --scope <scope
|
||||
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
||||
<ul>
|
||||
<li><strong><name></strong> <em>(string)</em><ul>
|
||||
<li>Required. The resource name for which the interactive query will be executed. Must be of the form <code>organizations/{organization_id}/optimizedHostStats/{dimensions}</code>. Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below <code>organizations/{org}/optimizedHostStats/apiproxy,request_verb</code></li>
|
||||
<li>Required. Resource name for which the interactive query will be executed. Use the following format in your request: <code>organizations/{organization_id}/optimizedHostStats/{dimensions}</code> Dimensions let you view metrics in meaningful groupings, such as <code>apiproxy</code>, <code>target_host</code>. The value of dimensions should be a comma-separated list as shown below: <code>organizations/{org}/optimizedHostStats/apiproxy,request_verb</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -1167,85 +1312,85 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
|
||||
<li>
|
||||
<p><strong>-p accuracy=string</strong></p>
|
||||
<ul>
|
||||
<li>Legacy field: not used anymore.</li>
|
||||
<li>No longer used by Apigee. Supported for backwards compatibility.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p envgroup-hostname=string</strong></p>
|
||||
<ul>
|
||||
<li>Required. The hostname for which the interactive query will be executed.</li>
|
||||
<li>Required. Hostname for which the interactive query will be executed.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p filter=string</strong></p>
|
||||
<ul>
|
||||
<li>Enables drill-down on specific dimension values.</li>
|
||||
<li>Filter that enables you to drill-down on specific dimension values.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p limit=string</strong></p>
|
||||
<ul>
|
||||
<li>This parameter is used to limit the number of result items. Default and the max value is 14400.</li>
|
||||
<li>Maximum number of result items to return. The default and maximum value that can be returned is 14400.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p offset=string</strong></p>
|
||||
<ul>
|
||||
<li>Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.</li>
|
||||
<li>Offset value. Use <code>offset</code> with <code>limit</code> to enable pagination of results. For example, to display results 11-20, set limit to <code>10</code> and offset to <code>10</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p realtime=boolean</strong></p>
|
||||
<ul>
|
||||
<li>Legacy field: not used anymore.</li>
|
||||
<li>No longer used by Apigee. Supported for backwards compatibility.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p select=string</strong></p>
|
||||
<ul>
|
||||
<li>Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)</li>
|
||||
<li>Required. Comma-separated list of metrics. For example: <code>sum(message_count),sum(error_count)</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p sort=string</strong></p>
|
||||
<ul>
|
||||
<li>This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.</li>
|
||||
<li>Flag that specifies whether the sort order should be ascending or descending. Valid values include <code>DESC</code> and <code>ASC</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p sortby=string</strong></p>
|
||||
<ul>
|
||||
<li>Comma separated list of columns to sort the final result.</li>
|
||||
<li>Comma-separated list of columns used to sort the final result.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p time-range=string</strong></p>
|
||||
<ul>
|
||||
<li>Required. Time interval for the interactive query. Time range is specified as start~end. E.g 04/15/2017 00:00~05/15/2017 23:59.</li>
|
||||
<li>Required. Time interval for the interactive query. Time range is specified in GMT as <code>start~end</code>. For example: <code>04/15/2017 00:00~05/15/2017 23:59</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p time-unit=string</strong></p>
|
||||
<ul>
|
||||
<li>A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.</li>
|
||||
<li>Granularity of metrics returned. Valid values include: <code>second</code>, <code>minute</code>, <code>hour</code>, <code>day</code>, <code>week</code>, or <code>month</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p topk=string</strong></p>
|
||||
<ul>
|
||||
<li>Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.</li>
|
||||
<li>Top number of results to return. For example, to return the top 5 results, set <code>topk=5</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p ts-ascending=boolean</strong></p>
|
||||
<ul>
|
||||
<li>Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.</li>
|
||||
<li>Flag that specifies whether to list timestamps in ascending (<code>true</code>) or descending (<code>false</code>) order. Apigee recommends that you set this value to <code>true</code> if you are using <code>sortby</code> with <code>sort=DESC</code>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p tzo=string</strong></p>
|
||||
<ul>
|
||||
<li>This parameters contains the timezone offset value.</li>
|
||||
<li>Timezone offset value.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
Reference in New Issue
Block a user