rms api 2.0.38.SP1
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
202
docs/rms/api-ref/ALL_META.TXT.json
Normal file
182
docs/rms/api-ref/CLASS.TXT.json
Normal file
3
docs/rms/api-ref/PARAMETERS.txt
Normal file
@ -0,0 +1,3 @@
|
||||
version=""
|
||||
language="en-us"
|
||||
type=""
|
BIN
docs/rms/api-ref/en-us_image_0000001342853528.png
Normal file
After Width: | Height: | Size: 32 KiB |
1
docs/rms/api-ref/public_sys-resources/ExpandCollapse.js
Normal file
@ -0,0 +1 @@
|
||||
var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d<f.length;d++){var e=f[d];if(e.className.indexOf(expandClassName)!=-1||e.className.indexOf(collapseClassName)!=-1||e.className.indexOf(collapseTableClassName)!=-1){if(a=="collapse"){if(e.tagName.toLowerCase()=="table"){e.className=collapseTableClassName}else{e.className=collapseClassName}}else{e.className=expandClassName}}}}function ExpandForHref(f){if(null==f||"#"==f||"###"==f){return}var a=null;try{a=document.getElementById(f)}catch(d){}if(null==a||a.length==0){return}try{var b=a.parentNode;while(b!=null&&b.tagName!="body"){if(b.className==collapseClassName){b.className=expandClassName}b=b.parentNode}}catch(c){}}window.onload=function(){var b=document.getElementsByTagName("div");for(var c=0;c<b.length;c++){var j=b[c];if(j.className.indexOf(expandClassName)!=-1){j.className=collapseClassName}}var d=document.getElementsByTagName("a");try{for(var c=0;c<d.length;c++){var f=d[c];var h=f.getAttribute("href");if(h!=""&&h!=null){f.addEventListener("click",showHasConref,false)}}}catch(g){}};function showHasConref(b){var a=b.currentTarget.getAttribute("href");try{if(a!=null&&a!="#"&&a.lastIndexOf("#")>-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}};
|
1
docs/rms/api-ref/public_sys-resources/avgCompile.js
Normal file
@ -0,0 +1 @@
|
||||
var name1=null;function test1(a){a=a.parentNode;a.className="test1"}function test2(a){a=a.parentNode;a.className="test2"}function test3(a){a=a.parentNode;a.className="test3"}function test4(a){a=a.parentNode;a.className="test4"}function test5(a){a=a.parentNode;a.className="test5"}function test6(a){a=a.parentNode;a.className="test6"}function test7(a){a=a.parentNode;a.className="test7"}function test8(a){a=a.parentNode;a.className="test8"}function test9(a){a=a.parentNode;a.className="test9"}function test10(a){a=a.parentNode;a.className="test10"}function test11(a){a=a.parentNode;a.className="test11"}function test12(a){a=a.parentNode;a.className="test12"}function test13(a){a=a.parentNode;a.className="test13"}function test2(a){a=a.parentNode;a.className="test2"}function test14(a){a=a.parentNode;a.className="test14"}function test15(a){a=a.parentNode;a.className="test15"}function test16(a){a=a.parentNode;a.className="test16"}function test17(a){a=a.parentNode;a.className="test17"}function test18(a){a=a.parentNode;a.className="test18"}function test19(a){a=a.parentNode;a.className="test19"}function test20(a){a=a.parentNode;a.className="test20"}function test21(a){a=a.parentNode;a.className="test21"}function test22(a){a=a.parentNode;a.className="test22"}function test23(a){a=a.parentNode;a.className="test23"};
|
BIN
docs/rms/api-ref/public_sys-resources/caution_3.0-en-us.png
Normal file
After Width: | Height: | Size: 2.7 KiB |
1
docs/rms/api-ref/public_sys-resources/commonltr.css
Normal file
2
docs/rms/api-ref/public_sys-resources/commonrtl.css
Normal file
@ -0,0 +1,2 @@
|
||||
/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with <div>. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式
|
||||
*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre}
|
BIN
docs/rms/api-ref/public_sys-resources/danger_3.0-en-us.png
Normal file
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/rms/api-ref/public_sys-resources/delta.gif
Normal file
After Width: | Height: | Size: 836 B |
BIN
docs/rms/api-ref/public_sys-resources/deltaend.gif
Normal file
After Width: | Height: | Size: 834 B |
BIN
docs/rms/api-ref/public_sys-resources/icon-arrowdn.gif
Normal file
After Width: | Height: | Size: 68 B |
BIN
docs/rms/api-ref/public_sys-resources/icon-arrowrt.gif
Normal file
After Width: | Height: | Size: 70 B |
BIN
docs/rms/api-ref/public_sys-resources/icon-caution.gif
Normal file
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/rms/api-ref/public_sys-resources/icon-danger.gif
Normal file
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/rms/api-ref/public_sys-resources/icon-huawei.gif
Normal file
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/rms/api-ref/public_sys-resources/icon-note.gif
Normal file
After Width: | Height: | Size: 983 B |
BIN
docs/rms/api-ref/public_sys-resources/icon-notice.gif
Normal file
After Width: | Height: | Size: 962 B |
BIN
docs/rms/api-ref/public_sys-resources/icon-tip.gif
Normal file
After Width: | Height: | Size: 879 B |
BIN
docs/rms/api-ref/public_sys-resources/icon-warning.gif
Normal file
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/rms/api-ref/public_sys-resources/note_3.0-en-us.png
Normal file
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/rms/api-ref/public_sys-resources/notice_3.0-en-us.png
Normal file
After Width: | Height: | Size: 1.6 KiB |
1
docs/rms/api-ref/public_sys-resources/popup.js
Normal file
@ -0,0 +1 @@
|
||||
var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!==null&&typeof document.body!=="undefined"){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(e){if(document.body===null||typeof document.body==="undefined"){return}if(i==0){return}clickFlag=true;var f=Json.parse("jsonData."+e);var a=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var b=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){b=0}var c=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=f;dhtmlgoodies_tooltip.style.left=c+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+b+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=c+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+b+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var d=dhtmlgoodies_tooltip.offsetWidth;if(d<dhtmlgoodies_tooltipMinWidth){d=dhtmlgoodies_tooltipMinWidth}dhtmlgoodies_tooltip.style.width=d+"px";dhtmlgoodies_tooltipShadow.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_tooltipShadow.style.height=dhtmlgoodies_tooltip.offsetHeight+"px";if((c+d)>a){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if((dhtmlgoodies_tooltip!==null&&typeof dhtmlgoodies_tooltip!=="undefined")&&+(dhtmlgoodies_tooltip.style!==null&&typeof dhtmlgoodies_tooltip.style!=="undefined")){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}};
|
BIN
docs/rms/api-ref/public_sys-resources/warning_3.0-en-us.png
Normal file
After Width: | Height: | Size: 3.1 KiB |
15
docs/rms/api-ref/rms_02_0001.html
Normal file
@ -0,0 +1,15 @@
|
||||
<a name="rms_02_0001"></a><a name="rms_02_0001"></a>
|
||||
|
||||
<h1 class="topictitle1">Before You Start</h1>
|
||||
<div id="body195mcpsimp"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0002.html">Introduction</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0003.html">Concepts</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0004.html">Querying Data by Page</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
12
docs/rms/api-ref/rms_02_0002.html
Normal file
@ -0,0 +1,12 @@
|
||||
<a name="rms_02_0002"></a><a name="rms_02_0002"></a>
|
||||
|
||||
<h1 class="topictitle1">Introduction</h1>
|
||||
<div id="body202mcpsimp"><p id="rms_02_0002__p203mcpsimp">Welcome to the <em id="rms_02_0002__i204mcpsimp">Resource Management Service API Reference</em>. The Resource Management Service (RMS) enables you to centrally manage your cloud resources. You can search for them.</p>
|
||||
<p id="rms_02_0002__p205mcpsimp">This document describes the RMS RESTful application programming interfaces (APIs), parameters, examples. This document describes how to use APIs to perform operations on RMS. For details about all supported operations, see <a href="rms_02_0005.html">API Overview</a>.</p>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_02_0001.html">Before You Start</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
23
docs/rms/api-ref/rms_02_0003.html
Normal file
@ -0,0 +1,23 @@
|
||||
<a name="rms_02_0003"></a><a name="rms_02_0003"></a>
|
||||
|
||||
<h1 class="topictitle1">Concepts</h1>
|
||||
<div id="body208mcpsimp"><ul id="rms_02_0003__ul209mcpsimp"><li id="rms_02_0003__li210mcpsimp">Account<p id="rms_02_0003__p211mcpsimp"><a name="rms_02_0003__li210mcpsimp"></a><a name="li210mcpsimp"></a>An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, which should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.</p>
|
||||
</li><li id="rms_02_0003__li212mcpsimp">Domain<p id="rms_02_0003__p213mcpsimp"><a name="rms_02_0003__li212mcpsimp"></a><a name="li212mcpsimp"></a>A domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The domain should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.</p>
|
||||
</li><li id="rms_02_0003__li214mcpsimp">User<p id="rms_02_0003__p215mcpsimp"><a name="rms_02_0003__li214mcpsimp"></a><a name="li214mcpsimp"></a>An IAM user is created by an account in IAM to use cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
|
||||
<p id="rms_02_0003__p216mcpsimp">You can view the account ID and IAM user ID on the My Credentials page of the management console. API authentication requires information such as the account name, domain name, username, and password.</p>
|
||||
</li><li id="rms_02_0003__li217mcpsimp">Region<p id="rms_02_0003__p218mcpsimp"><a name="rms_02_0003__li217mcpsimp"></a><a name="li217mcpsimp"></a>A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.</p>
|
||||
<p id="rms_02_0003__p219mcpsimp">Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.</p>
|
||||
</li><li id="rms_02_0003__li220mcpsimp">AZ<p id="rms_02_0003__p221mcpsimp"><a name="rms_02_0003__li220mcpsimp"></a><a name="li220mcpsimp"></a>An AZ comprises of one or more physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Computing, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ high-availability systems.</p>
|
||||
</li><li id="rms_02_0003__li222mcpsimp">Project<p id="rms_02_0003__p223mcpsimp"><a name="rms_02_0003__li222mcpsimp"></a><a name="li222mcpsimp"></a>A project corresponds to a region. Default projects are defined to group and physically isolate resources (including computing, storage, and network resources) across regions. Users can be granted permissions in a default project to access all resources under their accounts. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.</p>
|
||||
<div class="fignone" id="rms_02_0003__fig224mcpsimp"><span class="figcap"><b>Figure 1 </b>Project isolation model</span><br><span><img id="rms_02_0003__image108" src="en-us_image_0000001342853528.png"></span></div>
|
||||
<p id="rms_02_0003__p226mcpsimp">To view a project ID, go to the <strong id="rms_02_0003__b8744572283">My Credentials</strong> page.</p>
|
||||
</li><li id="rms_02_0003__li227mcpsimp">Enterprise project<p id="rms_02_0003__p228mcpsimp"><a name="rms_02_0003__li227mcpsimp"></a><a name="li227mcpsimp"></a>Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.</p>
|
||||
<p id="rms_02_0003__p229mcpsimp">For details about enterprise projects and about how to obtain enterprise project IDs, see <em id="rms_02_0003__i230mcpsimp">Enterprise Management User Guide</em>.</p>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_02_0001.html">Before You Start</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
43
docs/rms/api-ref/rms_02_0004.html
Normal file
@ -0,0 +1,43 @@
|
||||
<a name="rms_02_0004"></a><a name="rms_02_0004"></a>
|
||||
|
||||
<h1 class="topictitle1">Querying Data by Page</h1>
|
||||
<div id="body231mcpsimp"><p id="rms_02_0004__p232mcpsimp">Some RMS APIs support pagination query if you add <strong id="rms_02_0004__b233mcpsimp">limit</strong> and <strong id="rms_02_0004__b234mcpsimp">marker</strong> to the request URL. The value of <strong id="rms_02_0004__b235mcpsimp">marker</strong> must be the same as that returned in the last pagination query.</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0004__table236mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rms_02_0004__row244mcpsimp"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.1"><p id="rms_02_0004__p246mcpsimp"><strong id="rms_02_0004__b247mcpsimp">Parameter</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.2"><p id="rms_02_0004__p249mcpsimp"><strong id="rms_02_0004__b250mcpsimp">Type</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.3"><p id="rms_02_0004__p252mcpsimp"><strong id="rms_02_0004__b253mcpsimp">Mandatory</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.4"><p id="rms_02_0004__p255mcpsimp"><strong id="rms_02_0004__b256mcpsimp">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="rms_02_0004__row258mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.1 "><p id="rms_02_0004__p260mcpsimp">limit</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.2 "><p id="rms_02_0004__p262mcpsimp">Number</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.3 "><p id="rms_02_0004__p264mcpsimp">No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.4 "><p id="rms_02_0004__p266mcpsimp">Restricts the number of records displayed on each page. If <strong id="rms_02_0004__b267mcpsimp">limit</strong> is invalid, error code 400 will be returned.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_02_0004__row268mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.1 "><p id="rms_02_0004__p270mcpsimp">marker</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.2 "><p id="rms_02_0004__p272mcpsimp">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.3 "><p id="rms_02_0004__p274mcpsimp">No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.4 "><p id="rms_02_0004__p276mcpsimp">Specifies the <strong id="rms_02_0004__b277mcpsimp">marker</strong> value returned in the last pagination query. If <strong id="rms_02_0004__b278mcpsimp">marker</strong> is invalid, error code 400 will be returned.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_02_0001.html">Before You Start</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
25
docs/rms/api-ref/rms_02_0005.html
Normal file
@ -0,0 +1,25 @@
|
||||
<a name="rms_02_0005"></a><a name="rms_02_0005"></a>
|
||||
|
||||
<h1 class="topictitle1">API Overview</h1>
|
||||
<div id="body279mcpsimp">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0005__table280mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 1 </b>RMS APIs</caption><thead align="left"><tr id="rms_02_0005__row286mcpsimp"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.1.2.3.1.1"><p id="rms_02_0005__p288mcpsimp"><strong id="rms_02_0005__b289mcpsimp">API</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.1.2.3.1.2"><p id="rms_02_0005__p291mcpsimp"><strong id="rms_02_0005__b292mcpsimp">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="rms_02_0005__row294mcpsimp"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.1 "><p id="rms_02_0005__p296mcpsimp"><a href="rms_02_0007.html">Resource Query</a></p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.2 "><p id="rms_02_0005__p300mcpsimp">Query resources, query resource tags, and list cloud services.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_02_0005__row301mcpsimp"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.1 "><p id="rms_02_0005__p303mcpsimp"><a href="rms_02_0012.html">Resource Relationships</a></p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.2 "><p id="rms_02_0005__p307mcpsimp">Query resource relationships.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
13
docs/rms/api-ref/rms_02_0006.html
Normal file
@ -0,0 +1,13 @@
|
||||
<a name="rms_02_0006"></a><a name="rms_02_0006"></a>
|
||||
|
||||
<h1 class="topictitle1">APIs</h1>
|
||||
<div id="body308mcpsimp"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0007.html">Resource Query</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0012.html">Resource Relationships</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
21
docs/rms/api-ref/rms_02_0007.html
Normal file
@ -0,0 +1,21 @@
|
||||
<a name="rms_02_0007"></a><a name="rms_02_0007"></a>
|
||||
|
||||
<h1 class="topictitle1">Resource Query</h1>
|
||||
<div id="body313mcpsimp"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0008.html">Querying Resources of a Specific Type</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0009.html">Querying Cloud Services, Resources, and Regions Supported by RMS</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0010.html">Querying a Resource</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0011.html">Querying All Resources Under Your Account</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_02_0006.html">APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
469
docs/rms/api-ref/rms_02_0008.html
Normal file
338
docs/rms/api-ref/rms_02_0009.html
Normal file
424
docs/rms/api-ref/rms_02_0010.html
Normal file
746
docs/rms/api-ref/rms_02_0011.html
Normal file
15
docs/rms/api-ref/rms_02_0012.html
Normal file
@ -0,0 +1,15 @@
|
||||
<a name="rms_02_0012"></a><a name="rms_02_0012"></a>
|
||||
|
||||
<h1 class="topictitle1">Resource Relationships</h1>
|
||||
<div id="body2578mcpsimp"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0013.html">Querying Resource Relationships</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_02_0006.html">APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
389
docs/rms/api-ref/rms_02_0013.html
Normal file
13
docs/rms/api-ref/rms_02_0014.html
Normal file
@ -0,0 +1,13 @@
|
||||
<a name="rms_02_0014"></a><a name="rms_02_0014"></a>
|
||||
|
||||
<h1 class="topictitle1">Permissions Policies and Supported Actions</h1>
|
||||
<div id="body3053mcpsimp"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0015.html">Permissions Policies and Supported Actions</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0016.html">My Resources</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
24
docs/rms/api-ref/rms_02_0015.html
Normal file
@ -0,0 +1,24 @@
|
||||
<a name="rms_02_0015"></a><a name="rms_02_0015"></a>
|
||||
|
||||
<h1 class="topictitle1">Permissions Policies and Supported Actions</h1>
|
||||
<div id="body3058mcpsimp"><p id="rms_02_0015__p3059mcpsimp">This chapter describes fine-grained permissions management for your RMS. If your OTC account does not need individual IAM users, then you may skip over this chapter.</p>
|
||||
<p id="rms_02_0015__p3060mcpsimp">A policy is a set of permissions defined in JSON format. By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.</p>
|
||||
<p id="rms_02_0015__p3061mcpsimp">Based on the granularity of authorization, permissions are classified into roles and policies.</p>
|
||||
<ul id="rms_02_0015__ul3062mcpsimp"><li id="rms_02_0015__li3063mcpsimp">Roles are a type of service-based, coarse-grained authorization mechanism that defines permissions related to user responsibilities.</li><li id="rms_02_0015__li3064mcpsimp">Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</li></ul>
|
||||
<div class="note" id="rms_02_0015__note3065mcpsimp"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="rms_02_0015__p3066mcpsimp">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
|
||||
</div></div>
|
||||
<p id="rms_02_0015__p3067mcpsimp">An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully.</p>
|
||||
<div class="section" id="rms_02_0015__section3068mcpsimp"><h4 class="sectiontitle">Supported Actions</h4><p id="rms_02_0015__p3070mcpsimp">Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>
|
||||
<ul id="rms_02_0015__ul3071mcpsimp"><li id="rms_02_0015__li3072mcpsimp">Permissions: Statements in a policy that allow or deny certain operations.</li><li id="rms_02_0015__li3073mcpsimp">APIs: REST APIs that can be called by a user who has been granted specific permissions.</li><li id="rms_02_0015__li3074mcpsimp">Actions: Specific operations that are allowed or denied.</li><li id="rms_02_0015__li3075mcpsimp">Related actions: Actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the related actions.</li><li id="rms_02_0015__li3076mcpsimp">IAM projects or enterprise projects: Type of projects in which policies can be used to grant permissions. A policy can be applied to IAM projects, enterprise projects, or both. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM.<p id="rms_02_0015__p3077mcpsimp"><a name="rms_02_0015__li3076mcpsimp"></a><a name="li3076mcpsimp"></a>RMS supports the following actions that can be defined in custom policies:</p>
|
||||
<p id="rms_02_0015__p3078mcpsimp"><a href="rms_02_0016.html">My Resources</a> includes actions supported by all resource APIs, such as the APIs for viewing resource history and listing resources of a specific type.</p>
|
||||
</li></ul>
|
||||
<div class="note" id="rms_02_0015__note3081mcpsimp"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="rms_02_0015__p3082mcpsimp">The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.</p>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_02_0014.html">Permissions Policies and Supported Actions</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
48
docs/rms/api-ref/rms_02_0016.html
Normal file
@ -0,0 +1,48 @@
|
||||
<a name="rms_02_0016"></a><a name="rms_02_0016"></a>
|
||||
|
||||
<h1 class="topictitle1">My Resources</h1>
|
||||
<div id="body3083mcpsimp">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0016__table3084mcpsimp" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_02_0016__row3092mcpsimp"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.1.1.6.1.1"><p id="rms_02_0016__p3094mcpsimp"><strong id="rms_02_0016__b3095mcpsimp">Permission</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="37%" id="mcps1.3.1.1.6.1.2"><p id="rms_02_0016__p3097mcpsimp"><strong id="rms_02_0016__b3098mcpsimp">API</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.1.1.6.1.3"><p id="rms_02_0016__p3100mcpsimp"><strong id="rms_02_0016__b3101mcpsimp">Action</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.1.1.6.1.4"><p id="rms_02_0016__p3103mcpsimp"><strong id="rms_02_0016__b3104mcpsimp">IAM Project</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.1.1.6.1.5"><p id="rms_02_0016__p3106mcpsimp"><strong id="rms_02_0016__b3107mcpsimp">Enterprise Project</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="rms_02_0016__row3109mcpsimp"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.1.1.6.1.1 "><p id="rms_02_0016__p3111mcpsimp">Querying resources of a specific type</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.1.1.6.1.2 "><p id="rms_02_0016__p3113mcpsimp">GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.6.1.3 "><p id="rms_02_0016__p3115mcpsimp">rms:resources:list</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.1.1.6.1.4 "><p id="rms_02_0016__p3117mcpsimp">√</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.1.1.6.1.5 "><p id="rms_02_0016__p3119mcpsimp">N/A</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_02_0016__row3120mcpsimp"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.1.1.6.1.1 "><p id="rms_02_0016__p3122mcpsimp">Querying a resource</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.1.1.6.1.2 "><p id="rms_02_0016__p3124mcpsimp">GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources/{resource_id}</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.6.1.3 "><p id="rms_02_0016__p3126mcpsimp">rms:resources:get</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.1.1.6.1.4 "><p id="rms_02_0016__p3128mcpsimp">√</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.1.1.6.1.5 "><p id="rms_02_0016__p3130mcpsimp">N/A</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_02_0014.html">Permissions Policies and Supported Actions</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
13
docs/rms/api-ref/rms_02_0017.html
Normal file
@ -0,0 +1,13 @@
|
||||
<a name="rms_02_0017"></a><a name="rms_02_0017"></a>
|
||||
|
||||
<h1 class="topictitle1">Appendixes</h1>
|
||||
<div id="body3131mcpsimp"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0018.html">Error Codes</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_02_0019.html">Supported Resource</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
488
docs/rms/api-ref/rms_02_0018.html
Normal file
119
docs/rms/api-ref/rms_02_0019.html
Normal file
20
docs/rms/api-ref/rms_02_0020.html
Normal file
@ -0,0 +1,20 @@
|
||||
<a name="rms_02_0020"></a><a name="rms_02_0020"></a>
|
||||
|
||||
<h1 class="topictitle1">Change History</h1>
|
||||
<div id="body3818mcpsimp">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0020__table3819mcpsimp" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_02_0020__row3824mcpsimp"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.1.1.3.1.1"><p id="rms_02_0020__p3826mcpsimp"><strong id="rms_02_0020__b3827mcpsimp">Released On</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="75%" id="mcps1.3.1.1.3.1.2"><p id="rms_02_0020__p3829mcpsimp"><strong id="rms_02_0020__b3830mcpsimp">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="rms_02_0020__row3832mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.1.3.1.1 "><p id="rms_02_0020__p3834mcpsimp">2022-08-30</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="75%" headers="mcps1.3.1.1.3.1.2 "><p id="rms_02_0020__p3836mcpsimp">This issue is the first official release.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|