Files
doc-exports/docs/modelarts/api-ref/modelarts_03_0139.html
2025-07-28 12:24:54 +00:00

73 lines
10 KiB
HTML

<a name="EN-US_TOPIC_0000002374896637"></a><a name="EN-US_TOPIC_0000002374896637"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body39451090"><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640573_en-us_topic_0170093943_p14359124953115">ModelArts is a one-stop AI development platform geared toward developers and data scientists of all skill levels. It enables you to rapidly build, train, and deploy models anywhere (from the cloud to the edge), and manage full-lifecycle AI workflows. ModelArts accelerates AI development and fosters AI innovation with key capabilities, including data preprocessing and auto labeling, distributed training, automated model building, and one-click workflow execution. You can use ModelArts through open APIs.</p>
<p id="EN-US_TOPIC_0000002374896637__p10461651169">ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see <a href="modelarts_03_0005.html">Calling APIs</a>.</p>
<div class="section" id="EN-US_TOPIC_0000002374896637__section2081352311426"><a name="EN-US_TOPIC_0000002374896637__section2081352311426"></a><a name="section2081352311426"></a><h4 class="sectiontitle">Endpoint</h4><p id="EN-US_TOPIC_0000002374896637__p7150175811414">An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. To obtain the regions and endpoints, contact the enterprise administrator.</p>
<p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_en-us_topic_0000001072357044_en-us_topic_0278206748_p8060118">A service endpoint consists of the service name, region ID, and external domain name in the format of "{service_name}.{region_id}.{external_domain_name}". <a href="#EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_table24011519165716">Table 1</a> describes these parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_table24011519165716"></a><a name="en-us_topic_0000001072357044_table24011519165716"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_table24011519165716" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Endpoint parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_row19401111918577"><th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.3.4.2.4.1.1"><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p340115190577">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.3.4.2.4.1.2"><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p740181975719">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.4.2.4.1.3"><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p240161915712">How to Obtain</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_row7402121913572"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p1140211910578">service_name</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p164021119145720">Service name abbreviation (case-insensitive)</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p14021519155719"><span class="parmvalue" id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_parmvalue14402619155719"><b>modelarts</b></span> for ModelArts by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_row140251920574"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p4402519145713">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p1402141925713">Region ID</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p54021919125717">Contact the system administrator to obtain.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_row164022196579"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p12402161918572">external_domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p5402919115710">External domain name suffix</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p20402161995711">Contact the system administrator to obtain.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="notice" id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_note2384341183220"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_p4384154133215">If an endpoint uses a domain name, configure the hosts file in the format of "{float-ip} {service_name}.{region_id}.{external_domain_name}" on the local PC. Contact the system administrator to obtain <span class="parmname" id="EN-US_TOPIC_0000002374896637__en-us_topic_0000001072357044_parmname125791532210"><b>float-ip</b></span>.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896637__section7124442174215"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0000002374896637__ul1835855615162"><li id="EN-US_TOPIC_0000002374896637__li18358115611612">For more constraints, see API description.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896637__section1487012593424"><h4 class="sectiontitle">Basic Concepts</h4><ul id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0170093947_ul128965163312"><li id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_li489681620316">Account<p id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_p1089611169316"><a name="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_li489681620316"></a><a name="en-us_topic_0170640577_en-us_topic_0169294976_li489681620316"></a>An account is created upon successful registration with the cloud platform. 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. </p>
</li><li id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_li1564913617106">Region<p id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_p10588103711107"><a name="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_li1564913617106"></a><a name="en-us_topic_0170640577_en-us_topic_0169294976_li1564913617106"></a>A region is a geographic area where 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>
</li><li id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_li1183783919109">AZ<p id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_p061084051014"><a name="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_li1183783919109"></a><a name="en-us_topic_0170640577_en-us_topic_0169294976_li1183783919109"></a>An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. An AZ's computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow users to build cross-AZ high-availability systems.</p>
</li><li id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_li3896216123113">Project<p id="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_p10896181643118"><a name="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_li3896216123113"></a><a name="en-us_topic_0170640577_en-us_topic_0169294976_li3896216123113"></a>Projects group and isolate compute, storage, and network resources across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. 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="EN-US_TOPIC_0000002374896637__en-us_topic_0170640577_en-us_topic_0169294976_fig1189614168311"><span class="figcap"><b>Figure 1 </b>Project isolation model</span><br><span><img id="EN-US_TOPIC_0000002374896637__image13501955111319" src="figure/en-us_image_0000002351870506.png" title="Click to enlarge" class="imgResize"></span></div>
</li></ul>
</div>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="modelarts_03_0001.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="modelarts_03_0141.html">Endpoint</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="modelarts_03_0142.html">Constraints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="modelarts_03_0143.html">Basic Concepts</a></strong><br>
</li>
</ul>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>