forked from docs/doc-exports
Lai, Weijian
14be84ba51
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com> Co-authored-by: Lai, Weijian <laiweijian4@huawei.com> Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
176 lines
16 KiB
HTML
176 lines
16 KiB
HTML
<a name="modelarts_03_0200"></a><a name="modelarts_03_0200"></a>
|
|
|
|
<h1 class="topictitle1">Querying Supported Service Deployment Specifications</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0200__en-us_topic_0210524455_section11788321431"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0200__en-us_topic_0210524455_p8964339164317">This API is used to query supported service deployment specifications.</p>
|
|
</div>
|
|
<p id="modelarts_03_0200__en-us_topic_0210524455_p152505581199">URI</p>
|
|
<p id="modelarts_03_0200__en-us_topic_0210524455_p19550955118">GET /v1/{project_id}/services/specifications</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0200__en-us_topic_0210524455_table217714595104" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0200__en-us_topic_0210524455_row817715591101"><th align="left" class="cellrowborder" valign="top" width="18.81188118811881%" id="mcps1.3.4.2.5.1.1"><p id="modelarts_03_0200__en-us_topic_0210524455_p11177165919106">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.4.2.5.1.2"><p id="modelarts_03_0200__en-us_topic_0210524455_p6177125931013">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.871287128712872%" id="mcps1.3.4.2.5.1.3"><p id="modelarts_03_0200__en-us_topic_0210524455_p5177105914105">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.48514851485149%" id="mcps1.3.4.2.5.1.4"><p id="modelarts_03_0200__en-us_topic_0210524455_p0177195914103">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0200__en-us_topic_0210524455_row3177165911107"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.5.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p3177559101013">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.4.2.5.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p19177155951012">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.4.2.5.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p51774594103">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.48514851485149%" headers="mcps1.3.4.2.5.1.4 "><p id="modelarts_03_0200__en-us_topic_0210524455_p10177359141020">Project ID. For details about how to obtain the project ID, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row9177359101017"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.5.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p13177459131018">is_personal_cluster</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.4.2.5.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p191773597101">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.4.2.5.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p6177115913104">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.48514851485149%" headers="mcps1.3.4.2.5.1.4 "><p id="modelarts_03_0200__en-us_topic_0210524455_p4177145931016">Whether to query the service deployment specifications supported by dedicated resource pool. The default value is <strong id="modelarts_03_0200__en-us_topic_0210524455_b1251212472515">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row0422942171119"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.5.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p1142214221116">infer_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.4.2.5.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p10422194221110">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.4.2.5.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p10422104214116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.48514851485149%" headers="mcps1.3.4.2.5.1.4 "><p id="modelarts_03_0200__en-us_topic_0210524455_p3901625164410">Inference mode. The default value is <strong id="modelarts_03_0200__en-us_topic_0210524455_b946285816511">real-time</strong>. The value can be <strong id="modelarts_03_0200__en-us_topic_0210524455_b845604741920">real-time</strong> or <strong id="modelarts_03_0200__en-us_topic_0210524455_b7339229155015">batch</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0200__en-us_topic_0210524455_section613171210124"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0200__en-us_topic_0210524455_p18131151211213">None</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0200__en-us_topic_0210524455_section31311212151210"><h4 class="sectiontitle">Response Body</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0200__en-us_topic_0210524455_table1912592318122" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0200__en-us_topic_0210524455_row3125182320122"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.6.2.2.4.1.1"><p id="modelarts_03_0200__en-us_topic_0210524455_p112518239126">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.6.2.2.4.1.2"><p id="modelarts_03_0200__en-us_topic_0210524455_p9126923121214">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.6.2.2.4.1.3"><p id="modelarts_03_0200__en-us_topic_0210524455_p13126923151214">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0200__en-us_topic_0210524455_row212662381217"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.6.2.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p3126162311217">specifications</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.6.2.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p5126202319122"><strong id="modelarts_03_0200__en-us_topic_0210524455_b12398516869">specification</strong> array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.2.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p412632341219">Supported service deployment specifications. For details, see <a href="#modelarts_03_0200__en-us_topic_0210524455_table16128205111319">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="modelarts_03_0200__en-us_topic_0210524455_table16128205111319"></a><a name="en-us_topic_0210524455_table16128205111319"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0200__en-us_topic_0210524455_table16128205111319" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="modelarts_03_0200__en-us_topic_0210524455_b25431718712">specification</strong> parameters</caption><thead align="left"><tr id="modelarts_03_0200__en-us_topic_0210524455_row2012818517132"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.6.3.2.4.1.1"><p id="modelarts_03_0200__en-us_topic_0210524455_p9129105181312">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.6.3.2.4.1.2"><p id="modelarts_03_0200__en-us_topic_0210524455_p201291859132">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67.67676767676768%" id="mcps1.3.6.3.2.4.1.3"><p id="modelarts_03_0200__en-us_topic_0210524455_p912965171313">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0200__en-us_topic_0210524455_row131294512138"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.6.3.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p2012912518137">specification</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p66721018181317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.67676767676768%" headers="mcps1.3.6.3.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p151291559136">Unique specifications ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row113741630161311"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.6.3.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p12374143081318">billing_spec</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p237413013136">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.67676767676768%" headers="mcps1.3.6.3.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p1837420308137">Unique ID of the billing specifications</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row16783481314"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.6.3.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p17673341130">spec_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p367173410135">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.67676767676768%" headers="mcps1.3.6.3.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p19811162184613">Specifications status</p>
|
|
<ul id="modelarts_03_0200__en-us_topic_0210524455_ul1309229114615"><li id="modelarts_03_0200__en-us_topic_0210524455_li1392963518465"><strong id="modelarts_03_0200__en-us_topic_0210524455_b62631950174">normal</strong>: The specifications are normal.</li><li id="modelarts_03_0200__en-us_topic_0210524455_li43091129134610"><strong id="modelarts_03_0200__en-us_topic_0210524455_b2418162317819">sellout</strong>: The specifications cannot be used to deploy services because they are sold out.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row18875151131315"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.6.3.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p287515116138">is_open</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p68751451151310">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.67676767676768%" headers="mcps1.3.6.3.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p18875125171314">Whether to enable the specifications. The default value is <strong id="modelarts_03_0200__en-us_topic_0210524455_b203220262912">true</strong>. If this parameter is set to <strong id="modelarts_03_0200__en-us_topic_0210524455_b89037302910">false</strong>, you need to submit a service ticket to apply for the specifications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row8716351414"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.6.3.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p1971033149">source_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p167733146">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.67676767676768%" headers="mcps1.3.6.3.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p1645210223478">Type of the model to which the specifications apply.</p>
|
|
<ul id="modelarts_03_0200__en-us_topic_0210524455_ul73311124174711"><li id="modelarts_03_0200__en-us_topic_0210524455_li965384054711">Empty: indicates a model generated by the user.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row71613414257"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.6.3.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p12161643259">is_free</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p516174162514">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.67676767676768%" headers="mcps1.3.6.3.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p1816120412518">Whether the flavor is free of charge. The value <strong id="modelarts_03_0200__en-us_topic_0210524455_b0280558152">true</strong> indicates that the flavor is free of charge.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row105241118152515"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.6.3.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p15524518152510">over_quota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p252441852516">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.67676767676768%" headers="mcps1.3.6.3.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p185241718142515">Whether the quota exceeds the upper limit. The value <strong id="modelarts_03_0200__en-us_topic_0210524455_b18824113671519">true</strong> indicates that the quota exceeds the upper limit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row05163159253"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.6.3.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p11517215202517">extend_params</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p1451791502517">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.67676767676768%" headers="mcps1.3.6.3.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p115171615102511">Billing item</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0200__en-us_topic_0210524455_row16191122572"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.6.3.2.4.1.1 "><p id="modelarts_03_0200__en-us_topic_0210524455_p2619712195712">display_en</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.6.3.2.4.1.2 "><p id="modelarts_03_0200__en-us_topic_0210524455_p8619212185715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.67676767676768%" headers="mcps1.3.6.3.2.4.1.3 "><p id="modelarts_03_0200__en-us_topic_0210524455_p9619181213572">Specifications description in English</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0200__en-us_topic_0210524455_section24381160485"><h4 class="sectiontitle">Samples</h4><ul id="modelarts_03_0200__en-us_topic_0210524455_ul12437171674811"><li id="modelarts_03_0200__en-us_topic_0210524455_li1043791620487">Sample request<pre class="screen" id="modelarts_03_0200__en-us_topic_0210524455_screen74370168481">GET https://endpoint/v1/{project_id}/services/specifications</pre>
|
|
</li></ul>
|
|
<ul id="modelarts_03_0200__en-us_topic_0210524455_ul18438141694819"><li id="modelarts_03_0200__en-us_topic_0210524455_li114388169486">Sample response<pre class="screen" id="modelarts_03_0200__en-us_topic_0210524455_screen0438161618483">{
|
|
"specifications": [
|
|
{
|
|
"specification": "modelarts.vm.gpu.v100",
|
|
"billing_spec": "modelarts.vm.gpu.v100",
|
|
"is_open": true,
|
|
"spec_status": "normal",
|
|
"is_free": false,
|
|
"over_quota": false,
|
|
"extend_params": 1
|
|
},
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0200__en-us_topic_0210524455_section16948739"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0200__en-us_topic_0210524455_p1731954913014">For details about the status code, see <a href="modelarts_03_0094.html#modelarts_03_0094__en-us_topic_0132773864_table1450010510213">Table 1</a>.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0200__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0200__p1572811255123">See <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_03_0081.html">Service Management</a></div>
|
|
</div>
|
|
</div>
|
|
|