forked from docs/doc-exports
weihongmin1
89457a7fa8
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: weihongmin1 <weihongmin1@huawei.com> Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
203 lines
14 KiB
HTML
203 lines
14 KiB
HTML
<a name="ListProviders"></a><a name="ListProviders"></a>
|
|
|
|
<h1 class="topictitle1">Querying Supported Services</h1>
|
|
<div id="body8662426"><div class="section" id="ListProviders__section103531620113220"><h4 class="sectiontitle">Function</h4><p id="ListProviders__p135319203325">You can use this API to query services supported by EPS.</p>
|
|
</div>
|
|
<div class="section" id="ListProviders__section18354172043217"><h4 class="sectiontitle">URI</h4><p id="ListProviders__p535412012325">GET /v1.0/enterprise-projects/providers</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListProviders__table735942003210" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Query parameters</caption><thead align="left"><tr id="ListProviders__row1635715209326"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListProviders__p173591620203215">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListProviders__p163601320163218">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListProviders__p113601920183216">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListProviders__p436072013211">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListProviders__row12357920133217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListProviders__p1036214205329">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListProviders__p836318206322">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListProviders__p16363320193220">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListProviders__p18363152033215">Default value: 10, upper limit: 200, lower limit: 1.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListProviders__row1635742093218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListProviders__p3363120133220">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListProviders__p133641820193217">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListProviders__p103647204325">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListProviders__p20365120173210">Specifies the index position. The query starts from the next data record specified by offset. The value must be a number and cannot be a negative number. The default value is <strong id="ListProviders__b231014330541">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListProviders__row435782011323"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListProviders__p93652201328">provider</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListProviders__p17365192043214">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListProviders__p1836582013327">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListProviders__p236619203326">Cloud service name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListProviders__section1636642073210"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListProviders__en-us_topic_0000001430428421_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="ListProviders__row13367112016326"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListProviders__p4367920163213">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListProviders__p1036813207325">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListProviders__p1636802013216">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListProviders__p1136815205327">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListProviders__row9367520173218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListProviders__p18369132073215">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListProviders__p16369142013326">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListProviders__p8369192013216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListProviders__p33695204321">Specifies the user token. EPS is a global service. When calling the IAM API to obtain a user token, set <strong id="ListProviders__b12903847125514">scope</strong> to <strong id="ListProviders__b59031747185516">domain</strong>. The value of <strong id="ListProviders__b1943140125714">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListProviders__section18370020153212"><h4 class="sectiontitle">Response</h4><p id="ListProviders__p15370142016322"><strong id="ListProviders__b2096164105716">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListProviders__en-us_topic_0000001430428421_response_ProviderListResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="ListProviders__row6373172073216"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListProviders__p63751620193216">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListProviders__p13376172015326">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListProviders__p437619207329">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListProviders__row14373192011327"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListProviders__p173771920113218">providers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListProviders__p16377820173212">Array of <a href="#ListProviders__en-us_topic_0000001430428421_response_ProviderResponseBody">ProviderResponseBody</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListProviders__p937862043214">Specifies cloud services.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListProviders__row153745206324"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListProviders__p73787206325">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListProviders__p737915207327">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListProviders__p8379162053217">Specifies the total cloud services supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListProviders__en-us_topic_0000001430428421_response_ProviderResponseBody"></a><a name="en-us_topic_0000001430428421_response_ProviderResponseBody"></a><table cellpadding="4" cellspacing="0" summary="" id="ListProviders__en-us_topic_0000001430428421_response_ProviderResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ProviderResponseBody</caption><thead align="left"><tr id="ListProviders__row738022063210"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListProviders__p138112023219">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListProviders__p838120200325">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListProviders__p13382162053220">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListProviders__row23805200325"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListProviders__p3382122083214">provider</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListProviders__p638212205329">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListProviders__p03821020193211">Cloud service name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListProviders__row19380920193212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListProviders__p193833209323">provider_i18n_display_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListProviders__p16383162023210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListProviders__p838352083217">Specifies the display name of the cloud service. You can set the language by setting the <strong id="ListProviders__b193173819583">locale</strong> parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListProviders__row1738012043211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListProviders__p1938317204324">resource_types</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListProviders__p43846204328">Array of <a href="#ListProviders__en-us_topic_0000001430428421_response_ResourceTypeBody">ResourceTypeBody</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListProviders__p1938442053217">Specifies the resource type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListProviders__en-us_topic_0000001430428421_response_ResourceTypeBody"></a><a name="en-us_topic_0000001430428421_response_ResourceTypeBody"></a><table cellpadding="4" cellspacing="0" summary="" id="ListProviders__en-us_topic_0000001430428421_response_ResourceTypeBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResourceTypeBody</caption><thead align="left"><tr id="ListProviders__row1338562083213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListProviders__p1738618201329">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListProviders__p63864202321">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListProviders__p138632018326">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListProviders__row19385920103217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListProviders__p123871420143211">resource_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListProviders__p113871520173219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListProviders__p193885206327">Specifies the resource type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListProviders__row103858205322"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListProviders__p18388122053216">resource_type_i18n_display_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListProviders__p438992063217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListProviders__p73891205324">Specifies the display name of the resource type. You can set the language by setting the <strong id="ListProviders__b46458325592">locale</strong> parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListProviders__row93855203323"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListProviders__p1539092053213">regions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListProviders__p1139013204321">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListProviders__p1939132093218">Specifies the supported regions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListProviders__row19385122083213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListProviders__p1391192020322">global</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListProviders__p1139215207324">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListProviders__p17392122018320">Specifies whether the resource is a global resource.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListProviders__section17661122063219"><h4 class="sectiontitle">Example Request</h4><p id="ListProviders__p15661420103217">Querying supported services</p>
|
|
<pre class="screen" id="ListProviders__screen12661620173210">GET https://{Endpoint}/v1.0/enterprise-projects/providers</pre>
|
|
</div>
|
|
<div class="section" id="ListProviders__section1661122043216"><h4 class="sectiontitle">Example Response</h4><p id="ListProviders__p86616205321"><strong id="ListProviders__b1324744195718">Status code: 200</strong></p>
|
|
<pre class="screen" id="ListProviders__screen1666122018329">{
|
|
"providers" : [ {
|
|
"provider" : "evs",
|
|
"provider_i18n_display_name" : "Elastic Volume Service",
|
|
"resource_types" : {
|
|
"resource_type_i18n_display_name" : "volume",
|
|
"global" : false,
|
|
"resource_type" : "disk",
|
|
"regions" : [ "regionid1" ]
|
|
}
|
|
} ],
|
|
"total_count" : 1
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ListProviders__section4531164315292"><h4 class="sectiontitle">Status Code</h4><p id="ListProviders__p145228330242">For details, see <a href="en-us_topic_0171146972.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="ListProviders__section0396144719295"><h4 class="sectiontitle">Error Codes</h4><p id="ListProviders__p177044331253">For details, see <a href="en-us_topic_0121230887.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002.html">Querying Supported Services</a></div>
|
|
</div>
|
|
</div>
|
|
|