vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
81c5e8ac5cc46fd2dd36207b81a0b7e30fbb9e3e
doc-exports/docs/modelarts/api-ref/modelarts_03_0086.html
Artem Goncharov 3196b64bfc move doc sources to other location (#3) 
move doc sources to other location

Reviewed-by: OpenTelekomCloud Bot <None>
2022-04-27 16:24:25 +00:00

356 lines
40 KiB
HTML
Raw Blame History

<a name="modelarts_03_0086"></a><a name="modelarts_03_0086"></a>
<h1 class="topictitle1">Updating Service Configurations</h1>
<div id="body8662426"><div class="section" id="modelarts_03_0086__en-us_topic_0130045990_section15493132575920"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0086__en-us_topic_0130045990_p185143185919">This API is used to update configurations of a model service. It can also be used to start or stop a service.</p>
</div>
<div class="section" id="modelarts_03_0086__en-us_topic_0130045990_section181341535122619"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0086__en-us_topic_0130045990_p28751615549">PUT /v1/{project_id}/services/{service_id}</p>
<div class="p" id="modelarts_03_0086__en-us_topic_0130045990_p14336111611503"><a href="#modelarts_03_0086__en-us_topic_0130045990_table10624434011">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="modelarts_03_0086__en-us_topic_0130045990_table10624434011"></a><a name="en-us_topic_0130045990_table10624434011"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0086__en-us_topic_0130045990_table10624434011" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0086__en-us_topic_0130045990_row13653412406"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0086__en-us_topic_0130045990_p8665404020">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0086__en-us_topic_0130045990_p46614184018">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0086__en-us_topic_0130045990_p668154124018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0086__en-us_topic_0130045990_p469204194016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0086__en-us_topic_0130045990_row1797617864917"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p8780885181639">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p40163046181639">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p31981288181639">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p40347522181639">Project ID. For details about how to obtain the project ID, see <a href="modelarts_03_0147.html#modelarts_03_0147">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_row870174164011"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p372348400">service_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p19736411406">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p174643403">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p575194174011">Service ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="modelarts_03_0086__en-us_topic_0130045990_section71456147333"><h4 class="sectiontitle">Request Body</h4><div class="p" id="modelarts_03_0086__en-us_topic_0130045990_p1829834125010"><a href="#modelarts_03_0086__en-us_topic_0130045990_table188019141442">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="modelarts_03_0086__en-us_topic_0130045990_table188019141442"></a><a name="en-us_topic_0130045990_table188019141442"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0086__en-us_topic_0130045990_table188019141442" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0086__en-us_topic_0130045990_row2085141411444"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.2.5.1.1"><p id="modelarts_03_0086__en-us_topic_0130045990_p887914144410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.2.5.1.2"><p id="modelarts_03_0086__en-us_topic_0130045990_p588131412444">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.2.5.1.3"><p id="modelarts_03_0086__en-us_topic_0130045990_p1890111404419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.3.2.2.2.5.1.4"><p id="modelarts_03_0086__en-us_topic_0130045990_p0922141448">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0086__en-us_topic_0130045990_row5939144448"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p159451474415">description</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p2097181416446">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p7984141443">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p499151454414">Service description, which contains a maximum of 100 characters. If this parameter is not set, the service description is not updated.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_row0878165523919"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p12878135510399">status</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p4878125516398">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p7878195533917">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p6878135573918">Service status. The value can be <strong id="modelarts_03_0086__en-us_topic_0130045990_b1065941718557">running</strong> or <strong id="modelarts_03_0086__en-us_topic_0130045990_b1286132119554">stopped</strong>. If this parameter is not set, the service status is not changed. <strong id="modelarts_03_0086__en-us_topic_0130045990_b1210001017106">status</strong> and <strong id="modelarts_03_0086__en-us_topic_0130045990_b4100161031014">config</strong> cannot be modified at the same time. If both parameters exist, modify only the <strong id="modelarts_03_0086__en-us_topic_0130045990_b18100110161013">status</strong> parameter.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_row15100141444414"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p410191434420">config</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p610231410445">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p1410451464419"><strong id="modelarts_03_0086__en-us_topic_0130045990_b1072918477618">config</strong> array corresponding to <strong id="modelarts_03_0086__en-us_topic_0130045990_b772919478613">infer_type</strong></p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p1210518145446">Service configuration. If this parameter is not set, the service is not updated. The model service is modified and the <strong id="modelarts_03_0086__en-us_topic_0130045990_b77671241114614">update_time</strong> parameter is returned only for requests with <strong id="modelarts_03_0086__en-us_topic_0130045990_b0854163912487">config</strong> updated.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_row061911416350"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p1361964203515">schedule</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p561919413356">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p176199493520"><strong id="modelarts_03_0086__en-us_topic_0130045990_b4637204016210">schedule</strong> array</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p20619164123510">Service scheduling configuration, which can be configured only for real-time services. By default, this parameter is not used. Services run for a long time. For details, see <a href="#modelarts_03_0086__en-us_topic_0130045990_table1892915349285">Table 5</a>.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_row145217386813"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p184531138282">additional_properties</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p2045353819817">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p04533384817">Map&lt;String, Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p154531438986">Additional service attribute, which facilitates service management</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0086__en-us_topic_0130045990_table6841887256" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b190922610169">config</strong> parameters of <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b16222163916163">real-time</strong></caption><thead align="left"><tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row4846788252"><th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.3.2.3.2.5.1.1"><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p884819812515">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.3.2.3.2.5.1.2"><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1985013812252">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.2.3.2.5.1.3"><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1852188192520">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.46534653465347%" id="mcps1.3.3.2.3.2.5.1.4"><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p38538832514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row1856380258"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1786010872513">model_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p386268152512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1386419814252">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p9866118172511">Model ID</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row1086798112511"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p986916812517">weight</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p687111819259">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p138731787259">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p19875118162511">Traffic weight allocated to a model. This parameter is mandatory only when <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b5285632201718">infer_type</strong> is set to <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b751912367172">real-time</strong>. The sum of the weights must be 100.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row1687613842514"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1187828182513">specification</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p38801282251">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p08821882254">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1732816427113">Resource specifications. Select specifications based on service requirements. </p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row1577715014366"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p49518457100">custom_spec</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1595144518103">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p2095144591017"><strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b17417104116391">custom_spec</strong> structure</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p795164591015">Custom specifications. Set this parameter when you use a dedicated resource pool. For details, see <a href="modelarts_03_0082.html#modelarts_03_0082__en-us_topic_0129882788_table134334512416">Table 6</a>.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row988558102512"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1588814812519">instance_count</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p68902872512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p18926812256">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p11894788252">Number of instances deployed in a model. The value must be greater than 0.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row208952088256"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p48972820252">envs</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1889910820252">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p119011483251">Map&lt;String, String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p590416818251">(Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank.</p>
<p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1933202593313">To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row184117584514"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1984255875116">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p28421358135110">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p6842125817517">string</p>
</td>
<td class="cellrowborder" valign="top" width="53.46534653465347%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p4842658185112">ID of a dedicated resource pool. By default, this parameter is left blank, indicating that no dedicated resource pool is used. </p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0086__en-us_topic_0130045990_table6420928063" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b174461719142117">config</strong> parameters of <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b127532110217">batch</strong></caption><thead align="left"><tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row12420102810614"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.4.2.5.1.1"><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p164282280612">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.4.2.5.1.2"><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1442892817613">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.4.2.5.1.3"><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p942814289610">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.3.2.4.2.5.1.4"><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p342819281067">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row242862813615"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1042811281364">model_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1343542810611">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p643515281612">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p144351289614">Model ID</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row644311283615"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1444316281614">specification</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1745022815613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p124501281565">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1445012281764">Resource flavor. Available options: <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b5824182213308">modelarts.vm.cpu.2u</strong> and <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b671143010304">modelarts.vm.gpu.p4</strong></p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row104508285618"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p645020286620">instance_count</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p104501028868">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p545910281362">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1745912811612">Number of instances deployed in a model.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row245911284618"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p174598287617">envs</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p194590281468">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p204591928064">Map&lt;String, String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p14459202819615">(Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank.</p>
<p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p7751032133413">To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row106241138135111"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p362417380511">src_type</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1662410381513">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p186242388512">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p5624163820510">Data source type. This parameter can be set to <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b14481412163019">ManifestFile</strong>. By default, this parameter is left blank, indicating that only files in the <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b163761134133017">src_path</strong> directory are read. If this parameter is set to <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b16420104411415">ManifestFile</strong>, <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b1474075184120">src_path</strong> must be a specific Manifest file path. You can specify multiple data paths in the Manifest file. </p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row27917187920"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p27919181917">src_path</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p37921815919">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p2791818799">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p137911181899">OBS path of the input data of a batch job</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row924312220920"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p13250162218914">dest_path</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p152505229917">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p122507220919">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p647112917104">OBS path of the output data of a batch job</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row47439433566"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p4743184317564">req_uri</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p97431443195610">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p769362075712">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p12743174314568">Inference API called in a batch task, which is a REST API in the model image. Select an API URI from the model <span class="parmvalue" id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_parmvalue89825505114"><b>config.json</b></span> file for inference. If a ModelArts built-in inference image is used, the value of this parameter is <span class="parmvalue" id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_parmvalue259414411118"><b>/</b></span>.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row34628464568"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1246314615563">mapping_type</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p16463154665614">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p127001020155716">String</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1935524110385">Mapping type of the input data. The value can be <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b14884203513113">file</strong> or <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b189763515317">csv</strong>.</p>
<ul id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_ul1226004413385"><li id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_li10900195016384">If you select <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b857165115313">file</strong>, each inference request corresponds to a file in the input data path. When this mode is used, <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b1713117713327">req_uri</strong> of this model can have only one input parameter and the type of this parameter is <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b11716724133218">file</strong>.</li><li id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_li126094413816">If you select <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b51761653163214">csv</strong>, each inference request corresponds to a row of data in the CSV file. When this mode is used, the files in the input data path can only be in CSV format and <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b10318151483410">mapping_rule</strong> needs to be configured to map the index of each parameter in the inference request body to the CSV file.</li></ul>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_row52721349165615"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p172741749115618">mapping_rule</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p127454975612">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p12274849145617">Map</p>
</td>
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p10153011183915">Mapping between input parameters and CSV data. This parameter is mandatory only when <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b1530995144513">mapping_type</strong> is set to <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b6309195124510">csv</strong>.</p>
<p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p1643134111314">Mapping rule: The mapping rule comes from the input parameter (<strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b13148827162211">input_params</strong>) in the model configuration file <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b192461033162216">config.json</strong>. When <span class="parmname" id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_parmname765411320412"><b>type</b></span> is set to <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b775182713213">string</strong>, <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b1369692913211">number</strong>, <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b545863313213">integer</strong>, or <strong id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_b17721184218325">boolean</strong>, you need to configure the index parameter. For details, see .</p>
<p id="modelarts_03_0086__en-us_topic_0130045990_en-us_topic_0129882788_p2043174112315">The index must be a positive integer starting from 0. If the value of index does not comply with the rule, this parameter is ignored in the request. After the mapping rule is configured, the corresponding CSV data must be separated by commas (,).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="modelarts_03_0086__en-us_topic_0130045990_table1892915349285"></a><a name="en-us_topic_0130045990_table1892915349285"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0086__en-us_topic_0130045990_table1892915349285" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="modelarts_03_0086__en-us_topic_0130045990_b566614125320">schedule</strong> parameters</caption><thead align="left"><tr id="modelarts_03_0086__en-us_topic_0130045990_row9929133418283"><th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.3.3.2.5.1.1"><p id="modelarts_03_0086__en-us_topic_0130045990_p7929113442813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.3.3.2.5.1.2"><p id="modelarts_03_0086__en-us_topic_0130045990_p49301534192811">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.871287128712872%" id="mcps1.3.3.3.2.5.1.3"><p id="modelarts_03_0086__en-us_topic_0130045990_p199305340285">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.44554455445545%" id="mcps1.3.3.3.2.5.1.4"><p id="modelarts_03_0086__en-us_topic_0130045990_p7930173472812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0086__en-us_topic_0130045990_row1893015341284"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p15930834142811">type</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p19930434162810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p15930193412820">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.44554455445545%" headers="mcps1.3.3.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p1393083414285">Scheduling type. Only the value <strong id="modelarts_03_0086__en-us_topic_0130045990_b6616426533">stop</strong> is supported.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_row179301634112811"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p1593053482815">time_unit</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p10930133402815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p129301334162818">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.44554455445545%" headers="mcps1.3.3.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p17746741122916">Scheduling time unit. Possible values are <strong id="modelarts_03_0086__en-us_topic_0130045990_b2283123120318">DAYS</strong>, <strong id="modelarts_03_0086__en-us_topic_0130045990_b20284731636">HOURS</strong>, and <strong id="modelarts_03_0086__en-us_topic_0130045990_b102841311837">MINUTES</strong>.</p>
</td>
</tr>
<tr id="modelarts_03_0086__en-us_topic_0130045990_row89301634162818"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.3.2.5.1.1 "><p id="modelarts_03_0086__en-us_topic_0130045990_p39301334172816">duration</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.3.2.5.1.2 "><p id="modelarts_03_0086__en-us_topic_0130045990_p1293093442817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.3.2.5.1.3 "><p id="modelarts_03_0086__en-us_topic_0130045990_p12930734202819">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.44554455445545%" headers="mcps1.3.3.3.2.5.1.4 "><p id="modelarts_03_0086__en-us_topic_0130045990_p753864762914">Value that maps to the time unit. For example, if the task stops after two hours, set <strong id="modelarts_03_0086__en-us_topic_0130045990_b1522116351834">time_unit</strong> to <strong id="modelarts_03_0086__en-us_topic_0130045990_b82228355319">HOURS</strong> and <strong id="modelarts_03_0086__en-us_topic_0130045990_b1422243512311">duration</strong> to <strong id="modelarts_03_0086__en-us_topic_0130045990_b522313351133">2</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="modelarts_03_0086__en-us_topic_0130045990_section54078976"><h4 class="sectiontitle">Response Body</h4><p id="modelarts_03_0086__en-us_topic_0130045990_p12262245525">None</p>
</div>
<div class="section" id="modelarts_03_0086__en-us_topic_0130045990_section1810193414711"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0086__en-us_topic_0130045990_p1626113524475">The following shows how to update a real-time service.</p>
</div>
<ul id="modelarts_03_0086__en-us_topic_0130045990_ul11661134735818"><li id="modelarts_03_0086__en-us_topic_0130045990_li8663184755814">Sample request<pre class="screen" id="modelarts_03_0086__en-us_topic_0130045990_screen1815816535552">PUT https://endpoint/v1/{project_id}/services/{service_id}
{
"description": "",
"status": "running",
"config": [{
"model_id": "xxxx",
"weight": "100",
"specification": "modelarts.vm.cpu.2u",
"instance_count": 1
}]
}</pre>
</li></ul>
<ul id="modelarts_03_0086__en-us_topic_0130045990_ul163453474715"><li id="modelarts_03_0086__en-us_topic_0130045990_li1533103454717">Sample response<pre class="screen" id="modelarts_03_0086__en-us_topic_0130045990_screen29439035618">{}</pre>
</li></ul>
<div class="section" id="modelarts_03_0086__en-us_topic_0130045990_section16948739"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0086__en-us_topic_0130045990_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>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_03_0081.html">Service Management</a></div>
</div>
</div>
View Git Blame Copy Permalink