vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/config/api-ref/rms_04_0201.html
Wei, Hongmin da6ca4fb3c Config API First Version 
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2024-08-22 10:49:27 +00:00

407 lines
28 KiB
HTML
Raw Blame History

<a name="rms_04_0201"></a><a name="rms_04_0201"></a>
<h1 class="topictitle1">Querying the Resource Recorder</h1>
<div id="body17393132434112"><div class="section" id="rms_04_0201__section4393182417411"><h4 class="sectiontitle">Function</h4><p id="rms_04_0201__p13393132444118">This API is used to query details about the resource recorder.</p>
</div>
<div class="section" id="rms_04_0201__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="rms_04_0201__p93931224164110">For details, see <a href="rms_03_0000.html">Calling APIs</a>.</p>
</div>
<div class="section" id="rms_04_0201__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="rms_04_0201__p1239419249419">GET /v1/resource-manager/domains/{domain_id}/tracker-config</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__table9395172414114" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="rms_04_0201__row193956246417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="rms_04_0201__p8396724154116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="rms_04_0201__p3396172414115">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="rms_04_0201__p16396112414419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="rms_04_0201__p193961524124119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row939562410418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rms_04_0201__p15396824134115">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rms_04_0201__p1539712412419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rms_04_0201__p15397224134115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rms_04_0201__p739792417411">Specifies tags.</p>
<p id="rms_04_0201__p16397172419417">Maximum: <strong id="rms_04_0201__b7397024174118">36</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0201__section15397152404112"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rms_04_0201__row173981224104113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="rms_04_0201__p1139917248416">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="rms_04_0201__p4399424134116">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="rms_04_0201__p19400132418411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="rms_04_0201__p740072444118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row20398142404112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0201__p19400102464119">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rms_04_0201__p14001024174120">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0201__p184015245418">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0201__p1640142410415">Specifies the invoker's token.</p>
</td>
</tr>
<tr id="rms_04_0201__row73984246412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0201__p154012248416">X-Security-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rms_04_0201__p8401924144111">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0201__p74011824104118">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0201__p840212242418">Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0201__section840222420413"><h4 class="sectiontitle">Response Parameters</h4><p id="rms_04_0201__p1640210248411"><strong id="rms_04_0201__b440217241419">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__response_TrackerConfigBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0201__row640272418412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="rms_04_0201__p1440372419415">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="rms_04_0201__p114041243419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="rms_04_0201__p7404162416418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row1840392484111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0201__p64041124134113">channel</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0201__p13404724184111"><a href="#rms_04_0201__response_ChannelConfigBody">ChannelConfigBody</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0201__p44041424194115">Specifies configurations for the tracker channel.</p>
</td>
</tr>
<tr id="rms_04_0201__row64031224194111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0201__p13405524204113">selector</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0201__p8405924124117"><a href="#rms_04_0201__response_SelectorConfigBody">SelectorConfigBody</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0201__p1240516246418">Specifies the selector.</p>
</td>
</tr>
<tr id="rms_04_0201__row24030244414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0201__p2040542414415">retention_period_in_days</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0201__p440562414418">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0201__p440692417416">Number of days for data storage.</p>
</td>
</tr>
<tr id="rms_04_0201__row12403112494117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0201__p24061224164111">agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0201__p11406132444110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0201__p9406142454120">Specifies the IAM agency name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0201__response_ChannelConfigBody"></a><a name="response_ChannelConfigBody"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__response_ChannelConfigBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ChannelConfigBody</caption><thead align="left"><tr id="rms_04_0201__row540611240415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="rms_04_0201__p1540712410419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="rms_04_0201__p4407152444113">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="rms_04_0201__p13408424144116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row11407182444120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0201__p8408152417410">smn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0201__p5408192417411"><a href="#rms_04_0201__response_TrackerSMNChannelConfigBody">TrackerSMNChannelConfigBody</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0201__p13408424144118">Specifies configurations for the SMN channel. For details about how to grant other accounts the permissions for publishing messages to SMN topics, see <strong id="rms_04_0201__b94089247411">Cross-Account Authorization</strong> (<strong id="rms_04_0201__b16408124104120">Resource Recorder</strong> &gt; <strong id="rms_04_0201__b1840812419419">Enabling, Configuring, or Modifying the Resource Recorder</strong>) in the <em id="rms_04_0201__i1240862410418">User Guide</em>.</p>
</td>
</tr>
<tr id="rms_04_0201__row5407142444111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0201__p540817249414">obs</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0201__p104091524124119"><a href="#rms_04_0201__response_TrackerOBSChannelConfigBody">TrackerOBSChannelConfigBody</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0201__p240920241415">Specifies configurations for the OBS bucket. For details about how to grant other accounts the permissions for dumping files to OBS buckets, see <strong id="rms_04_0201__b11409122410412">Cross-Account Authorization</strong> (<strong id="rms_04_0201__b8409524194118">Resource Recorder</strong> &gt; <strong id="rms_04_0201__b184091024194113">Enabling, Configuring, or Modifying the Resource Recorder</strong>) in the <em id="rms_04_0201__i9409524164117">User Guide</em>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0201__response_TrackerSMNChannelConfigBody"></a><a name="response_TrackerSMNChannelConfigBody"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__response_TrackerSMNChannelConfigBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>TrackerSMNChannelConfigBody</caption><thead align="left"><tr id="rms_04_0201__row340962412415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="rms_04_0201__p124101324164113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="rms_04_0201__p19411142414116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="rms_04_0201__p4411424194114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row340982464115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0201__p541162416416">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0201__p141118248412">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0201__p1741112484119">Specifies the region ID.</p>
</td>
</tr>
<tr id="rms_04_0201__row184101124164116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0201__p1341282417414">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0201__p1841292474115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0201__p04120245416">Specifies the project ID.</p>
</td>
</tr>
<tr id="rms_04_0201__row741072464119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0201__p941222415415">topic_urn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0201__p6412924204116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0201__p74131924184115">Specifies the SMN topic URN.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0201__response_TrackerOBSChannelConfigBody"></a><a name="response_TrackerOBSChannelConfigBody"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__response_TrackerOBSChannelConfigBody" frame="border" border="1" rules="all"><caption><b>Table 6 </b>TrackerOBSChannelConfigBody</caption><thead align="left"><tr id="rms_04_0201__row17413142474117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="rms_04_0201__p841492454111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="rms_04_0201__p141442414114">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="rms_04_0201__p14141024124115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row134131324114111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0201__p5415152464117">bucket_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0201__p16415142444118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0201__p641619248417">Specifies the OBS bucket name.</p>
<p id="rms_04_0201__p17416424204111">Maximum: <strong id="rms_04_0201__b154162024144120">63</strong></p>
</td>
</tr>
<tr id="rms_04_0201__row184136246415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0201__p154167247412">bucket_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0201__p6416202418418">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0201__p18416142411415">OBS bucket prefix</p>
<p id="rms_04_0201__p84171245413">Maximum: <strong id="rms_04_0201__b5417142419412">256</strong></p>
</td>
</tr>
<tr id="rms_04_0201__row16413112444110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0201__p741762444114">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0201__p16417624144112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0201__p9417192484113">Specifies the region ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0201__response_SelectorConfigBody"></a><a name="response_SelectorConfigBody"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__response_SelectorConfigBody" frame="border" border="1" rules="all"><caption><b>Table 7 </b>SelectorConfigBody</caption><thead align="left"><tr id="rms_04_0201__row15418112414113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="rms_04_0201__p4418142420415">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="rms_04_0201__p1341919244416">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="rms_04_0201__p12419192494114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row11418102414415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0201__p341982412411">all_supported</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0201__p1741982404116">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0201__p12419172412411">Specifies whether to select all supported resources.</p>
</td>
</tr>
<tr id="rms_04_0201__row1641892494118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0201__p11420122412418">resource_types</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0201__p15420024114117">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0201__p7420424194117">Specifies the resource type list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0201__p442082411417"><strong id="rms_04_0201__b14420924114119">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0201__row18421132414119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="rms_04_0201__p13421132444114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="rms_04_0201__p3422182494117">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="rms_04_0201__p184226249412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row442112454116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0201__p2422524184114">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0201__p1542215249414">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0201__p9422122411415">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0201__row134214247410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0201__p1742318241411">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0201__p1242332418415">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0201__p10423112419413">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0201__p19423112494118"><strong id="rms_04_0201__b19423172416415">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__response_ErrorResp_1" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0201__row12424824194116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="rms_04_0201__p642402464110">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="rms_04_0201__p1042415244419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="rms_04_0201__p15427162418415">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row12424122411417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0201__p642842419416">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0201__p4428182434112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0201__p17428124184118">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0201__row1642462484117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0201__p20428172474113">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0201__p1428142420416">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0201__p17429524164114">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0201__p34291024124120"><strong id="rms_04_0201__b10429172404118">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__response_ErrorResp_2" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0201__row2042912243410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p id="rms_04_0201__p94309246416">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p id="rms_04_0201__p7430624114118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p id="rms_04_0201__p184301524144112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row204291324194110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="rms_04_0201__p17431224164114">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="rms_04_0201__p14431424144114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="rms_04_0201__p843111245418">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0201__row11429112418411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="rms_04_0201__p343118245415">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="rms_04_0201__p5431152414113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="rms_04_0201__p74322242414">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0201__p1432132411413"><strong id="rms_04_0201__b0432172416412">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__response_ErrorResp_3" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0201__row1543262411418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.1"><p id="rms_04_0201__p143342424110">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.2"><p id="rms_04_0201__p1843312245419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.15.2.4.1.3"><p id="rms_04_0201__p1543422417412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row18432122474119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="rms_04_0201__p243462412418">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="rms_04_0201__p14434112415416">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="rms_04_0201__p6434172464116">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0201__row7432524164112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="rms_04_0201__p4434324174115">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="rms_04_0201__p943420244414">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="rms_04_0201__p643522424116">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0201__section13435182484116"><h4 class="sectiontitle">Example Requests</h4><p id="rms_04_0201__p9435142415418">None</p>
</div>
<div class="section" id="rms_04_0201__section1043511241415"><h4 class="sectiontitle">Example Responses</h4><p id="rms_04_0201__p1043519242413"><strong id="rms_04_0201__b1643512424116">Status code: 200</strong></p>
<p id="rms_04_0201__p164353242418">Operation succeeded.</p>
<pre class="screen" id="rms_04_0201__screen4861134173317">{
"channel": {
"smn": {
"region_id": "eu-de",
"project_id": "ecabfaea4fd6425ba80d6f8860d8847d",
"topic_urn": "urn:smn:eu-de:ecabfaea4fd6425ba80d6f8860d8847d:obs_testcase"
},
"obs": {
"bucket_name": "resource-dump",
"bucket_prefix": null,
"region_id": "eu-de"
}
},
"selector": {
"all_supported": true,
"resource_types": []
},
"retention_period_in_days": 2557,
"agency_name": "rms_tracker_agency"
}</pre>
</div>
<div class="section" id="rms_04_0201__section24912251414"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0201__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_04_0201__row4452624114114"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="rms_04_0201__p204917255410">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="rms_04_0201__p7491825114118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0201__row1452172420410"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0201__p104918259415">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0201__p1549225194112">Operation succeeded.</p>
</td>
</tr>
<tr id="rms_04_0201__row6453124194110"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0201__p949125194116">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0201__p1350125154119">Invalid parameters.</p>
</td>
</tr>
<tr id="rms_04_0201__row1345312241415"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0201__p35022534114">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0201__p5504251419">Authentication failed or you do not have the operation permissions.</p>
</td>
</tr>
<tr id="rms_04_0201__row1745311245410"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0201__p1250102520416">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0201__p450122517411">No resource recorder found.</p>
</td>
</tr>
<tr id="rms_04_0201__row8453142474110"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0201__p9501525174117">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0201__p5509251418">Server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0201__section65016258416"><h4 class="sectiontitle">Error Codes</h4><p id="rms_04_0201__p175016251416">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_04_0200.html">Resource Recorder</a></div>
</div>
</div>
View Git Blame Copy Permalink